Added large tests, bug fixes (#33)
closes #29, closes #17
- Added large tests for Libclang, cJSON and SQLite #17.
- Bug fix: Nested parsing, added tests for nested parsing. Sub parsers now use a stack to hold information about current declaration.
- Bug fix: Unsupported operation error when finding dynamic library path on windows #29.
- Added property originalName to Binding.
- Config provider now throws ConfigError if a required config is missing. This fixes tests not running previously due to exit call in config provider.
- Updated libclang wrapper to support running from multiple isolates (fixes concurrent test running).
diff --git a/bin/ffigen.dart b/bin/ffigen.dart
index 26f2605..4a321ee 100644
--- a/bin/ffigen.dart
+++ b/bin/ffigen.dart
@@ -11,7 +11,7 @@
import 'package:logging/logging.dart';
import 'package:yaml/yaml.dart' as yaml;
-var _logger = Logger('ffigen.dart');
+var _logger = Logger('ffigen.ffigen');
void main(List<String> args) {
// Parses the cmd args.
@@ -21,7 +21,13 @@
setupLogger(result);
// Create a config object.
- final config = getConfig(result);
+ Config config;
+ try {
+ config = getConfig(result);
+ } on ConfigError {
+ print('Please fix configuration errors and re-run the tool.');
+ exit(1);
+ }
// Parse the bindings according to config object provided.
final library = parser.parse(config);
diff --git a/example/libclang-example/generated_bindings.dart b/example/libclang-example/generated_bindings.dart
index eee8d52..924da2a 100644
--- a/example/libclang-example/generated_bindings.dart
+++ b/example/libclang-example/generated_bindings.dart
@@ -2466,445 +2466,6 @@
}
_dart_clang_indexTranslationUnit _clang_indexTranslationUnit;
-
- ffi.Pointer<ffi.Int8> clang_getCString_wrap(
- ffi.Pointer<CXString> string,
- ) {
- _clang_getCString_wrap ??= _dylib.lookupFunction<_c_clang_getCString_wrap,
- _dart_clang_getCString_wrap>('clang_getCString_wrap');
- return _clang_getCString_wrap(
- string,
- );
- }
-
- _dart_clang_getCString_wrap _clang_getCString_wrap;
-
- void clang_disposeString_wrap(
- ffi.Pointer<CXString> string,
- ) {
- _clang_disposeString_wrap ??= _dylib.lookupFunction<
- _c_clang_disposeString_wrap,
- _dart_clang_disposeString_wrap>('clang_disposeString_wrap');
- return _clang_disposeString_wrap(
- string,
- );
- }
-
- _dart_clang_disposeString_wrap _clang_disposeString_wrap;
-
- int clang_getCursorKind_wrap(
- ffi.Pointer<CXCursor> cursor,
- ) {
- _clang_getCursorKind_wrap ??= _dylib.lookupFunction<
- _c_clang_getCursorKind_wrap,
- _dart_clang_getCursorKind_wrap>('clang_getCursorKind_wrap');
- return _clang_getCursorKind_wrap(
- cursor,
- );
- }
-
- _dart_clang_getCursorKind_wrap _clang_getCursorKind_wrap;
-
- ffi.Pointer<CXString> clang_getCursorKindSpelling_wrap(
- int kind,
- ) {
- _clang_getCursorKindSpelling_wrap ??= _dylib.lookupFunction<
- _c_clang_getCursorKindSpelling_wrap,
- _dart_clang_getCursorKindSpelling_wrap>(
- 'clang_getCursorKindSpelling_wrap');
- return _clang_getCursorKindSpelling_wrap(
- kind,
- );
- }
-
- _dart_clang_getCursorKindSpelling_wrap _clang_getCursorKindSpelling_wrap;
-
- ffi.Pointer<CXType> clang_getCursorType_wrap(
- ffi.Pointer<CXCursor> cursor,
- ) {
- _clang_getCursorType_wrap ??= _dylib.lookupFunction<
- _c_clang_getCursorType_wrap,
- _dart_clang_getCursorType_wrap>('clang_getCursorType_wrap');
- return _clang_getCursorType_wrap(
- cursor,
- );
- }
-
- _dart_clang_getCursorType_wrap _clang_getCursorType_wrap;
-
- ffi.Pointer<CXString> clang_getTypeSpelling_wrap(
- ffi.Pointer<CXType> type,
- ) {
- _clang_getTypeSpelling_wrap ??= _dylib.lookupFunction<
- _c_clang_getTypeSpelling_wrap,
- _dart_clang_getTypeSpelling_wrap>('clang_getTypeSpelling_wrap');
- return _clang_getTypeSpelling_wrap(
- type,
- );
- }
-
- _dart_clang_getTypeSpelling_wrap _clang_getTypeSpelling_wrap;
-
- ffi.Pointer<CXString> clang_getTypeKindSpelling_wrap(
- int typeKind,
- ) {
- _clang_getTypeKindSpelling_wrap ??= _dylib.lookupFunction<
- _c_clang_getTypeKindSpelling_wrap,
- _dart_clang_getTypeKindSpelling_wrap>('clang_getTypeKindSpelling_wrap');
- return _clang_getTypeKindSpelling_wrap(
- typeKind,
- );
- }
-
- _dart_clang_getTypeKindSpelling_wrap _clang_getTypeKindSpelling_wrap;
-
- ffi.Pointer<CXType> clang_getResultType_wrap(
- ffi.Pointer<CXType> functionType,
- ) {
- _clang_getResultType_wrap ??= _dylib.lookupFunction<
- _c_clang_getResultType_wrap,
- _dart_clang_getResultType_wrap>('clang_getResultType_wrap');
- return _clang_getResultType_wrap(
- functionType,
- );
- }
-
- _dart_clang_getResultType_wrap _clang_getResultType_wrap;
-
- ffi.Pointer<CXType> clang_getPointeeType_wrap(
- ffi.Pointer<CXType> pointerType,
- ) {
- _clang_getPointeeType_wrap ??= _dylib.lookupFunction<
- _c_clang_getPointeeType_wrap,
- _dart_clang_getPointeeType_wrap>('clang_getPointeeType_wrap');
- return _clang_getPointeeType_wrap(
- pointerType,
- );
- }
-
- _dart_clang_getPointeeType_wrap _clang_getPointeeType_wrap;
-
- ffi.Pointer<CXType> clang_getCanonicalType_wrap(
- ffi.Pointer<CXType> typerefType,
- ) {
- _clang_getCanonicalType_wrap ??= _dylib.lookupFunction<
- _c_clang_getCanonicalType_wrap,
- _dart_clang_getCanonicalType_wrap>('clang_getCanonicalType_wrap');
- return _clang_getCanonicalType_wrap(
- typerefType,
- );
- }
-
- _dart_clang_getCanonicalType_wrap _clang_getCanonicalType_wrap;
-
- ffi.Pointer<CXType> clang_Type_getNamedType_wrap(
- ffi.Pointer<CXType> elaboratedType,
- ) {
- _clang_Type_getNamedType_wrap ??= _dylib.lookupFunction<
- _c_clang_Type_getNamedType_wrap,
- _dart_clang_Type_getNamedType_wrap>('clang_Type_getNamedType_wrap');
- return _clang_Type_getNamedType_wrap(
- elaboratedType,
- );
- }
-
- _dart_clang_Type_getNamedType_wrap _clang_Type_getNamedType_wrap;
-
- ffi.Pointer<CXCursor> clang_getTypeDeclaration_wrap(
- ffi.Pointer<CXType> cxtype,
- ) {
- _clang_getTypeDeclaration_wrap ??= _dylib.lookupFunction<
- _c_clang_getTypeDeclaration_wrap,
- _dart_clang_getTypeDeclaration_wrap>('clang_getTypeDeclaration_wrap');
- return _clang_getTypeDeclaration_wrap(
- cxtype,
- );
- }
-
- _dart_clang_getTypeDeclaration_wrap _clang_getTypeDeclaration_wrap;
-
- ffi.Pointer<CXType> clang_getTypedefDeclUnderlyingType_wrap(
- ffi.Pointer<CXCursor> cxcursor,
- ) {
- _clang_getTypedefDeclUnderlyingType_wrap ??= _dylib.lookupFunction<
- _c_clang_getTypedefDeclUnderlyingType_wrap,
- _dart_clang_getTypedefDeclUnderlyingType_wrap>(
- 'clang_getTypedefDeclUnderlyingType_wrap');
- return _clang_getTypedefDeclUnderlyingType_wrap(
- cxcursor,
- );
- }
-
- _dart_clang_getTypedefDeclUnderlyingType_wrap
- _clang_getTypedefDeclUnderlyingType_wrap;
-
- /// The name of parameter, struct, typedef.
- ffi.Pointer<CXString> clang_getCursorSpelling_wrap(
- ffi.Pointer<CXCursor> cursor,
- ) {
- _clang_getCursorSpelling_wrap ??= _dylib.lookupFunction<
- _c_clang_getCursorSpelling_wrap,
- _dart_clang_getCursorSpelling_wrap>('clang_getCursorSpelling_wrap');
- return _clang_getCursorSpelling_wrap(
- cursor,
- );
- }
-
- _dart_clang_getCursorSpelling_wrap _clang_getCursorSpelling_wrap;
-
- ffi.Pointer<CXCursor> clang_getTranslationUnitCursor_wrap(
- ffi.Pointer<CXTranslationUnitImpl> tu,
- ) {
- _clang_getTranslationUnitCursor_wrap ??= _dylib.lookupFunction<
- _c_clang_getTranslationUnitCursor_wrap,
- _dart_clang_getTranslationUnitCursor_wrap>(
- 'clang_getTranslationUnitCursor_wrap');
- return _clang_getTranslationUnitCursor_wrap(
- tu,
- );
- }
-
- _dart_clang_getTranslationUnitCursor_wrap
- _clang_getTranslationUnitCursor_wrap;
-
- ffi.Pointer<CXString> clang_formatDiagnostic_wrap(
- ffi.Pointer<ffi.Void> diag,
- int opts,
- ) {
- _clang_formatDiagnostic_wrap ??= _dylib.lookupFunction<
- _c_clang_formatDiagnostic_wrap,
- _dart_clang_formatDiagnostic_wrap>('clang_formatDiagnostic_wrap');
- return _clang_formatDiagnostic_wrap(
- diag,
- opts,
- );
- }
-
- _dart_clang_formatDiagnostic_wrap _clang_formatDiagnostic_wrap;
-
- /// Visitor is a function pointer with parameters having pointers to cxcursor
- /// instead of cxcursor by default.
- int clang_visitChildren_wrap(
- ffi.Pointer<CXCursor> parent,
- ffi.Pointer<ffi.NativeFunction<ModifiedCXCursorVisitor_1>> _modifiedVisitor,
- ffi.Pointer<ffi.Void> clientData,
- ) {
- _clang_visitChildren_wrap ??= _dylib.lookupFunction<
- _c_clang_visitChildren_wrap,
- _dart_clang_visitChildren_wrap>('clang_visitChildren_wrap');
- return _clang_visitChildren_wrap(
- parent,
- _modifiedVisitor,
- clientData,
- );
- }
-
- _dart_clang_visitChildren_wrap _clang_visitChildren_wrap;
-
- int clang_Cursor_getNumArguments_wrap(
- ffi.Pointer<CXCursor> cursor,
- ) {
- _clang_Cursor_getNumArguments_wrap ??= _dylib.lookupFunction<
- _c_clang_Cursor_getNumArguments_wrap,
- _dart_clang_Cursor_getNumArguments_wrap>(
- 'clang_Cursor_getNumArguments_wrap');
- return _clang_Cursor_getNumArguments_wrap(
- cursor,
- );
- }
-
- _dart_clang_Cursor_getNumArguments_wrap _clang_Cursor_getNumArguments_wrap;
-
- ffi.Pointer<CXCursor> clang_Cursor_getArgument_wrap(
- ffi.Pointer<CXCursor> cursor,
- int i,
- ) {
- _clang_Cursor_getArgument_wrap ??= _dylib.lookupFunction<
- _c_clang_Cursor_getArgument_wrap,
- _dart_clang_Cursor_getArgument_wrap>('clang_Cursor_getArgument_wrap');
- return _clang_Cursor_getArgument_wrap(
- cursor,
- i,
- );
- }
-
- _dart_clang_Cursor_getArgument_wrap _clang_Cursor_getArgument_wrap;
-
- int clang_getNumArgTypes_wrap(
- ffi.Pointer<CXType> cxtype,
- ) {
- _clang_getNumArgTypes_wrap ??= _dylib.lookupFunction<
- _c_clang_getNumArgTypes_wrap,
- _dart_clang_getNumArgTypes_wrap>('clang_getNumArgTypes_wrap');
- return _clang_getNumArgTypes_wrap(
- cxtype,
- );
- }
-
- _dart_clang_getNumArgTypes_wrap _clang_getNumArgTypes_wrap;
-
- ffi.Pointer<CXType> clang_getArgType_wrap(
- ffi.Pointer<CXType> cxtype,
- int i,
- ) {
- _clang_getArgType_wrap ??= _dylib.lookupFunction<_c_clang_getArgType_wrap,
- _dart_clang_getArgType_wrap>('clang_getArgType_wrap');
- return _clang_getArgType_wrap(
- cxtype,
- i,
- );
- }
-
- _dart_clang_getArgType_wrap _clang_getArgType_wrap;
-
- int clang_getEnumConstantDeclValue_wrap(
- ffi.Pointer<CXCursor> cursor,
- ) {
- _clang_getEnumConstantDeclValue_wrap ??= _dylib.lookupFunction<
- _c_clang_getEnumConstantDeclValue_wrap,
- _dart_clang_getEnumConstantDeclValue_wrap>(
- 'clang_getEnumConstantDeclValue_wrap');
- return _clang_getEnumConstantDeclValue_wrap(
- cursor,
- );
- }
-
- _dart_clang_getEnumConstantDeclValue_wrap
- _clang_getEnumConstantDeclValue_wrap;
-
- /// Returns non-zero if the ranges are the same, zero if they differ.
- int clang_equalRanges_wrap(
- ffi.Pointer<CXSourceRange> c1,
- ffi.Pointer<CXSourceRange> c2,
- ) {
- _clang_equalRanges_wrap ??= _dylib.lookupFunction<_c_clang_equalRanges_wrap,
- _dart_clang_equalRanges_wrap>('clang_equalRanges_wrap');
- return _clang_equalRanges_wrap(
- c1,
- c2,
- );
- }
-
- _dart_clang_equalRanges_wrap _clang_equalRanges_wrap;
-
- /// Returns the comment range.
- ffi.Pointer<CXSourceRange> clang_Cursor_getCommentRange_wrap(
- ffi.Pointer<CXCursor> cursor,
- ) {
- _clang_Cursor_getCommentRange_wrap ??= _dylib.lookupFunction<
- _c_clang_Cursor_getCommentRange_wrap,
- _dart_clang_Cursor_getCommentRange_wrap>(
- 'clang_Cursor_getCommentRange_wrap');
- return _clang_Cursor_getCommentRange_wrap(
- cursor,
- );
- }
-
- _dart_clang_Cursor_getCommentRange_wrap _clang_Cursor_getCommentRange_wrap;
-
- /// Returns the raw comment.
- ffi.Pointer<CXString> clang_Cursor_getRawCommentText_wrap(
- ffi.Pointer<CXCursor> cursor,
- ) {
- _clang_Cursor_getRawCommentText_wrap ??= _dylib.lookupFunction<
- _c_clang_Cursor_getRawCommentText_wrap,
- _dart_clang_Cursor_getRawCommentText_wrap>(
- 'clang_Cursor_getRawCommentText_wrap');
- return _clang_Cursor_getRawCommentText_wrap(
- cursor,
- );
- }
-
- _dart_clang_Cursor_getRawCommentText_wrap
- _clang_Cursor_getRawCommentText_wrap;
-
- /// Returns the first paragraph of doxygen doc comment.
- ffi.Pointer<CXString> clang_Cursor_getBriefCommentText_wrap(
- ffi.Pointer<CXCursor> cursor,
- ) {
- _clang_Cursor_getBriefCommentText_wrap ??= _dylib.lookupFunction<
- _c_clang_Cursor_getBriefCommentText_wrap,
- _dart_clang_Cursor_getBriefCommentText_wrap>(
- 'clang_Cursor_getBriefCommentText_wrap');
- return _clang_Cursor_getBriefCommentText_wrap(
- cursor,
- );
- }
-
- _dart_clang_Cursor_getBriefCommentText_wrap
- _clang_Cursor_getBriefCommentText_wrap;
-
- ffi.Pointer<CXSourceLocation> clang_getCursorLocation_wrap(
- ffi.Pointer<CXCursor> cursor,
- ) {
- _clang_getCursorLocation_wrap ??= _dylib.lookupFunction<
- _c_clang_getCursorLocation_wrap,
- _dart_clang_getCursorLocation_wrap>('clang_getCursorLocation_wrap');
- return _clang_getCursorLocation_wrap(
- cursor,
- );
- }
-
- _dart_clang_getCursorLocation_wrap _clang_getCursorLocation_wrap;
-
- void clang_getFileLocation_wrap(
- ffi.Pointer<CXSourceLocation> location,
- ffi.Pointer<ffi.Pointer<ffi.Void>> file,
- ffi.Pointer<ffi.Uint32> line,
- ffi.Pointer<ffi.Uint32> column,
- ffi.Pointer<ffi.Uint32> offset,
- ) {
- _clang_getFileLocation_wrap ??= _dylib.lookupFunction<
- _c_clang_getFileLocation_wrap,
- _dart_clang_getFileLocation_wrap>('clang_getFileLocation_wrap');
- return _clang_getFileLocation_wrap(
- location,
- file,
- line,
- column,
- offset,
- );
- }
-
- _dart_clang_getFileLocation_wrap _clang_getFileLocation_wrap;
-
- ffi.Pointer<CXString> clang_getFileName_wrap(
- ffi.Pointer<ffi.Void> SFile,
- ) {
- _clang_getFileName_wrap ??= _dylib.lookupFunction<_c_clang_getFileName_wrap,
- _dart_clang_getFileName_wrap>('clang_getFileName_wrap');
- return _clang_getFileName_wrap(
- SFile,
- );
- }
-
- _dart_clang_getFileName_wrap _clang_getFileName_wrap;
-
- int clang_getNumElements_wrap(
- ffi.Pointer<CXType> cxtype,
- ) {
- _clang_getNumElements_wrap ??= _dylib.lookupFunction<
- _c_clang_getNumElements_wrap,
- _dart_clang_getNumElements_wrap>('clang_getNumElements_wrap');
- return _clang_getNumElements_wrap(
- cxtype,
- );
- }
-
- _dart_clang_getNumElements_wrap _clang_getNumElements_wrap;
-
- ffi.Pointer<CXType> clang_getArrayElementType_wrap(
- ffi.Pointer<CXType> cxtype,
- ) {
- _clang_getArrayElementType_wrap ??= _dylib.lookupFunction<
- _c_clang_getArrayElementType_wrap,
- _dart_clang_getArrayElementType_wrap>('clang_getArrayElementType_wrap');
- return _clang_getArrayElementType_wrap(
- cxtype,
- );
- }
-
- _dart_clang_getArrayElementType_wrap _clang_getArrayElementType_wrap;
}
/// A character string.
@@ -4917,290 +4478,6 @@
ffi.Pointer<CXTranslationUnitImpl> arg5,
);
-typedef _c_clang_getCString_wrap = ffi.Pointer<ffi.Int8> Function(
- ffi.Pointer<CXString> string,
-);
-
-typedef _dart_clang_getCString_wrap = ffi.Pointer<ffi.Int8> Function(
- ffi.Pointer<CXString> string,
-);
-
-typedef _c_clang_disposeString_wrap = ffi.Void Function(
- ffi.Pointer<CXString> string,
-);
-
-typedef _dart_clang_disposeString_wrap = void Function(
- ffi.Pointer<CXString> string,
-);
-
-typedef _c_clang_getCursorKind_wrap = ffi.Int32 Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _dart_clang_getCursorKind_wrap = int Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _c_clang_getCursorKindSpelling_wrap = ffi.Pointer<CXString> Function(
- ffi.Int32 kind,
-);
-
-typedef _dart_clang_getCursorKindSpelling_wrap = ffi.Pointer<CXString> Function(
- int kind,
-);
-
-typedef _c_clang_getCursorType_wrap = ffi.Pointer<CXType> Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _dart_clang_getCursorType_wrap = ffi.Pointer<CXType> Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _c_clang_getTypeSpelling_wrap = ffi.Pointer<CXString> Function(
- ffi.Pointer<CXType> type,
-);
-
-typedef _dart_clang_getTypeSpelling_wrap = ffi.Pointer<CXString> Function(
- ffi.Pointer<CXType> type,
-);
-
-typedef _c_clang_getTypeKindSpelling_wrap = ffi.Pointer<CXString> Function(
- ffi.Int32 typeKind,
-);
-
-typedef _dart_clang_getTypeKindSpelling_wrap = ffi.Pointer<CXString> Function(
- int typeKind,
-);
-
-typedef _c_clang_getResultType_wrap = ffi.Pointer<CXType> Function(
- ffi.Pointer<CXType> functionType,
-);
-
-typedef _dart_clang_getResultType_wrap = ffi.Pointer<CXType> Function(
- ffi.Pointer<CXType> functionType,
-);
-
-typedef _c_clang_getPointeeType_wrap = ffi.Pointer<CXType> Function(
- ffi.Pointer<CXType> pointerType,
-);
-
-typedef _dart_clang_getPointeeType_wrap = ffi.Pointer<CXType> Function(
- ffi.Pointer<CXType> pointerType,
-);
-
-typedef _c_clang_getCanonicalType_wrap = ffi.Pointer<CXType> Function(
- ffi.Pointer<CXType> typerefType,
-);
-
-typedef _dart_clang_getCanonicalType_wrap = ffi.Pointer<CXType> Function(
- ffi.Pointer<CXType> typerefType,
-);
-
-typedef _c_clang_Type_getNamedType_wrap = ffi.Pointer<CXType> Function(
- ffi.Pointer<CXType> elaboratedType,
-);
-
-typedef _dart_clang_Type_getNamedType_wrap = ffi.Pointer<CXType> Function(
- ffi.Pointer<CXType> elaboratedType,
-);
-
-typedef _c_clang_getTypeDeclaration_wrap = ffi.Pointer<CXCursor> Function(
- ffi.Pointer<CXType> cxtype,
-);
-
-typedef _dart_clang_getTypeDeclaration_wrap = ffi.Pointer<CXCursor> Function(
- ffi.Pointer<CXType> cxtype,
-);
-
-typedef _c_clang_getTypedefDeclUnderlyingType_wrap = ffi.Pointer<CXType>
- Function(
- ffi.Pointer<CXCursor> cxcursor,
-);
-
-typedef _dart_clang_getTypedefDeclUnderlyingType_wrap = ffi.Pointer<CXType>
- Function(
- ffi.Pointer<CXCursor> cxcursor,
-);
-
-typedef _c_clang_getCursorSpelling_wrap = ffi.Pointer<CXString> Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _dart_clang_getCursorSpelling_wrap = ffi.Pointer<CXString> Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _c_clang_getTranslationUnitCursor_wrap = ffi.Pointer<CXCursor> Function(
- ffi.Pointer<CXTranslationUnitImpl> tu,
-);
-
-typedef _dart_clang_getTranslationUnitCursor_wrap = ffi.Pointer<CXCursor>
- Function(
- ffi.Pointer<CXTranslationUnitImpl> tu,
-);
-
-typedef _c_clang_formatDiagnostic_wrap = ffi.Pointer<CXString> Function(
- ffi.Pointer<ffi.Void> diag,
- ffi.Int32 opts,
-);
-
-typedef _dart_clang_formatDiagnostic_wrap = ffi.Pointer<CXString> Function(
- ffi.Pointer<ffi.Void> diag,
- int opts,
-);
-
-typedef ModifiedCXCursorVisitor_1 = ffi.Int32 Function(
- ffi.Pointer<CXCursor>,
- ffi.Pointer<CXCursor>,
- ffi.Pointer<ffi.Void>,
-);
-
-typedef _c_clang_visitChildren_wrap = ffi.Uint32 Function(
- ffi.Pointer<CXCursor> parent,
- ffi.Pointer<ffi.NativeFunction<ModifiedCXCursorVisitor_1>> _modifiedVisitor,
- ffi.Pointer<ffi.Void> clientData,
-);
-
-typedef _dart_clang_visitChildren_wrap = int Function(
- ffi.Pointer<CXCursor> parent,
- ffi.Pointer<ffi.NativeFunction<ModifiedCXCursorVisitor_1>> _modifiedVisitor,
- ffi.Pointer<ffi.Void> clientData,
-);
-
-typedef _c_clang_Cursor_getNumArguments_wrap = ffi.Int32 Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _dart_clang_Cursor_getNumArguments_wrap = int Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _c_clang_Cursor_getArgument_wrap = ffi.Pointer<CXCursor> Function(
- ffi.Pointer<CXCursor> cursor,
- ffi.Uint32 i,
-);
-
-typedef _dart_clang_Cursor_getArgument_wrap = ffi.Pointer<CXCursor> Function(
- ffi.Pointer<CXCursor> cursor,
- int i,
-);
-
-typedef _c_clang_getNumArgTypes_wrap = ffi.Int32 Function(
- ffi.Pointer<CXType> cxtype,
-);
-
-typedef _dart_clang_getNumArgTypes_wrap = int Function(
- ffi.Pointer<CXType> cxtype,
-);
-
-typedef _c_clang_getArgType_wrap = ffi.Pointer<CXType> Function(
- ffi.Pointer<CXType> cxtype,
- ffi.Uint32 i,
-);
-
-typedef _dart_clang_getArgType_wrap = ffi.Pointer<CXType> Function(
- ffi.Pointer<CXType> cxtype,
- int i,
-);
-
-typedef _c_clang_getEnumConstantDeclValue_wrap = ffi.Int64 Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _dart_clang_getEnumConstantDeclValue_wrap = int Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _c_clang_equalRanges_wrap = ffi.Uint32 Function(
- ffi.Pointer<CXSourceRange> c1,
- ffi.Pointer<CXSourceRange> c2,
-);
-
-typedef _dart_clang_equalRanges_wrap = int Function(
- ffi.Pointer<CXSourceRange> c1,
- ffi.Pointer<CXSourceRange> c2,
-);
-
-typedef _c_clang_Cursor_getCommentRange_wrap = ffi.Pointer<CXSourceRange>
- Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _dart_clang_Cursor_getCommentRange_wrap = ffi.Pointer<CXSourceRange>
- Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _c_clang_Cursor_getRawCommentText_wrap = ffi.Pointer<CXString> Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _dart_clang_Cursor_getRawCommentText_wrap = ffi.Pointer<CXString>
- Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _c_clang_Cursor_getBriefCommentText_wrap = ffi.Pointer<CXString>
- Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _dart_clang_Cursor_getBriefCommentText_wrap = ffi.Pointer<CXString>
- Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _c_clang_getCursorLocation_wrap = ffi.Pointer<CXSourceLocation>
- Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _dart_clang_getCursorLocation_wrap = ffi.Pointer<CXSourceLocation>
- Function(
- ffi.Pointer<CXCursor> cursor,
-);
-
-typedef _c_clang_getFileLocation_wrap = ffi.Void Function(
- ffi.Pointer<CXSourceLocation> location,
- ffi.Pointer<ffi.Pointer<ffi.Void>> file,
- ffi.Pointer<ffi.Uint32> line,
- ffi.Pointer<ffi.Uint32> column,
- ffi.Pointer<ffi.Uint32> offset,
-);
-
-typedef _dart_clang_getFileLocation_wrap = void Function(
- ffi.Pointer<CXSourceLocation> location,
- ffi.Pointer<ffi.Pointer<ffi.Void>> file,
- ffi.Pointer<ffi.Uint32> line,
- ffi.Pointer<ffi.Uint32> column,
- ffi.Pointer<ffi.Uint32> offset,
-);
-
-typedef _c_clang_getFileName_wrap = ffi.Pointer<CXString> Function(
- ffi.Pointer<ffi.Void> SFile,
-);
-
-typedef _dart_clang_getFileName_wrap = ffi.Pointer<CXString> Function(
- ffi.Pointer<ffi.Void> SFile,
-);
-
-typedef _c_clang_getNumElements_wrap = ffi.Uint64 Function(
- ffi.Pointer<CXType> cxtype,
-);
-
-typedef _dart_clang_getNumElements_wrap = int Function(
- ffi.Pointer<CXType> cxtype,
-);
-
-typedef _c_clang_getArrayElementType_wrap = ffi.Pointer<CXType> Function(
- ffi.Pointer<CXType> cxtype,
-);
-
-typedef _dart_clang_getArrayElementType_wrap = ffi.Pointer<CXType> Function(
- ffi.Pointer<CXType> cxtype,
-);
-
typedef _typedefC_3 = ffi.Int32 Function(
ffi.Pointer<ffi.Void>,
ffi.Pointer<ffi.Void>,
diff --git a/example/libclang-example/pubspec.yaml b/example/libclang-example/pubspec.yaml
index f6acbeb..bc02bad 100644
--- a/example/libclang-example/pubspec.yaml
+++ b/example/libclang-example/pubspec.yaml
@@ -18,12 +18,11 @@
# Bash style Glob matching is also supported.
# TODO(11): Globs dont work on windows if they begin with '.' or '..'.
headers:
- - '../../tool/wrapped_libclang/wrapper.c'
+ - ../../third_party/libclang/include/clang-c/Index.h
# Excludes included headers based on their names (not fullpath name).
header-filter:
include:
- - 'wrapper.c'
- 'CXString.h'
- 'Index.h'
diff --git a/lib/src/code_generator/binding.dart b/lib/src/code_generator/binding.dart
index 507de6c..5a10c06 100644
--- a/lib/src/code_generator/binding.dart
+++ b/lib/src/code_generator/binding.dart
@@ -12,11 +12,13 @@
///
/// Do not extend directly, use [LookUpBinding] or [NoLookUpBinding].
abstract class Binding {
+ final String originalName;
+
String name;
final String dartDoc;
- Binding({@required this.name, this.dartDoc});
+ Binding({@required this.originalName, @required this.name, this.dartDoc});
/// Return typedef dependencies.
List<Typedef> getTypedefDependencies(Writer w);
@@ -30,12 +32,18 @@
/// Base class for bindings which look up symbols in dynamic library.
abstract class LookUpBinding extends Binding {
- LookUpBinding({String name, String dartDoc})
- : super(name: name, dartDoc: dartDoc);
+ LookUpBinding({
+ @required String originalName,
+ @required String name,
+ String dartDoc,
+ }) : super(originalName: originalName, name: name, dartDoc: dartDoc);
}
/// Base class for bindings which don't look up symbols in dynamic library.
abstract class NoLookUpBinding extends Binding {
- NoLookUpBinding({String name, String dartDoc})
- : super(name: name, dartDoc: dartDoc);
+ NoLookUpBinding({
+ @required String originalName,
+ @required String name,
+ String dartDoc,
+ }) : super(originalName: originalName, name: name, dartDoc: dartDoc);
}
diff --git a/lib/src/code_generator/constant.dart b/lib/src/code_generator/constant.dart
index d64e7ac..6af8a6d 100644
--- a/lib/src/code_generator/constant.dart
+++ b/lib/src/code_generator/constant.dart
@@ -31,11 +31,12 @@
final String rawValue;
Constant({
+ String originalName,
@required String name,
String dartDoc,
@required this.type,
@required this.rawValue,
- }) : super(name: name, dartDoc: dartDoc);
+ }) : super(originalName: originalName ?? name, name: name, dartDoc: dartDoc);
@override
BindingString toBindingString(Writer w) {
diff --git a/lib/src/code_generator/enum_class.dart b/lib/src/code_generator/enum_class.dart
index f578793..8232ccb 100644
--- a/lib/src/code_generator/enum_class.dart
+++ b/lib/src/code_generator/enum_class.dart
@@ -28,11 +28,12 @@
final List<EnumConstant> enumConstants;
EnumClass({
+ String originalName,
@required String name,
String dartDoc,
List<EnumConstant> enumConstants,
}) : enumConstants = enumConstants ?? [],
- super(name: name, dartDoc: dartDoc);
+ super(originalName: originalName ?? name, name: name, dartDoc: dartDoc);
@override
BindingString toBindingString(Writer w) {
diff --git a/lib/src/code_generator/func.dart b/lib/src/code_generator/func.dart
index 4c321be..f0f317e 100644
--- a/lib/src/code_generator/func.dart
+++ b/lib/src/code_generator/func.dart
@@ -30,20 +30,19 @@
/// typedef _dart_sum = int Function(int a, int b);
/// ```
class Func extends LookUpBinding {
- final String lookupSymbolName;
final Type returnType;
final List<Parameter> parameters;
/// [lookupSymbolName], if not provided, takes the value of [name].
Func({
@required String name,
- String lookupSymbolName,
+ String originalName,
String dartDoc,
@required this.returnType,
List<Parameter> parameters,
}) : parameters = parameters ?? [],
- lookupSymbolName = lookupSymbolName ?? name,
- super(name: name, dartDoc: dartDoc) {
+ super(
+ originalName: originalName ?? name, name: name, dartDoc: dartDoc) {
for (var i = 0; i < this.parameters.length; i++) {
if (this.parameters[i].name == null ||
this.parameters[i].name.trim() == '') {
@@ -125,7 +124,7 @@
}
s.write(') {\n');
s.write(
- "$funcVarName ??= ${w.dylibIdentifier}.lookupFunction<${cType.name},${dartType.name}>('$lookupSymbolName');\n");
+ "$funcVarName ??= ${w.dylibIdentifier}.lookupFunction<${cType.name},${dartType.name}>('$originalName');\n");
s.write(' return $funcVarName(\n');
for (final p in parameters) {
diff --git a/lib/src/code_generator/global.dart b/lib/src/code_generator/global.dart
index f1f919f..d0e67cf 100644
--- a/lib/src/code_generator/global.dart
+++ b/lib/src/code_generator/global.dart
@@ -22,15 +22,14 @@
/// final int a = _dylib.lookup<ffi.Int32>('a').value;
/// ```
class Global extends LookUpBinding {
- final String lookupSymbolName;
final Type type;
Global({
+ String originalName,
@required String name,
- @required this.lookupSymbolName,
@required this.type,
String dartDoc,
- }) : super(name: name, dartDoc: dartDoc);
+ }) : super(originalName: originalName ?? name, name: name, dartDoc: dartDoc);
@override
BindingString toBindingString(Writer w) {
@@ -45,7 +44,7 @@
s.write(
'${w.ffiLibraryPrefix}.Pointer<${type.getCType(w)}> $holderVarName;\n');
s.write(
- "${type.getDartType(w)} get $globalVarName => ($holderVarName ??= ${w.dylibIdentifier}.lookup<${type.getCType(w)}>('$lookupSymbolName')).value;\n\n");
+ "${type.getDartType(w)} get $globalVarName => ($holderVarName ??= ${w.dylibIdentifier}.lookup<${type.getCType(w)}>('$originalName')).value;\n\n");
return BindingString(type: BindingStringType.global, string: s.toString());
}
diff --git a/lib/src/code_generator/library.dart b/lib/src/code_generator/library.dart
index 13a7340..6c292fd 100644
--- a/lib/src/code_generator/library.dart
+++ b/lib/src/code_generator/library.dart
@@ -11,7 +11,7 @@
import 'utils.dart';
import 'writer.dart';
-var _logger = Logger('code_generator:library.dart');
+var _logger = Logger('ffigen.code_generator.library');
/// Container for all Bindings.
class Library {
@@ -31,34 +31,19 @@
final lookUpBindings = bindings.whereType<LookUpBinding>().toList();
final noLookUpBindings = bindings.whereType<NoLookUpBinding>().toList();
+ //TODO(21): Resolve dart keyword as identifiers.
/// Handle any declaration-declaration name conflict in [lookUpBindings].
final lookUpDeclConflictHandler = UniqueNamer({});
for (final b in lookUpBindings) {
- // Print warning if name was conflicting and has been changed.
- if (lookUpDeclConflictHandler.isUsed(b.name)) {
- final oldName = b.name;
- b.name = lookUpDeclConflictHandler.makeUnique(b.name);
-
- _logger.warning(
- "Resolved name conflict: Declaration '$oldName' and has been renamed to '${b.name}'.");
- } else {
- lookUpDeclConflictHandler.markUsed(b.name);
- }
+ _warnPrivateDeclaration(b);
+ _resolveNameConflict(lookUpDeclConflictHandler, b);
}
/// Handle any declaration-declaration name conflict in [noLookUpBindings].
final noLookUpDeclConflictHandler = UniqueNamer({});
for (final b in noLookUpBindings) {
- // Print warning if name was conflicting and has been changed.
- if (noLookUpDeclConflictHandler.isUsed(b.name)) {
- final oldName = b.name;
- b.name = noLookUpDeclConflictHandler.makeUnique(b.name);
-
- _logger.warning(
- "Resolved name conflict: Declaration '$oldName' and has been renamed to '${b.name}'.");
- } else {
- noLookUpDeclConflictHandler.markUsed(b.name);
- }
+ _warnPrivateDeclaration(b);
+ _resolveNameConflict(noLookUpDeclConflictHandler, b);
}
_writer = Writer(
@@ -70,6 +55,28 @@
);
}
+ /// Logs a warning if generated declaration will be private.
+ void _warnPrivateDeclaration(Binding b) {
+ if (b.name.startsWith('_')) {
+ _logger.warning(
+ "Generated declaration '${b.name}' start's with '_' and therefore will be private.");
+ }
+ }
+
+ /// LResolves name conflict(if any) and logs a warning.
+ void _resolveNameConflict(UniqueNamer namer, Binding b) {
+ // Print warning if name was conflicting and has been changed.
+ if (namer.isUsed(b.name)) {
+ final oldName = b.name;
+ b.name = namer.makeUnique(b.name);
+
+ _logger.warning(
+ "Resolved name conflict: Declaration '$oldName' and has been renamed to '${b.name}'.");
+ } else {
+ namer.markUsed(b.name);
+ }
+ }
+
/// Sort all bindings in alphabetical order.
void sort() {
bindings.sort((b1, b2) => b1.name.compareTo(b2.name));
diff --git a/lib/src/code_generator/struc.dart b/lib/src/code_generator/struc.dart
index 7c41a47..11bae3d 100644
--- a/lib/src/code_generator/struc.dart
+++ b/lib/src/code_generator/struc.dart
@@ -39,11 +39,12 @@
List<Member> members;
Struc({
+ String originalName,
@required String name,
String dartDoc,
List<Member> members,
}) : members = members ?? [],
- super(name: name, dartDoc: dartDoc);
+ super(originalName: originalName ?? name, name: name, dartDoc: dartDoc);
List<int> _getArrayDimensionLengths(Type type) {
final array = <int>[];
@@ -153,7 +154,7 @@
final String name;
final Type type;
- const Member({this.name, this.type, this.dartDoc});
+ const Member({@required this.name, @required this.type, this.dartDoc});
}
// Helper bindings for struct array.
diff --git a/lib/src/config_provider/config.dart b/lib/src/config_provider/config.dart
index 3e6e336..b0abcc0 100644
--- a/lib/src/config_provider/config.dart
+++ b/lib/src/config_provider/config.dart
@@ -18,7 +18,7 @@
import 'declaration.dart';
import 'spec_utils.dart';
-var _logger = Logger('config_provider:config.dart');
+var _logger = Logger('ffigen.config_provider.config');
/// Provides configurations to other modules.
///
@@ -80,8 +80,6 @@
Config._();
/// Create config from Yaml map.
- ///
- /// Ensure that log printing is setup before using this.
factory Config.fromYaml(YamlMap map) {
final configspecs = Config._();
_logger.finest('Config Map: ' + map.toString());
@@ -90,8 +88,7 @@
final result = configspecs._checkConfigs(map, specs);
if (!result) {
- _logger.info('Please fix errors in Configurations and re-run the tool');
- exit(1);
+ throw ConfigError();
}
configspecs._extract(map, specs);
@@ -153,7 +150,9 @@
'Path to folder containing libclang dynamic library, used to parse C headers',
requirement: Requirement.no,
defaultValue: () => getDylibPath(Platform.script
- .resolve(path.join('..', 'tool', 'wrapped_libclang'))
+ .resolve(path.posix.join('..', 'tool', 'wrapped_libclang'))
+ // Path needs to be in posix style here or an illegal character
+ // error is thrown on windows.
.toFilePath()),
validator: libclangDylibValidator,
extractor: libclangDylibExtractor,
@@ -189,10 +188,9 @@
requirement: Requirement.no,
validator: declarationConfigValidator,
extractor: declarationConfigExtractor,
- defaultValue: () => Declaration(declarationTypeName: 'Function'),
+ defaultValue: () => Declaration(),
extractedResult: (dynamic result) {
functionDecl = result as Declaration;
- functionDecl.declarationTypeName = 'Function';
},
),
strings.structs: Specification<Declaration>(
@@ -200,10 +198,9 @@
requirement: Requirement.no,
validator: declarationConfigValidator,
extractor: declarationConfigExtractor,
- defaultValue: () => Declaration(declarationTypeName: 'Struct'),
+ defaultValue: () => Declaration(),
extractedResult: (dynamic result) {
structDecl = result as Declaration;
- structDecl.declarationTypeName = 'Struct';
},
),
strings.enums: Specification<Declaration>(
@@ -211,10 +208,9 @@
requirement: Requirement.no,
validator: declarationConfigValidator,
extractor: declarationConfigExtractor,
- defaultValue: () => Declaration(declarationTypeName: 'Enum'),
+ defaultValue: () => Declaration(),
extractedResult: (dynamic result) {
enumClassDecl = result as Declaration;
- enumClassDecl.declarationTypeName = 'Enum';
},
),
strings.sizemap: Specification<Map<int, SupportedNativeType>>(
@@ -326,3 +322,17 @@
this.excludedInclusionHeaders = const {},
});
}
+
+class ConfigError implements Exception {
+ final String message;
+ ConfigError([this.message]);
+
+ @override
+ String toString() {
+ if (message == null) {
+ return 'ConfigError: Invalid configurations provided.';
+ } else {
+ return 'ConfigError: $message';
+ }
+ }
+}
diff --git a/lib/src/config_provider/declaration.dart b/lib/src/config_provider/declaration.dart
index 4674bc5..f808f13 100644
--- a/lib/src/config_provider/declaration.dart
+++ b/lib/src/config_provider/declaration.dart
@@ -1,17 +1,9 @@
// Copyright (c) 2020, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
-import 'package:logging/logging.dart';
-
-var _logger = Logger('config_provider:declaration.dart');
/// A generic declaration config.
class Declaration {
- /// Display name of a declaration type.
- ///
- /// Used for logging and warning purposes.
- String declarationTypeName;
-
// matchers
List<RegExp> _includeMatchers = [];
Set<String> _includeFull = {};
@@ -21,7 +13,6 @@
Map<String, String> _prefixReplacement = {};
Declaration({
- this.declarationTypeName = 'declaration',
List<String> includeMatchers,
List<String> includeFull,
List<String> excludeMatchers,
@@ -66,11 +57,6 @@
// Apply global prefixes.
name = '${_globalPrefix}$name';
- // Warn user if a declaration starts with '_'.
- if (name.startsWith('_')) {
- _logger.warning(
- "Generated $declarationTypeName '$name' start's with '_' and therefore will be private.");
- }
return name;
}
diff --git a/lib/src/config_provider/spec_utils.dart b/lib/src/config_provider/spec_utils.dart
index 70cccdd..0dff6e4 100644
--- a/lib/src/config_provider/spec_utils.dart
+++ b/lib/src/config_provider/spec_utils.dart
@@ -14,7 +14,16 @@
import './config.dart';
import 'declaration.dart';
-var _logger = Logger('config_provider:spec_utils.dart');
+var _logger = Logger('ffigen.config_provider.spec_utils');
+
+/// Replaces the path separators according to current platform.
+String _replaceSeparators(String path) {
+ if (Platform.isWindows) {
+ return path.replaceAll(p.posix.separator, p.windows.separator);
+ } else {
+ return path.replaceAll(p.windows.separator, p.posix.separator);
+ }
+}
bool booleanExtractor(dynamic value) => value as bool;
@@ -104,13 +113,15 @@
final headerGlob = h as String;
// Add file directly to header if it's not a Glob but a File.
if (File(headerGlob).existsSync()) {
- headers.add(headerGlob);
+ final osSpecificPath = _replaceSeparators(headerGlob);
+ headers.add(osSpecificPath);
_logger.fine('Adding header/file: $headerGlob');
} else {
final glob = Glob(headerGlob);
for (final file in glob.listSync(followLinks: true)) {
- headers.add(file.path);
- _logger.fine('Adding header/file: ${file.path}');
+ final fixedPath = _replaceSeparators(file.path);
+ headers.add(fixedPath);
+ _logger.fine('Adding header/file: ${fixedPath}');
}
}
}
@@ -146,21 +157,19 @@
}
String getDylibPath(String dylibParentFoler) {
+ dylibParentFoler = _replaceSeparators(dylibParentFoler);
String dylibPath;
if (Platform.isMacOS) {
dylibPath = p.join(dylibParentFoler, strings.libclang_dylib_macos);
} else if (Platform.isWindows) {
- // Fix path for windows if '/' is used as seperator instead of '\'
- // because our examples input path like this.
- final newValue = dylibParentFoler.replaceAll('/', r'\');
- dylibPath = p.join(newValue, strings.libclang_dylib_windows);
+ dylibPath = p.join(dylibParentFoler, strings.libclang_dylib_windows);
} else {
dylibPath = p.join(dylibParentFoler, strings.libclang_dylib_linux);
}
return dylibPath;
}
-String outputExtractor(dynamic value) => value as String;
+String outputExtractor(dynamic value) => _replaceSeparators(value as String);
bool outputValidator(String name, dynamic value) {
if (value is String) {
diff --git a/lib/src/header_parser/clang_bindings/clang_bindings.dart b/lib/src/header_parser/clang_bindings/clang_bindings.dart
index 809109f..7040fb5 100644
--- a/lib/src/header_parser/clang_bindings/clang_bindings.dart
+++ b/lib/src/header_parser/clang_bindings/clang_bindings.dart
@@ -347,7 +347,7 @@
int clang_visitChildren_wrap(
ffi.Pointer<CXCursor> parent,
ffi.Pointer<ffi.NativeFunction<ModifiedCXCursorVisitor_1>> _modifiedVisitor,
- ffi.Pointer<ffi.Void> clientData,
+ int uid,
) {
_clang_visitChildren_wrap ??= _dylib.lookupFunction<
_c_clang_visitChildren_wrap,
@@ -355,7 +355,7 @@
return _clang_visitChildren_wrap(
parent,
_modifiedVisitor,
- clientData,
+ uid,
);
}
@@ -1922,13 +1922,13 @@
typedef _c_clang_visitChildren_wrap = ffi.Uint32 Function(
ffi.Pointer<CXCursor> parent,
ffi.Pointer<ffi.NativeFunction<ModifiedCXCursorVisitor_1>> _modifiedVisitor,
- ffi.Pointer<ffi.Void> clientData,
+ ffi.Int64 uid,
);
typedef _dart_clang_visitChildren_wrap = int Function(
ffi.Pointer<CXCursor> parent,
ffi.Pointer<ffi.NativeFunction<ModifiedCXCursorVisitor_1>> _modifiedVisitor,
- ffi.Pointer<ffi.Void> clientData,
+ int uid,
);
typedef _c_clang_Cursor_getNumArguments_wrap = ffi.Int32 Function(
diff --git a/lib/src/header_parser/data.dart b/lib/src/header_parser/data.dart
index c1b57bf..ebda2dc 100644
--- a/lib/src/header_parser/data.dart
+++ b/lib/src/header_parser/data.dart
@@ -2,6 +2,9 @@
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
+import 'dart:ffi';
+import 'dart:isolate';
+
import 'package:ffigen/src/config_provider.dart';
import 'clang_bindings/clang_bindings.dart' show Clang;
@@ -12,3 +15,9 @@
/// Holds clang functions.
Clang clang;
+
+/// Holds the unique id refering to this isolate.
+///
+/// Used by visitChildren_wrap to call the correct dart function from C.
+// int get uid => Isolate.current.controlPort.;
+final uid = Isolate.current.controlPort.nativePort;
diff --git a/lib/src/header_parser/parser.dart b/lib/src/header_parser/parser.dart
index 48944df..bc3c7f8 100644
--- a/lib/src/header_parser/parser.dart
+++ b/lib/src/header_parser/parser.dart
@@ -38,9 +38,9 @@
// BELOW FUNCTIONS ARE MEANT FOR INTERNAL USE AND TESTING
// ===================================================================================
-var _logger = Logger('header_parser:parser.dart');
+var _logger = Logger('ffigen.header_parser.parser');
-/// initialises parser, clears any previous values.
+/// Initialises parser, clears any previous values.
void initParser(Config c) {
config = c;
diff --git a/lib/src/header_parser/sub_parsers/enumdecl_parser.dart b/lib/src/header_parser/sub_parsers/enumdecl_parser.dart
index a98738b..8cba1c9 100644
--- a/lib/src/header_parser/sub_parsers/enumdecl_parser.dart
+++ b/lib/src/header_parser/sub_parsers/enumdecl_parser.dart
@@ -9,14 +9,19 @@
import 'package:logging/logging.dart';
import '../clang_bindings/clang_bindings.dart' as clang_types;
-import '../data.dart' show clang;
+import '../data.dart';
import '../includer.dart';
import '../utils.dart';
-var _logger = Logger('header_parser:enumdecl_parser.dart');
+var _logger = Logger('ffigen.header_parser.enumdecl_parser');
-/// Temporarily holds a enumClass before its returned by [parseEnumDeclaration].
-EnumClass _enumClass;
+/// Holds temporary information regarding [EnumClass] while parsing.
+class _ParsedEnum {
+ EnumClass enumClass;
+ _ParsedEnum();
+}
+
+final _stack = Stack<_ParsedEnum>();
/// Parses a function declaration.
EnumClass parseEnumDeclaration(
@@ -25,22 +30,23 @@
/// Optionally provide name to use (useful in case struct is inside a typedef).
String name,
}) {
- _enumClass = null;
+ _stack.push(_ParsedEnum());
final enumName = name ?? cursor.spelling();
if (enumName == '') {
_logger.finest('unnamed enum declaration');
} else if (shouldIncludeEnumClass(enumName) && !isSeenEnumClass(enumName)) {
_logger.fine('++++ Adding Enum: ${cursor.completeStringRepr()}');
- _enumClass = EnumClass(
+ _stack.top.enumClass = EnumClass(
dartDoc: getCursorDocComment(cursor),
+ originalName: enumName,
name: config.enumClassDecl.getPrefixedName(enumName),
);
- addEnumClassToSeen(enumName, _enumClass);
+ addEnumClassToSeen(enumName, _stack.top.enumClass);
_addEnumConstant(cursor);
}
- return _enumClass;
+ return _stack.pop().enumClass;
}
void _addEnumConstant(Pointer<clang_types.CXCursor> cursor) {
@@ -48,7 +54,7 @@
cursor,
Pointer.fromFunction(
_enumCursorVisitor, clang_types.CXChildVisitResult.CXChildVisit_Break),
- nullptr,
+ uid,
);
visitChildrenResultChecker(resultCode);
@@ -81,7 +87,7 @@
/// Adds the parameter to func in [functiondecl_parser.dart].
void _addEnumConstantToEnumClass(Pointer<clang_types.CXCursor> cursor) {
- _enumClass.enumConstants.add(
+ _stack.top.enumClass.enumConstants.add(
EnumConstant(
dartDoc: getCursorDocComment(
cursor,
diff --git a/lib/src/header_parser/sub_parsers/functiondecl_parser.dart b/lib/src/header_parser/sub_parsers/functiondecl_parser.dart
index 18c341b..8f35c24 100644
--- a/lib/src/header_parser/sub_parsers/functiondecl_parser.dart
+++ b/lib/src/header_parser/sub_parsers/functiondecl_parser.dart
@@ -13,16 +13,23 @@
import '../includer.dart';
import '../utils.dart';
-var _logger = Logger('header_parser:functiondecl_parser.dart');
+var _logger = Logger('ffigen.header_parser.functiondecl_parser');
-/// Temporarily holds a function before its returned by [parseFunctionDeclaration].
-Func _func;
+/// Holds temporary information regarding [Func] while parsing.
+class _ParserFunc {
+ Func func;
+ bool structByValueParameter = false;
+ bool unimplementedParameterType = false;
+ _ParserFunc();
+}
+
+final _stack = Stack<_ParserFunc>();
/// Parses a function declaration.
Func parseFunctionDeclaration(Pointer<clang_types.CXCursor> cursor) {
- _func = null;
- structByValueParameter = false;
- unimplementedParameterType = false;
+ _stack.push(_ParserFunc());
+ _stack.top.structByValueParameter = false;
+ _stack.top.unimplementedParameterType = false;
final funcName = cursor.spelling();
if (shouldIncludeFunc(funcName) && !isSeenFunc(funcName)) {
@@ -32,41 +39,43 @@
final parameters = _getParameters(cursor);
//TODO(3): Remove this when support for Structs by value arrives.
- if (rt.broadType == BroadType.Struct || structByValueParameter) {
+ if (rt.broadType == BroadType.Struct || _stack.top.structByValueParameter) {
_logger.fine(
'---- Removed Function, reason: struct pass/return by value: ${cursor.completeStringRepr()}');
_logger.warning(
"Skipped Function '$funcName', struct pass/return by value not supported.");
- return null; // Returning null so that [addToBindings] function excludes this.
+ return _stack
+ .pop()
+ .func; // Returning null so that [addToBindings] function excludes this.
}
if (rt.getBaseType().broadType == BroadType.Unimplemented ||
- unimplementedParameterType) {
+ _stack.top.unimplementedParameterType) {
_logger.fine(
'---- Removed Function, reason: unsupported return type or parameter type: ${cursor.completeStringRepr()}');
_logger.warning(
"Skipped Function '$funcName', function has unsupported return type or parameter type.");
- return null; // Returning null so that [addToBindings] function excludes this.
+ return _stack
+ .pop()
+ .func; // Returning null so that [addToBindings] function excludes this.
}
- _func = Func(
+ _stack.top.func = Func(
dartDoc: getCursorDocComment(
cursor,
nesting.length + commentPrefix.length,
),
name: config.functionDecl.getPrefixedName(funcName),
- lookupSymbolName: funcName,
+ originalName: funcName,
returnType: rt,
parameters: parameters,
);
- addFuncToSeen(funcName, _func);
+ addFuncToSeen(funcName, _stack.top.func);
}
- return _func;
+ return _stack.pop().func;
}
-bool structByValueParameter = false;
-bool unimplementedParameterType = false;
Type _getFunctionReturnType(Pointer<clang_types.CXCursor> cursor) {
return cursor.returnType().toCodeGenTypeAndDispose();
}
@@ -83,9 +92,9 @@
final pt = _getParameterType(paramCursor);
//TODO(3): Remove this when support for Structs by value arrives.
if (pt.broadType == BroadType.Struct) {
- structByValueParameter = true;
+ _stack.top.structByValueParameter = true;
} else if (pt.getBaseType().broadType == BroadType.Unimplemented) {
- unimplementedParameterType = true;
+ _stack.top.unimplementedParameterType = true;
}
final pn = paramCursor.spelling();
diff --git a/lib/src/header_parser/sub_parsers/structdecl_parser.dart b/lib/src/header_parser/sub_parsers/structdecl_parser.dart
index 309ab39..32e2fd7 100644
--- a/lib/src/header_parser/sub_parsers/structdecl_parser.dart
+++ b/lib/src/header_parser/sub_parsers/structdecl_parser.dart
@@ -12,10 +12,18 @@
import '../includer.dart';
import '../utils.dart';
-var _logger = Logger('header_parser:structdecl_parser.dart');
+var _logger = Logger('ffigen.header_parser.structdecl_parser');
-/// Temporarily holds a struc before its returned by [parseStructDeclaration].
-Struc _struc;
+/// Holds temporary information regarding [struc] while parsing.
+class _ParsedStruc {
+ Struc struc;
+ bool nestedStructMember = false;
+ bool unimplementedMemberType = false;
+ bool arrayMember = false;
+ _ParsedStruc();
+}
+
+final _stack = Stack<_ParsedStruc>();
/// Parses a struct declaration.
Struc parseStructDeclaration(
@@ -28,73 +36,65 @@
/// when they are passed/returned by an included function.)
bool ignoreFilter = false,
}) {
- _struc = null;
+ _stack.push(_ParsedStruc());
final structName = name ?? cursor.spelling();
- if (structName == '') {
+ if (structName.isEmpty) {
_logger.finest('unnamed structure or typedef structure declaration');
- return null;
} else if ((ignoreFilter || shouldIncludeStruct(structName)) &&
(!isSeenStruc(structName))) {
_logger.fine(
'++++ Adding Structure: structName: ${structName}, ${cursor.completeStringRepr()}');
-
- _struc = Struc(
+ _stack.top.struc = Struc(
+ originalName: structName,
name: config.structDecl.getPrefixedName(structName),
dartDoc: getCursorDocComment(cursor),
);
// Adding to seen here to stop recursion if a struct has itself as a
// member, members are updated later.
- addStrucToSeen(structName, _struc);
- _struc.members = _getMembers(cursor, structName);
+ addStrucToSeen(structName, _stack.top.struc);
+ _setStructMembers(cursor);
}
- return _struc;
+ return _stack.pop().struc;
}
-List<Member> _members;
-List<Member> _getMembers(Pointer<clang_types.CXCursor> cursor, String structName) {
- _members = [];
- arrayMember = false;
- nestedStructMember = false;
- unimplementedMemberType = false;
+void _setStructMembers(Pointer<clang_types.CXCursor> cursor) {
+ _stack.top.arrayMember = false;
+ _stack.top.nestedStructMember = false;
+ _stack.top.unimplementedMemberType = false;
final resultCode = clang.clang_visitChildren_wrap(
- cursor,
- Pointer.fromFunction(
- _structMembersVisitor, clang_types.CXChildVisitResult.CXChildVisit_Break),
- nullptr);
+ cursor,
+ Pointer.fromFunction(_structMembersVisitor,
+ clang_types.CXChildVisitResult.CXChildVisit_Break),
+ uid,
+ );
visitChildrenResultChecker(resultCode);
// Returning null to exclude the struct members as it has a struct by value field.
- if (arrayMember && !config.arrayWorkaround) {
+ if (_stack.top.arrayMember && !config.arrayWorkaround) {
_logger.fine(
'---- Removed Struct members, reason: struct has array members ${cursor.completeStringRepr()}');
_logger.warning(
- 'Removed All Struct Members from: $structName, Array members not supported');
- return [];
- } else if (nestedStructMember) {
+ 'Removed All Struct Members from: ${_stack.top.struc.name}(${_stack.top.struc.originalName}), Array members not supported');
+ return _stack.top.struc.members.clear();
+ } else if (_stack.top.nestedStructMember) {
_logger.fine(
'---- Removed Struct members, reason: struct has struct members ${cursor.completeStringRepr()}');
_logger.warning(
- "Removed All Struct Members from '$structName', Nested Structures not supported.");
- return [];
- } else if (unimplementedMemberType) {
+ 'Removed All Struct Members from ${_stack.top.struc.name}(${_stack.top.struc.originalName}), Nested Structures not supported.');
+ return _stack.top.struc.members.clear();
+ } else if (_stack.top.unimplementedMemberType) {
_logger.fine(
'---- Removed Struct members, reason: member with unimplementedtype ${cursor.completeStringRepr()}');
_logger.warning(
- "Removed All Struct Members from '$structName', struct member has an unsupported type.");
- return [];
+ 'Removed All Struct Members from ${_stack.top.struc.name}(${_stack.top.struc.originalName}), struct member has an unsupported type.');
+ return _stack.top.struc.members.clear();
}
-
- return _members;
}
-bool nestedStructMember = false;
-bool unimplementedMemberType = false;
-bool arrayMember = false;
-
/// Visitor for the struct cursor [CXCursorKind.CXCursor_StructDecl].
///
/// Child visitor invoked on struct cursor.
@@ -110,21 +110,21 @@
if (mt.broadType == BroadType.Struct) {
// Setting this flag will exclude adding members for this struct's
// bindings.
- nestedStructMember = true;
+ _stack.top.nestedStructMember = true;
} else if (mt.broadType == BroadType.ConstantArray) {
- arrayMember = true;
+ _stack.top.arrayMember = true;
if (mt.child.broadType == BroadType.Struct) {
// Setting this flag will exclude adding members for this struct's
// bindings.
- nestedStructMember = true;
+ _stack.top.nestedStructMember = true;
}
}
if (mt.getBaseType().broadType == BroadType.Unimplemented) {
- unimplementedMemberType = true;
+ _stack.top.unimplementedMemberType = true;
}
- _members.add(
+ _stack.top.struc.members.add(
Member(
dartDoc: getCursorDocComment(
cursor,
diff --git a/lib/src/header_parser/sub_parsers/typedefdecl_parser.dart b/lib/src/header_parser/sub_parsers/typedefdecl_parser.dart
index 8d2a831..558fce3 100644
--- a/lib/src/header_parser/sub_parsers/typedefdecl_parser.dart
+++ b/lib/src/header_parser/sub_parsers/typedefdecl_parser.dart
@@ -8,35 +8,37 @@
import 'package:logging/logging.dart';
import '../clang_bindings/clang_bindings.dart' as clang_types;
-import '../data.dart' show clang;
+import '../data.dart';
import '../sub_parsers/enumdecl_parser.dart';
import '../sub_parsers/structdecl_parser.dart';
import '../utils.dart';
-var _logger = Logger('header_parser:typedefdecl_parser.dart');
+var _logger = Logger('ffigen.header_parser.typedefdecl_parser');
-/// Temporarily holds a binding before its returned by [parseTypedefDeclaration].
-Binding _binding;
+/// Holds temporary information regarding a typedef referenced [Binding]
+/// while parsing.
+class _ParsedTypedef {
+ Binding binding;
+ String typedefName;
+ _ParsedTypedef();
+}
-/// Temporarily holds parent cursor name.
-String _typedefName;
+final _stack = Stack<_ParsedTypedef>();
/// Parses a typedef declaration.
Binding parseTypedefDeclaration(Pointer<clang_types.CXCursor> cursor) {
- _binding = null;
+ _stack.push(_ParsedTypedef());
// Name of typedef.
- _typedefName = cursor.spelling();
-
+ _stack.top.typedefName = cursor.spelling();
final resultCode = clang.clang_visitChildren_wrap(
cursor,
Pointer.fromFunction(_typedefdeclarationCursorVisitor,
clang_types.CXChildVisitResult.CXChildVisit_Break),
- nullptr,
+ uid,
);
visitChildrenResultChecker(resultCode);
-
- return _binding;
+ return _stack.pop().binding;
}
/// Visitor for extracting binding for a TypedefDeclarations of a
@@ -52,10 +54,12 @@
switch (clang.clang_getCursorKind_wrap(cursor)) {
case clang_types.CXCursorKind.CXCursor_StructDecl:
- _binding = parseStructDeclaration(cursor, name: _typedefName);
+ _stack.top.binding =
+ parseStructDeclaration(cursor, name: _stack.top.typedefName);
break;
case clang_types.CXCursorKind.CXCursor_EnumDecl:
- _binding = parseEnumDeclaration(cursor, name: _typedefName);
+ _stack.top.binding =
+ parseEnumDeclaration(cursor, name: _stack.top.typedefName);
break;
default:
_logger.finest('typedefdeclarationCursorVisitor: Ignored');
diff --git a/lib/src/header_parser/translation_unit_parser.dart b/lib/src/header_parser/translation_unit_parser.dart
index 73c8880..987254e 100644
--- a/lib/src/header_parser/translation_unit_parser.dart
+++ b/lib/src/header_parser/translation_unit_parser.dart
@@ -8,7 +8,7 @@
import 'package:logging/logging.dart';
import 'clang_bindings/clang_bindings.dart' as clang_types;
-import 'data.dart' show clang;
+import 'data.dart';
import 'includer.dart';
import 'sub_parsers/enumdecl_parser.dart';
import 'sub_parsers/functiondecl_parser.dart';
@@ -16,7 +16,7 @@
import 'sub_parsers/typedefdecl_parser.dart';
import 'utils.dart';
-var _logger = Logger('header_parser:translation_unit_parser.dart');
+var _logger = Logger('ffigen.header_parser.translation_unit_parser');
List<Binding> _bindings;
@@ -24,12 +24,11 @@
List<Binding> parseTranslationUnit(
Pointer<clang_types.CXCursor> translationUnitCursor) {
_bindings = [];
-
final resultCode = clang.clang_visitChildren_wrap(
translationUnitCursor,
Pointer.fromFunction(
_rootCursorVisitor, clang_types.CXChildVisitResult.CXChildVisit_Break),
- nullptr,
+ uid,
);
visitChildrenResultChecker(resultCode);
diff --git a/lib/src/header_parser/type_extractor/extractor.dart b/lib/src/header_parser/type_extractor/extractor.dart
index 6c59dd6..2c0f666 100644
--- a/lib/src/header_parser/type_extractor/extractor.dart
+++ b/lib/src/header_parser/type_extractor/extractor.dart
@@ -16,7 +16,7 @@
import '../type_extractor/cxtypekindmap.dart';
import '../utils.dart';
-var _logger = Logger('header_parser:extractor.dart');
+var _logger = Logger('ffigen.header_parser.extractor');
const _padding = ' ';
/// Converts cxtype to a typestring code_generator can accept.
@@ -64,16 +64,12 @@
.CXType_ConstantArray: // Primarily used for constant array in struct members.
return Type.constantArray(
clang.clang_getNumElements_wrap(cxtype),
- clang
- .clang_getArrayElementType_wrap(cxtype)
- .toCodeGenTypeAndDispose(),
+ clang.clang_getArrayElementType_wrap(cxtype).toCodeGenTypeAndDispose(),
);
case clang_types.CXTypeKind
.CXType_IncompleteArray: // Primarily used for incomplete array in function parameters.
return Type.incompleteArray(
- clang
- .clang_getArrayElementType_wrap(cxtype)
- .toCodeGenTypeAndDispose(),
+ clang.clang_getArrayElementType_wrap(cxtype).toCodeGenTypeAndDispose(),
);
default:
if (cxTypeKindToSupportedNativeTypes.containsKey(kind)) {
@@ -104,8 +100,7 @@
structName = cxtype.spelling();
}
- final fixedStructName =
- config.structDecl.getPrefixedName(structName);
+ final fixedStructName = config.structDecl.getPrefixedName(structName);
// Also add a struct binding, if its unseen.
// TODO(23): Check if we should auto add struct.
@@ -140,9 +135,9 @@
// Set a name for typedefc incase it was null or empty.
if (name == null || name == '') {
- name = _getNextUniqueString('_typedefC');
+ name = _getNextIncrementedString('_typedefC');
} else {
- name = _getNextUniqueString(name);
+ name = _getNextIncrementedString(name);
}
final _parameters = <Parameter>[];
final totalArgs = clang.clang_getNumArgTypes_wrap(cxtype);
@@ -164,20 +159,19 @@
name: name,
typedefType: TypedefType.C,
parameters: _parameters,
- returnType: clang
- .clang_getResultType_wrap(cxtype)
- .toCodeGenTypeAndDispose(),
+ returnType:
+ clang.clang_getResultType_wrap(cxtype).toCodeGenTypeAndDispose(),
);
return Type.nativeFunc(typedefC);
}
/// Generate a unique string for naming in [Typedef].
-String _getNextUniqueString(String prefix) {
- int i = _uniqueStringCounters[prefix] ?? 0;
+String _getNextIncrementedString(String prefix) {
+ int i = _incrementedStringCounters[prefix] ?? 0;
i++;
- _uniqueStringCounters[prefix] = i;
+ _incrementedStringCounters[prefix] = i;
return '${prefix}_$i';
}
-Map<String, int> _uniqueStringCounters = {};
+Map<String, int> _incrementedStringCounters = {};
diff --git a/lib/src/header_parser/utils.dart b/lib/src/header_parser/utils.dart
index dc7efcf..052ea5f 100644
--- a/lib/src/header_parser/utils.dart
+++ b/lib/src/header_parser/utils.dart
@@ -302,3 +302,11 @@
free(this);
}
}
+
+class Stack<T> {
+ final _stack = <T>[];
+
+ T get top => _stack.last;
+ T pop() => _stack.removeLast();
+ void push(T item) => _stack.add(item);
+}
diff --git a/test/code_generator_test.dart b/test/code_generator_test.dart
index a7a66c9..4fd5aea 100644
--- a/test/code_generator_test.dart
+++ b/test/code_generator_test.dart
@@ -15,7 +15,6 @@
bindings: [
Func(
name: 'noParam',
- lookupSymbolName: 'noParam',
dartDoc: 'Just a test function\nheres another line',
returnType: Type.nativeType(
SupportedNativeType.Int32,
@@ -23,7 +22,6 @@
),
Func(
name: 'withPrimitiveParam',
- lookupSymbolName: 'withPrimitiveParam',
parameters: [
Parameter(
name: 'a',
@@ -44,7 +42,6 @@
),
Func(
name: 'withPointerParam',
- lookupSymbolName: 'withPointerParam',
parameters: [
Parameter(
name: 'a',
@@ -308,7 +305,6 @@
struct_some,
Func(
name: 'someFunc',
- lookupSymbolName: 'someFunc',
parameters: [
Parameter(
name: 'some',
@@ -401,14 +397,12 @@
bindings: [
Global(
name: 'test1',
- lookupSymbolName: 'test1',
type: Type.nativeType(
SupportedNativeType.Int32,
),
),
Global(
name: 'test2',
- lookupSymbolName: 'test2',
type: Type.pointer(
Type.nativeType(
SupportedNativeType.Float,
@@ -418,7 +412,6 @@
struc_some,
Global(
name: 'test5',
- lookupSymbolName: 'test5',
type: Type.pointer(
Type.struct(
struc_some,
@@ -574,22 +567,18 @@
bindings: [
Func(
name: 'test',
- lookupSymbolName: 'test',
returnType: Type.nativeType(SupportedNativeType.Void),
),
Func(
name: '_test',
- lookupSymbolName: '_test',
returnType: Type.nativeType(SupportedNativeType.Void),
),
Func(
name: '_c_test',
- lookupSymbolName: '_c_test',
returnType: Type.nativeType(SupportedNativeType.Void),
),
Func(
name: '_dart_test',
- lookupSymbolName: '_dart_test',
returnType: Type.nativeType(SupportedNativeType.Void),
),
Struc(
@@ -609,7 +598,6 @@
Struc(name: 'ArrayHelperPrefixCollisionTest'),
Func(
name: 'Test',
- lookupSymbolName: 'Test',
returnType: Type.nativeType(SupportedNativeType.Void),
),
EnumClass(name: '_c_Test'),
diff --git a/test/collision_tests/decl_decl_collision_test.dart b/test/collision_tests/decl_decl_collision_test.dart
index 7e1bfd0..3b09841 100644
--- a/test/collision_tests/decl_decl_collision_test.dart
+++ b/test/collision_tests/decl_decl_collision_test.dart
@@ -5,8 +5,13 @@
import 'package:ffigen/src/code_generator.dart';
import 'package:test/test.dart';
+import '../test_utils.dart';
+
void main() {
- group('Declaration-Declaration Collision', () {
+ group('decl_decl_collision_test', () {
+ setUpAll(() {
+ logWarnings();
+ });
test('declaration conflict', () {
final l1 = Library(name: 'Bindings', bindings: [
Struc(name: 'TestStruc'),
@@ -27,11 +32,11 @@
EnumClass(name: 'TestEnum_1'),
Func(
name: 'testFunc',
- lookupSymbolName: 'testFunc',
+ originalName: 'testFunc',
returnType: Type.nativeType(SupportedNativeType.Void)),
Func(
name: 'testFunc_1',
- lookupSymbolName: 'testFunc',
+ originalName: 'testFunc',
returnType: Type.nativeType(SupportedNativeType.Void)),
]);
diff --git a/test/debug_generated/README.md b/test/debug_generated/README.md
new file mode 100644
index 0000000..f8fe72f
--- /dev/null
+++ b/test/debug_generated/README.md
@@ -0,0 +1,3 @@
+This folder is used in tests.
+These files are deleted if tests are successful, but
+will contain debug files from failed tests.
diff --git a/test/header_parser_tests/function_n_struct.h b/test/header_parser_tests/function_n_struct.h
new file mode 100644
index 0000000..e779d5f
--- /dev/null
+++ b/test/header_parser_tests/function_n_struct.h
@@ -0,0 +1,15 @@
+// Copyright (c) 2020, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+struct Struct1
+{
+ int a;
+};
+
+struct Struct2
+{
+ struct Struct1 a;
+};
+
+void func1(struct Struct2 *s);
diff --git a/test/header_parser_tests/function_n_struct_.dart b/test/header_parser_tests/function_n_struct_.dart
new file mode 100644
index 0000000..e99faf0
--- /dev/null
+++ b/test/header_parser_tests/function_n_struct_.dart
@@ -0,0 +1,66 @@
+// Copyright (c) 2020, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'package:ffigen/src/code_generator.dart';
+import 'package:ffigen/src/header_parser.dart' as parser;
+import 'package:ffigen/src/config_provider.dart';
+import 'package:test/test.dart';
+import 'package:yaml/yaml.dart' as yaml;
+import 'package:ffigen/src/strings.dart' as strings;
+
+import '../test_utils.dart';
+
+Library actual, expected;
+
+void main() {
+ group('function_n_struct_test', () {
+ setUpAll(() {
+ logWarnings();
+ expected = expectedLibrary();
+ actual = parser.parse(
+ Config.fromYaml(yaml.loadYaml('''
+${strings.name}: 'NativeLibrary'
+${strings.description}: 'Function And Struct Test'
+${strings.output}: 'unused'
+${strings.libclang_dylib_folder}: 'tool/wrapped_libclang'
+${strings.headers}:
+ - 'test/header_parser_tests/function_n_struct.h'
+ ''') as yaml.YamlMap),
+ );
+ });
+
+ test('func1', () {
+ expect(actual.getBindingAsString('func1'),
+ expected.getBindingAsString('func1'));
+ });
+ test('Struct2', () {
+ expect((actual.getBinding('Struct2') as Struc).members.isEmpty, true);
+ });
+ });
+}
+
+Library expectedLibrary() {
+ final struc2 = Struc(name: 'Struct2', members: []);
+ return Library(
+ name: 'Bindings',
+ bindings: [
+ struc2,
+ Struc(name: 'Struct1', members: [
+ Member(
+ name: 'a',
+ type: Type.nativeType(SupportedNativeType.Int32),
+ ),
+ ]),
+ Func(
+ name: 'func1',
+ parameters: [
+ Parameter(name: 's', type: Type.pointer(Type.struct(struc2))),
+ ],
+ returnType: Type.nativeType(
+ SupportedNativeType.Void,
+ ),
+ ),
+ ],
+ );
+}
diff --git a/test/header_parser_tests/functions_test.dart b/test/header_parser_tests/functions_test.dart
index b566fb4..67a147a 100644
--- a/test/header_parser_tests/functions_test.dart
+++ b/test/header_parser_tests/functions_test.dart
@@ -5,28 +5,23 @@
import 'package:ffigen/src/code_generator.dart';
import 'package:ffigen/src/header_parser.dart' as parser;
import 'package:ffigen/src/config_provider.dart';
-import 'package:logging/logging.dart';
import 'package:test/test.dart';
import 'package:yaml/yaml.dart' as yaml;
import 'package:ffigen/src/strings.dart' as strings;
+import '../test_utils.dart';
+
Library actual, expected;
void main() {
- group('header_parser', () {
+ group('functions_test', () {
setUpAll(() {
+ logWarnings();
expected = expectedLibrary();
-
- Logger.root.onRecord.listen((log) {
- if (log.level > Level.INFO) {
- print(
- 'functions_test.dart: ${log.level.name.padRight(8)}: ${log.message}');
- }
- });
actual = parser.parse(
Config.fromYaml(yaml.loadYaml('''
${strings.name}: 'NativeLibrary'
-${strings.description}: 'Prefix Test'
+${strings.description}: 'Functions Test'
${strings.output}: 'unused'
${strings.libclang_dylib_folder}: 'tool/wrapped_libclang'
${strings.headers}:
@@ -42,43 +37,37 @@
});
test('func1', () {
- expect(binding(actual, 'func1'), binding(expected, 'func1'));
+ expect(actual.getBindingAsString('func1'),
+ expected.getBindingAsString('func1'));
});
test('func2', () {
- expect(binding(actual, 'func2'), binding(expected, 'func2'));
+ expect(actual.getBindingAsString('func2'),
+ expected.getBindingAsString('func2'));
});
test('func3', () {
- expect(binding(actual, 'func3'), binding(expected, 'func3'));
+ expect(actual.getBindingAsString('func3'),
+ expected.getBindingAsString('func3'));
});
test('func4', () {
- expect(binding(actual, 'func4'), binding(expected, 'func4'));
+ expect(actual.getBindingAsString('func4'),
+ expected.getBindingAsString('func4'));
});
});
}
-/// Extracts a binding's string from a library.
-String binding(Library lib, String name) {
- return lib.bindings
- .firstWhere((element) => element.name == name)
- .toBindingString(lib.writer)
- .string;
-}
-
Library expectedLibrary() {
return Library(
name: 'Bindings',
bindings: [
Func(
name: 'func1',
- lookupSymbolName: 'func1',
returnType: Type.nativeType(
SupportedNativeType.Void,
),
),
Func(
name: 'func2',
- lookupSymbolName: 'func2',
returnType: Type.nativeType(
SupportedNativeType.Int32,
),
@@ -93,7 +82,6 @@
),
Func(
name: 'func3',
- lookupSymbolName: 'func3',
returnType: Type.nativeType(
SupportedNativeType.Double,
),
@@ -125,7 +113,6 @@
),
Func(
name: 'func4',
- lookupSymbolName: 'func4',
returnType: Type.pointer(Type.nativeType(SupportedNativeType.Void)),
parameters: [
Parameter(
diff --git a/test/header_parser_tests/nested_parsing.h b/test/header_parser_tests/nested_parsing.h
new file mode 100644
index 0000000..29ad832
--- /dev/null
+++ b/test/header_parser_tests/nested_parsing.h
@@ -0,0 +1,16 @@
+// Copyright (c) 2020, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+struct Struct2
+{
+ int e;
+ int f;
+};
+
+struct Struct1
+{
+ int a;
+ int b;
+ struct Struct2 *struct2;
+};
diff --git a/test/header_parser_tests/nested_parsing_test.dart b/test/header_parser_tests/nested_parsing_test.dart
new file mode 100644
index 0000000..8783f46
--- /dev/null
+++ b/test/header_parser_tests/nested_parsing_test.dart
@@ -0,0 +1,83 @@
+// Copyright (c) 2020, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'package:ffigen/src/code_generator.dart';
+import 'package:ffigen/src/header_parser.dart' as parser;
+import 'package:ffigen/src/config_provider.dart';
+import 'package:test/test.dart';
+import 'package:yaml/yaml.dart' as yaml;
+import 'package:ffigen/src/strings.dart' as strings;
+
+import '../test_utils.dart';
+
+Library actual, expected;
+
+void main() {
+ group('nested_parsing_test', () {
+ setUpAll(() {
+ logWarnings();
+ expected = expectedLibrary();
+ actual = parser.parse(
+ Config.fromYaml(yaml.loadYaml('''
+${strings.name}: 'NativeLibrary'
+${strings.description}: 'Nested Parsing Test'
+${strings.output}: 'unused'
+${strings.libclang_dylib_folder}: 'tool/wrapped_libclang'
+${strings.headers}:
+ - 'test/header_parser_tests/nested_parsing.h'
+structs:
+ include:
+ names:
+ - Struct1
+${strings.headerFilter}:
+ ${strings.include}:
+ - 'nested_parsing.h'
+ ''') as yaml.YamlMap),
+ );
+ });
+
+ test('Total bindings count', () {
+ expect(actual.bindings.length, expected.bindings.length);
+ });
+
+ test('Struct1', () {
+ expect(actual.getBindingAsString('Struct1'),
+ expected.getBindingAsString('Struct1'));
+ });
+ test('Struct2', () {
+ expect(actual.getBindingAsString('Struct2'),
+ expected.getBindingAsString('Struct2'));
+ });
+ });
+}
+
+Library expectedLibrary() {
+ final struc2 = Struc(name: 'Struct2', members: [
+ Member(
+ name: 'e',
+ type: Type.nativeType(SupportedNativeType.Int32),
+ ),
+ Member(
+ name: 'f',
+ type: Type.nativeType(SupportedNativeType.Int32),
+ ),
+ ]);
+ return Library(
+ name: 'Bindings',
+ bindings: [
+ struc2,
+ Struc(name: 'Struct1', members: [
+ Member(
+ name: 'a',
+ type: Type.nativeType(SupportedNativeType.Int32),
+ ),
+ Member(
+ name: 'b',
+ type: Type.nativeType(SupportedNativeType.Int32),
+ ),
+ Member(name: 'struct2', type: Type.pointer(Type.struct(struc2))),
+ ]),
+ ],
+ );
+}
diff --git a/test/large_integration_tests/_expected_cjson_bindings.dart b/test/large_integration_tests/_expected_cjson_bindings.dart
new file mode 100644
index 0000000..e7766d2
--- /dev/null
+++ b/test/large_integration_tests/_expected_cjson_bindings.dart
@@ -0,0 +1,1752 @@
+/// AUTO GENERATED FILE, DO NOT EDIT.
+///
+/// Generated by `package:ffigen`.
+import 'dart:ffi' as ffi;
+
+/// Bindings to Cjson.
+class CJson {
+ /// Holds the Dynamic library.
+ final ffi.DynamicLibrary _dylib;
+
+ /// The symbols are looked up in [dynamicLibrary].
+ CJson(ffi.DynamicLibrary dynamicLibrary) : _dylib = dynamicLibrary;
+
+ ffi.Pointer<ffi.Int8> cJSON_Version() {
+ _cJSON_Version ??= _dylib
+ .lookupFunction<_c_cJSON_Version, _dart_cJSON_Version>('cJSON_Version');
+ return _cJSON_Version();
+ }
+
+ _dart_cJSON_Version _cJSON_Version;
+
+ void cJSON_InitHooks(
+ ffi.Pointer<cJSON_Hooks> hooks,
+ ) {
+ _cJSON_InitHooks ??=
+ _dylib.lookupFunction<_c_cJSON_InitHooks, _dart_cJSON_InitHooks>(
+ 'cJSON_InitHooks');
+ return _cJSON_InitHooks(
+ hooks,
+ );
+ }
+
+ _dart_cJSON_InitHooks _cJSON_InitHooks;
+
+ ffi.Pointer<cJSON> cJSON_Parse(
+ ffi.Pointer<ffi.Int8> value,
+ ) {
+ _cJSON_Parse ??=
+ _dylib.lookupFunction<_c_cJSON_Parse, _dart_cJSON_Parse>('cJSON_Parse');
+ return _cJSON_Parse(
+ value,
+ );
+ }
+
+ _dart_cJSON_Parse _cJSON_Parse;
+
+ ffi.Pointer<cJSON> cJSON_ParseWithOpts(
+ ffi.Pointer<ffi.Int8> value,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> return_parse_end,
+ int require_null_terminated,
+ ) {
+ _cJSON_ParseWithOpts ??= _dylib.lookupFunction<_c_cJSON_ParseWithOpts,
+ _dart_cJSON_ParseWithOpts>('cJSON_ParseWithOpts');
+ return _cJSON_ParseWithOpts(
+ value,
+ return_parse_end,
+ require_null_terminated,
+ );
+ }
+
+ _dart_cJSON_ParseWithOpts _cJSON_ParseWithOpts;
+
+ ffi.Pointer<ffi.Int8> cJSON_Print(
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_Print ??=
+ _dylib.lookupFunction<_c_cJSON_Print, _dart_cJSON_Print>('cJSON_Print');
+ return _cJSON_Print(
+ item,
+ );
+ }
+
+ _dart_cJSON_Print _cJSON_Print;
+
+ ffi.Pointer<ffi.Int8> cJSON_PrintUnformatted(
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_PrintUnformatted ??= _dylib.lookupFunction<_c_cJSON_PrintUnformatted,
+ _dart_cJSON_PrintUnformatted>('cJSON_PrintUnformatted');
+ return _cJSON_PrintUnformatted(
+ item,
+ );
+ }
+
+ _dart_cJSON_PrintUnformatted _cJSON_PrintUnformatted;
+
+ ffi.Pointer<ffi.Int8> cJSON_PrintBuffered(
+ ffi.Pointer<cJSON> item,
+ int prebuffer,
+ int fmt,
+ ) {
+ _cJSON_PrintBuffered ??= _dylib.lookupFunction<_c_cJSON_PrintBuffered,
+ _dart_cJSON_PrintBuffered>('cJSON_PrintBuffered');
+ return _cJSON_PrintBuffered(
+ item,
+ prebuffer,
+ fmt,
+ );
+ }
+
+ _dart_cJSON_PrintBuffered _cJSON_PrintBuffered;
+
+ int cJSON_PrintPreallocated(
+ ffi.Pointer<cJSON> item,
+ ffi.Pointer<ffi.Int8> buffer,
+ int length,
+ int format,
+ ) {
+ _cJSON_PrintPreallocated ??= _dylib.lookupFunction<
+ _c_cJSON_PrintPreallocated,
+ _dart_cJSON_PrintPreallocated>('cJSON_PrintPreallocated');
+ return _cJSON_PrintPreallocated(
+ item,
+ buffer,
+ length,
+ format,
+ );
+ }
+
+ _dart_cJSON_PrintPreallocated _cJSON_PrintPreallocated;
+
+ void cJSON_Delete(
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_Delete ??= _dylib
+ .lookupFunction<_c_cJSON_Delete, _dart_cJSON_Delete>('cJSON_Delete');
+ return _cJSON_Delete(
+ item,
+ );
+ }
+
+ _dart_cJSON_Delete _cJSON_Delete;
+
+ int cJSON_GetArraySize(
+ ffi.Pointer<cJSON> array,
+ ) {
+ _cJSON_GetArraySize ??=
+ _dylib.lookupFunction<_c_cJSON_GetArraySize, _dart_cJSON_GetArraySize>(
+ 'cJSON_GetArraySize');
+ return _cJSON_GetArraySize(
+ array,
+ );
+ }
+
+ _dart_cJSON_GetArraySize _cJSON_GetArraySize;
+
+ ffi.Pointer<cJSON> cJSON_GetArrayItem(
+ ffi.Pointer<cJSON> array,
+ int index,
+ ) {
+ _cJSON_GetArrayItem ??=
+ _dylib.lookupFunction<_c_cJSON_GetArrayItem, _dart_cJSON_GetArrayItem>(
+ 'cJSON_GetArrayItem');
+ return _cJSON_GetArrayItem(
+ array,
+ index,
+ );
+ }
+
+ _dart_cJSON_GetArrayItem _cJSON_GetArrayItem;
+
+ ffi.Pointer<cJSON> cJSON_GetObjectItem(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ) {
+ _cJSON_GetObjectItem ??= _dylib.lookupFunction<_c_cJSON_GetObjectItem,
+ _dart_cJSON_GetObjectItem>('cJSON_GetObjectItem');
+ return _cJSON_GetObjectItem(
+ object,
+ string,
+ );
+ }
+
+ _dart_cJSON_GetObjectItem _cJSON_GetObjectItem;
+
+ ffi.Pointer<cJSON> cJSON_GetObjectItemCaseSensitive(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ) {
+ _cJSON_GetObjectItemCaseSensitive ??= _dylib.lookupFunction<
+ _c_cJSON_GetObjectItemCaseSensitive,
+ _dart_cJSON_GetObjectItemCaseSensitive>(
+ 'cJSON_GetObjectItemCaseSensitive');
+ return _cJSON_GetObjectItemCaseSensitive(
+ object,
+ string,
+ );
+ }
+
+ _dart_cJSON_GetObjectItemCaseSensitive _cJSON_GetObjectItemCaseSensitive;
+
+ int cJSON_HasObjectItem(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ) {
+ _cJSON_HasObjectItem ??= _dylib.lookupFunction<_c_cJSON_HasObjectItem,
+ _dart_cJSON_HasObjectItem>('cJSON_HasObjectItem');
+ return _cJSON_HasObjectItem(
+ object,
+ string,
+ );
+ }
+
+ _dart_cJSON_HasObjectItem _cJSON_HasObjectItem;
+
+ ffi.Pointer<ffi.Int8> cJSON_GetErrorPtr() {
+ _cJSON_GetErrorPtr ??=
+ _dylib.lookupFunction<_c_cJSON_GetErrorPtr, _dart_cJSON_GetErrorPtr>(
+ 'cJSON_GetErrorPtr');
+ return _cJSON_GetErrorPtr();
+ }
+
+ _dart_cJSON_GetErrorPtr _cJSON_GetErrorPtr;
+
+ ffi.Pointer<ffi.Int8> cJSON_GetStringValue(
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_GetStringValue ??= _dylib.lookupFunction<_c_cJSON_GetStringValue,
+ _dart_cJSON_GetStringValue>('cJSON_GetStringValue');
+ return _cJSON_GetStringValue(
+ item,
+ );
+ }
+
+ _dart_cJSON_GetStringValue _cJSON_GetStringValue;
+
+ int cJSON_IsInvalid(
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_IsInvalid ??=
+ _dylib.lookupFunction<_c_cJSON_IsInvalid, _dart_cJSON_IsInvalid>(
+ 'cJSON_IsInvalid');
+ return _cJSON_IsInvalid(
+ item,
+ );
+ }
+
+ _dart_cJSON_IsInvalid _cJSON_IsInvalid;
+
+ int cJSON_IsFalse(
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_IsFalse ??= _dylib
+ .lookupFunction<_c_cJSON_IsFalse, _dart_cJSON_IsFalse>('cJSON_IsFalse');
+ return _cJSON_IsFalse(
+ item,
+ );
+ }
+
+ _dart_cJSON_IsFalse _cJSON_IsFalse;
+
+ int cJSON_IsTrue(
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_IsTrue ??= _dylib
+ .lookupFunction<_c_cJSON_IsTrue, _dart_cJSON_IsTrue>('cJSON_IsTrue');
+ return _cJSON_IsTrue(
+ item,
+ );
+ }
+
+ _dart_cJSON_IsTrue _cJSON_IsTrue;
+
+ int cJSON_IsBool(
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_IsBool ??= _dylib
+ .lookupFunction<_c_cJSON_IsBool, _dart_cJSON_IsBool>('cJSON_IsBool');
+ return _cJSON_IsBool(
+ item,
+ );
+ }
+
+ _dart_cJSON_IsBool _cJSON_IsBool;
+
+ int cJSON_IsNull(
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_IsNull ??= _dylib
+ .lookupFunction<_c_cJSON_IsNull, _dart_cJSON_IsNull>('cJSON_IsNull');
+ return _cJSON_IsNull(
+ item,
+ );
+ }
+
+ _dart_cJSON_IsNull _cJSON_IsNull;
+
+ int cJSON_IsNumber(
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_IsNumber ??=
+ _dylib.lookupFunction<_c_cJSON_IsNumber, _dart_cJSON_IsNumber>(
+ 'cJSON_IsNumber');
+ return _cJSON_IsNumber(
+ item,
+ );
+ }
+
+ _dart_cJSON_IsNumber _cJSON_IsNumber;
+
+ int cJSON_IsString(
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_IsString ??=
+ _dylib.lookupFunction<_c_cJSON_IsString, _dart_cJSON_IsString>(
+ 'cJSON_IsString');
+ return _cJSON_IsString(
+ item,
+ );
+ }
+
+ _dart_cJSON_IsString _cJSON_IsString;
+
+ int cJSON_IsArray(
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_IsArray ??= _dylib
+ .lookupFunction<_c_cJSON_IsArray, _dart_cJSON_IsArray>('cJSON_IsArray');
+ return _cJSON_IsArray(
+ item,
+ );
+ }
+
+ _dart_cJSON_IsArray _cJSON_IsArray;
+
+ int cJSON_IsObject(
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_IsObject ??=
+ _dylib.lookupFunction<_c_cJSON_IsObject, _dart_cJSON_IsObject>(
+ 'cJSON_IsObject');
+ return _cJSON_IsObject(
+ item,
+ );
+ }
+
+ _dart_cJSON_IsObject _cJSON_IsObject;
+
+ int cJSON_IsRaw(
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_IsRaw ??=
+ _dylib.lookupFunction<_c_cJSON_IsRaw, _dart_cJSON_IsRaw>('cJSON_IsRaw');
+ return _cJSON_IsRaw(
+ item,
+ );
+ }
+
+ _dart_cJSON_IsRaw _cJSON_IsRaw;
+
+ ffi.Pointer<cJSON> cJSON_CreateNull() {
+ _cJSON_CreateNull ??=
+ _dylib.lookupFunction<_c_cJSON_CreateNull, _dart_cJSON_CreateNull>(
+ 'cJSON_CreateNull');
+ return _cJSON_CreateNull();
+ }
+
+ _dart_cJSON_CreateNull _cJSON_CreateNull;
+
+ ffi.Pointer<cJSON> cJSON_CreateTrue() {
+ _cJSON_CreateTrue ??=
+ _dylib.lookupFunction<_c_cJSON_CreateTrue, _dart_cJSON_CreateTrue>(
+ 'cJSON_CreateTrue');
+ return _cJSON_CreateTrue();
+ }
+
+ _dart_cJSON_CreateTrue _cJSON_CreateTrue;
+
+ ffi.Pointer<cJSON> cJSON_CreateFalse() {
+ _cJSON_CreateFalse ??=
+ _dylib.lookupFunction<_c_cJSON_CreateFalse, _dart_cJSON_CreateFalse>(
+ 'cJSON_CreateFalse');
+ return _cJSON_CreateFalse();
+ }
+
+ _dart_cJSON_CreateFalse _cJSON_CreateFalse;
+
+ ffi.Pointer<cJSON> cJSON_CreateBool(
+ int boolean,
+ ) {
+ _cJSON_CreateBool ??=
+ _dylib.lookupFunction<_c_cJSON_CreateBool, _dart_cJSON_CreateBool>(
+ 'cJSON_CreateBool');
+ return _cJSON_CreateBool(
+ boolean,
+ );
+ }
+
+ _dart_cJSON_CreateBool _cJSON_CreateBool;
+
+ ffi.Pointer<cJSON> cJSON_CreateNumber(
+ double num,
+ ) {
+ _cJSON_CreateNumber ??=
+ _dylib.lookupFunction<_c_cJSON_CreateNumber, _dart_cJSON_CreateNumber>(
+ 'cJSON_CreateNumber');
+ return _cJSON_CreateNumber(
+ num,
+ );
+ }
+
+ _dart_cJSON_CreateNumber _cJSON_CreateNumber;
+
+ ffi.Pointer<cJSON> cJSON_CreateString(
+ ffi.Pointer<ffi.Int8> string,
+ ) {
+ _cJSON_CreateString ??=
+ _dylib.lookupFunction<_c_cJSON_CreateString, _dart_cJSON_CreateString>(
+ 'cJSON_CreateString');
+ return _cJSON_CreateString(
+ string,
+ );
+ }
+
+ _dart_cJSON_CreateString _cJSON_CreateString;
+
+ ffi.Pointer<cJSON> cJSON_CreateRaw(
+ ffi.Pointer<ffi.Int8> raw,
+ ) {
+ _cJSON_CreateRaw ??=
+ _dylib.lookupFunction<_c_cJSON_CreateRaw, _dart_cJSON_CreateRaw>(
+ 'cJSON_CreateRaw');
+ return _cJSON_CreateRaw(
+ raw,
+ );
+ }
+
+ _dart_cJSON_CreateRaw _cJSON_CreateRaw;
+
+ ffi.Pointer<cJSON> cJSON_CreateArray() {
+ _cJSON_CreateArray ??=
+ _dylib.lookupFunction<_c_cJSON_CreateArray, _dart_cJSON_CreateArray>(
+ 'cJSON_CreateArray');
+ return _cJSON_CreateArray();
+ }
+
+ _dart_cJSON_CreateArray _cJSON_CreateArray;
+
+ ffi.Pointer<cJSON> cJSON_CreateObject() {
+ _cJSON_CreateObject ??=
+ _dylib.lookupFunction<_c_cJSON_CreateObject, _dart_cJSON_CreateObject>(
+ 'cJSON_CreateObject');
+ return _cJSON_CreateObject();
+ }
+
+ _dart_cJSON_CreateObject _cJSON_CreateObject;
+
+ ffi.Pointer<cJSON> cJSON_CreateStringReference(
+ ffi.Pointer<ffi.Int8> string,
+ ) {
+ _cJSON_CreateStringReference ??= _dylib.lookupFunction<
+ _c_cJSON_CreateStringReference,
+ _dart_cJSON_CreateStringReference>('cJSON_CreateStringReference');
+ return _cJSON_CreateStringReference(
+ string,
+ );
+ }
+
+ _dart_cJSON_CreateStringReference _cJSON_CreateStringReference;
+
+ ffi.Pointer<cJSON> cJSON_CreateObjectReference(
+ ffi.Pointer<cJSON> child,
+ ) {
+ _cJSON_CreateObjectReference ??= _dylib.lookupFunction<
+ _c_cJSON_CreateObjectReference,
+ _dart_cJSON_CreateObjectReference>('cJSON_CreateObjectReference');
+ return _cJSON_CreateObjectReference(
+ child,
+ );
+ }
+
+ _dart_cJSON_CreateObjectReference _cJSON_CreateObjectReference;
+
+ ffi.Pointer<cJSON> cJSON_CreateArrayReference(
+ ffi.Pointer<cJSON> child,
+ ) {
+ _cJSON_CreateArrayReference ??= _dylib.lookupFunction<
+ _c_cJSON_CreateArrayReference,
+ _dart_cJSON_CreateArrayReference>('cJSON_CreateArrayReference');
+ return _cJSON_CreateArrayReference(
+ child,
+ );
+ }
+
+ _dart_cJSON_CreateArrayReference _cJSON_CreateArrayReference;
+
+ ffi.Pointer<cJSON> cJSON_CreateIntArray(
+ ffi.Pointer<ffi.Int32> numbers,
+ int count,
+ ) {
+ _cJSON_CreateIntArray ??= _dylib.lookupFunction<_c_cJSON_CreateIntArray,
+ _dart_cJSON_CreateIntArray>('cJSON_CreateIntArray');
+ return _cJSON_CreateIntArray(
+ numbers,
+ count,
+ );
+ }
+
+ _dart_cJSON_CreateIntArray _cJSON_CreateIntArray;
+
+ ffi.Pointer<cJSON> cJSON_CreateFloatArray(
+ ffi.Pointer<ffi.Float> numbers,
+ int count,
+ ) {
+ _cJSON_CreateFloatArray ??= _dylib.lookupFunction<_c_cJSON_CreateFloatArray,
+ _dart_cJSON_CreateFloatArray>('cJSON_CreateFloatArray');
+ return _cJSON_CreateFloatArray(
+ numbers,
+ count,
+ );
+ }
+
+ _dart_cJSON_CreateFloatArray _cJSON_CreateFloatArray;
+
+ ffi.Pointer<cJSON> cJSON_CreateDoubleArray(
+ ffi.Pointer<ffi.Double> numbers,
+ int count,
+ ) {
+ _cJSON_CreateDoubleArray ??= _dylib.lookupFunction<
+ _c_cJSON_CreateDoubleArray,
+ _dart_cJSON_CreateDoubleArray>('cJSON_CreateDoubleArray');
+ return _cJSON_CreateDoubleArray(
+ numbers,
+ count,
+ );
+ }
+
+ _dart_cJSON_CreateDoubleArray _cJSON_CreateDoubleArray;
+
+ ffi.Pointer<cJSON> cJSON_CreateStringArray(
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> strings,
+ int count,
+ ) {
+ _cJSON_CreateStringArray ??= _dylib.lookupFunction<
+ _c_cJSON_CreateStringArray,
+ _dart_cJSON_CreateStringArray>('cJSON_CreateStringArray');
+ return _cJSON_CreateStringArray(
+ strings,
+ count,
+ );
+ }
+
+ _dart_cJSON_CreateStringArray _cJSON_CreateStringArray;
+
+ void cJSON_AddItemToArray(
+ ffi.Pointer<cJSON> array,
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_AddItemToArray ??= _dylib.lookupFunction<_c_cJSON_AddItemToArray,
+ _dart_cJSON_AddItemToArray>('cJSON_AddItemToArray');
+ return _cJSON_AddItemToArray(
+ array,
+ item,
+ );
+ }
+
+ _dart_cJSON_AddItemToArray _cJSON_AddItemToArray;
+
+ void cJSON_AddItemToObject(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_AddItemToObject ??= _dylib.lookupFunction<_c_cJSON_AddItemToObject,
+ _dart_cJSON_AddItemToObject>('cJSON_AddItemToObject');
+ return _cJSON_AddItemToObject(
+ object,
+ string,
+ item,
+ );
+ }
+
+ _dart_cJSON_AddItemToObject _cJSON_AddItemToObject;
+
+ void cJSON_AddItemToObjectCS(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_AddItemToObjectCS ??= _dylib.lookupFunction<
+ _c_cJSON_AddItemToObjectCS,
+ _dart_cJSON_AddItemToObjectCS>('cJSON_AddItemToObjectCS');
+ return _cJSON_AddItemToObjectCS(
+ object,
+ string,
+ item,
+ );
+ }
+
+ _dart_cJSON_AddItemToObjectCS _cJSON_AddItemToObjectCS;
+
+ void cJSON_AddItemReferenceToArray(
+ ffi.Pointer<cJSON> array,
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_AddItemReferenceToArray ??= _dylib.lookupFunction<
+ _c_cJSON_AddItemReferenceToArray,
+ _dart_cJSON_AddItemReferenceToArray>('cJSON_AddItemReferenceToArray');
+ return _cJSON_AddItemReferenceToArray(
+ array,
+ item,
+ );
+ }
+
+ _dart_cJSON_AddItemReferenceToArray _cJSON_AddItemReferenceToArray;
+
+ void cJSON_AddItemReferenceToObject(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_AddItemReferenceToObject ??= _dylib.lookupFunction<
+ _c_cJSON_AddItemReferenceToObject,
+ _dart_cJSON_AddItemReferenceToObject>('cJSON_AddItemReferenceToObject');
+ return _cJSON_AddItemReferenceToObject(
+ object,
+ string,
+ item,
+ );
+ }
+
+ _dart_cJSON_AddItemReferenceToObject _cJSON_AddItemReferenceToObject;
+
+ ffi.Pointer<cJSON> cJSON_DetachItemViaPointer(
+ ffi.Pointer<cJSON> parent,
+ ffi.Pointer<cJSON> item,
+ ) {
+ _cJSON_DetachItemViaPointer ??= _dylib.lookupFunction<
+ _c_cJSON_DetachItemViaPointer,
+ _dart_cJSON_DetachItemViaPointer>('cJSON_DetachItemViaPointer');
+ return _cJSON_DetachItemViaPointer(
+ parent,
+ item,
+ );
+ }
+
+ _dart_cJSON_DetachItemViaPointer _cJSON_DetachItemViaPointer;
+
+ ffi.Pointer<cJSON> cJSON_DetachItemFromArray(
+ ffi.Pointer<cJSON> array,
+ int which,
+ ) {
+ _cJSON_DetachItemFromArray ??= _dylib.lookupFunction<
+ _c_cJSON_DetachItemFromArray,
+ _dart_cJSON_DetachItemFromArray>('cJSON_DetachItemFromArray');
+ return _cJSON_DetachItemFromArray(
+ array,
+ which,
+ );
+ }
+
+ _dart_cJSON_DetachItemFromArray _cJSON_DetachItemFromArray;
+
+ void cJSON_DeleteItemFromArray(
+ ffi.Pointer<cJSON> array,
+ int which,
+ ) {
+ _cJSON_DeleteItemFromArray ??= _dylib.lookupFunction<
+ _c_cJSON_DeleteItemFromArray,
+ _dart_cJSON_DeleteItemFromArray>('cJSON_DeleteItemFromArray');
+ return _cJSON_DeleteItemFromArray(
+ array,
+ which,
+ );
+ }
+
+ _dart_cJSON_DeleteItemFromArray _cJSON_DeleteItemFromArray;
+
+ ffi.Pointer<cJSON> cJSON_DetachItemFromObject(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ) {
+ _cJSON_DetachItemFromObject ??= _dylib.lookupFunction<
+ _c_cJSON_DetachItemFromObject,
+ _dart_cJSON_DetachItemFromObject>('cJSON_DetachItemFromObject');
+ return _cJSON_DetachItemFromObject(
+ object,
+ string,
+ );
+ }
+
+ _dart_cJSON_DetachItemFromObject _cJSON_DetachItemFromObject;
+
+ ffi.Pointer<cJSON> cJSON_DetachItemFromObjectCaseSensitive(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ) {
+ _cJSON_DetachItemFromObjectCaseSensitive ??= _dylib.lookupFunction<
+ _c_cJSON_DetachItemFromObjectCaseSensitive,
+ _dart_cJSON_DetachItemFromObjectCaseSensitive>(
+ 'cJSON_DetachItemFromObjectCaseSensitive');
+ return _cJSON_DetachItemFromObjectCaseSensitive(
+ object,
+ string,
+ );
+ }
+
+ _dart_cJSON_DetachItemFromObjectCaseSensitive
+ _cJSON_DetachItemFromObjectCaseSensitive;
+
+ void cJSON_DeleteItemFromObject(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ) {
+ _cJSON_DeleteItemFromObject ??= _dylib.lookupFunction<
+ _c_cJSON_DeleteItemFromObject,
+ _dart_cJSON_DeleteItemFromObject>('cJSON_DeleteItemFromObject');
+ return _cJSON_DeleteItemFromObject(
+ object,
+ string,
+ );
+ }
+
+ _dart_cJSON_DeleteItemFromObject _cJSON_DeleteItemFromObject;
+
+ void cJSON_DeleteItemFromObjectCaseSensitive(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ) {
+ _cJSON_DeleteItemFromObjectCaseSensitive ??= _dylib.lookupFunction<
+ _c_cJSON_DeleteItemFromObjectCaseSensitive,
+ _dart_cJSON_DeleteItemFromObjectCaseSensitive>(
+ 'cJSON_DeleteItemFromObjectCaseSensitive');
+ return _cJSON_DeleteItemFromObjectCaseSensitive(
+ object,
+ string,
+ );
+ }
+
+ _dart_cJSON_DeleteItemFromObjectCaseSensitive
+ _cJSON_DeleteItemFromObjectCaseSensitive;
+
+ void cJSON_InsertItemInArray(
+ ffi.Pointer<cJSON> array,
+ int which,
+ ffi.Pointer<cJSON> newitem,
+ ) {
+ _cJSON_InsertItemInArray ??= _dylib.lookupFunction<
+ _c_cJSON_InsertItemInArray,
+ _dart_cJSON_InsertItemInArray>('cJSON_InsertItemInArray');
+ return _cJSON_InsertItemInArray(
+ array,
+ which,
+ newitem,
+ );
+ }
+
+ _dart_cJSON_InsertItemInArray _cJSON_InsertItemInArray;
+
+ int cJSON_ReplaceItemViaPointer(
+ ffi.Pointer<cJSON> parent,
+ ffi.Pointer<cJSON> item,
+ ffi.Pointer<cJSON> replacement,
+ ) {
+ _cJSON_ReplaceItemViaPointer ??= _dylib.lookupFunction<
+ _c_cJSON_ReplaceItemViaPointer,
+ _dart_cJSON_ReplaceItemViaPointer>('cJSON_ReplaceItemViaPointer');
+ return _cJSON_ReplaceItemViaPointer(
+ parent,
+ item,
+ replacement,
+ );
+ }
+
+ _dart_cJSON_ReplaceItemViaPointer _cJSON_ReplaceItemViaPointer;
+
+ void cJSON_ReplaceItemInArray(
+ ffi.Pointer<cJSON> array,
+ int which,
+ ffi.Pointer<cJSON> newitem,
+ ) {
+ _cJSON_ReplaceItemInArray ??= _dylib.lookupFunction<
+ _c_cJSON_ReplaceItemInArray,
+ _dart_cJSON_ReplaceItemInArray>('cJSON_ReplaceItemInArray');
+ return _cJSON_ReplaceItemInArray(
+ array,
+ which,
+ newitem,
+ );
+ }
+
+ _dart_cJSON_ReplaceItemInArray _cJSON_ReplaceItemInArray;
+
+ void cJSON_ReplaceItemInObject(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ffi.Pointer<cJSON> newitem,
+ ) {
+ _cJSON_ReplaceItemInObject ??= _dylib.lookupFunction<
+ _c_cJSON_ReplaceItemInObject,
+ _dart_cJSON_ReplaceItemInObject>('cJSON_ReplaceItemInObject');
+ return _cJSON_ReplaceItemInObject(
+ object,
+ string,
+ newitem,
+ );
+ }
+
+ _dart_cJSON_ReplaceItemInObject _cJSON_ReplaceItemInObject;
+
+ void cJSON_ReplaceItemInObjectCaseSensitive(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ffi.Pointer<cJSON> newitem,
+ ) {
+ _cJSON_ReplaceItemInObjectCaseSensitive ??= _dylib.lookupFunction<
+ _c_cJSON_ReplaceItemInObjectCaseSensitive,
+ _dart_cJSON_ReplaceItemInObjectCaseSensitive>(
+ 'cJSON_ReplaceItemInObjectCaseSensitive');
+ return _cJSON_ReplaceItemInObjectCaseSensitive(
+ object,
+ string,
+ newitem,
+ );
+ }
+
+ _dart_cJSON_ReplaceItemInObjectCaseSensitive
+ _cJSON_ReplaceItemInObjectCaseSensitive;
+
+ ffi.Pointer<cJSON> cJSON_Duplicate(
+ ffi.Pointer<cJSON> item,
+ int recurse,
+ ) {
+ _cJSON_Duplicate ??=
+ _dylib.lookupFunction<_c_cJSON_Duplicate, _dart_cJSON_Duplicate>(
+ 'cJSON_Duplicate');
+ return _cJSON_Duplicate(
+ item,
+ recurse,
+ );
+ }
+
+ _dart_cJSON_Duplicate _cJSON_Duplicate;
+
+ int cJSON_Compare(
+ ffi.Pointer<cJSON> a,
+ ffi.Pointer<cJSON> b,
+ int case_sensitive,
+ ) {
+ _cJSON_Compare ??= _dylib
+ .lookupFunction<_c_cJSON_Compare, _dart_cJSON_Compare>('cJSON_Compare');
+ return _cJSON_Compare(
+ a,
+ b,
+ case_sensitive,
+ );
+ }
+
+ _dart_cJSON_Compare _cJSON_Compare;
+
+ void cJSON_Minify(
+ ffi.Pointer<ffi.Int8> json,
+ ) {
+ _cJSON_Minify ??= _dylib
+ .lookupFunction<_c_cJSON_Minify, _dart_cJSON_Minify>('cJSON_Minify');
+ return _cJSON_Minify(
+ json,
+ );
+ }
+
+ _dart_cJSON_Minify _cJSON_Minify;
+
+ ffi.Pointer<cJSON> cJSON_AddNullToObject(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+ ) {
+ _cJSON_AddNullToObject ??= _dylib.lookupFunction<_c_cJSON_AddNullToObject,
+ _dart_cJSON_AddNullToObject>('cJSON_AddNullToObject');
+ return _cJSON_AddNullToObject(
+ object,
+ name,
+ );
+ }
+
+ _dart_cJSON_AddNullToObject _cJSON_AddNullToObject;
+
+ ffi.Pointer<cJSON> cJSON_AddTrueToObject(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+ ) {
+ _cJSON_AddTrueToObject ??= _dylib.lookupFunction<_c_cJSON_AddTrueToObject,
+ _dart_cJSON_AddTrueToObject>('cJSON_AddTrueToObject');
+ return _cJSON_AddTrueToObject(
+ object,
+ name,
+ );
+ }
+
+ _dart_cJSON_AddTrueToObject _cJSON_AddTrueToObject;
+
+ ffi.Pointer<cJSON> cJSON_AddFalseToObject(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+ ) {
+ _cJSON_AddFalseToObject ??= _dylib.lookupFunction<_c_cJSON_AddFalseToObject,
+ _dart_cJSON_AddFalseToObject>('cJSON_AddFalseToObject');
+ return _cJSON_AddFalseToObject(
+ object,
+ name,
+ );
+ }
+
+ _dart_cJSON_AddFalseToObject _cJSON_AddFalseToObject;
+
+ ffi.Pointer<cJSON> cJSON_AddBoolToObject(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+ int boolean,
+ ) {
+ _cJSON_AddBoolToObject ??= _dylib.lookupFunction<_c_cJSON_AddBoolToObject,
+ _dart_cJSON_AddBoolToObject>('cJSON_AddBoolToObject');
+ return _cJSON_AddBoolToObject(
+ object,
+ name,
+ boolean,
+ );
+ }
+
+ _dart_cJSON_AddBoolToObject _cJSON_AddBoolToObject;
+
+ ffi.Pointer<cJSON> cJSON_AddNumberToObject(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+ double number,
+ ) {
+ _cJSON_AddNumberToObject ??= _dylib.lookupFunction<
+ _c_cJSON_AddNumberToObject,
+ _dart_cJSON_AddNumberToObject>('cJSON_AddNumberToObject');
+ return _cJSON_AddNumberToObject(
+ object,
+ name,
+ number,
+ );
+ }
+
+ _dart_cJSON_AddNumberToObject _cJSON_AddNumberToObject;
+
+ ffi.Pointer<cJSON> cJSON_AddStringToObject(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+ ffi.Pointer<ffi.Int8> string,
+ ) {
+ _cJSON_AddStringToObject ??= _dylib.lookupFunction<
+ _c_cJSON_AddStringToObject,
+ _dart_cJSON_AddStringToObject>('cJSON_AddStringToObject');
+ return _cJSON_AddStringToObject(
+ object,
+ name,
+ string,
+ );
+ }
+
+ _dart_cJSON_AddStringToObject _cJSON_AddStringToObject;
+
+ ffi.Pointer<cJSON> cJSON_AddRawToObject(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+ ffi.Pointer<ffi.Int8> raw,
+ ) {
+ _cJSON_AddRawToObject ??= _dylib.lookupFunction<_c_cJSON_AddRawToObject,
+ _dart_cJSON_AddRawToObject>('cJSON_AddRawToObject');
+ return _cJSON_AddRawToObject(
+ object,
+ name,
+ raw,
+ );
+ }
+
+ _dart_cJSON_AddRawToObject _cJSON_AddRawToObject;
+
+ ffi.Pointer<cJSON> cJSON_AddObjectToObject(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+ ) {
+ _cJSON_AddObjectToObject ??= _dylib.lookupFunction<
+ _c_cJSON_AddObjectToObject,
+ _dart_cJSON_AddObjectToObject>('cJSON_AddObjectToObject');
+ return _cJSON_AddObjectToObject(
+ object,
+ name,
+ );
+ }
+
+ _dart_cJSON_AddObjectToObject _cJSON_AddObjectToObject;
+
+ ffi.Pointer<cJSON> cJSON_AddArrayToObject(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+ ) {
+ _cJSON_AddArrayToObject ??= _dylib.lookupFunction<_c_cJSON_AddArrayToObject,
+ _dart_cJSON_AddArrayToObject>('cJSON_AddArrayToObject');
+ return _cJSON_AddArrayToObject(
+ object,
+ name,
+ );
+ }
+
+ _dart_cJSON_AddArrayToObject _cJSON_AddArrayToObject;
+
+ double cJSON_SetNumberHelper(
+ ffi.Pointer<cJSON> object,
+ double number,
+ ) {
+ _cJSON_SetNumberHelper ??= _dylib.lookupFunction<_c_cJSON_SetNumberHelper,
+ _dart_cJSON_SetNumberHelper>('cJSON_SetNumberHelper');
+ return _cJSON_SetNumberHelper(
+ object,
+ number,
+ );
+ }
+
+ _dart_cJSON_SetNumberHelper _cJSON_SetNumberHelper;
+
+ ffi.Pointer<ffi.Void> cJSON_malloc(
+ int size,
+ ) {
+ _cJSON_malloc ??= _dylib
+ .lookupFunction<_c_cJSON_malloc, _dart_cJSON_malloc>('cJSON_malloc');
+ return _cJSON_malloc(
+ size,
+ );
+ }
+
+ _dart_cJSON_malloc _cJSON_malloc;
+
+ void cJSON_free(
+ ffi.Pointer<ffi.Void> object,
+ ) {
+ _cJSON_free ??=
+ _dylib.lookupFunction<_c_cJSON_free, _dart_cJSON_free>('cJSON_free');
+ return _cJSON_free(
+ object,
+ );
+ }
+
+ _dart_cJSON_free _cJSON_free;
+}
+
+class cJSON extends ffi.Struct {
+ ffi.Pointer<cJSON> next;
+
+ ffi.Pointer<cJSON> prev;
+
+ ffi.Pointer<cJSON> child;
+
+ @ffi.Int32()
+ int type;
+
+ ffi.Pointer<ffi.Int8> valuestring;
+
+ @ffi.Int32()
+ int valueint;
+
+ @ffi.Double()
+ double valuedouble;
+
+ ffi.Pointer<ffi.Int8> string;
+}
+
+class cJSON_Hooks extends ffi.Struct {
+ ffi.Pointer<ffi.NativeFunction<_typedefC_11>> malloc_fn;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_12>> free_fn;
+}
+
+typedef _c_cJSON_Version = ffi.Pointer<ffi.Int8> Function();
+
+typedef _dart_cJSON_Version = ffi.Pointer<ffi.Int8> Function();
+
+typedef _c_cJSON_InitHooks = ffi.Void Function(
+ ffi.Pointer<cJSON_Hooks> hooks,
+);
+
+typedef _dart_cJSON_InitHooks = void Function(
+ ffi.Pointer<cJSON_Hooks> hooks,
+);
+
+typedef _c_cJSON_Parse = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Int8> value,
+);
+
+typedef _dart_cJSON_Parse = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Int8> value,
+);
+
+typedef _c_cJSON_ParseWithOpts = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Int8> value,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> return_parse_end,
+ ffi.Int32 require_null_terminated,
+);
+
+typedef _dart_cJSON_ParseWithOpts = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Int8> value,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> return_parse_end,
+ int require_null_terminated,
+);
+
+typedef _c_cJSON_Print = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_Print = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_PrintUnformatted = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_PrintUnformatted = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_PrintBuffered = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<cJSON> item,
+ ffi.Int32 prebuffer,
+ ffi.Int32 fmt,
+);
+
+typedef _dart_cJSON_PrintBuffered = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<cJSON> item,
+ int prebuffer,
+ int fmt,
+);
+
+typedef _c_cJSON_PrintPreallocated = ffi.Int32 Function(
+ ffi.Pointer<cJSON> item,
+ ffi.Pointer<ffi.Int8> buffer,
+ ffi.Int32 length,
+ ffi.Int32 format,
+);
+
+typedef _dart_cJSON_PrintPreallocated = int Function(
+ ffi.Pointer<cJSON> item,
+ ffi.Pointer<ffi.Int8> buffer,
+ int length,
+ int format,
+);
+
+typedef _c_cJSON_Delete = ffi.Void Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_Delete = void Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_GetArraySize = ffi.Int32 Function(
+ ffi.Pointer<cJSON> array,
+);
+
+typedef _dart_cJSON_GetArraySize = int Function(
+ ffi.Pointer<cJSON> array,
+);
+
+typedef _c_cJSON_GetArrayItem = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> array,
+ ffi.Int32 index,
+);
+
+typedef _dart_cJSON_GetArrayItem = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> array,
+ int index,
+);
+
+typedef _c_cJSON_GetObjectItem = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _dart_cJSON_GetObjectItem = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _c_cJSON_GetObjectItemCaseSensitive = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _dart_cJSON_GetObjectItemCaseSensitive = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _c_cJSON_HasObjectItem = ffi.Int32 Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _dart_cJSON_HasObjectItem = int Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _c_cJSON_GetErrorPtr = ffi.Pointer<ffi.Int8> Function();
+
+typedef _dart_cJSON_GetErrorPtr = ffi.Pointer<ffi.Int8> Function();
+
+typedef _c_cJSON_GetStringValue = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_GetStringValue = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_IsInvalid = ffi.Int32 Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_IsInvalid = int Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_IsFalse = ffi.Int32 Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_IsFalse = int Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_IsTrue = ffi.Int32 Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_IsTrue = int Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_IsBool = ffi.Int32 Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_IsBool = int Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_IsNull = ffi.Int32 Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_IsNull = int Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_IsNumber = ffi.Int32 Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_IsNumber = int Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_IsString = ffi.Int32 Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_IsString = int Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_IsArray = ffi.Int32 Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_IsArray = int Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_IsObject = ffi.Int32 Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_IsObject = int Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_IsRaw = ffi.Int32 Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_IsRaw = int Function(
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_CreateNull = ffi.Pointer<cJSON> Function();
+
+typedef _dart_cJSON_CreateNull = ffi.Pointer<cJSON> Function();
+
+typedef _c_cJSON_CreateTrue = ffi.Pointer<cJSON> Function();
+
+typedef _dart_cJSON_CreateTrue = ffi.Pointer<cJSON> Function();
+
+typedef _c_cJSON_CreateFalse = ffi.Pointer<cJSON> Function();
+
+typedef _dart_cJSON_CreateFalse = ffi.Pointer<cJSON> Function();
+
+typedef _c_cJSON_CreateBool = ffi.Pointer<cJSON> Function(
+ ffi.Int32 boolean,
+);
+
+typedef _dart_cJSON_CreateBool = ffi.Pointer<cJSON> Function(
+ int boolean,
+);
+
+typedef _c_cJSON_CreateNumber = ffi.Pointer<cJSON> Function(
+ ffi.Double num,
+);
+
+typedef _dart_cJSON_CreateNumber = ffi.Pointer<cJSON> Function(
+ double num,
+);
+
+typedef _c_cJSON_CreateString = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _dart_cJSON_CreateString = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _c_cJSON_CreateRaw = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Int8> raw,
+);
+
+typedef _dart_cJSON_CreateRaw = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Int8> raw,
+);
+
+typedef _c_cJSON_CreateArray = ffi.Pointer<cJSON> Function();
+
+typedef _dart_cJSON_CreateArray = ffi.Pointer<cJSON> Function();
+
+typedef _c_cJSON_CreateObject = ffi.Pointer<cJSON> Function();
+
+typedef _dart_cJSON_CreateObject = ffi.Pointer<cJSON> Function();
+
+typedef _c_cJSON_CreateStringReference = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _dart_cJSON_CreateStringReference = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _c_cJSON_CreateObjectReference = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> child,
+);
+
+typedef _dart_cJSON_CreateObjectReference = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> child,
+);
+
+typedef _c_cJSON_CreateArrayReference = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> child,
+);
+
+typedef _dart_cJSON_CreateArrayReference = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> child,
+);
+
+typedef _c_cJSON_CreateIntArray = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Int32> numbers,
+ ffi.Int32 count,
+);
+
+typedef _dart_cJSON_CreateIntArray = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Int32> numbers,
+ int count,
+);
+
+typedef _c_cJSON_CreateFloatArray = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Float> numbers,
+ ffi.Int32 count,
+);
+
+typedef _dart_cJSON_CreateFloatArray = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Float> numbers,
+ int count,
+);
+
+typedef _c_cJSON_CreateDoubleArray = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Double> numbers,
+ ffi.Int32 count,
+);
+
+typedef _dart_cJSON_CreateDoubleArray = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Double> numbers,
+ int count,
+);
+
+typedef _c_cJSON_CreateStringArray = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> strings,
+ ffi.Int32 count,
+);
+
+typedef _dart_cJSON_CreateStringArray = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> strings,
+ int count,
+);
+
+typedef _c_cJSON_AddItemToArray = ffi.Void Function(
+ ffi.Pointer<cJSON> array,
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_AddItemToArray = void Function(
+ ffi.Pointer<cJSON> array,
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_AddItemToObject = ffi.Void Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_AddItemToObject = void Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_AddItemToObjectCS = ffi.Void Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_AddItemToObjectCS = void Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_AddItemReferenceToArray = ffi.Void Function(
+ ffi.Pointer<cJSON> array,
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_AddItemReferenceToArray = void Function(
+ ffi.Pointer<cJSON> array,
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_AddItemReferenceToObject = ffi.Void Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_AddItemReferenceToObject = void Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_DetachItemViaPointer = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> parent,
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _dart_cJSON_DetachItemViaPointer = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> parent,
+ ffi.Pointer<cJSON> item,
+);
+
+typedef _c_cJSON_DetachItemFromArray = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> array,
+ ffi.Int32 which,
+);
+
+typedef _dart_cJSON_DetachItemFromArray = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> array,
+ int which,
+);
+
+typedef _c_cJSON_DeleteItemFromArray = ffi.Void Function(
+ ffi.Pointer<cJSON> array,
+ ffi.Int32 which,
+);
+
+typedef _dart_cJSON_DeleteItemFromArray = void Function(
+ ffi.Pointer<cJSON> array,
+ int which,
+);
+
+typedef _c_cJSON_DetachItemFromObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _dart_cJSON_DetachItemFromObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _c_cJSON_DetachItemFromObjectCaseSensitive = ffi.Pointer<cJSON>
+ Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _dart_cJSON_DetachItemFromObjectCaseSensitive = ffi.Pointer<cJSON>
+ Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _c_cJSON_DeleteItemFromObject = ffi.Void Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _dart_cJSON_DeleteItemFromObject = void Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _c_cJSON_DeleteItemFromObjectCaseSensitive = ffi.Void Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _dart_cJSON_DeleteItemFromObjectCaseSensitive = void Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _c_cJSON_InsertItemInArray = ffi.Void Function(
+ ffi.Pointer<cJSON> array,
+ ffi.Int32 which,
+ ffi.Pointer<cJSON> newitem,
+);
+
+typedef _dart_cJSON_InsertItemInArray = void Function(
+ ffi.Pointer<cJSON> array,
+ int which,
+ ffi.Pointer<cJSON> newitem,
+);
+
+typedef _c_cJSON_ReplaceItemViaPointer = ffi.Int32 Function(
+ ffi.Pointer<cJSON> parent,
+ ffi.Pointer<cJSON> item,
+ ffi.Pointer<cJSON> replacement,
+);
+
+typedef _dart_cJSON_ReplaceItemViaPointer = int Function(
+ ffi.Pointer<cJSON> parent,
+ ffi.Pointer<cJSON> item,
+ ffi.Pointer<cJSON> replacement,
+);
+
+typedef _c_cJSON_ReplaceItemInArray = ffi.Void Function(
+ ffi.Pointer<cJSON> array,
+ ffi.Int32 which,
+ ffi.Pointer<cJSON> newitem,
+);
+
+typedef _dart_cJSON_ReplaceItemInArray = void Function(
+ ffi.Pointer<cJSON> array,
+ int which,
+ ffi.Pointer<cJSON> newitem,
+);
+
+typedef _c_cJSON_ReplaceItemInObject = ffi.Void Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ffi.Pointer<cJSON> newitem,
+);
+
+typedef _dart_cJSON_ReplaceItemInObject = void Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ffi.Pointer<cJSON> newitem,
+);
+
+typedef _c_cJSON_ReplaceItemInObjectCaseSensitive = ffi.Void Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ffi.Pointer<cJSON> newitem,
+);
+
+typedef _dart_cJSON_ReplaceItemInObjectCaseSensitive = void Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> string,
+ ffi.Pointer<cJSON> newitem,
+);
+
+typedef _c_cJSON_Duplicate = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> item,
+ ffi.Int32 recurse,
+);
+
+typedef _dart_cJSON_Duplicate = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> item,
+ int recurse,
+);
+
+typedef _c_cJSON_Compare = ffi.Int32 Function(
+ ffi.Pointer<cJSON> a,
+ ffi.Pointer<cJSON> b,
+ ffi.Int32 case_sensitive,
+);
+
+typedef _dart_cJSON_Compare = int Function(
+ ffi.Pointer<cJSON> a,
+ ffi.Pointer<cJSON> b,
+ int case_sensitive,
+);
+
+typedef _c_cJSON_Minify = ffi.Void Function(
+ ffi.Pointer<ffi.Int8> json,
+);
+
+typedef _dart_cJSON_Minify = void Function(
+ ffi.Pointer<ffi.Int8> json,
+);
+
+typedef _c_cJSON_AddNullToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+);
+
+typedef _dart_cJSON_AddNullToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+);
+
+typedef _c_cJSON_AddTrueToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+);
+
+typedef _dart_cJSON_AddTrueToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+);
+
+typedef _c_cJSON_AddFalseToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+);
+
+typedef _dart_cJSON_AddFalseToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+);
+
+typedef _c_cJSON_AddBoolToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+ ffi.Int32 boolean,
+);
+
+typedef _dart_cJSON_AddBoolToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+ int boolean,
+);
+
+typedef _c_cJSON_AddNumberToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+ ffi.Double number,
+);
+
+typedef _dart_cJSON_AddNumberToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+ double number,
+);
+
+typedef _c_cJSON_AddStringToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _dart_cJSON_AddStringToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+ ffi.Pointer<ffi.Int8> string,
+);
+
+typedef _c_cJSON_AddRawToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+ ffi.Pointer<ffi.Int8> raw,
+);
+
+typedef _dart_cJSON_AddRawToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+ ffi.Pointer<ffi.Int8> raw,
+);
+
+typedef _c_cJSON_AddObjectToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+);
+
+typedef _dart_cJSON_AddObjectToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+);
+
+typedef _c_cJSON_AddArrayToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+);
+
+typedef _dart_cJSON_AddArrayToObject = ffi.Pointer<cJSON> Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Pointer<ffi.Int8> name,
+);
+
+typedef _c_cJSON_SetNumberHelper = ffi.Double Function(
+ ffi.Pointer<cJSON> object,
+ ffi.Double number,
+);
+
+typedef _dart_cJSON_SetNumberHelper = double Function(
+ ffi.Pointer<cJSON> object,
+ double number,
+);
+
+typedef _c_cJSON_malloc = ffi.Pointer<ffi.Void> Function(
+ ffi.Uint64 size,
+);
+
+typedef _dart_cJSON_malloc = ffi.Pointer<ffi.Void> Function(
+ int size,
+);
+
+typedef _c_cJSON_free = ffi.Void Function(
+ ffi.Pointer<ffi.Void> object,
+);
+
+typedef _dart_cJSON_free = void Function(
+ ffi.Pointer<ffi.Void> object,
+);
+
+typedef _typedefC_11 = ffi.Pointer<ffi.Void> Function(
+ ffi.Uint64,
+);
+
+typedef _typedefC_12 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
diff --git a/test/large_integration_tests/_expected_libclang_bindings.dart b/test/large_integration_tests/_expected_libclang_bindings.dart
new file mode 100644
index 0000000..1aa4cb5
--- /dev/null
+++ b/test/large_integration_tests/_expected_libclang_bindings.dart
@@ -0,0 +1,5765 @@
+/// AUTO GENERATED FILE, DO NOT EDIT.
+///
+/// Generated by `package:ffigen`.
+import 'dart:ffi' as ffi;
+
+/// Bindings to LibClang.
+class LibClang {
+ /// Holds the Dynamic library.
+ final ffi.DynamicLibrary _dylib;
+
+ /// The symbols are looked up in [dynamicLibrary].
+ LibClang(ffi.DynamicLibrary dynamicLibrary) : _dylib = dynamicLibrary;
+
+ /// Free the given string set.
+ void clang_disposeStringSet(
+ ffi.Pointer<CXStringSet> set,
+ ) {
+ _clang_disposeStringSet ??= _dylib.lookupFunction<_c_clang_disposeStringSet,
+ _dart_clang_disposeStringSet>('clang_disposeStringSet');
+ return _clang_disposeStringSet(
+ set,
+ );
+ }
+
+ _dart_clang_disposeStringSet _clang_disposeStringSet;
+
+ /// Return the timestamp for use with Clang's -fbuild-session-timestamp=
+ /// option.
+ int clang_getBuildSessionTimestamp() {
+ _clang_getBuildSessionTimestamp ??= _dylib.lookupFunction<
+ _c_clang_getBuildSessionTimestamp,
+ _dart_clang_getBuildSessionTimestamp>('clang_getBuildSessionTimestamp');
+ return _clang_getBuildSessionTimestamp();
+ }
+
+ _dart_clang_getBuildSessionTimestamp _clang_getBuildSessionTimestamp;
+
+ /// Create a CXVirtualFileOverlay object. Must be disposed with
+ /// clang_VirtualFileOverlay_dispose().
+ ffi.Pointer<CXVirtualFileOverlayImpl> clang_VirtualFileOverlay_create(
+ int options,
+ ) {
+ _clang_VirtualFileOverlay_create ??= _dylib.lookupFunction<
+ _c_clang_VirtualFileOverlay_create,
+ _dart_clang_VirtualFileOverlay_create>(
+ 'clang_VirtualFileOverlay_create');
+ return _clang_VirtualFileOverlay_create(
+ options,
+ );
+ }
+
+ _dart_clang_VirtualFileOverlay_create _clang_VirtualFileOverlay_create;
+
+ /// Map an absolute virtual file path to an absolute real one. The virtual
+ /// path must be canonicalized (not contain "."/"..").
+ int clang_VirtualFileOverlay_addFileMapping(
+ ffi.Pointer<CXVirtualFileOverlayImpl> arg0,
+ ffi.Pointer<ffi.Int8> virtualPath,
+ ffi.Pointer<ffi.Int8> realPath,
+ ) {
+ _clang_VirtualFileOverlay_addFileMapping ??= _dylib.lookupFunction<
+ _c_clang_VirtualFileOverlay_addFileMapping,
+ _dart_clang_VirtualFileOverlay_addFileMapping>(
+ 'clang_VirtualFileOverlay_addFileMapping');
+ return _clang_VirtualFileOverlay_addFileMapping(
+ arg0,
+ virtualPath,
+ realPath,
+ );
+ }
+
+ _dart_clang_VirtualFileOverlay_addFileMapping
+ _clang_VirtualFileOverlay_addFileMapping;
+
+ /// Set the case sensitivity for the CXVirtualFileOverlay object. The
+ /// CXVirtualFileOverlay object is case-sensitive by default, this option can
+ /// be used to override the default.
+ int clang_VirtualFileOverlay_setCaseSensitivity(
+ ffi.Pointer<CXVirtualFileOverlayImpl> arg0,
+ int caseSensitive,
+ ) {
+ _clang_VirtualFileOverlay_setCaseSensitivity ??= _dylib.lookupFunction<
+ _c_clang_VirtualFileOverlay_setCaseSensitivity,
+ _dart_clang_VirtualFileOverlay_setCaseSensitivity>(
+ 'clang_VirtualFileOverlay_setCaseSensitivity');
+ return _clang_VirtualFileOverlay_setCaseSensitivity(
+ arg0,
+ caseSensitive,
+ );
+ }
+
+ _dart_clang_VirtualFileOverlay_setCaseSensitivity
+ _clang_VirtualFileOverlay_setCaseSensitivity;
+
+ /// Write out the CXVirtualFileOverlay object to a char buffer.
+ int clang_VirtualFileOverlay_writeToBuffer(
+ ffi.Pointer<CXVirtualFileOverlayImpl> arg0,
+ int options,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> out_buffer_ptr,
+ ffi.Pointer<ffi.Uint32> out_buffer_size,
+ ) {
+ _clang_VirtualFileOverlay_writeToBuffer ??= _dylib.lookupFunction<
+ _c_clang_VirtualFileOverlay_writeToBuffer,
+ _dart_clang_VirtualFileOverlay_writeToBuffer>(
+ 'clang_VirtualFileOverlay_writeToBuffer');
+ return _clang_VirtualFileOverlay_writeToBuffer(
+ arg0,
+ options,
+ out_buffer_ptr,
+ out_buffer_size,
+ );
+ }
+
+ _dart_clang_VirtualFileOverlay_writeToBuffer
+ _clang_VirtualFileOverlay_writeToBuffer;
+
+ /// free memory allocated by libclang, such as the buffer returned by
+ /// CXVirtualFileOverlay() or clang_ModuleMapDescriptor_writeToBuffer().
+ void clang_free(
+ ffi.Pointer<ffi.Void> buffer,
+ ) {
+ _clang_free ??=
+ _dylib.lookupFunction<_c_clang_free, _dart_clang_free>('clang_free');
+ return _clang_free(
+ buffer,
+ );
+ }
+
+ _dart_clang_free _clang_free;
+
+ /// Dispose a CXVirtualFileOverlay object.
+ void clang_VirtualFileOverlay_dispose(
+ ffi.Pointer<CXVirtualFileOverlayImpl> arg0,
+ ) {
+ _clang_VirtualFileOverlay_dispose ??= _dylib.lookupFunction<
+ _c_clang_VirtualFileOverlay_dispose,
+ _dart_clang_VirtualFileOverlay_dispose>(
+ 'clang_VirtualFileOverlay_dispose');
+ return _clang_VirtualFileOverlay_dispose(
+ arg0,
+ );
+ }
+
+ _dart_clang_VirtualFileOverlay_dispose _clang_VirtualFileOverlay_dispose;
+
+ /// Create a CXModuleMapDescriptor object. Must be disposed with
+ /// clang_ModuleMapDescriptor_dispose().
+ ffi.Pointer<CXModuleMapDescriptorImpl> clang_ModuleMapDescriptor_create(
+ int options,
+ ) {
+ _clang_ModuleMapDescriptor_create ??= _dylib.lookupFunction<
+ _c_clang_ModuleMapDescriptor_create,
+ _dart_clang_ModuleMapDescriptor_create>(
+ 'clang_ModuleMapDescriptor_create');
+ return _clang_ModuleMapDescriptor_create(
+ options,
+ );
+ }
+
+ _dart_clang_ModuleMapDescriptor_create _clang_ModuleMapDescriptor_create;
+
+ /// Sets the framework module name that the module.map describes.
+ int clang_ModuleMapDescriptor_setFrameworkModuleName(
+ ffi.Pointer<CXModuleMapDescriptorImpl> arg0,
+ ffi.Pointer<ffi.Int8> name,
+ ) {
+ _clang_ModuleMapDescriptor_setFrameworkModuleName ??= _dylib.lookupFunction<
+ _c_clang_ModuleMapDescriptor_setFrameworkModuleName,
+ _dart_clang_ModuleMapDescriptor_setFrameworkModuleName>(
+ 'clang_ModuleMapDescriptor_setFrameworkModuleName');
+ return _clang_ModuleMapDescriptor_setFrameworkModuleName(
+ arg0,
+ name,
+ );
+ }
+
+ _dart_clang_ModuleMapDescriptor_setFrameworkModuleName
+ _clang_ModuleMapDescriptor_setFrameworkModuleName;
+
+ /// Sets the umbrealla header name that the module.map describes.
+ int clang_ModuleMapDescriptor_setUmbrellaHeader(
+ ffi.Pointer<CXModuleMapDescriptorImpl> arg0,
+ ffi.Pointer<ffi.Int8> name,
+ ) {
+ _clang_ModuleMapDescriptor_setUmbrellaHeader ??= _dylib.lookupFunction<
+ _c_clang_ModuleMapDescriptor_setUmbrellaHeader,
+ _dart_clang_ModuleMapDescriptor_setUmbrellaHeader>(
+ 'clang_ModuleMapDescriptor_setUmbrellaHeader');
+ return _clang_ModuleMapDescriptor_setUmbrellaHeader(
+ arg0,
+ name,
+ );
+ }
+
+ _dart_clang_ModuleMapDescriptor_setUmbrellaHeader
+ _clang_ModuleMapDescriptor_setUmbrellaHeader;
+
+ /// Write out the CXModuleMapDescriptor object to a char buffer.
+ int clang_ModuleMapDescriptor_writeToBuffer(
+ ffi.Pointer<CXModuleMapDescriptorImpl> arg0,
+ int options,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> out_buffer_ptr,
+ ffi.Pointer<ffi.Uint32> out_buffer_size,
+ ) {
+ _clang_ModuleMapDescriptor_writeToBuffer ??= _dylib.lookupFunction<
+ _c_clang_ModuleMapDescriptor_writeToBuffer,
+ _dart_clang_ModuleMapDescriptor_writeToBuffer>(
+ 'clang_ModuleMapDescriptor_writeToBuffer');
+ return _clang_ModuleMapDescriptor_writeToBuffer(
+ arg0,
+ options,
+ out_buffer_ptr,
+ out_buffer_size,
+ );
+ }
+
+ _dart_clang_ModuleMapDescriptor_writeToBuffer
+ _clang_ModuleMapDescriptor_writeToBuffer;
+
+ /// Dispose a CXModuleMapDescriptor object.
+ void clang_ModuleMapDescriptor_dispose(
+ ffi.Pointer<CXModuleMapDescriptorImpl> arg0,
+ ) {
+ _clang_ModuleMapDescriptor_dispose ??= _dylib.lookupFunction<
+ _c_clang_ModuleMapDescriptor_dispose,
+ _dart_clang_ModuleMapDescriptor_dispose>(
+ 'clang_ModuleMapDescriptor_dispose');
+ return _clang_ModuleMapDescriptor_dispose(
+ arg0,
+ );
+ }
+
+ _dart_clang_ModuleMapDescriptor_dispose _clang_ModuleMapDescriptor_dispose;
+
+ /// Provides a shared context for creating translation units.
+ ffi.Pointer<ffi.Void> clang_createIndex(
+ int excludeDeclarationsFromPCH,
+ int displayDiagnostics,
+ ) {
+ _clang_createIndex ??=
+ _dylib.lookupFunction<_c_clang_createIndex, _dart_clang_createIndex>(
+ 'clang_createIndex');
+ return _clang_createIndex(
+ excludeDeclarationsFromPCH,
+ displayDiagnostics,
+ );
+ }
+
+ _dart_clang_createIndex _clang_createIndex;
+
+ /// Destroy the given index.
+ void clang_disposeIndex(
+ ffi.Pointer<ffi.Void> index,
+ ) {
+ _clang_disposeIndex ??=
+ _dylib.lookupFunction<_c_clang_disposeIndex, _dart_clang_disposeIndex>(
+ 'clang_disposeIndex');
+ return _clang_disposeIndex(
+ index,
+ );
+ }
+
+ _dart_clang_disposeIndex _clang_disposeIndex;
+
+ /// Sets general options associated with a CXIndex.
+ void clang_CXIndex_setGlobalOptions(
+ ffi.Pointer<ffi.Void> arg0,
+ int options,
+ ) {
+ _clang_CXIndex_setGlobalOptions ??= _dylib.lookupFunction<
+ _c_clang_CXIndex_setGlobalOptions,
+ _dart_clang_CXIndex_setGlobalOptions>('clang_CXIndex_setGlobalOptions');
+ return _clang_CXIndex_setGlobalOptions(
+ arg0,
+ options,
+ );
+ }
+
+ _dart_clang_CXIndex_setGlobalOptions _clang_CXIndex_setGlobalOptions;
+
+ /// Gets the general options associated with a CXIndex.
+ int clang_CXIndex_getGlobalOptions(
+ ffi.Pointer<ffi.Void> arg0,
+ ) {
+ _clang_CXIndex_getGlobalOptions ??= _dylib.lookupFunction<
+ _c_clang_CXIndex_getGlobalOptions,
+ _dart_clang_CXIndex_getGlobalOptions>('clang_CXIndex_getGlobalOptions');
+ return _clang_CXIndex_getGlobalOptions(
+ arg0,
+ );
+ }
+
+ _dart_clang_CXIndex_getGlobalOptions _clang_CXIndex_getGlobalOptions;
+
+ /// Sets the invocation emission path option in a CXIndex.
+ void clang_CXIndex_setInvocationEmissionPathOption(
+ ffi.Pointer<ffi.Void> arg0,
+ ffi.Pointer<ffi.Int8> Path,
+ ) {
+ _clang_CXIndex_setInvocationEmissionPathOption ??= _dylib.lookupFunction<
+ _c_clang_CXIndex_setInvocationEmissionPathOption,
+ _dart_clang_CXIndex_setInvocationEmissionPathOption>(
+ 'clang_CXIndex_setInvocationEmissionPathOption');
+ return _clang_CXIndex_setInvocationEmissionPathOption(
+ arg0,
+ Path,
+ );
+ }
+
+ _dart_clang_CXIndex_setInvocationEmissionPathOption
+ _clang_CXIndex_setInvocationEmissionPathOption;
+
+ /// Retrieve the last modification time of the given file.
+ int clang_getFileTime(
+ ffi.Pointer<ffi.Void> SFile,
+ ) {
+ _clang_getFileTime ??=
+ _dylib.lookupFunction<_c_clang_getFileTime, _dart_clang_getFileTime>(
+ 'clang_getFileTime');
+ return _clang_getFileTime(
+ SFile,
+ );
+ }
+
+ _dart_clang_getFileTime _clang_getFileTime;
+
+ /// Retrieve the unique ID for the given file.
+ int clang_getFileUniqueID(
+ ffi.Pointer<ffi.Void> file,
+ ffi.Pointer<CXFileUniqueID> outID,
+ ) {
+ _clang_getFileUniqueID ??= _dylib.lookupFunction<_c_clang_getFileUniqueID,
+ _dart_clang_getFileUniqueID>('clang_getFileUniqueID');
+ return _clang_getFileUniqueID(
+ file,
+ outID,
+ );
+ }
+
+ _dart_clang_getFileUniqueID _clang_getFileUniqueID;
+
+ /// Determine whether the given header is guarded against multiple inclusions,
+ /// either with the conventional #ifndef/#define/#endif macro guards or with
+ /// #pragma once.
+ int clang_isFileMultipleIncludeGuarded(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+ ffi.Pointer<ffi.Void> file,
+ ) {
+ _clang_isFileMultipleIncludeGuarded ??= _dylib.lookupFunction<
+ _c_clang_isFileMultipleIncludeGuarded,
+ _dart_clang_isFileMultipleIncludeGuarded>(
+ 'clang_isFileMultipleIncludeGuarded');
+ return _clang_isFileMultipleIncludeGuarded(
+ tu,
+ file,
+ );
+ }
+
+ _dart_clang_isFileMultipleIncludeGuarded _clang_isFileMultipleIncludeGuarded;
+
+ /// Retrieve a file handle within the given translation unit.
+ ffi.Pointer<ffi.Void> clang_getFile(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+ ffi.Pointer<ffi.Int8> file_name,
+ ) {
+ _clang_getFile ??= _dylib
+ .lookupFunction<_c_clang_getFile, _dart_clang_getFile>('clang_getFile');
+ return _clang_getFile(
+ tu,
+ file_name,
+ );
+ }
+
+ _dart_clang_getFile _clang_getFile;
+
+ /// Retrieve the buffer associated with the given file.
+ ffi.Pointer<ffi.Int8> clang_getFileContents(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+ ffi.Pointer<ffi.Void> file,
+ ffi.Pointer<ffi.Uint64> size,
+ ) {
+ _clang_getFileContents ??= _dylib.lookupFunction<_c_clang_getFileContents,
+ _dart_clang_getFileContents>('clang_getFileContents');
+ return _clang_getFileContents(
+ tu,
+ file,
+ size,
+ );
+ }
+
+ _dart_clang_getFileContents _clang_getFileContents;
+
+ /// Returns non-zero if the file1 and file2 point to the same file, or they
+ /// are both NULL.
+ int clang_File_isEqual(
+ ffi.Pointer<ffi.Void> file1,
+ ffi.Pointer<ffi.Void> file2,
+ ) {
+ _clang_File_isEqual ??=
+ _dylib.lookupFunction<_c_clang_File_isEqual, _dart_clang_File_isEqual>(
+ 'clang_File_isEqual');
+ return _clang_File_isEqual(
+ file1,
+ file2,
+ );
+ }
+
+ _dart_clang_File_isEqual _clang_File_isEqual;
+
+ /// Retrieve all ranges that were skipped by the preprocessor.
+ ffi.Pointer<CXSourceRangeList> clang_getSkippedRanges(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+ ffi.Pointer<ffi.Void> file,
+ ) {
+ _clang_getSkippedRanges ??= _dylib.lookupFunction<_c_clang_getSkippedRanges,
+ _dart_clang_getSkippedRanges>('clang_getSkippedRanges');
+ return _clang_getSkippedRanges(
+ tu,
+ file,
+ );
+ }
+
+ _dart_clang_getSkippedRanges _clang_getSkippedRanges;
+
+ /// Retrieve all ranges from all files that were skipped by the preprocessor.
+ ffi.Pointer<CXSourceRangeList> clang_getAllSkippedRanges(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+ ) {
+ _clang_getAllSkippedRanges ??= _dylib.lookupFunction<
+ _c_clang_getAllSkippedRanges,
+ _dart_clang_getAllSkippedRanges>('clang_getAllSkippedRanges');
+ return _clang_getAllSkippedRanges(
+ tu,
+ );
+ }
+
+ _dart_clang_getAllSkippedRanges _clang_getAllSkippedRanges;
+
+ /// Destroy the given CXSourceRangeList.
+ void clang_disposeSourceRangeList(
+ ffi.Pointer<CXSourceRangeList> ranges,
+ ) {
+ _clang_disposeSourceRangeList ??= _dylib.lookupFunction<
+ _c_clang_disposeSourceRangeList,
+ _dart_clang_disposeSourceRangeList>('clang_disposeSourceRangeList');
+ return _clang_disposeSourceRangeList(
+ ranges,
+ );
+ }
+
+ _dart_clang_disposeSourceRangeList _clang_disposeSourceRangeList;
+
+ /// Determine the number of diagnostics in a CXDiagnosticSet.
+ int clang_getNumDiagnosticsInSet(
+ ffi.Pointer<ffi.Void> Diags,
+ ) {
+ _clang_getNumDiagnosticsInSet ??= _dylib.lookupFunction<
+ _c_clang_getNumDiagnosticsInSet,
+ _dart_clang_getNumDiagnosticsInSet>('clang_getNumDiagnosticsInSet');
+ return _clang_getNumDiagnosticsInSet(
+ Diags,
+ );
+ }
+
+ _dart_clang_getNumDiagnosticsInSet _clang_getNumDiagnosticsInSet;
+
+ /// Retrieve a diagnostic associated with the given CXDiagnosticSet.
+ ffi.Pointer<ffi.Void> clang_getDiagnosticInSet(
+ ffi.Pointer<ffi.Void> Diags,
+ int Index,
+ ) {
+ _clang_getDiagnosticInSet ??= _dylib.lookupFunction<
+ _c_clang_getDiagnosticInSet,
+ _dart_clang_getDiagnosticInSet>('clang_getDiagnosticInSet');
+ return _clang_getDiagnosticInSet(
+ Diags,
+ Index,
+ );
+ }
+
+ _dart_clang_getDiagnosticInSet _clang_getDiagnosticInSet;
+
+ /// Deserialize a set of diagnostics from a Clang diagnostics bitcode file.
+ ffi.Pointer<ffi.Void> clang_loadDiagnostics(
+ ffi.Pointer<ffi.Int8> file,
+ ffi.Pointer<ffi.Int32> error,
+ ffi.Pointer<CXString> errorString,
+ ) {
+ _clang_loadDiagnostics ??= _dylib.lookupFunction<_c_clang_loadDiagnostics,
+ _dart_clang_loadDiagnostics>('clang_loadDiagnostics');
+ return _clang_loadDiagnostics(
+ file,
+ error,
+ errorString,
+ );
+ }
+
+ _dart_clang_loadDiagnostics _clang_loadDiagnostics;
+
+ /// Release a CXDiagnosticSet and all of its contained diagnostics.
+ void clang_disposeDiagnosticSet(
+ ffi.Pointer<ffi.Void> Diags,
+ ) {
+ _clang_disposeDiagnosticSet ??= _dylib.lookupFunction<
+ _c_clang_disposeDiagnosticSet,
+ _dart_clang_disposeDiagnosticSet>('clang_disposeDiagnosticSet');
+ return _clang_disposeDiagnosticSet(
+ Diags,
+ );
+ }
+
+ _dart_clang_disposeDiagnosticSet _clang_disposeDiagnosticSet;
+
+ /// Retrieve the child diagnostics of a CXDiagnostic.
+ ffi.Pointer<ffi.Void> clang_getChildDiagnostics(
+ ffi.Pointer<ffi.Void> D,
+ ) {
+ _clang_getChildDiagnostics ??= _dylib.lookupFunction<
+ _c_clang_getChildDiagnostics,
+ _dart_clang_getChildDiagnostics>('clang_getChildDiagnostics');
+ return _clang_getChildDiagnostics(
+ D,
+ );
+ }
+
+ _dart_clang_getChildDiagnostics _clang_getChildDiagnostics;
+
+ /// Determine the number of diagnostics produced for the given translation
+ /// unit.
+ int clang_getNumDiagnostics(
+ ffi.Pointer<CXTranslationUnitImpl> Unit,
+ ) {
+ _clang_getNumDiagnostics ??= _dylib.lookupFunction<
+ _c_clang_getNumDiagnostics,
+ _dart_clang_getNumDiagnostics>('clang_getNumDiagnostics');
+ return _clang_getNumDiagnostics(
+ Unit,
+ );
+ }
+
+ _dart_clang_getNumDiagnostics _clang_getNumDiagnostics;
+
+ /// Retrieve a diagnostic associated with the given translation unit.
+ ffi.Pointer<ffi.Void> clang_getDiagnostic(
+ ffi.Pointer<CXTranslationUnitImpl> Unit,
+ int Index,
+ ) {
+ _clang_getDiagnostic ??= _dylib.lookupFunction<_c_clang_getDiagnostic,
+ _dart_clang_getDiagnostic>('clang_getDiagnostic');
+ return _clang_getDiagnostic(
+ Unit,
+ Index,
+ );
+ }
+
+ _dart_clang_getDiagnostic _clang_getDiagnostic;
+
+ /// Retrieve the complete set of diagnostics associated with a translation
+ /// unit.
+ ffi.Pointer<ffi.Void> clang_getDiagnosticSetFromTU(
+ ffi.Pointer<CXTranslationUnitImpl> Unit,
+ ) {
+ _clang_getDiagnosticSetFromTU ??= _dylib.lookupFunction<
+ _c_clang_getDiagnosticSetFromTU,
+ _dart_clang_getDiagnosticSetFromTU>('clang_getDiagnosticSetFromTU');
+ return _clang_getDiagnosticSetFromTU(
+ Unit,
+ );
+ }
+
+ _dart_clang_getDiagnosticSetFromTU _clang_getDiagnosticSetFromTU;
+
+ /// Destroy a diagnostic.
+ void clang_disposeDiagnostic(
+ ffi.Pointer<ffi.Void> Diagnostic,
+ ) {
+ _clang_disposeDiagnostic ??= _dylib.lookupFunction<
+ _c_clang_disposeDiagnostic,
+ _dart_clang_disposeDiagnostic>('clang_disposeDiagnostic');
+ return _clang_disposeDiagnostic(
+ Diagnostic,
+ );
+ }
+
+ _dart_clang_disposeDiagnostic _clang_disposeDiagnostic;
+
+ /// Retrieve the set of display options most similar to the default behavior
+ /// of the clang compiler.
+ int clang_defaultDiagnosticDisplayOptions() {
+ _clang_defaultDiagnosticDisplayOptions ??= _dylib.lookupFunction<
+ _c_clang_defaultDiagnosticDisplayOptions,
+ _dart_clang_defaultDiagnosticDisplayOptions>(
+ 'clang_defaultDiagnosticDisplayOptions');
+ return _clang_defaultDiagnosticDisplayOptions();
+ }
+
+ _dart_clang_defaultDiagnosticDisplayOptions
+ _clang_defaultDiagnosticDisplayOptions;
+
+ /// Determine the severity of the given diagnostic.
+ int clang_getDiagnosticSeverity(
+ ffi.Pointer<ffi.Void> arg0,
+ ) {
+ _clang_getDiagnosticSeverity ??= _dylib.lookupFunction<
+ _c_clang_getDiagnosticSeverity,
+ _dart_clang_getDiagnosticSeverity>('clang_getDiagnosticSeverity');
+ return _clang_getDiagnosticSeverity(
+ arg0,
+ );
+ }
+
+ _dart_clang_getDiagnosticSeverity _clang_getDiagnosticSeverity;
+
+ /// Retrieve the category number for this diagnostic.
+ int clang_getDiagnosticCategory(
+ ffi.Pointer<ffi.Void> arg0,
+ ) {
+ _clang_getDiagnosticCategory ??= _dylib.lookupFunction<
+ _c_clang_getDiagnosticCategory,
+ _dart_clang_getDiagnosticCategory>('clang_getDiagnosticCategory');
+ return _clang_getDiagnosticCategory(
+ arg0,
+ );
+ }
+
+ _dart_clang_getDiagnosticCategory _clang_getDiagnosticCategory;
+
+ /// Determine the number of source ranges associated with the given
+ /// diagnostic.
+ int clang_getDiagnosticNumRanges(
+ ffi.Pointer<ffi.Void> arg0,
+ ) {
+ _clang_getDiagnosticNumRanges ??= _dylib.lookupFunction<
+ _c_clang_getDiagnosticNumRanges,
+ _dart_clang_getDiagnosticNumRanges>('clang_getDiagnosticNumRanges');
+ return _clang_getDiagnosticNumRanges(
+ arg0,
+ );
+ }
+
+ _dart_clang_getDiagnosticNumRanges _clang_getDiagnosticNumRanges;
+
+ /// Determine the number of fix-it hints associated with the given diagnostic.
+ int clang_getDiagnosticNumFixIts(
+ ffi.Pointer<ffi.Void> Diagnostic,
+ ) {
+ _clang_getDiagnosticNumFixIts ??= _dylib.lookupFunction<
+ _c_clang_getDiagnosticNumFixIts,
+ _dart_clang_getDiagnosticNumFixIts>('clang_getDiagnosticNumFixIts');
+ return _clang_getDiagnosticNumFixIts(
+ Diagnostic,
+ );
+ }
+
+ _dart_clang_getDiagnosticNumFixIts _clang_getDiagnosticNumFixIts;
+
+ /// Return the CXTranslationUnit for a given source file and the provided
+ /// command line arguments one would pass to the compiler.
+ ffi.Pointer<CXTranslationUnitImpl> clang_createTranslationUnitFromSourceFile(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> source_filename,
+ int num_clang_command_line_args,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> clang_command_line_args,
+ int num_unsaved_files,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ ) {
+ _clang_createTranslationUnitFromSourceFile ??= _dylib.lookupFunction<
+ _c_clang_createTranslationUnitFromSourceFile,
+ _dart_clang_createTranslationUnitFromSourceFile>(
+ 'clang_createTranslationUnitFromSourceFile');
+ return _clang_createTranslationUnitFromSourceFile(
+ CIdx,
+ source_filename,
+ num_clang_command_line_args,
+ clang_command_line_args,
+ num_unsaved_files,
+ unsaved_files,
+ );
+ }
+
+ _dart_clang_createTranslationUnitFromSourceFile
+ _clang_createTranslationUnitFromSourceFile;
+
+ /// Same as clang_createTranslationUnit2, but returns the CXTranslationUnit
+ /// instead of an error code. In case of an error this routine returns a NULL
+ /// CXTranslationUnit, without further detailed error codes.
+ ffi.Pointer<CXTranslationUnitImpl> clang_createTranslationUnit(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> ast_filename,
+ ) {
+ _clang_createTranslationUnit ??= _dylib.lookupFunction<
+ _c_clang_createTranslationUnit,
+ _dart_clang_createTranslationUnit>('clang_createTranslationUnit');
+ return _clang_createTranslationUnit(
+ CIdx,
+ ast_filename,
+ );
+ }
+
+ _dart_clang_createTranslationUnit _clang_createTranslationUnit;
+
+ /// Create a translation unit from an AST file ( -emit-ast).
+ int clang_createTranslationUnit2(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> ast_filename,
+ ffi.Pointer<ffi.Pointer<CXTranslationUnitImpl>> out_TU,
+ ) {
+ _clang_createTranslationUnit2 ??= _dylib.lookupFunction<
+ _c_clang_createTranslationUnit2,
+ _dart_clang_createTranslationUnit2>('clang_createTranslationUnit2');
+ return _clang_createTranslationUnit2(
+ CIdx,
+ ast_filename,
+ out_TU,
+ );
+ }
+
+ _dart_clang_createTranslationUnit2 _clang_createTranslationUnit2;
+
+ /// Returns the set of flags that is suitable for parsing a translation unit
+ /// that is being edited.
+ int clang_defaultEditingTranslationUnitOptions() {
+ _clang_defaultEditingTranslationUnitOptions ??= _dylib.lookupFunction<
+ _c_clang_defaultEditingTranslationUnitOptions,
+ _dart_clang_defaultEditingTranslationUnitOptions>(
+ 'clang_defaultEditingTranslationUnitOptions');
+ return _clang_defaultEditingTranslationUnitOptions();
+ }
+
+ _dart_clang_defaultEditingTranslationUnitOptions
+ _clang_defaultEditingTranslationUnitOptions;
+
+ /// Same as clang_parseTranslationUnit2, but returns the CXTranslationUnit
+ /// instead of an error code. In case of an error this routine returns a NULL
+ /// CXTranslationUnit, without further detailed error codes.
+ ffi.Pointer<CXTranslationUnitImpl> clang_parseTranslationUnit(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> source_filename,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> command_line_args,
+ int num_command_line_args,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ int num_unsaved_files,
+ int options,
+ ) {
+ _clang_parseTranslationUnit ??= _dylib.lookupFunction<
+ _c_clang_parseTranslationUnit,
+ _dart_clang_parseTranslationUnit>('clang_parseTranslationUnit');
+ return _clang_parseTranslationUnit(
+ CIdx,
+ source_filename,
+ command_line_args,
+ num_command_line_args,
+ unsaved_files,
+ num_unsaved_files,
+ options,
+ );
+ }
+
+ _dart_clang_parseTranslationUnit _clang_parseTranslationUnit;
+
+ /// Parse the given source file and the translation unit corresponding to that
+ /// file.
+ int clang_parseTranslationUnit2(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> source_filename,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> command_line_args,
+ int num_command_line_args,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ int num_unsaved_files,
+ int options,
+ ffi.Pointer<ffi.Pointer<CXTranslationUnitImpl>> out_TU,
+ ) {
+ _clang_parseTranslationUnit2 ??= _dylib.lookupFunction<
+ _c_clang_parseTranslationUnit2,
+ _dart_clang_parseTranslationUnit2>('clang_parseTranslationUnit2');
+ return _clang_parseTranslationUnit2(
+ CIdx,
+ source_filename,
+ command_line_args,
+ num_command_line_args,
+ unsaved_files,
+ num_unsaved_files,
+ options,
+ out_TU,
+ );
+ }
+
+ _dart_clang_parseTranslationUnit2 _clang_parseTranslationUnit2;
+
+ /// Same as clang_parseTranslationUnit2 but requires a full command line for
+ /// command_line_args including argv[0]. This is useful if the standard
+ /// library paths are relative to the binary.
+ int clang_parseTranslationUnit2FullArgv(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> source_filename,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> command_line_args,
+ int num_command_line_args,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ int num_unsaved_files,
+ int options,
+ ffi.Pointer<ffi.Pointer<CXTranslationUnitImpl>> out_TU,
+ ) {
+ _clang_parseTranslationUnit2FullArgv ??= _dylib.lookupFunction<
+ _c_clang_parseTranslationUnit2FullArgv,
+ _dart_clang_parseTranslationUnit2FullArgv>(
+ 'clang_parseTranslationUnit2FullArgv');
+ return _clang_parseTranslationUnit2FullArgv(
+ CIdx,
+ source_filename,
+ command_line_args,
+ num_command_line_args,
+ unsaved_files,
+ num_unsaved_files,
+ options,
+ out_TU,
+ );
+ }
+
+ _dart_clang_parseTranslationUnit2FullArgv
+ _clang_parseTranslationUnit2FullArgv;
+
+ /// Returns the set of flags that is suitable for saving a translation unit.
+ int clang_defaultSaveOptions(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+ ) {
+ _clang_defaultSaveOptions ??= _dylib.lookupFunction<
+ _c_clang_defaultSaveOptions,
+ _dart_clang_defaultSaveOptions>('clang_defaultSaveOptions');
+ return _clang_defaultSaveOptions(
+ TU,
+ );
+ }
+
+ _dart_clang_defaultSaveOptions _clang_defaultSaveOptions;
+
+ /// Saves a translation unit into a serialized representation of that
+ /// translation unit on disk.
+ int clang_saveTranslationUnit(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+ ffi.Pointer<ffi.Int8> FileName,
+ int options,
+ ) {
+ _clang_saveTranslationUnit ??= _dylib.lookupFunction<
+ _c_clang_saveTranslationUnit,
+ _dart_clang_saveTranslationUnit>('clang_saveTranslationUnit');
+ return _clang_saveTranslationUnit(
+ TU,
+ FileName,
+ options,
+ );
+ }
+
+ _dart_clang_saveTranslationUnit _clang_saveTranslationUnit;
+
+ /// Suspend a translation unit in order to free memory associated with it.
+ int clang_suspendTranslationUnit(
+ ffi.Pointer<CXTranslationUnitImpl> arg0,
+ ) {
+ _clang_suspendTranslationUnit ??= _dylib.lookupFunction<
+ _c_clang_suspendTranslationUnit,
+ _dart_clang_suspendTranslationUnit>('clang_suspendTranslationUnit');
+ return _clang_suspendTranslationUnit(
+ arg0,
+ );
+ }
+
+ _dart_clang_suspendTranslationUnit _clang_suspendTranslationUnit;
+
+ /// Destroy the specified CXTranslationUnit object.
+ void clang_disposeTranslationUnit(
+ ffi.Pointer<CXTranslationUnitImpl> arg0,
+ ) {
+ _clang_disposeTranslationUnit ??= _dylib.lookupFunction<
+ _c_clang_disposeTranslationUnit,
+ _dart_clang_disposeTranslationUnit>('clang_disposeTranslationUnit');
+ return _clang_disposeTranslationUnit(
+ arg0,
+ );
+ }
+
+ _dart_clang_disposeTranslationUnit _clang_disposeTranslationUnit;
+
+ /// Returns the set of flags that is suitable for reparsing a translation
+ /// unit.
+ int clang_defaultReparseOptions(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+ ) {
+ _clang_defaultReparseOptions ??= _dylib.lookupFunction<
+ _c_clang_defaultReparseOptions,
+ _dart_clang_defaultReparseOptions>('clang_defaultReparseOptions');
+ return _clang_defaultReparseOptions(
+ TU,
+ );
+ }
+
+ _dart_clang_defaultReparseOptions _clang_defaultReparseOptions;
+
+ /// Reparse the source files that produced this translation unit.
+ int clang_reparseTranslationUnit(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+ int num_unsaved_files,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ int options,
+ ) {
+ _clang_reparseTranslationUnit ??= _dylib.lookupFunction<
+ _c_clang_reparseTranslationUnit,
+ _dart_clang_reparseTranslationUnit>('clang_reparseTranslationUnit');
+ return _clang_reparseTranslationUnit(
+ TU,
+ num_unsaved_files,
+ unsaved_files,
+ options,
+ );
+ }
+
+ _dart_clang_reparseTranslationUnit _clang_reparseTranslationUnit;
+
+ /// Returns the human-readable null-terminated C string that represents the
+ /// name of the memory category. This string should never be freed.
+ ffi.Pointer<ffi.Int8> clang_getTUResourceUsageName(
+ int kind,
+ ) {
+ _clang_getTUResourceUsageName ??= _dylib.lookupFunction<
+ _c_clang_getTUResourceUsageName,
+ _dart_clang_getTUResourceUsageName>('clang_getTUResourceUsageName');
+ return _clang_getTUResourceUsageName(
+ kind,
+ );
+ }
+
+ _dart_clang_getTUResourceUsageName _clang_getTUResourceUsageName;
+
+ /// Get target information for this translation unit.
+ ffi.Pointer<CXTargetInfoImpl> clang_getTranslationUnitTargetInfo(
+ ffi.Pointer<CXTranslationUnitImpl> CTUnit,
+ ) {
+ _clang_getTranslationUnitTargetInfo ??= _dylib.lookupFunction<
+ _c_clang_getTranslationUnitTargetInfo,
+ _dart_clang_getTranslationUnitTargetInfo>(
+ 'clang_getTranslationUnitTargetInfo');
+ return _clang_getTranslationUnitTargetInfo(
+ CTUnit,
+ );
+ }
+
+ _dart_clang_getTranslationUnitTargetInfo _clang_getTranslationUnitTargetInfo;
+
+ /// Destroy the CXTargetInfo object.
+ void clang_TargetInfo_dispose(
+ ffi.Pointer<CXTargetInfoImpl> Info,
+ ) {
+ _clang_TargetInfo_dispose ??= _dylib.lookupFunction<
+ _c_clang_TargetInfo_dispose,
+ _dart_clang_TargetInfo_dispose>('clang_TargetInfo_dispose');
+ return _clang_TargetInfo_dispose(
+ Info,
+ );
+ }
+
+ _dart_clang_TargetInfo_dispose _clang_TargetInfo_dispose;
+
+ /// Get the pointer width of the target in bits.
+ int clang_TargetInfo_getPointerWidth(
+ ffi.Pointer<CXTargetInfoImpl> Info,
+ ) {
+ _clang_TargetInfo_getPointerWidth ??= _dylib.lookupFunction<
+ _c_clang_TargetInfo_getPointerWidth,
+ _dart_clang_TargetInfo_getPointerWidth>(
+ 'clang_TargetInfo_getPointerWidth');
+ return _clang_TargetInfo_getPointerWidth(
+ Info,
+ );
+ }
+
+ _dart_clang_TargetInfo_getPointerWidth _clang_TargetInfo_getPointerWidth;
+
+ /// Determine whether the given cursor kind represents a declaration.
+ int clang_isDeclaration(
+ int arg0,
+ ) {
+ _clang_isDeclaration ??= _dylib.lookupFunction<_c_clang_isDeclaration,
+ _dart_clang_isDeclaration>('clang_isDeclaration');
+ return _clang_isDeclaration(
+ arg0,
+ );
+ }
+
+ _dart_clang_isDeclaration _clang_isDeclaration;
+
+ /// Determine whether the given cursor kind represents a simple reference.
+ int clang_isReference(
+ int arg0,
+ ) {
+ _clang_isReference ??=
+ _dylib.lookupFunction<_c_clang_isReference, _dart_clang_isReference>(
+ 'clang_isReference');
+ return _clang_isReference(
+ arg0,
+ );
+ }
+
+ _dart_clang_isReference _clang_isReference;
+
+ /// Determine whether the given cursor kind represents an expression.
+ int clang_isExpression(
+ int arg0,
+ ) {
+ _clang_isExpression ??=
+ _dylib.lookupFunction<_c_clang_isExpression, _dart_clang_isExpression>(
+ 'clang_isExpression');
+ return _clang_isExpression(
+ arg0,
+ );
+ }
+
+ _dart_clang_isExpression _clang_isExpression;
+
+ /// Determine whether the given cursor kind represents a statement.
+ int clang_isStatement(
+ int arg0,
+ ) {
+ _clang_isStatement ??=
+ _dylib.lookupFunction<_c_clang_isStatement, _dart_clang_isStatement>(
+ 'clang_isStatement');
+ return _clang_isStatement(
+ arg0,
+ );
+ }
+
+ _dart_clang_isStatement _clang_isStatement;
+
+ /// Determine whether the given cursor kind represents an attribute.
+ int clang_isAttribute(
+ int arg0,
+ ) {
+ _clang_isAttribute ??=
+ _dylib.lookupFunction<_c_clang_isAttribute, _dart_clang_isAttribute>(
+ 'clang_isAttribute');
+ return _clang_isAttribute(
+ arg0,
+ );
+ }
+
+ _dart_clang_isAttribute _clang_isAttribute;
+
+ /// Determine whether the given cursor kind represents an invalid cursor.
+ int clang_isInvalid(
+ int arg0,
+ ) {
+ _clang_isInvalid ??=
+ _dylib.lookupFunction<_c_clang_isInvalid, _dart_clang_isInvalid>(
+ 'clang_isInvalid');
+ return _clang_isInvalid(
+ arg0,
+ );
+ }
+
+ _dart_clang_isInvalid _clang_isInvalid;
+
+ /// Determine whether the given cursor kind represents a translation unit.
+ int clang_isTranslationUnit(
+ int arg0,
+ ) {
+ _clang_isTranslationUnit ??= _dylib.lookupFunction<
+ _c_clang_isTranslationUnit,
+ _dart_clang_isTranslationUnit>('clang_isTranslationUnit');
+ return _clang_isTranslationUnit(
+ arg0,
+ );
+ }
+
+ _dart_clang_isTranslationUnit _clang_isTranslationUnit;
+
+ /// * Determine whether the given cursor represents a preprocessing element,
+ /// such as a preprocessor directive or macro instantiation.
+ int clang_isPreprocessing(
+ int arg0,
+ ) {
+ _clang_isPreprocessing ??= _dylib.lookupFunction<_c_clang_isPreprocessing,
+ _dart_clang_isPreprocessing>('clang_isPreprocessing');
+ return _clang_isPreprocessing(
+ arg0,
+ );
+ }
+
+ _dart_clang_isPreprocessing _clang_isPreprocessing;
+
+ /// * Determine whether the given cursor represents a currently unexposed
+ /// piece of the AST (e.g., CXCursor_UnexposedStmt).
+ int clang_isUnexposed(
+ int arg0,
+ ) {
+ _clang_isUnexposed ??=
+ _dylib.lookupFunction<_c_clang_isUnexposed, _dart_clang_isUnexposed>(
+ 'clang_isUnexposed');
+ return _clang_isUnexposed(
+ arg0,
+ );
+ }
+
+ _dart_clang_isUnexposed _clang_isUnexposed;
+
+ /// Free the memory associated with a CXPlatformAvailability structure.
+ void clang_disposeCXPlatformAvailability(
+ ffi.Pointer<CXPlatformAvailability> availability,
+ ) {
+ _clang_disposeCXPlatformAvailability ??= _dylib.lookupFunction<
+ _c_clang_disposeCXPlatformAvailability,
+ _dart_clang_disposeCXPlatformAvailability>(
+ 'clang_disposeCXPlatformAvailability');
+ return _clang_disposeCXPlatformAvailability(
+ availability,
+ );
+ }
+
+ _dart_clang_disposeCXPlatformAvailability
+ _clang_disposeCXPlatformAvailability;
+
+ /// Creates an empty CXCursorSet.
+ ffi.Pointer<CXCursorSetImpl> clang_createCXCursorSet() {
+ _clang_createCXCursorSet ??= _dylib.lookupFunction<
+ _c_clang_createCXCursorSet,
+ _dart_clang_createCXCursorSet>('clang_createCXCursorSet');
+ return _clang_createCXCursorSet();
+ }
+
+ _dart_clang_createCXCursorSet _clang_createCXCursorSet;
+
+ /// Disposes a CXCursorSet and releases its associated memory.
+ void clang_disposeCXCursorSet(
+ ffi.Pointer<CXCursorSetImpl> cset,
+ ) {
+ _clang_disposeCXCursorSet ??= _dylib.lookupFunction<
+ _c_clang_disposeCXCursorSet,
+ _dart_clang_disposeCXCursorSet>('clang_disposeCXCursorSet');
+ return _clang_disposeCXCursorSet(
+ cset,
+ );
+ }
+
+ _dart_clang_disposeCXCursorSet _clang_disposeCXCursorSet;
+
+ /// Free the set of overridden cursors returned by
+ /// clang_getOverriddenCursors().
+ void clang_disposeOverriddenCursors(
+ ffi.Pointer<CXCursor> overridden,
+ ) {
+ _clang_disposeOverriddenCursors ??= _dylib.lookupFunction<
+ _c_clang_disposeOverriddenCursors,
+ _dart_clang_disposeOverriddenCursors>('clang_disposeOverriddenCursors');
+ return _clang_disposeOverriddenCursors(
+ overridden,
+ );
+ }
+
+ _dart_clang_disposeOverriddenCursors _clang_disposeOverriddenCursors;
+
+ /// Get a property value for the given printing policy.
+ int clang_PrintingPolicy_getProperty(
+ ffi.Pointer<ffi.Void> Policy,
+ int Property,
+ ) {
+ _clang_PrintingPolicy_getProperty ??= _dylib.lookupFunction<
+ _c_clang_PrintingPolicy_getProperty,
+ _dart_clang_PrintingPolicy_getProperty>(
+ 'clang_PrintingPolicy_getProperty');
+ return _clang_PrintingPolicy_getProperty(
+ Policy,
+ Property,
+ );
+ }
+
+ _dart_clang_PrintingPolicy_getProperty _clang_PrintingPolicy_getProperty;
+
+ /// Set a property value for the given printing policy.
+ void clang_PrintingPolicy_setProperty(
+ ffi.Pointer<ffi.Void> Policy,
+ int Property,
+ int Value,
+ ) {
+ _clang_PrintingPolicy_setProperty ??= _dylib.lookupFunction<
+ _c_clang_PrintingPolicy_setProperty,
+ _dart_clang_PrintingPolicy_setProperty>(
+ 'clang_PrintingPolicy_setProperty');
+ return _clang_PrintingPolicy_setProperty(
+ Policy,
+ Property,
+ Value,
+ );
+ }
+
+ _dart_clang_PrintingPolicy_setProperty _clang_PrintingPolicy_setProperty;
+
+ /// Release a printing policy.
+ void clang_PrintingPolicy_dispose(
+ ffi.Pointer<ffi.Void> Policy,
+ ) {
+ _clang_PrintingPolicy_dispose ??= _dylib.lookupFunction<
+ _c_clang_PrintingPolicy_dispose,
+ _dart_clang_PrintingPolicy_dispose>('clang_PrintingPolicy_dispose');
+ return _clang_PrintingPolicy_dispose(
+ Policy,
+ );
+ }
+
+ _dart_clang_PrintingPolicy_dispose _clang_PrintingPolicy_dispose;
+
+ /// Given a CXFile header file, return the module that contains it, if one
+ /// exists.
+ ffi.Pointer<ffi.Void> clang_getModuleForFile(
+ ffi.Pointer<CXTranslationUnitImpl> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ) {
+ _clang_getModuleForFile ??= _dylib.lookupFunction<_c_clang_getModuleForFile,
+ _dart_clang_getModuleForFile>('clang_getModuleForFile');
+ return _clang_getModuleForFile(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_clang_getModuleForFile _clang_getModuleForFile;
+
+ /// Returns the module file where the provided module object came from.
+ ffi.Pointer<ffi.Void> clang_Module_getASTFile(
+ ffi.Pointer<ffi.Void> Module,
+ ) {
+ _clang_Module_getASTFile ??= _dylib.lookupFunction<
+ _c_clang_Module_getASTFile,
+ _dart_clang_Module_getASTFile>('clang_Module_getASTFile');
+ return _clang_Module_getASTFile(
+ Module,
+ );
+ }
+
+ _dart_clang_Module_getASTFile _clang_Module_getASTFile;
+
+ /// Returns the parent of a sub-module or NULL if the given module is
+ /// top-level, e.g. for 'std.vector' it will return the 'std' module.
+ ffi.Pointer<ffi.Void> clang_Module_getParent(
+ ffi.Pointer<ffi.Void> Module,
+ ) {
+ _clang_Module_getParent ??= _dylib.lookupFunction<_c_clang_Module_getParent,
+ _dart_clang_Module_getParent>('clang_Module_getParent');
+ return _clang_Module_getParent(
+ Module,
+ );
+ }
+
+ _dart_clang_Module_getParent _clang_Module_getParent;
+
+ /// Returns non-zero if the module is a system one.
+ int clang_Module_isSystem(
+ ffi.Pointer<ffi.Void> Module,
+ ) {
+ _clang_Module_isSystem ??= _dylib.lookupFunction<_c_clang_Module_isSystem,
+ _dart_clang_Module_isSystem>('clang_Module_isSystem');
+ return _clang_Module_isSystem(
+ Module,
+ );
+ }
+
+ _dart_clang_Module_isSystem _clang_Module_isSystem;
+
+ /// Returns the number of top level headers associated with this module.
+ int clang_Module_getNumTopLevelHeaders(
+ ffi.Pointer<CXTranslationUnitImpl> arg0,
+ ffi.Pointer<ffi.Void> Module,
+ ) {
+ _clang_Module_getNumTopLevelHeaders ??= _dylib.lookupFunction<
+ _c_clang_Module_getNumTopLevelHeaders,
+ _dart_clang_Module_getNumTopLevelHeaders>(
+ 'clang_Module_getNumTopLevelHeaders');
+ return _clang_Module_getNumTopLevelHeaders(
+ arg0,
+ Module,
+ );
+ }
+
+ _dart_clang_Module_getNumTopLevelHeaders _clang_Module_getNumTopLevelHeaders;
+
+ /// Returns the specified top level header associated with the module.
+ ffi.Pointer<ffi.Void> clang_Module_getTopLevelHeader(
+ ffi.Pointer<CXTranslationUnitImpl> arg0,
+ ffi.Pointer<ffi.Void> Module,
+ int Index,
+ ) {
+ _clang_Module_getTopLevelHeader ??= _dylib.lookupFunction<
+ _c_clang_Module_getTopLevelHeader,
+ _dart_clang_Module_getTopLevelHeader>('clang_Module_getTopLevelHeader');
+ return _clang_Module_getTopLevelHeader(
+ arg0,
+ Module,
+ Index,
+ );
+ }
+
+ _dart_clang_Module_getTopLevelHeader _clang_Module_getTopLevelHeader;
+
+ /// Annotate the given set of tokens by providing cursors for each token that
+ /// can be mapped to a specific entity within the abstract syntax tree.
+ void clang_annotateTokens(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+ ffi.Pointer<CXToken> Tokens,
+ int NumTokens,
+ ffi.Pointer<CXCursor> Cursors,
+ ) {
+ _clang_annotateTokens ??= _dylib.lookupFunction<_c_clang_annotateTokens,
+ _dart_clang_annotateTokens>('clang_annotateTokens');
+ return _clang_annotateTokens(
+ TU,
+ Tokens,
+ NumTokens,
+ Cursors,
+ );
+ }
+
+ _dart_clang_annotateTokens _clang_annotateTokens;
+
+ /// Free the given set of tokens.
+ void clang_disposeTokens(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+ ffi.Pointer<CXToken> Tokens,
+ int NumTokens,
+ ) {
+ _clang_disposeTokens ??= _dylib.lookupFunction<_c_clang_disposeTokens,
+ _dart_clang_disposeTokens>('clang_disposeTokens');
+ return _clang_disposeTokens(
+ TU,
+ Tokens,
+ NumTokens,
+ );
+ }
+
+ _dart_clang_disposeTokens _clang_disposeTokens;
+
+ void clang_enableStackTraces() {
+ _clang_enableStackTraces ??= _dylib.lookupFunction<
+ _c_clang_enableStackTraces,
+ _dart_clang_enableStackTraces>('clang_enableStackTraces');
+ return _clang_enableStackTraces();
+ }
+
+ _dart_clang_enableStackTraces _clang_enableStackTraces;
+
+ void clang_executeOnThread(
+ ffi.Pointer<ffi.NativeFunction<_typedefC_1>> fn,
+ ffi.Pointer<ffi.Void> user_data,
+ int stack_size,
+ ) {
+ _clang_executeOnThread ??= _dylib.lookupFunction<_c_clang_executeOnThread,
+ _dart_clang_executeOnThread>('clang_executeOnThread');
+ return _clang_executeOnThread(
+ fn,
+ user_data,
+ stack_size,
+ );
+ }
+
+ _dart_clang_executeOnThread _clang_executeOnThread;
+
+ /// Determine the kind of a particular chunk within a completion string.
+ int clang_getCompletionChunkKind(
+ ffi.Pointer<ffi.Void> completion_string,
+ int chunk_number,
+ ) {
+ _clang_getCompletionChunkKind ??= _dylib.lookupFunction<
+ _c_clang_getCompletionChunkKind,
+ _dart_clang_getCompletionChunkKind>('clang_getCompletionChunkKind');
+ return _clang_getCompletionChunkKind(
+ completion_string,
+ chunk_number,
+ );
+ }
+
+ _dart_clang_getCompletionChunkKind _clang_getCompletionChunkKind;
+
+ /// Retrieve the completion string associated with a particular chunk within a
+ /// completion string.
+ ffi.Pointer<ffi.Void> clang_getCompletionChunkCompletionString(
+ ffi.Pointer<ffi.Void> completion_string,
+ int chunk_number,
+ ) {
+ _clang_getCompletionChunkCompletionString ??= _dylib.lookupFunction<
+ _c_clang_getCompletionChunkCompletionString,
+ _dart_clang_getCompletionChunkCompletionString>(
+ 'clang_getCompletionChunkCompletionString');
+ return _clang_getCompletionChunkCompletionString(
+ completion_string,
+ chunk_number,
+ );
+ }
+
+ _dart_clang_getCompletionChunkCompletionString
+ _clang_getCompletionChunkCompletionString;
+
+ /// Retrieve the number of chunks in the given code-completion string.
+ int clang_getNumCompletionChunks(
+ ffi.Pointer<ffi.Void> completion_string,
+ ) {
+ _clang_getNumCompletionChunks ??= _dylib.lookupFunction<
+ _c_clang_getNumCompletionChunks,
+ _dart_clang_getNumCompletionChunks>('clang_getNumCompletionChunks');
+ return _clang_getNumCompletionChunks(
+ completion_string,
+ );
+ }
+
+ _dart_clang_getNumCompletionChunks _clang_getNumCompletionChunks;
+
+ /// Determine the priority of this code completion.
+ int clang_getCompletionPriority(
+ ffi.Pointer<ffi.Void> completion_string,
+ ) {
+ _clang_getCompletionPriority ??= _dylib.lookupFunction<
+ _c_clang_getCompletionPriority,
+ _dart_clang_getCompletionPriority>('clang_getCompletionPriority');
+ return _clang_getCompletionPriority(
+ completion_string,
+ );
+ }
+
+ _dart_clang_getCompletionPriority _clang_getCompletionPriority;
+
+ /// Determine the availability of the entity that this code-completion string
+ /// refers to.
+ int clang_getCompletionAvailability(
+ ffi.Pointer<ffi.Void> completion_string,
+ ) {
+ _clang_getCompletionAvailability ??= _dylib.lookupFunction<
+ _c_clang_getCompletionAvailability,
+ _dart_clang_getCompletionAvailability>(
+ 'clang_getCompletionAvailability');
+ return _clang_getCompletionAvailability(
+ completion_string,
+ );
+ }
+
+ _dart_clang_getCompletionAvailability _clang_getCompletionAvailability;
+
+ /// Retrieve the number of annotations associated with the given completion
+ /// string.
+ int clang_getCompletionNumAnnotations(
+ ffi.Pointer<ffi.Void> completion_string,
+ ) {
+ _clang_getCompletionNumAnnotations ??= _dylib.lookupFunction<
+ _c_clang_getCompletionNumAnnotations,
+ _dart_clang_getCompletionNumAnnotations>(
+ 'clang_getCompletionNumAnnotations');
+ return _clang_getCompletionNumAnnotations(
+ completion_string,
+ );
+ }
+
+ _dart_clang_getCompletionNumAnnotations _clang_getCompletionNumAnnotations;
+
+ /// Retrieve the number of fix-its for the given completion index.
+ int clang_getCompletionNumFixIts(
+ ffi.Pointer<CXCodeCompleteResults> results,
+ int completion_index,
+ ) {
+ _clang_getCompletionNumFixIts ??= _dylib.lookupFunction<
+ _c_clang_getCompletionNumFixIts,
+ _dart_clang_getCompletionNumFixIts>('clang_getCompletionNumFixIts');
+ return _clang_getCompletionNumFixIts(
+ results,
+ completion_index,
+ );
+ }
+
+ _dart_clang_getCompletionNumFixIts _clang_getCompletionNumFixIts;
+
+ /// Returns a default set of code-completion options that can be passed to
+ /// clang_codeCompleteAt().
+ int clang_defaultCodeCompleteOptions() {
+ _clang_defaultCodeCompleteOptions ??= _dylib.lookupFunction<
+ _c_clang_defaultCodeCompleteOptions,
+ _dart_clang_defaultCodeCompleteOptions>(
+ 'clang_defaultCodeCompleteOptions');
+ return _clang_defaultCodeCompleteOptions();
+ }
+
+ _dart_clang_defaultCodeCompleteOptions _clang_defaultCodeCompleteOptions;
+
+ /// Perform code completion at a given location in a translation unit.
+ ffi.Pointer<CXCodeCompleteResults> clang_codeCompleteAt(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+ ffi.Pointer<ffi.Int8> complete_filename,
+ int complete_line,
+ int complete_column,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ int num_unsaved_files,
+ int options,
+ ) {
+ _clang_codeCompleteAt ??= _dylib.lookupFunction<_c_clang_codeCompleteAt,
+ _dart_clang_codeCompleteAt>('clang_codeCompleteAt');
+ return _clang_codeCompleteAt(
+ TU,
+ complete_filename,
+ complete_line,
+ complete_column,
+ unsaved_files,
+ num_unsaved_files,
+ options,
+ );
+ }
+
+ _dart_clang_codeCompleteAt _clang_codeCompleteAt;
+
+ /// Sort the code-completion results in case-insensitive alphabetical order.
+ void clang_sortCodeCompletionResults(
+ ffi.Pointer<CXCompletionResult> Results,
+ int NumResults,
+ ) {
+ _clang_sortCodeCompletionResults ??= _dylib.lookupFunction<
+ _c_clang_sortCodeCompletionResults,
+ _dart_clang_sortCodeCompletionResults>(
+ 'clang_sortCodeCompletionResults');
+ return _clang_sortCodeCompletionResults(
+ Results,
+ NumResults,
+ );
+ }
+
+ _dart_clang_sortCodeCompletionResults _clang_sortCodeCompletionResults;
+
+ /// Free the given set of code-completion results.
+ void clang_disposeCodeCompleteResults(
+ ffi.Pointer<CXCodeCompleteResults> Results,
+ ) {
+ _clang_disposeCodeCompleteResults ??= _dylib.lookupFunction<
+ _c_clang_disposeCodeCompleteResults,
+ _dart_clang_disposeCodeCompleteResults>(
+ 'clang_disposeCodeCompleteResults');
+ return _clang_disposeCodeCompleteResults(
+ Results,
+ );
+ }
+
+ _dart_clang_disposeCodeCompleteResults _clang_disposeCodeCompleteResults;
+
+ /// Determine the number of diagnostics produced prior to the location where
+ /// code completion was performed.
+ int clang_codeCompleteGetNumDiagnostics(
+ ffi.Pointer<CXCodeCompleteResults> Results,
+ ) {
+ _clang_codeCompleteGetNumDiagnostics ??= _dylib.lookupFunction<
+ _c_clang_codeCompleteGetNumDiagnostics,
+ _dart_clang_codeCompleteGetNumDiagnostics>(
+ 'clang_codeCompleteGetNumDiagnostics');
+ return _clang_codeCompleteGetNumDiagnostics(
+ Results,
+ );
+ }
+
+ _dart_clang_codeCompleteGetNumDiagnostics
+ _clang_codeCompleteGetNumDiagnostics;
+
+ /// Retrieve a diagnostic associated with the given code completion.
+ ffi.Pointer<ffi.Void> clang_codeCompleteGetDiagnostic(
+ ffi.Pointer<CXCodeCompleteResults> Results,
+ int Index,
+ ) {
+ _clang_codeCompleteGetDiagnostic ??= _dylib.lookupFunction<
+ _c_clang_codeCompleteGetDiagnostic,
+ _dart_clang_codeCompleteGetDiagnostic>(
+ 'clang_codeCompleteGetDiagnostic');
+ return _clang_codeCompleteGetDiagnostic(
+ Results,
+ Index,
+ );
+ }
+
+ _dart_clang_codeCompleteGetDiagnostic _clang_codeCompleteGetDiagnostic;
+
+ /// Determines what completions are appropriate for the context the given code
+ /// completion.
+ int clang_codeCompleteGetContexts(
+ ffi.Pointer<CXCodeCompleteResults> Results,
+ ) {
+ _clang_codeCompleteGetContexts ??= _dylib.lookupFunction<
+ _c_clang_codeCompleteGetContexts,
+ _dart_clang_codeCompleteGetContexts>('clang_codeCompleteGetContexts');
+ return _clang_codeCompleteGetContexts(
+ Results,
+ );
+ }
+
+ _dart_clang_codeCompleteGetContexts _clang_codeCompleteGetContexts;
+
+ /// Returns the cursor kind for the container for the current code completion
+ /// context. The container is only guaranteed to be set for contexts where a
+ /// container exists (i.e. member accesses or Objective-C message sends); if
+ /// there is not a container, this function will return CXCursor_InvalidCode.
+ int clang_codeCompleteGetContainerKind(
+ ffi.Pointer<CXCodeCompleteResults> Results,
+ ffi.Pointer<ffi.Uint32> IsIncomplete,
+ ) {
+ _clang_codeCompleteGetContainerKind ??= _dylib.lookupFunction<
+ _c_clang_codeCompleteGetContainerKind,
+ _dart_clang_codeCompleteGetContainerKind>(
+ 'clang_codeCompleteGetContainerKind');
+ return _clang_codeCompleteGetContainerKind(
+ Results,
+ IsIncomplete,
+ );
+ }
+
+ _dart_clang_codeCompleteGetContainerKind _clang_codeCompleteGetContainerKind;
+
+ /// Enable/disable crash recovery.
+ void clang_toggleCrashRecovery(
+ int isEnabled,
+ ) {
+ _clang_toggleCrashRecovery ??= _dylib.lookupFunction<
+ _c_clang_toggleCrashRecovery,
+ _dart_clang_toggleCrashRecovery>('clang_toggleCrashRecovery');
+ return _clang_toggleCrashRecovery(
+ isEnabled,
+ );
+ }
+
+ _dart_clang_toggleCrashRecovery _clang_toggleCrashRecovery;
+
+ /// Visit the set of preprocessor inclusions in a translation unit. The
+ /// visitor function is called with the provided data for every included file.
+ /// This does not include headers included by the PCH file (unless one is
+ /// inspecting the inclusions in the PCH file itself).
+ void clang_getInclusions(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+ ffi.Pointer<ffi.NativeFunction<CXInclusionVisitor_1>> visitor,
+ ffi.Pointer<ffi.Void> client_data,
+ ) {
+ _clang_getInclusions ??= _dylib.lookupFunction<_c_clang_getInclusions,
+ _dart_clang_getInclusions>('clang_getInclusions');
+ return _clang_getInclusions(
+ tu,
+ visitor,
+ client_data,
+ );
+ }
+
+ _dart_clang_getInclusions _clang_getInclusions;
+
+ /// Returns the kind of the evaluated result.
+ int clang_EvalResult_getKind(
+ ffi.Pointer<ffi.Void> E,
+ ) {
+ _clang_EvalResult_getKind ??= _dylib.lookupFunction<
+ _c_clang_EvalResult_getKind,
+ _dart_clang_EvalResult_getKind>('clang_EvalResult_getKind');
+ return _clang_EvalResult_getKind(
+ E,
+ );
+ }
+
+ _dart_clang_EvalResult_getKind _clang_EvalResult_getKind;
+
+ /// Returns the evaluation result as integer if the kind is Int.
+ int clang_EvalResult_getAsInt(
+ ffi.Pointer<ffi.Void> E,
+ ) {
+ _clang_EvalResult_getAsInt ??= _dylib.lookupFunction<
+ _c_clang_EvalResult_getAsInt,
+ _dart_clang_EvalResult_getAsInt>('clang_EvalResult_getAsInt');
+ return _clang_EvalResult_getAsInt(
+ E,
+ );
+ }
+
+ _dart_clang_EvalResult_getAsInt _clang_EvalResult_getAsInt;
+
+ /// Returns the evaluation result as a long long integer if the kind is Int.
+ /// This prevents overflows that may happen if the result is returned with
+ /// clang_EvalResult_getAsInt.
+ int clang_EvalResult_getAsLongLong(
+ ffi.Pointer<ffi.Void> E,
+ ) {
+ _clang_EvalResult_getAsLongLong ??= _dylib.lookupFunction<
+ _c_clang_EvalResult_getAsLongLong,
+ _dart_clang_EvalResult_getAsLongLong>('clang_EvalResult_getAsLongLong');
+ return _clang_EvalResult_getAsLongLong(
+ E,
+ );
+ }
+
+ _dart_clang_EvalResult_getAsLongLong _clang_EvalResult_getAsLongLong;
+
+ /// Returns a non-zero value if the kind is Int and the evaluation result
+ /// resulted in an unsigned integer.
+ int clang_EvalResult_isUnsignedInt(
+ ffi.Pointer<ffi.Void> E,
+ ) {
+ _clang_EvalResult_isUnsignedInt ??= _dylib.lookupFunction<
+ _c_clang_EvalResult_isUnsignedInt,
+ _dart_clang_EvalResult_isUnsignedInt>('clang_EvalResult_isUnsignedInt');
+ return _clang_EvalResult_isUnsignedInt(
+ E,
+ );
+ }
+
+ _dart_clang_EvalResult_isUnsignedInt _clang_EvalResult_isUnsignedInt;
+
+ /// Returns the evaluation result as an unsigned integer if the kind is Int
+ /// and clang_EvalResult_isUnsignedInt is non-zero.
+ int clang_EvalResult_getAsUnsigned(
+ ffi.Pointer<ffi.Void> E,
+ ) {
+ _clang_EvalResult_getAsUnsigned ??= _dylib.lookupFunction<
+ _c_clang_EvalResult_getAsUnsigned,
+ _dart_clang_EvalResult_getAsUnsigned>('clang_EvalResult_getAsUnsigned');
+ return _clang_EvalResult_getAsUnsigned(
+ E,
+ );
+ }
+
+ _dart_clang_EvalResult_getAsUnsigned _clang_EvalResult_getAsUnsigned;
+
+ /// Returns the evaluation result as double if the kind is double.
+ double clang_EvalResult_getAsDouble(
+ ffi.Pointer<ffi.Void> E,
+ ) {
+ _clang_EvalResult_getAsDouble ??= _dylib.lookupFunction<
+ _c_clang_EvalResult_getAsDouble,
+ _dart_clang_EvalResult_getAsDouble>('clang_EvalResult_getAsDouble');
+ return _clang_EvalResult_getAsDouble(
+ E,
+ );
+ }
+
+ _dart_clang_EvalResult_getAsDouble _clang_EvalResult_getAsDouble;
+
+ /// Returns the evaluation result as a constant string if the kind is other
+ /// than Int or float. User must not free this pointer, instead call
+ /// clang_EvalResult_dispose on the CXEvalResult returned by
+ /// clang_Cursor_Evaluate.
+ ffi.Pointer<ffi.Int8> clang_EvalResult_getAsStr(
+ ffi.Pointer<ffi.Void> E,
+ ) {
+ _clang_EvalResult_getAsStr ??= _dylib.lookupFunction<
+ _c_clang_EvalResult_getAsStr,
+ _dart_clang_EvalResult_getAsStr>('clang_EvalResult_getAsStr');
+ return _clang_EvalResult_getAsStr(
+ E,
+ );
+ }
+
+ _dart_clang_EvalResult_getAsStr _clang_EvalResult_getAsStr;
+
+ /// Disposes the created Eval memory.
+ void clang_EvalResult_dispose(
+ ffi.Pointer<ffi.Void> E,
+ ) {
+ _clang_EvalResult_dispose ??= _dylib.lookupFunction<
+ _c_clang_EvalResult_dispose,
+ _dart_clang_EvalResult_dispose>('clang_EvalResult_dispose');
+ return _clang_EvalResult_dispose(
+ E,
+ );
+ }
+
+ _dart_clang_EvalResult_dispose _clang_EvalResult_dispose;
+
+ /// Retrieve a remapping.
+ ffi.Pointer<ffi.Void> clang_getRemappings(
+ ffi.Pointer<ffi.Int8> path,
+ ) {
+ _clang_getRemappings ??= _dylib.lookupFunction<_c_clang_getRemappings,
+ _dart_clang_getRemappings>('clang_getRemappings');
+ return _clang_getRemappings(
+ path,
+ );
+ }
+
+ _dart_clang_getRemappings _clang_getRemappings;
+
+ /// Retrieve a remapping.
+ ffi.Pointer<ffi.Void> clang_getRemappingsFromFileList(
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> filePaths,
+ int numFiles,
+ ) {
+ _clang_getRemappingsFromFileList ??= _dylib.lookupFunction<
+ _c_clang_getRemappingsFromFileList,
+ _dart_clang_getRemappingsFromFileList>(
+ 'clang_getRemappingsFromFileList');
+ return _clang_getRemappingsFromFileList(
+ filePaths,
+ numFiles,
+ );
+ }
+
+ _dart_clang_getRemappingsFromFileList _clang_getRemappingsFromFileList;
+
+ /// Determine the number of remappings.
+ int clang_remap_getNumFiles(
+ ffi.Pointer<ffi.Void> arg0,
+ ) {
+ _clang_remap_getNumFiles ??= _dylib.lookupFunction<
+ _c_clang_remap_getNumFiles,
+ _dart_clang_remap_getNumFiles>('clang_remap_getNumFiles');
+ return _clang_remap_getNumFiles(
+ arg0,
+ );
+ }
+
+ _dart_clang_remap_getNumFiles _clang_remap_getNumFiles;
+
+ /// Get the original and the associated filename from the remapping.
+ void clang_remap_getFilenames(
+ ffi.Pointer<ffi.Void> arg0,
+ int index,
+ ffi.Pointer<CXString> original,
+ ffi.Pointer<CXString> transformed,
+ ) {
+ _clang_remap_getFilenames ??= _dylib.lookupFunction<
+ _c_clang_remap_getFilenames,
+ _dart_clang_remap_getFilenames>('clang_remap_getFilenames');
+ return _clang_remap_getFilenames(
+ arg0,
+ index,
+ original,
+ transformed,
+ );
+ }
+
+ _dart_clang_remap_getFilenames _clang_remap_getFilenames;
+
+ /// Dispose the remapping.
+ void clang_remap_dispose(
+ ffi.Pointer<ffi.Void> arg0,
+ ) {
+ _clang_remap_dispose ??= _dylib.lookupFunction<_c_clang_remap_dispose,
+ _dart_clang_remap_dispose>('clang_remap_dispose');
+ return _clang_remap_dispose(
+ arg0,
+ );
+ }
+
+ _dart_clang_remap_dispose _clang_remap_dispose;
+
+ int clang_index_isEntityObjCContainerKind(
+ int arg0,
+ ) {
+ _clang_index_isEntityObjCContainerKind ??= _dylib.lookupFunction<
+ _c_clang_index_isEntityObjCContainerKind,
+ _dart_clang_index_isEntityObjCContainerKind>(
+ 'clang_index_isEntityObjCContainerKind');
+ return _clang_index_isEntityObjCContainerKind(
+ arg0,
+ );
+ }
+
+ _dart_clang_index_isEntityObjCContainerKind
+ _clang_index_isEntityObjCContainerKind;
+
+ ffi.Pointer<CXIdxObjCContainerDeclInfo> clang_index_getObjCContainerDeclInfo(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+ ) {
+ _clang_index_getObjCContainerDeclInfo ??= _dylib.lookupFunction<
+ _c_clang_index_getObjCContainerDeclInfo,
+ _dart_clang_index_getObjCContainerDeclInfo>(
+ 'clang_index_getObjCContainerDeclInfo');
+ return _clang_index_getObjCContainerDeclInfo(
+ arg0,
+ );
+ }
+
+ _dart_clang_index_getObjCContainerDeclInfo
+ _clang_index_getObjCContainerDeclInfo;
+
+ ffi.Pointer<CXIdxObjCInterfaceDeclInfo> clang_index_getObjCInterfaceDeclInfo(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+ ) {
+ _clang_index_getObjCInterfaceDeclInfo ??= _dylib.lookupFunction<
+ _c_clang_index_getObjCInterfaceDeclInfo,
+ _dart_clang_index_getObjCInterfaceDeclInfo>(
+ 'clang_index_getObjCInterfaceDeclInfo');
+ return _clang_index_getObjCInterfaceDeclInfo(
+ arg0,
+ );
+ }
+
+ _dart_clang_index_getObjCInterfaceDeclInfo
+ _clang_index_getObjCInterfaceDeclInfo;
+
+ ffi.Pointer<CXIdxObjCCategoryDeclInfo> clang_index_getObjCCategoryDeclInfo(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+ ) {
+ _clang_index_getObjCCategoryDeclInfo ??= _dylib.lookupFunction<
+ _c_clang_index_getObjCCategoryDeclInfo,
+ _dart_clang_index_getObjCCategoryDeclInfo>(
+ 'clang_index_getObjCCategoryDeclInfo');
+ return _clang_index_getObjCCategoryDeclInfo(
+ arg0,
+ );
+ }
+
+ _dart_clang_index_getObjCCategoryDeclInfo
+ _clang_index_getObjCCategoryDeclInfo;
+
+ ffi.Pointer<CXIdxObjCProtocolRefListInfo>
+ clang_index_getObjCProtocolRefListInfo(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+ ) {
+ _clang_index_getObjCProtocolRefListInfo ??= _dylib.lookupFunction<
+ _c_clang_index_getObjCProtocolRefListInfo,
+ _dart_clang_index_getObjCProtocolRefListInfo>(
+ 'clang_index_getObjCProtocolRefListInfo');
+ return _clang_index_getObjCProtocolRefListInfo(
+ arg0,
+ );
+ }
+
+ _dart_clang_index_getObjCProtocolRefListInfo
+ _clang_index_getObjCProtocolRefListInfo;
+
+ ffi.Pointer<CXIdxObjCPropertyDeclInfo> clang_index_getObjCPropertyDeclInfo(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+ ) {
+ _clang_index_getObjCPropertyDeclInfo ??= _dylib.lookupFunction<
+ _c_clang_index_getObjCPropertyDeclInfo,
+ _dart_clang_index_getObjCPropertyDeclInfo>(
+ 'clang_index_getObjCPropertyDeclInfo');
+ return _clang_index_getObjCPropertyDeclInfo(
+ arg0,
+ );
+ }
+
+ _dart_clang_index_getObjCPropertyDeclInfo
+ _clang_index_getObjCPropertyDeclInfo;
+
+ ffi.Pointer<CXIdxIBOutletCollectionAttrInfo>
+ clang_index_getIBOutletCollectionAttrInfo(
+ ffi.Pointer<CXIdxAttrInfo> arg0,
+ ) {
+ _clang_index_getIBOutletCollectionAttrInfo ??= _dylib.lookupFunction<
+ _c_clang_index_getIBOutletCollectionAttrInfo,
+ _dart_clang_index_getIBOutletCollectionAttrInfo>(
+ 'clang_index_getIBOutletCollectionAttrInfo');
+ return _clang_index_getIBOutletCollectionAttrInfo(
+ arg0,
+ );
+ }
+
+ _dart_clang_index_getIBOutletCollectionAttrInfo
+ _clang_index_getIBOutletCollectionAttrInfo;
+
+ ffi.Pointer<CXIdxCXXClassDeclInfo> clang_index_getCXXClassDeclInfo(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+ ) {
+ _clang_index_getCXXClassDeclInfo ??= _dylib.lookupFunction<
+ _c_clang_index_getCXXClassDeclInfo,
+ _dart_clang_index_getCXXClassDeclInfo>(
+ 'clang_index_getCXXClassDeclInfo');
+ return _clang_index_getCXXClassDeclInfo(
+ arg0,
+ );
+ }
+
+ _dart_clang_index_getCXXClassDeclInfo _clang_index_getCXXClassDeclInfo;
+
+ /// For retrieving a custom CXIdxClientContainer attached to a container.
+ ffi.Pointer<ffi.Void> clang_index_getClientContainer(
+ ffi.Pointer<CXIdxContainerInfo> arg0,
+ ) {
+ _clang_index_getClientContainer ??= _dylib.lookupFunction<
+ _c_clang_index_getClientContainer,
+ _dart_clang_index_getClientContainer>('clang_index_getClientContainer');
+ return _clang_index_getClientContainer(
+ arg0,
+ );
+ }
+
+ _dart_clang_index_getClientContainer _clang_index_getClientContainer;
+
+ /// For setting a custom CXIdxClientContainer attached to a container.
+ void clang_index_setClientContainer(
+ ffi.Pointer<CXIdxContainerInfo> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ) {
+ _clang_index_setClientContainer ??= _dylib.lookupFunction<
+ _c_clang_index_setClientContainer,
+ _dart_clang_index_setClientContainer>('clang_index_setClientContainer');
+ return _clang_index_setClientContainer(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_clang_index_setClientContainer _clang_index_setClientContainer;
+
+ /// For retrieving a custom CXIdxClientEntity attached to an entity.
+ ffi.Pointer<ffi.Void> clang_index_getClientEntity(
+ ffi.Pointer<CXIdxEntityInfo> arg0,
+ ) {
+ _clang_index_getClientEntity ??= _dylib.lookupFunction<
+ _c_clang_index_getClientEntity,
+ _dart_clang_index_getClientEntity>('clang_index_getClientEntity');
+ return _clang_index_getClientEntity(
+ arg0,
+ );
+ }
+
+ _dart_clang_index_getClientEntity _clang_index_getClientEntity;
+
+ /// For setting a custom CXIdxClientEntity attached to an entity.
+ void clang_index_setClientEntity(
+ ffi.Pointer<CXIdxEntityInfo> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ) {
+ _clang_index_setClientEntity ??= _dylib.lookupFunction<
+ _c_clang_index_setClientEntity,
+ _dart_clang_index_setClientEntity>('clang_index_setClientEntity');
+ return _clang_index_setClientEntity(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_clang_index_setClientEntity _clang_index_setClientEntity;
+
+ /// An indexing action/session, to be applied to one or multiple translation
+ /// units.
+ ffi.Pointer<ffi.Void> clang_IndexAction_create(
+ ffi.Pointer<ffi.Void> CIdx,
+ ) {
+ _clang_IndexAction_create ??= _dylib.lookupFunction<
+ _c_clang_IndexAction_create,
+ _dart_clang_IndexAction_create>('clang_IndexAction_create');
+ return _clang_IndexAction_create(
+ CIdx,
+ );
+ }
+
+ _dart_clang_IndexAction_create _clang_IndexAction_create;
+
+ /// Destroy the given index action.
+ void clang_IndexAction_dispose(
+ ffi.Pointer<ffi.Void> arg0,
+ ) {
+ _clang_IndexAction_dispose ??= _dylib.lookupFunction<
+ _c_clang_IndexAction_dispose,
+ _dart_clang_IndexAction_dispose>('clang_IndexAction_dispose');
+ return _clang_IndexAction_dispose(
+ arg0,
+ );
+ }
+
+ _dart_clang_IndexAction_dispose _clang_IndexAction_dispose;
+
+ /// Index the given source file and the translation unit corresponding to that
+ /// file via callbacks implemented through #IndexerCallbacks.
+ int clang_indexSourceFile(
+ ffi.Pointer<ffi.Void> arg0,
+ ffi.Pointer<ffi.Void> client_data,
+ ffi.Pointer<IndexerCallbacks> index_callbacks,
+ int index_callbacks_size,
+ int index_options,
+ ffi.Pointer<ffi.Int8> source_filename,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> command_line_args,
+ int num_command_line_args,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ int num_unsaved_files,
+ ffi.Pointer<ffi.Pointer<CXTranslationUnitImpl>> out_TU,
+ int TU_options,
+ ) {
+ _clang_indexSourceFile ??= _dylib.lookupFunction<_c_clang_indexSourceFile,
+ _dart_clang_indexSourceFile>('clang_indexSourceFile');
+ return _clang_indexSourceFile(
+ arg0,
+ client_data,
+ index_callbacks,
+ index_callbacks_size,
+ index_options,
+ source_filename,
+ command_line_args,
+ num_command_line_args,
+ unsaved_files,
+ num_unsaved_files,
+ out_TU,
+ TU_options,
+ );
+ }
+
+ _dart_clang_indexSourceFile _clang_indexSourceFile;
+
+ /// Same as clang_indexSourceFile but requires a full command line for
+ /// command_line_args including argv[0]. This is useful if the standard
+ /// library paths are relative to the binary.
+ int clang_indexSourceFileFullArgv(
+ ffi.Pointer<ffi.Void> arg0,
+ ffi.Pointer<ffi.Void> client_data,
+ ffi.Pointer<IndexerCallbacks> index_callbacks,
+ int index_callbacks_size,
+ int index_options,
+ ffi.Pointer<ffi.Int8> source_filename,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> command_line_args,
+ int num_command_line_args,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ int num_unsaved_files,
+ ffi.Pointer<ffi.Pointer<CXTranslationUnitImpl>> out_TU,
+ int TU_options,
+ ) {
+ _clang_indexSourceFileFullArgv ??= _dylib.lookupFunction<
+ _c_clang_indexSourceFileFullArgv,
+ _dart_clang_indexSourceFileFullArgv>('clang_indexSourceFileFullArgv');
+ return _clang_indexSourceFileFullArgv(
+ arg0,
+ client_data,
+ index_callbacks,
+ index_callbacks_size,
+ index_options,
+ source_filename,
+ command_line_args,
+ num_command_line_args,
+ unsaved_files,
+ num_unsaved_files,
+ out_TU,
+ TU_options,
+ );
+ }
+
+ _dart_clang_indexSourceFileFullArgv _clang_indexSourceFileFullArgv;
+
+ /// Index the given translation unit via callbacks implemented through
+ /// #IndexerCallbacks.
+ int clang_indexTranslationUnit(
+ ffi.Pointer<ffi.Void> arg0,
+ ffi.Pointer<ffi.Void> client_data,
+ ffi.Pointer<IndexerCallbacks> index_callbacks,
+ int index_callbacks_size,
+ int index_options,
+ ffi.Pointer<CXTranslationUnitImpl> arg5,
+ ) {
+ _clang_indexTranslationUnit ??= _dylib.lookupFunction<
+ _c_clang_indexTranslationUnit,
+ _dart_clang_indexTranslationUnit>('clang_indexTranslationUnit');
+ return _clang_indexTranslationUnit(
+ arg0,
+ client_data,
+ index_callbacks,
+ index_callbacks_size,
+ index_options,
+ arg5,
+ );
+ }
+
+ _dart_clang_indexTranslationUnit _clang_indexTranslationUnit;
+}
+
+/// Error codes returned by libclang routines.
+class CXErrorCode {
+ /// No error.
+ static const int CXError_Success = 0;
+
+ /// A generic error code, no further details are available.
+ static const int CXError_Failure = 1;
+
+ /// libclang crashed while performing the requested operation.
+ static const int CXError_Crashed = 2;
+
+ /// The function detected that the arguments violate the function contract.
+ static const int CXError_InvalidArguments = 3;
+
+ /// An AST deserialization error has occurred.
+ static const int CXError_ASTReadError = 4;
+}
+
+/// A character string.
+class CXString extends ffi.Struct {
+ ffi.Pointer<ffi.Void> data;
+
+ @ffi.Uint32()
+ int private_flags;
+}
+
+class CXStringSet extends ffi.Struct {
+ ffi.Pointer<CXString> Strings;
+
+ @ffi.Uint32()
+ int Count;
+}
+
+class CXVirtualFileOverlayImpl extends ffi.Struct {}
+
+class CXModuleMapDescriptorImpl extends ffi.Struct {}
+
+class CXTargetInfoImpl extends ffi.Struct {}
+
+class CXTranslationUnitImpl extends ffi.Struct {}
+
+/// Provides the contents of a file that has not yet been saved to disk.
+class CXUnsavedFile extends ffi.Struct {
+ /// The file whose contents have not yet been saved.
+ ffi.Pointer<ffi.Int8> Filename;
+
+ /// A buffer containing the unsaved contents of this file.
+ ffi.Pointer<ffi.Int8> Contents;
+
+ /// The length of the unsaved contents of this buffer.
+ @ffi.Uint64()
+ int Length;
+}
+
+/// Describes the availability of a particular entity, which indicates whether
+/// the use of this entity will result in a warning or error due to it being
+/// deprecated or unavailable.
+class CXAvailabilityKind {
+ /// The entity is available.
+ static const int CXAvailability_Available = 0;
+
+ /// The entity is available, but has been deprecated (and its use is not
+ /// recommended).
+ static const int CXAvailability_Deprecated = 1;
+
+ /// The entity is not available; any use of it will be an error.
+ static const int CXAvailability_NotAvailable = 2;
+
+ /// The entity is available, but not accessible; any use of it will be an
+ /// error.
+ static const int CXAvailability_NotAccessible = 3;
+}
+
+/// Describes a version number of the form major.minor.subminor.
+class CXVersion extends ffi.Struct {
+ /// The major version number, e.g., the '10' in '10.7.3'. A negative value
+ /// indicates that there is no version number at all.
+ @ffi.Int32()
+ int Major;
+
+ /// The minor version number, e.g., the '7' in '10.7.3'. This value will be
+ /// negative if no minor version number was provided, e.g., for version '10'.
+ @ffi.Int32()
+ int Minor;
+
+ /// The subminor version number, e.g., the '3' in '10.7.3'. This value will be
+ /// negative if no minor or subminor version number was provided, e.g., in
+ /// version '10' or '10.7'.
+ @ffi.Int32()
+ int Subminor;
+}
+
+/// Describes the exception specification of a cursor.
+class CXCursor_ExceptionSpecificationKind {
+ /// The cursor has no exception specification.
+ static const int CXCursor_ExceptionSpecificationKind_None = 0;
+
+ /// The cursor has exception specification throw()
+ static const int CXCursor_ExceptionSpecificationKind_DynamicNone = 1;
+
+ /// The cursor has exception specification throw(T1, T2)
+ static const int CXCursor_ExceptionSpecificationKind_Dynamic = 2;
+
+ /// The cursor has exception specification throw(...).
+ static const int CXCursor_ExceptionSpecificationKind_MSAny = 3;
+
+ /// The cursor has exception specification basic noexcept.
+ static const int CXCursor_ExceptionSpecificationKind_BasicNoexcept = 4;
+
+ /// The cursor has exception specification computed noexcept.
+ static const int CXCursor_ExceptionSpecificationKind_ComputedNoexcept = 5;
+
+ /// The exception specification has not yet been evaluated.
+ static const int CXCursor_ExceptionSpecificationKind_Unevaluated = 6;
+
+ /// The exception specification has not yet been instantiated.
+ static const int CXCursor_ExceptionSpecificationKind_Uninstantiated = 7;
+
+ /// The exception specification has not been parsed yet.
+ static const int CXCursor_ExceptionSpecificationKind_Unparsed = 8;
+
+ /// The cursor has a __declspec(nothrow) exception specification.
+ static const int CXCursor_ExceptionSpecificationKind_NoThrow = 9;
+}
+
+class CXGlobalOptFlags {
+ /// Used to indicate that no special CXIndex options are needed.
+ static const int CXGlobalOpt_None = 0;
+
+ /// Used to indicate that threads that libclang creates for indexing purposes
+ /// should use background priority.
+ static const int CXGlobalOpt_ThreadBackgroundPriorityForIndexing = 1;
+
+ /// Used to indicate that threads that libclang creates for editing purposes
+ /// should use background priority.
+ static const int CXGlobalOpt_ThreadBackgroundPriorityForEditing = 2;
+
+ /// Used to indicate that all threads that libclang creates should use
+ /// background priority.
+ static const int CXGlobalOpt_ThreadBackgroundPriorityForAll = 3;
+}
+
+/// Uniquely identifies a CXFile, that refers to the same underlying file,
+/// across an indexing session.
+class CXFileUniqueID extends ffi.Struct {
+ @ffi.Uint64()
+ int _unique_data_item_0;
+ @ffi.Uint64()
+ int _unique_data_item_1;
+ @ffi.Uint64()
+ int _unique_data_item_2;
+
+ /// Helper for array `data`.
+ ArrayHelper_CXFileUniqueID_data_level0 get data =>
+ ArrayHelper_CXFileUniqueID_data_level0(this, [3], 0, 0);
+}
+
+/// Helper for array `data` in struct `CXFileUniqueID`.
+class ArrayHelper_CXFileUniqueID_data_level0 {
+ final CXFileUniqueID _struct;
+ final List<int> dimensions;
+ final int level;
+ final int _absoluteIndex;
+ int get length => dimensions[level];
+ ArrayHelper_CXFileUniqueID_data_level0(
+ this._struct, this.dimensions, this.level, this._absoluteIndex);
+ void _checkBounds(int index) {
+ if (index >= length || index < 0) {
+ throw RangeError(
+ 'Dimension $level: index not in range 0..${length} exclusive.');
+ }
+ }
+
+ int operator [](int index) {
+ _checkBounds(index);
+ switch (_absoluteIndex + index) {
+ case 0:
+ return _struct._unique_data_item_0;
+ case 1:
+ return _struct._unique_data_item_1;
+ case 2:
+ return _struct._unique_data_item_2;
+ default:
+ throw Exception('Invalid Array Helper generated.');
+ }
+ }
+
+ void operator []=(int index, int value) {
+ _checkBounds(index);
+ switch (_absoluteIndex + index) {
+ case 0:
+ _struct._unique_data_item_0 = value;
+ break;
+ case 1:
+ _struct._unique_data_item_1 = value;
+ break;
+ case 2:
+ _struct._unique_data_item_2 = value;
+ break;
+ default:
+ throw Exception('Invalid Array Helper generated.');
+ }
+ }
+}
+
+/// Identifies a specific source location within a translation unit.
+class CXSourceLocation extends ffi.Struct {
+ ffi.Pointer<ffi.Void> _unique_ptr_data_item_0;
+ ffi.Pointer<ffi.Void> _unique_ptr_data_item_1;
+
+ /// Helper for array `ptr_data`.
+ ArrayHelper_CXSourceLocation_ptr_data_level0 get ptr_data =>
+ ArrayHelper_CXSourceLocation_ptr_data_level0(this, [2], 0, 0);
+ @ffi.Uint32()
+ int int_data;
+}
+
+/// Helper for array `ptr_data` in struct `CXSourceLocation`.
+class ArrayHelper_CXSourceLocation_ptr_data_level0 {
+ final CXSourceLocation _struct;
+ final List<int> dimensions;
+ final int level;
+ final int _absoluteIndex;
+ int get length => dimensions[level];
+ ArrayHelper_CXSourceLocation_ptr_data_level0(
+ this._struct, this.dimensions, this.level, this._absoluteIndex);
+ void _checkBounds(int index) {
+ if (index >= length || index < 0) {
+ throw RangeError(
+ 'Dimension $level: index not in range 0..${length} exclusive.');
+ }
+ }
+
+ ffi.Pointer<ffi.Void> operator [](int index) {
+ _checkBounds(index);
+ switch (_absoluteIndex + index) {
+ case 0:
+ return _struct._unique_ptr_data_item_0;
+ case 1:
+ return _struct._unique_ptr_data_item_1;
+ default:
+ throw Exception('Invalid Array Helper generated.');
+ }
+ }
+
+ void operator []=(int index, ffi.Pointer<ffi.Void> value) {
+ _checkBounds(index);
+ switch (_absoluteIndex + index) {
+ case 0:
+ _struct._unique_ptr_data_item_0 = value;
+ break;
+ case 1:
+ _struct._unique_ptr_data_item_1 = value;
+ break;
+ default:
+ throw Exception('Invalid Array Helper generated.');
+ }
+ }
+}
+
+/// Identifies a half-open character range in the source code.
+class CXSourceRange extends ffi.Struct {
+ ffi.Pointer<ffi.Void> _unique_ptr_data_item_0;
+ ffi.Pointer<ffi.Void> _unique_ptr_data_item_1;
+
+ /// Helper for array `ptr_data`.
+ ArrayHelper_CXSourceRange_ptr_data_level0 get ptr_data =>
+ ArrayHelper_CXSourceRange_ptr_data_level0(this, [2], 0, 0);
+ @ffi.Uint32()
+ int begin_int_data;
+
+ @ffi.Uint32()
+ int end_int_data;
+}
+
+/// Helper for array `ptr_data` in struct `CXSourceRange`.
+class ArrayHelper_CXSourceRange_ptr_data_level0 {
+ final CXSourceRange _struct;
+ final List<int> dimensions;
+ final int level;
+ final int _absoluteIndex;
+ int get length => dimensions[level];
+ ArrayHelper_CXSourceRange_ptr_data_level0(
+ this._struct, this.dimensions, this.level, this._absoluteIndex);
+ void _checkBounds(int index) {
+ if (index >= length || index < 0) {
+ throw RangeError(
+ 'Dimension $level: index not in range 0..${length} exclusive.');
+ }
+ }
+
+ ffi.Pointer<ffi.Void> operator [](int index) {
+ _checkBounds(index);
+ switch (_absoluteIndex + index) {
+ case 0:
+ return _struct._unique_ptr_data_item_0;
+ case 1:
+ return _struct._unique_ptr_data_item_1;
+ default:
+ throw Exception('Invalid Array Helper generated.');
+ }
+ }
+
+ void operator []=(int index, ffi.Pointer<ffi.Void> value) {
+ _checkBounds(index);
+ switch (_absoluteIndex + index) {
+ case 0:
+ _struct._unique_ptr_data_item_0 = value;
+ break;
+ case 1:
+ _struct._unique_ptr_data_item_1 = value;
+ break;
+ default:
+ throw Exception('Invalid Array Helper generated.');
+ }
+ }
+}
+
+/// Identifies an array of ranges.
+class CXSourceRangeList extends ffi.Struct {
+ /// The number of ranges in the ranges array.
+ @ffi.Uint32()
+ int count;
+
+ /// An array of CXSourceRanges.
+ ffi.Pointer<CXSourceRange> ranges;
+}
+
+/// Describes the severity of a particular diagnostic.
+class CXDiagnosticSeverity {
+ /// A diagnostic that has been suppressed, e.g., by a command-line option.
+ static const int CXDiagnostic_Ignored = 0;
+
+ /// This diagnostic is a note that should be attached to the previous
+ /// (non-note) diagnostic.
+ static const int CXDiagnostic_Note = 1;
+
+ /// This diagnostic indicates suspicious code that may not be wrong.
+ static const int CXDiagnostic_Warning = 2;
+
+ /// This diagnostic indicates that the code is ill-formed.
+ static const int CXDiagnostic_Error = 3;
+
+ /// This diagnostic indicates that the code is ill-formed such that future
+ /// parser recovery is unlikely to produce useful results.
+ static const int CXDiagnostic_Fatal = 4;
+}
+
+/// Describes the kind of error that occurred (if any) in a call to
+/// clang_loadDiagnostics.
+class CXLoadDiag_Error {
+ /// Indicates that no error occurred.
+ static const int CXLoadDiag_None = 0;
+
+ /// Indicates that an unknown error occurred while attempting to deserialize
+ /// diagnostics.
+ static const int CXLoadDiag_Unknown = 1;
+
+ /// Indicates that the file containing the serialized diagnostics could not be
+ /// opened.
+ static const int CXLoadDiag_CannotLoad = 2;
+
+ /// Indicates that the serialized diagnostics file is invalid or corrupt.
+ static const int CXLoadDiag_InvalidFile = 3;
+}
+
+/// Options to control the display of diagnostics.
+class CXDiagnosticDisplayOptions {
+ /// Display the source-location information where the diagnostic was located.
+ static const int CXDiagnostic_DisplaySourceLocation = 1;
+
+ /// If displaying the source-location information of the diagnostic, also
+ /// include the column number.
+ static const int CXDiagnostic_DisplayColumn = 2;
+
+ /// If displaying the source-location information of the diagnostic, also
+ /// include information about source ranges in a machine-parsable format.
+ static const int CXDiagnostic_DisplaySourceRanges = 4;
+
+ /// Display the option name associated with this diagnostic, if any.
+ static const int CXDiagnostic_DisplayOption = 8;
+
+ /// Display the category number associated with this diagnostic, if any.
+ static const int CXDiagnostic_DisplayCategoryId = 16;
+
+ /// Display the category name associated with this diagnostic, if any.
+ static const int CXDiagnostic_DisplayCategoryName = 32;
+}
+
+/// Flags that control the creation of translation units.
+class CXTranslationUnit_Flags {
+ /// Used to indicate that no special translation-unit options are needed.
+ static const int CXTranslationUnit_None = 0;
+
+ /// Used to indicate that the parser should construct a "detailed"
+ /// preprocessing record, including all macro definitions and instantiations.
+ static const int CXTranslationUnit_DetailedPreprocessingRecord = 1;
+
+ /// Used to indicate that the translation unit is incomplete.
+ static const int CXTranslationUnit_Incomplete = 2;
+
+ /// Used to indicate that the translation unit should be built with an
+ /// implicit precompiled header for the preamble.
+ static const int CXTranslationUnit_PrecompiledPreamble = 4;
+
+ /// Used to indicate that the translation unit should cache some
+ /// code-completion results with each reparse of the source file.
+ static const int CXTranslationUnit_CacheCompletionResults = 8;
+
+ /// Used to indicate that the translation unit will be serialized with
+ /// clang_saveTranslationUnit.
+ static const int CXTranslationUnit_ForSerialization = 16;
+
+ /// DEPRECATED: Enabled chained precompiled preambles in C++.
+ static const int CXTranslationUnit_CXXChainedPCH = 32;
+
+ /// Used to indicate that function/method bodies should be skipped while
+ /// parsing.
+ static const int CXTranslationUnit_SkipFunctionBodies = 64;
+
+ /// Used to indicate that brief documentation comments should be included into
+ /// the set of code completions returned from this translation unit.
+ static const int CXTranslationUnit_IncludeBriefCommentsInCodeCompletion = 128;
+
+ /// Used to indicate that the precompiled preamble should be created on the
+ /// first parse. Otherwise it will be created on the first reparse. This
+ /// trades runtime on the first parse (serializing the preamble takes time)
+ /// for reduced runtime on the second parse (can now reuse the preamble).
+ static const int CXTranslationUnit_CreatePreambleOnFirstParse = 256;
+
+ /// Do not stop processing when fatal errors are encountered.
+ static const int CXTranslationUnit_KeepGoing = 512;
+
+ /// Sets the preprocessor in a mode for parsing a single file only.
+ static const int CXTranslationUnit_SingleFileParse = 1024;
+
+ /// Used in combination with CXTranslationUnit_SkipFunctionBodies to constrain
+ /// the skipping of function bodies to the preamble.
+ static const int CXTranslationUnit_LimitSkipFunctionBodiesToPreamble = 2048;
+
+ /// Used to indicate that attributed types should be included in CXType.
+ static const int CXTranslationUnit_IncludeAttributedTypes = 4096;
+
+ /// Used to indicate that implicit attributes should be visited.
+ static const int CXTranslationUnit_VisitImplicitAttributes = 8192;
+
+ /// Used to indicate that non-errors from included files should be ignored.
+ static const int CXTranslationUnit_IgnoreNonErrorsFromIncludedFiles = 16384;
+
+ /// Tells the preprocessor not to skip excluded conditional blocks.
+ static const int CXTranslationUnit_RetainExcludedConditionalBlocks = 32768;
+}
+
+/// Flags that control how translation units are saved.
+class CXSaveTranslationUnit_Flags {
+ /// Used to indicate that no special saving options are needed.
+ static const int CXSaveTranslationUnit_None = 0;
+}
+
+/// Describes the kind of error that occurred (if any) in a call to
+/// clang_saveTranslationUnit().
+class CXSaveError {
+ /// Indicates that no error occurred while saving a translation unit.
+ static const int CXSaveError_None = 0;
+
+ /// Indicates that an unknown error occurred while attempting to save the
+ /// file.
+ static const int CXSaveError_Unknown = 1;
+
+ /// Indicates that errors during translation prevented this attempt to save
+ /// the translation unit.
+ static const int CXSaveError_TranslationErrors = 2;
+
+ /// Indicates that the translation unit to be saved was somehow invalid (e.g.,
+ /// NULL).
+ static const int CXSaveError_InvalidTU = 3;
+}
+
+/// Flags that control the reparsing of translation units.
+class CXReparse_Flags {
+ /// Used to indicate that no special reparsing options are needed.
+ static const int CXReparse_None = 0;
+}
+
+/// Categorizes how memory is being used by a translation unit.
+class CXTUResourceUsageKind {
+ static const int CXTUResourceUsage_AST = 1;
+ static const int CXTUResourceUsage_Identifiers = 2;
+ static const int CXTUResourceUsage_Selectors = 3;
+ static const int CXTUResourceUsage_GlobalCompletionResults = 4;
+ static const int CXTUResourceUsage_SourceManagerContentCache = 5;
+ static const int CXTUResourceUsage_AST_SideTables = 6;
+ static const int CXTUResourceUsage_SourceManager_Membuffer_Malloc = 7;
+ static const int CXTUResourceUsage_SourceManager_Membuffer_MMap = 8;
+ static const int CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc = 9;
+ static const int CXTUResourceUsage_ExternalASTSource_Membuffer_MMap = 10;
+ static const int CXTUResourceUsage_Preprocessor = 11;
+ static const int CXTUResourceUsage_PreprocessingRecord = 12;
+ static const int CXTUResourceUsage_SourceManager_DataStructures = 13;
+ static const int CXTUResourceUsage_Preprocessor_HeaderSearch = 14;
+ static const int CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN = 1;
+ static const int CXTUResourceUsage_MEMORY_IN_BYTES_END = 14;
+ static const int CXTUResourceUsage_First = 1;
+ static const int CXTUResourceUsage_Last = 14;
+}
+
+class CXTUResourceUsageEntry extends ffi.Struct {
+ @ffi.Int32()
+ int kind;
+
+ @ffi.Uint64()
+ int amount;
+}
+
+/// The memory usage of a CXTranslationUnit, broken into categories.
+class CXTUResourceUsage extends ffi.Struct {
+ ffi.Pointer<ffi.Void> data;
+
+ @ffi.Uint32()
+ int numEntries;
+
+ ffi.Pointer<CXTUResourceUsageEntry> entries;
+}
+
+/// Describes the kind of entity that a cursor refers to.
+class CXCursorKind {
+ /// A declaration whose specific kind is not exposed via this interface.
+ static const int CXCursor_UnexposedDecl = 1;
+
+ /// A C or C++ struct.
+ static const int CXCursor_StructDecl = 2;
+
+ /// A C or C++ union.
+ static const int CXCursor_UnionDecl = 3;
+
+ /// A C++ class.
+ static const int CXCursor_ClassDecl = 4;
+
+ /// An enumeration.
+ static const int CXCursor_EnumDecl = 5;
+
+ /// A field (in C) or non-static data member (in C++) in a struct, union, or
+ /// C++ class.
+ static const int CXCursor_FieldDecl = 6;
+
+ /// An enumerator constant.
+ static const int CXCursor_EnumConstantDecl = 7;
+
+ /// A function.
+ static const int CXCursor_FunctionDecl = 8;
+
+ /// A variable.
+ static const int CXCursor_VarDecl = 9;
+
+ /// A function or method parameter.
+ static const int CXCursor_ParmDecl = 10;
+
+ /// An Objective-C @interface.
+ static const int CXCursor_ObjCInterfaceDecl = 11;
+
+ /// An Objective-C @interface for a category.
+ static const int CXCursor_ObjCCategoryDecl = 12;
+
+ /// An Objective-C @protocol declaration.
+ static const int CXCursor_ObjCProtocolDecl = 13;
+
+ /// An Objective-C @property declaration.
+ static const int CXCursor_ObjCPropertyDecl = 14;
+
+ /// An Objective-C instance variable.
+ static const int CXCursor_ObjCIvarDecl = 15;
+
+ /// An Objective-C instance method.
+ static const int CXCursor_ObjCInstanceMethodDecl = 16;
+
+ /// An Objective-C class method.
+ static const int CXCursor_ObjCClassMethodDecl = 17;
+
+ /// An Objective-C @implementation.
+ static const int CXCursor_ObjCImplementationDecl = 18;
+
+ /// An Objective-C @implementation for a category.
+ static const int CXCursor_ObjCCategoryImplDecl = 19;
+
+ /// A typedef.
+ static const int CXCursor_TypedefDecl = 20;
+
+ /// A C++ class method.
+ static const int CXCursor_CXXMethod = 21;
+
+ /// A C++ namespace.
+ static const int CXCursor_Namespace = 22;
+
+ /// A linkage specification, e.g. 'extern "C"'.
+ static const int CXCursor_LinkageSpec = 23;
+
+ /// A C++ constructor.
+ static const int CXCursor_Constructor = 24;
+
+ /// A C++ destructor.
+ static const int CXCursor_Destructor = 25;
+
+ /// A C++ conversion function.
+ static const int CXCursor_ConversionFunction = 26;
+
+ /// A C++ template type parameter.
+ static const int CXCursor_TemplateTypeParameter = 27;
+
+ /// A C++ non-type template parameter.
+ static const int CXCursor_NonTypeTemplateParameter = 28;
+
+ /// A C++ template template parameter.
+ static const int CXCursor_TemplateTemplateParameter = 29;
+
+ /// A C++ function template.
+ static const int CXCursor_FunctionTemplate = 30;
+
+ /// A C++ class template.
+ static const int CXCursor_ClassTemplate = 31;
+
+ /// A C++ class template partial specialization.
+ static const int CXCursor_ClassTemplatePartialSpecialization = 32;
+
+ /// A C++ namespace alias declaration.
+ static const int CXCursor_NamespaceAlias = 33;
+
+ /// A C++ using directive.
+ static const int CXCursor_UsingDirective = 34;
+
+ /// A C++ using declaration.
+ static const int CXCursor_UsingDeclaration = 35;
+
+ /// A C++ alias declaration
+ static const int CXCursor_TypeAliasDecl = 36;
+
+ /// An Objective-C @synthesize definition.
+ static const int CXCursor_ObjCSynthesizeDecl = 37;
+
+ /// An Objective-C @dynamic definition.
+ static const int CXCursor_ObjCDynamicDecl = 38;
+
+ /// An access specifier.
+ static const int CXCursor_CXXAccessSpecifier = 39;
+ static const int CXCursor_FirstDecl = 1;
+ static const int CXCursor_LastDecl = 39;
+ static const int CXCursor_FirstRef = 40;
+ static const int CXCursor_ObjCSuperClassRef = 40;
+ static const int CXCursor_ObjCProtocolRef = 41;
+ static const int CXCursor_ObjCClassRef = 42;
+
+ /// A reference to a type declaration.
+ static const int CXCursor_TypeRef = 43;
+ static const int CXCursor_CXXBaseSpecifier = 44;
+
+ /// A reference to a class template, function template, template template
+ /// parameter, or class template partial specialization.
+ static const int CXCursor_TemplateRef = 45;
+
+ /// A reference to a namespace or namespace alias.
+ static const int CXCursor_NamespaceRef = 46;
+
+ /// A reference to a member of a struct, union, or class that occurs in some
+ /// non-expression context, e.g., a designated initializer.
+ static const int CXCursor_MemberRef = 47;
+
+ /// A reference to a labeled statement.
+ static const int CXCursor_LabelRef = 48;
+
+ /// A reference to a set of overloaded functions or function templates that
+ /// has not yet been resolved to a specific function or function template.
+ static const int CXCursor_OverloadedDeclRef = 49;
+
+ /// A reference to a variable that occurs in some non-expression context,
+ /// e.g., a C++ lambda capture list.
+ static const int CXCursor_VariableRef = 50;
+ static const int CXCursor_LastRef = 50;
+ static const int CXCursor_FirstInvalid = 70;
+ static const int CXCursor_InvalidFile = 70;
+ static const int CXCursor_NoDeclFound = 71;
+ static const int CXCursor_NotImplemented = 72;
+ static const int CXCursor_InvalidCode = 73;
+ static const int CXCursor_LastInvalid = 73;
+ static const int CXCursor_FirstExpr = 100;
+
+ /// An expression whose specific kind is not exposed via this interface.
+ static const int CXCursor_UnexposedExpr = 100;
+
+ /// An expression that refers to some value declaration, such as a function,
+ /// variable, or enumerator.
+ static const int CXCursor_DeclRefExpr = 101;
+
+ /// An expression that refers to a member of a struct, union, class,
+ /// Objective-C class, etc.
+ static const int CXCursor_MemberRefExpr = 102;
+
+ /// An expression that calls a function.
+ static const int CXCursor_CallExpr = 103;
+
+ /// An expression that sends a message to an Objective-C object or class.
+ static const int CXCursor_ObjCMessageExpr = 104;
+
+ /// An expression that represents a block literal.
+ static const int CXCursor_BlockExpr = 105;
+
+ /// An integer literal.
+ static const int CXCursor_IntegerLiteral = 106;
+
+ /// A floating point number literal.
+ static const int CXCursor_FloatingLiteral = 107;
+
+ /// An imaginary number literal.
+ static const int CXCursor_ImaginaryLiteral = 108;
+
+ /// A string literal.
+ static const int CXCursor_StringLiteral = 109;
+
+ /// A character literal.
+ static const int CXCursor_CharacterLiteral = 110;
+
+ /// A parenthesized expression, e.g. "(1)".
+ static const int CXCursor_ParenExpr = 111;
+
+ /// This represents the unary-expression's (except sizeof and alignof).
+ static const int CXCursor_UnaryOperator = 112;
+
+ /// [C99 6.5.2.1] Array Subscripting.
+ static const int CXCursor_ArraySubscriptExpr = 113;
+
+ /// A builtin binary operation expression such as "x + y" or "x <= y".
+ static const int CXCursor_BinaryOperator = 114;
+
+ /// Compound assignment such as "+=".
+ static const int CXCursor_CompoundAssignOperator = 115;
+
+ /// The ?: ternary operator.
+ static const int CXCursor_ConditionalOperator = 116;
+
+ /// An explicit cast in C (C99 6.5.4) or a C-style cast in C++ (C++
+ /// [expr.cast]), which uses the syntax (Type)expr.
+ static const int CXCursor_CStyleCastExpr = 117;
+
+ /// [C99 6.5.2.5]
+ static const int CXCursor_CompoundLiteralExpr = 118;
+
+ /// Describes an C or C++ initializer list.
+ static const int CXCursor_InitListExpr = 119;
+
+ /// The GNU address of label extension, representing &&label.
+ static const int CXCursor_AddrLabelExpr = 120;
+
+ /// This is the GNU Statement Expression extension: ({int X=4; X;})
+ static const int CXCursor_StmtExpr = 121;
+
+ /// Represents a C11 generic selection.
+ static const int CXCursor_GenericSelectionExpr = 122;
+
+ /// Implements the GNU __null extension, which is a name for a null pointer
+ /// constant that has integral type (e.g., int or long) and is the same size
+ /// and alignment as a pointer.
+ static const int CXCursor_GNUNullExpr = 123;
+
+ /// C++'s static_cast<> expression.
+ static const int CXCursor_CXXStaticCastExpr = 124;
+
+ /// C++'s dynamic_cast<> expression.
+ static const int CXCursor_CXXDynamicCastExpr = 125;
+
+ /// C++'s reinterpret_cast<> expression.
+ static const int CXCursor_CXXReinterpretCastExpr = 126;
+
+ /// C++'s const_cast<> expression.
+ static const int CXCursor_CXXConstCastExpr = 127;
+
+ /// Represents an explicit C++ type conversion that uses "functional" notion
+ /// (C++ [expr.type.conv]).
+ static const int CXCursor_CXXFunctionalCastExpr = 128;
+
+ /// A C++ typeid expression (C++ [expr.typeid]).
+ static const int CXCursor_CXXTypeidExpr = 129;
+
+ /// [C++ 2.13.5] C++ Boolean Literal.
+ static const int CXCursor_CXXBoolLiteralExpr = 130;
+
+ /// [C++0x 2.14.7] C++ Pointer Literal.
+ static const int CXCursor_CXXNullPtrLiteralExpr = 131;
+
+ /// Represents the "this" expression in C++
+ static const int CXCursor_CXXThisExpr = 132;
+
+ /// [C++ 15] C++ Throw Expression.
+ static const int CXCursor_CXXThrowExpr = 133;
+
+ /// A new expression for memory allocation and constructor calls, e.g: "new
+ /// CXXNewExpr(foo)".
+ static const int CXCursor_CXXNewExpr = 134;
+
+ /// A delete expression for memory deallocation and destructor calls, e.g.
+ /// "delete[] pArray".
+ static const int CXCursor_CXXDeleteExpr = 135;
+
+ /// A unary expression. (noexcept, sizeof, or other traits)
+ static const int CXCursor_UnaryExpr = 136;
+
+ /// An Objective-C string literal i.e. "foo".
+ static const int CXCursor_ObjCStringLiteral = 137;
+
+ /// An Objective-C @encode expression.
+ static const int CXCursor_ObjCEncodeExpr = 138;
+
+ /// An Objective-C @selector expression.
+ static const int CXCursor_ObjCSelectorExpr = 139;
+
+ /// An Objective-C @protocol expression.
+ static const int CXCursor_ObjCProtocolExpr = 140;
+
+ /// An Objective-C "bridged" cast expression, which casts between Objective-C
+ /// pointers and C pointers, transferring ownership in the process.
+ static const int CXCursor_ObjCBridgedCastExpr = 141;
+
+ /// Represents a C++0x pack expansion that produces a sequence of expressions.
+ static const int CXCursor_PackExpansionExpr = 142;
+
+ /// Represents an expression that computes the length of a parameter pack.
+ static const int CXCursor_SizeOfPackExpr = 143;
+ static const int CXCursor_LambdaExpr = 144;
+
+ /// Objective-c Boolean Literal.
+ static const int CXCursor_ObjCBoolLiteralExpr = 145;
+
+ /// Represents the "self" expression in an Objective-C method.
+ static const int CXCursor_ObjCSelfExpr = 146;
+
+ /// OpenMP 4.0 [2.4, Array Section].
+ static const int CXCursor_OMPArraySectionExpr = 147;
+
+ /// Represents an (...) check.
+ static const int CXCursor_ObjCAvailabilityCheckExpr = 148;
+
+ /// Fixed point literal
+ static const int CXCursor_FixedPointLiteral = 149;
+ static const int CXCursor_LastExpr = 149;
+ static const int CXCursor_FirstStmt = 200;
+
+ /// A statement whose specific kind is not exposed via this interface.
+ static const int CXCursor_UnexposedStmt = 200;
+
+ /// A labelled statement in a function.
+ static const int CXCursor_LabelStmt = 201;
+
+ /// A group of statements like { stmt stmt }.
+ static const int CXCursor_CompoundStmt = 202;
+
+ /// A case statement.
+ static const int CXCursor_CaseStmt = 203;
+
+ /// A default statement.
+ static const int CXCursor_DefaultStmt = 204;
+
+ /// An if statement
+ static const int CXCursor_IfStmt = 205;
+
+ /// A switch statement.
+ static const int CXCursor_SwitchStmt = 206;
+
+ /// A while statement.
+ static const int CXCursor_WhileStmt = 207;
+
+ /// A do statement.
+ static const int CXCursor_DoStmt = 208;
+
+ /// A for statement.
+ static const int CXCursor_ForStmt = 209;
+
+ /// A goto statement.
+ static const int CXCursor_GotoStmt = 210;
+
+ /// An indirect goto statement.
+ static const int CXCursor_IndirectGotoStmt = 211;
+
+ /// A continue statement.
+ static const int CXCursor_ContinueStmt = 212;
+
+ /// A break statement.
+ static const int CXCursor_BreakStmt = 213;
+
+ /// A return statement.
+ static const int CXCursor_ReturnStmt = 214;
+
+ /// A GCC inline assembly statement extension.
+ static const int CXCursor_GCCAsmStmt = 215;
+ static const int CXCursor_AsmStmt = 215;
+
+ /// Objective-C's overall @try-@catch-@finally statement.
+ static const int CXCursor_ObjCAtTryStmt = 216;
+
+ /// Objective-C's @catch statement.
+ static const int CXCursor_ObjCAtCatchStmt = 217;
+
+ /// Objective-C's @finally statement.
+ static const int CXCursor_ObjCAtFinallyStmt = 218;
+
+ /// Objective-C's @throw statement.
+ static const int CXCursor_ObjCAtThrowStmt = 219;
+
+ /// Objective-C's @synchronized statement.
+ static const int CXCursor_ObjCAtSynchronizedStmt = 220;
+
+ /// Objective-C's autorelease pool statement.
+ static const int CXCursor_ObjCAutoreleasePoolStmt = 221;
+
+ /// Objective-C's collection statement.
+ static const int CXCursor_ObjCForCollectionStmt = 222;
+
+ /// C++'s catch statement.
+ static const int CXCursor_CXXCatchStmt = 223;
+
+ /// C++'s try statement.
+ static const int CXCursor_CXXTryStmt = 224;
+
+ /// C++'s for (* : *) statement.
+ static const int CXCursor_CXXForRangeStmt = 225;
+
+ /// Windows Structured Exception Handling's try statement.
+ static const int CXCursor_SEHTryStmt = 226;
+
+ /// Windows Structured Exception Handling's except statement.
+ static const int CXCursor_SEHExceptStmt = 227;
+
+ /// Windows Structured Exception Handling's finally statement.
+ static const int CXCursor_SEHFinallyStmt = 228;
+
+ /// A MS inline assembly statement extension.
+ static const int CXCursor_MSAsmStmt = 229;
+
+ /// The null statement ";": C99 6.8.3p3.
+ static const int CXCursor_NullStmt = 230;
+
+ /// Adaptor class for mixing declarations with statements and expressions.
+ static const int CXCursor_DeclStmt = 231;
+
+ /// OpenMP parallel directive.
+ static const int CXCursor_OMPParallelDirective = 232;
+
+ /// OpenMP SIMD directive.
+ static const int CXCursor_OMPSimdDirective = 233;
+
+ /// OpenMP for directive.
+ static const int CXCursor_OMPForDirective = 234;
+
+ /// OpenMP sections directive.
+ static const int CXCursor_OMPSectionsDirective = 235;
+
+ /// OpenMP section directive.
+ static const int CXCursor_OMPSectionDirective = 236;
+
+ /// OpenMP single directive.
+ static const int CXCursor_OMPSingleDirective = 237;
+
+ /// OpenMP parallel for directive.
+ static const int CXCursor_OMPParallelForDirective = 238;
+
+ /// OpenMP parallel sections directive.
+ static const int CXCursor_OMPParallelSectionsDirective = 239;
+
+ /// OpenMP task directive.
+ static const int CXCursor_OMPTaskDirective = 240;
+
+ /// OpenMP master directive.
+ static const int CXCursor_OMPMasterDirective = 241;
+
+ /// OpenMP critical directive.
+ static const int CXCursor_OMPCriticalDirective = 242;
+
+ /// OpenMP taskyield directive.
+ static const int CXCursor_OMPTaskyieldDirective = 243;
+
+ /// OpenMP barrier directive.
+ static const int CXCursor_OMPBarrierDirective = 244;
+
+ /// OpenMP taskwait directive.
+ static const int CXCursor_OMPTaskwaitDirective = 245;
+
+ /// OpenMP flush directive.
+ static const int CXCursor_OMPFlushDirective = 246;
+
+ /// Windows Structured Exception Handling's leave statement.
+ static const int CXCursor_SEHLeaveStmt = 247;
+
+ /// OpenMP ordered directive.
+ static const int CXCursor_OMPOrderedDirective = 248;
+
+ /// OpenMP atomic directive.
+ static const int CXCursor_OMPAtomicDirective = 249;
+
+ /// OpenMP for SIMD directive.
+ static const int CXCursor_OMPForSimdDirective = 250;
+
+ /// OpenMP parallel for SIMD directive.
+ static const int CXCursor_OMPParallelForSimdDirective = 251;
+
+ /// OpenMP target directive.
+ static const int CXCursor_OMPTargetDirective = 252;
+
+ /// OpenMP teams directive.
+ static const int CXCursor_OMPTeamsDirective = 253;
+
+ /// OpenMP taskgroup directive.
+ static const int CXCursor_OMPTaskgroupDirective = 254;
+
+ /// OpenMP cancellation point directive.
+ static const int CXCursor_OMPCancellationPointDirective = 255;
+
+ /// OpenMP cancel directive.
+ static const int CXCursor_OMPCancelDirective = 256;
+
+ /// OpenMP target data directive.
+ static const int CXCursor_OMPTargetDataDirective = 257;
+
+ /// OpenMP taskloop directive.
+ static const int CXCursor_OMPTaskLoopDirective = 258;
+
+ /// OpenMP taskloop simd directive.
+ static const int CXCursor_OMPTaskLoopSimdDirective = 259;
+
+ /// OpenMP distribute directive.
+ static const int CXCursor_OMPDistributeDirective = 260;
+
+ /// OpenMP target enter data directive.
+ static const int CXCursor_OMPTargetEnterDataDirective = 261;
+
+ /// OpenMP target exit data directive.
+ static const int CXCursor_OMPTargetExitDataDirective = 262;
+
+ /// OpenMP target parallel directive.
+ static const int CXCursor_OMPTargetParallelDirective = 263;
+
+ /// OpenMP target parallel for directive.
+ static const int CXCursor_OMPTargetParallelForDirective = 264;
+
+ /// OpenMP target update directive.
+ static const int CXCursor_OMPTargetUpdateDirective = 265;
+
+ /// OpenMP distribute parallel for directive.
+ static const int CXCursor_OMPDistributeParallelForDirective = 266;
+
+ /// OpenMP distribute parallel for simd directive.
+ static const int CXCursor_OMPDistributeParallelForSimdDirective = 267;
+
+ /// OpenMP distribute simd directive.
+ static const int CXCursor_OMPDistributeSimdDirective = 268;
+
+ /// OpenMP target parallel for simd directive.
+ static const int CXCursor_OMPTargetParallelForSimdDirective = 269;
+
+ /// OpenMP target simd directive.
+ static const int CXCursor_OMPTargetSimdDirective = 270;
+
+ /// OpenMP teams distribute directive.
+ static const int CXCursor_OMPTeamsDistributeDirective = 271;
+
+ /// OpenMP teams distribute simd directive.
+ static const int CXCursor_OMPTeamsDistributeSimdDirective = 272;
+
+ /// OpenMP teams distribute parallel for simd directive.
+ static const int CXCursor_OMPTeamsDistributeParallelForSimdDirective = 273;
+
+ /// OpenMP teams distribute parallel for directive.
+ static const int CXCursor_OMPTeamsDistributeParallelForDirective = 274;
+
+ /// OpenMP target teams directive.
+ static const int CXCursor_OMPTargetTeamsDirective = 275;
+
+ /// OpenMP target teams distribute directive.
+ static const int CXCursor_OMPTargetTeamsDistributeDirective = 276;
+
+ /// OpenMP target teams distribute parallel for directive.
+ static const int CXCursor_OMPTargetTeamsDistributeParallelForDirective = 277;
+
+ /// OpenMP target teams distribute parallel for simd directive.
+ static const int CXCursor_OMPTargetTeamsDistributeParallelForSimdDirective =
+ 278;
+
+ /// OpenMP target teams distribute simd directive.
+ static const int CXCursor_OMPTargetTeamsDistributeSimdDirective = 279;
+
+ /// C++2a std::bit_cast expression.
+ static const int CXCursor_BuiltinBitCastExpr = 280;
+
+ /// OpenMP master taskloop directive.
+ static const int CXCursor_OMPMasterTaskLoopDirective = 281;
+
+ /// OpenMP parallel master taskloop directive.
+ static const int CXCursor_OMPParallelMasterTaskLoopDirective = 282;
+
+ /// OpenMP master taskloop simd directive.
+ static const int CXCursor_OMPMasterTaskLoopSimdDirective = 283;
+
+ /// OpenMP parallel master taskloop simd directive.
+ static const int CXCursor_OMPParallelMasterTaskLoopSimdDirective = 284;
+
+ /// OpenMP parallel master directive.
+ static const int CXCursor_OMPParallelMasterDirective = 285;
+ static const int CXCursor_LastStmt = 285;
+
+ /// Cursor that represents the translation unit itself.
+ static const int CXCursor_TranslationUnit = 300;
+ static const int CXCursor_FirstAttr = 400;
+
+ /// An attribute whose specific kind is not exposed via this interface.
+ static const int CXCursor_UnexposedAttr = 400;
+ static const int CXCursor_IBActionAttr = 401;
+ static const int CXCursor_IBOutletAttr = 402;
+ static const int CXCursor_IBOutletCollectionAttr = 403;
+ static const int CXCursor_CXXFinalAttr = 404;
+ static const int CXCursor_CXXOverrideAttr = 405;
+ static const int CXCursor_AnnotateAttr = 406;
+ static const int CXCursor_AsmLabelAttr = 407;
+ static const int CXCursor_PackedAttr = 408;
+ static const int CXCursor_PureAttr = 409;
+ static const int CXCursor_ConstAttr = 410;
+ static const int CXCursor_NoDuplicateAttr = 411;
+ static const int CXCursor_CUDAConstantAttr = 412;
+ static const int CXCursor_CUDADeviceAttr = 413;
+ static const int CXCursor_CUDAGlobalAttr = 414;
+ static const int CXCursor_CUDAHostAttr = 415;
+ static const int CXCursor_CUDASharedAttr = 416;
+ static const int CXCursor_VisibilityAttr = 417;
+ static const int CXCursor_DLLExport = 418;
+ static const int CXCursor_DLLImport = 419;
+ static const int CXCursor_NSReturnsRetained = 420;
+ static const int CXCursor_NSReturnsNotRetained = 421;
+ static const int CXCursor_NSReturnsAutoreleased = 422;
+ static const int CXCursor_NSConsumesSelf = 423;
+ static const int CXCursor_NSConsumed = 424;
+ static const int CXCursor_ObjCException = 425;
+ static const int CXCursor_ObjCNSObject = 426;
+ static const int CXCursor_ObjCIndependentClass = 427;
+ static const int CXCursor_ObjCPreciseLifetime = 428;
+ static const int CXCursor_ObjCReturnsInnerPointer = 429;
+ static const int CXCursor_ObjCRequiresSuper = 430;
+ static const int CXCursor_ObjCRootClass = 431;
+ static const int CXCursor_ObjCSubclassingRestricted = 432;
+ static const int CXCursor_ObjCExplicitProtocolImpl = 433;
+ static const int CXCursor_ObjCDesignatedInitializer = 434;
+ static const int CXCursor_ObjCRuntimeVisible = 435;
+ static const int CXCursor_ObjCBoxable = 436;
+ static const int CXCursor_FlagEnum = 437;
+ static const int CXCursor_ConvergentAttr = 438;
+ static const int CXCursor_WarnUnusedAttr = 439;
+ static const int CXCursor_WarnUnusedResultAttr = 440;
+ static const int CXCursor_AlignedAttr = 441;
+ static const int CXCursor_LastAttr = 441;
+ static const int CXCursor_PreprocessingDirective = 500;
+ static const int CXCursor_MacroDefinition = 501;
+ static const int CXCursor_MacroExpansion = 502;
+ static const int CXCursor_MacroInstantiation = 502;
+ static const int CXCursor_InclusionDirective = 503;
+ static const int CXCursor_FirstPreprocessing = 500;
+ static const int CXCursor_LastPreprocessing = 503;
+
+ /// A module import declaration.
+ static const int CXCursor_ModuleImportDecl = 600;
+ static const int CXCursor_TypeAliasTemplateDecl = 601;
+
+ /// A static_assert or _Static_assert node
+ static const int CXCursor_StaticAssert = 602;
+
+ /// a friend declaration.
+ static const int CXCursor_FriendDecl = 603;
+ static const int CXCursor_FirstExtraDecl = 600;
+ static const int CXCursor_LastExtraDecl = 603;
+
+ /// A code completion overload candidate.
+ static const int CXCursor_OverloadCandidate = 700;
+}
+
+/// A cursor representing some element in the abstract syntax tree for a
+/// translation unit.
+class CXCursor extends ffi.Struct {
+ @ffi.Int32()
+ int kind;
+
+ @ffi.Int32()
+ int xdata;
+
+ ffi.Pointer<ffi.Void> _unique_data_item_0;
+ ffi.Pointer<ffi.Void> _unique_data_item_1;
+ ffi.Pointer<ffi.Void> _unique_data_item_2;
+
+ /// Helper for array `data`.
+ ArrayHelper_CXCursor_data_level0 get data =>
+ ArrayHelper_CXCursor_data_level0(this, [3], 0, 0);
+}
+
+/// Helper for array `data` in struct `CXCursor`.
+class ArrayHelper_CXCursor_data_level0 {
+ final CXCursor _struct;
+ final List<int> dimensions;
+ final int level;
+ final int _absoluteIndex;
+ int get length => dimensions[level];
+ ArrayHelper_CXCursor_data_level0(
+ this._struct, this.dimensions, this.level, this._absoluteIndex);
+ void _checkBounds(int index) {
+ if (index >= length || index < 0) {
+ throw RangeError(
+ 'Dimension $level: index not in range 0..${length} exclusive.');
+ }
+ }
+
+ ffi.Pointer<ffi.Void> operator [](int index) {
+ _checkBounds(index);
+ switch (_absoluteIndex + index) {
+ case 0:
+ return _struct._unique_data_item_0;
+ case 1:
+ return _struct._unique_data_item_1;
+ case 2:
+ return _struct._unique_data_item_2;
+ default:
+ throw Exception('Invalid Array Helper generated.');
+ }
+ }
+
+ void operator []=(int index, ffi.Pointer<ffi.Void> value) {
+ _checkBounds(index);
+ switch (_absoluteIndex + index) {
+ case 0:
+ _struct._unique_data_item_0 = value;
+ break;
+ case 1:
+ _struct._unique_data_item_1 = value;
+ break;
+ case 2:
+ _struct._unique_data_item_2 = value;
+ break;
+ default:
+ throw Exception('Invalid Array Helper generated.');
+ }
+ }
+}
+
+/// Describe the linkage of the entity referred to by a cursor.
+class CXLinkageKind {
+ /// This value indicates that no linkage information is available for a
+ /// provided CXCursor.
+ static const int CXLinkage_Invalid = 0;
+
+ /// This is the linkage for variables, parameters, and so on that have
+ /// automatic storage. This covers normal (non-extern) local variables.
+ static const int CXLinkage_NoLinkage = 1;
+
+ /// This is the linkage for static variables and static functions.
+ static const int CXLinkage_Internal = 2;
+
+ /// This is the linkage for entities with external linkage that live in C++
+ /// anonymous namespaces.
+ static const int CXLinkage_UniqueExternal = 3;
+
+ /// This is the linkage for entities with true, external linkage.
+ static const int CXLinkage_External = 4;
+}
+
+class CXVisibilityKind {
+ /// This value indicates that no visibility information is available for a
+ /// provided CXCursor.
+ static const int CXVisibility_Invalid = 0;
+
+ /// Symbol not seen by the linker.
+ static const int CXVisibility_Hidden = 1;
+
+ /// Symbol seen by the linker but resolves to a symbol inside this object.
+ static const int CXVisibility_Protected = 2;
+
+ /// Symbol seen by the linker and acts like a normal symbol.
+ static const int CXVisibility_Default = 3;
+}
+
+/// Describes the availability of a given entity on a particular platform, e.g.,
+/// a particular class might only be available on Mac OS 10.7 or newer.
+class CXPlatformAvailability extends ffi.Struct {}
+
+/// Describe the "language" of the entity referred to by a cursor.
+class CXLanguageKind {
+ static const int CXLanguage_Invalid = 0;
+ static const int CXLanguage_C = 1;
+ static const int CXLanguage_ObjC = 2;
+ static const int CXLanguage_CPlusPlus = 3;
+}
+
+/// Describe the "thread-local storage (TLS) kind" of the declaration referred
+/// to by a cursor.
+class CXTLSKind {
+ static const int CXTLS_None = 0;
+ static const int CXTLS_Dynamic = 1;
+ static const int CXTLS_Static = 2;
+}
+
+class CXCursorSetImpl extends ffi.Struct {}
+
+/// Describes the kind of type
+class CXTypeKind {
+ /// Represents an invalid type (e.g., where no type is available).
+ static const int CXType_Invalid = 0;
+
+ /// A type whose specific kind is not exposed via this interface.
+ static const int CXType_Unexposed = 1;
+ static const int CXType_Void = 2;
+ static const int CXType_Bool = 3;
+ static const int CXType_Char_U = 4;
+ static const int CXType_UChar = 5;
+ static const int CXType_Char16 = 6;
+ static const int CXType_Char32 = 7;
+ static const int CXType_UShort = 8;
+ static const int CXType_UInt = 9;
+ static const int CXType_ULong = 10;
+ static const int CXType_ULongLong = 11;
+ static const int CXType_UInt128 = 12;
+ static const int CXType_Char_S = 13;
+ static const int CXType_SChar = 14;
+ static const int CXType_WChar = 15;
+ static const int CXType_Short = 16;
+ static const int CXType_Int = 17;
+ static const int CXType_Long = 18;
+ static const int CXType_LongLong = 19;
+ static const int CXType_Int128 = 20;
+ static const int CXType_Float = 21;
+ static const int CXType_Double = 22;
+ static const int CXType_LongDouble = 23;
+ static const int CXType_NullPtr = 24;
+ static const int CXType_Overload = 25;
+ static const int CXType_Dependent = 26;
+ static const int CXType_ObjCId = 27;
+ static const int CXType_ObjCClass = 28;
+ static const int CXType_ObjCSel = 29;
+ static const int CXType_Float128 = 30;
+ static const int CXType_Half = 31;
+ static const int CXType_Float16 = 32;
+ static const int CXType_ShortAccum = 33;
+ static const int CXType_Accum = 34;
+ static const int CXType_LongAccum = 35;
+ static const int CXType_UShortAccum = 36;
+ static const int CXType_UAccum = 37;
+ static const int CXType_ULongAccum = 38;
+ static const int CXType_FirstBuiltin = 2;
+ static const int CXType_LastBuiltin = 38;
+ static const int CXType_Complex = 100;
+ static const int CXType_Pointer = 101;
+ static const int CXType_BlockPointer = 102;
+ static const int CXType_LValueReference = 103;
+ static const int CXType_RValueReference = 104;
+ static const int CXType_Record = 105;
+ static const int CXType_Enum = 106;
+ static const int CXType_Typedef = 107;
+ static const int CXType_ObjCInterface = 108;
+ static const int CXType_ObjCObjectPointer = 109;
+ static const int CXType_FunctionNoProto = 110;
+ static const int CXType_FunctionProto = 111;
+ static const int CXType_ConstantArray = 112;
+ static const int CXType_Vector = 113;
+ static const int CXType_IncompleteArray = 114;
+ static const int CXType_VariableArray = 115;
+ static const int CXType_DependentSizedArray = 116;
+ static const int CXType_MemberPointer = 117;
+ static const int CXType_Auto = 118;
+
+ /// Represents a type that was referred to using an elaborated type keyword.
+ static const int CXType_Elaborated = 119;
+ static const int CXType_Pipe = 120;
+ static const int CXType_OCLImage1dRO = 121;
+ static const int CXType_OCLImage1dArrayRO = 122;
+ static const int CXType_OCLImage1dBufferRO = 123;
+ static const int CXType_OCLImage2dRO = 124;
+ static const int CXType_OCLImage2dArrayRO = 125;
+ static const int CXType_OCLImage2dDepthRO = 126;
+ static const int CXType_OCLImage2dArrayDepthRO = 127;
+ static const int CXType_OCLImage2dMSAARO = 128;
+ static const int CXType_OCLImage2dArrayMSAARO = 129;
+ static const int CXType_OCLImage2dMSAADepthRO = 130;
+ static const int CXType_OCLImage2dArrayMSAADepthRO = 131;
+ static const int CXType_OCLImage3dRO = 132;
+ static const int CXType_OCLImage1dWO = 133;
+ static const int CXType_OCLImage1dArrayWO = 134;
+ static const int CXType_OCLImage1dBufferWO = 135;
+ static const int CXType_OCLImage2dWO = 136;
+ static const int CXType_OCLImage2dArrayWO = 137;
+ static const int CXType_OCLImage2dDepthWO = 138;
+ static const int CXType_OCLImage2dArrayDepthWO = 139;
+ static const int CXType_OCLImage2dMSAAWO = 140;
+ static const int CXType_OCLImage2dArrayMSAAWO = 141;
+ static const int CXType_OCLImage2dMSAADepthWO = 142;
+ static const int CXType_OCLImage2dArrayMSAADepthWO = 143;
+ static const int CXType_OCLImage3dWO = 144;
+ static const int CXType_OCLImage1dRW = 145;
+ static const int CXType_OCLImage1dArrayRW = 146;
+ static const int CXType_OCLImage1dBufferRW = 147;
+ static const int CXType_OCLImage2dRW = 148;
+ static const int CXType_OCLImage2dArrayRW = 149;
+ static const int CXType_OCLImage2dDepthRW = 150;
+ static const int CXType_OCLImage2dArrayDepthRW = 151;
+ static const int CXType_OCLImage2dMSAARW = 152;
+ static const int CXType_OCLImage2dArrayMSAARW = 153;
+ static const int CXType_OCLImage2dMSAADepthRW = 154;
+ static const int CXType_OCLImage2dArrayMSAADepthRW = 155;
+ static const int CXType_OCLImage3dRW = 156;
+ static const int CXType_OCLSampler = 157;
+ static const int CXType_OCLEvent = 158;
+ static const int CXType_OCLQueue = 159;
+ static const int CXType_OCLReserveID = 160;
+ static const int CXType_ObjCObject = 161;
+ static const int CXType_ObjCTypeParam = 162;
+ static const int CXType_Attributed = 163;
+ static const int CXType_OCLIntelSubgroupAVCMcePayload = 164;
+ static const int CXType_OCLIntelSubgroupAVCImePayload = 165;
+ static const int CXType_OCLIntelSubgroupAVCRefPayload = 166;
+ static const int CXType_OCLIntelSubgroupAVCSicPayload = 167;
+ static const int CXType_OCLIntelSubgroupAVCMceResult = 168;
+ static const int CXType_OCLIntelSubgroupAVCImeResult = 169;
+ static const int CXType_OCLIntelSubgroupAVCRefResult = 170;
+ static const int CXType_OCLIntelSubgroupAVCSicResult = 171;
+ static const int CXType_OCLIntelSubgroupAVCImeResultSingleRefStreamout = 172;
+ static const int CXType_OCLIntelSubgroupAVCImeResultDualRefStreamout = 173;
+ static const int CXType_OCLIntelSubgroupAVCImeSingleRefStreamin = 174;
+ static const int CXType_OCLIntelSubgroupAVCImeDualRefStreamin = 175;
+ static const int CXType_ExtVector = 176;
+}
+
+/// Describes the calling convention of a function type
+class CXCallingConv {
+ static const int CXCallingConv_Default = 0;
+ static const int CXCallingConv_C = 1;
+ static const int CXCallingConv_X86StdCall = 2;
+ static const int CXCallingConv_X86FastCall = 3;
+ static const int CXCallingConv_X86ThisCall = 4;
+ static const int CXCallingConv_X86Pascal = 5;
+ static const int CXCallingConv_AAPCS = 6;
+ static const int CXCallingConv_AAPCS_VFP = 7;
+ static const int CXCallingConv_X86RegCall = 8;
+ static const int CXCallingConv_IntelOclBicc = 9;
+ static const int CXCallingConv_Win64 = 10;
+ static const int CXCallingConv_X86_64Win64 = 10;
+ static const int CXCallingConv_X86_64SysV = 11;
+ static const int CXCallingConv_X86VectorCall = 12;
+ static const int CXCallingConv_Swift = 13;
+ static const int CXCallingConv_PreserveMost = 14;
+ static const int CXCallingConv_PreserveAll = 15;
+ static const int CXCallingConv_AArch64VectorCall = 16;
+ static const int CXCallingConv_Invalid = 100;
+ static const int CXCallingConv_Unexposed = 200;
+}
+
+/// The type of an element in the abstract syntax tree.
+class CXType extends ffi.Struct {
+ @ffi.Int32()
+ int kind;
+
+ ffi.Pointer<ffi.Void> _unique_data_item_0;
+ ffi.Pointer<ffi.Void> _unique_data_item_1;
+
+ /// Helper for array `data`.
+ ArrayHelper_CXType_data_level0 get data =>
+ ArrayHelper_CXType_data_level0(this, [2], 0, 0);
+}
+
+/// Helper for array `data` in struct `CXType`.
+class ArrayHelper_CXType_data_level0 {
+ final CXType _struct;
+ final List<int> dimensions;
+ final int level;
+ final int _absoluteIndex;
+ int get length => dimensions[level];
+ ArrayHelper_CXType_data_level0(
+ this._struct, this.dimensions, this.level, this._absoluteIndex);
+ void _checkBounds(int index) {
+ if (index >= length || index < 0) {
+ throw RangeError(
+ 'Dimension $level: index not in range 0..${length} exclusive.');
+ }
+ }
+
+ ffi.Pointer<ffi.Void> operator [](int index) {
+ _checkBounds(index);
+ switch (_absoluteIndex + index) {
+ case 0:
+ return _struct._unique_data_item_0;
+ case 1:
+ return _struct._unique_data_item_1;
+ default:
+ throw Exception('Invalid Array Helper generated.');
+ }
+ }
+
+ void operator []=(int index, ffi.Pointer<ffi.Void> value) {
+ _checkBounds(index);
+ switch (_absoluteIndex + index) {
+ case 0:
+ _struct._unique_data_item_0 = value;
+ break;
+ case 1:
+ _struct._unique_data_item_1 = value;
+ break;
+ default:
+ throw Exception('Invalid Array Helper generated.');
+ }
+ }
+}
+
+/// Describes the kind of a template argument.
+class CXTemplateArgumentKind {
+ static const int CXTemplateArgumentKind_Null = 0;
+ static const int CXTemplateArgumentKind_Type = 1;
+ static const int CXTemplateArgumentKind_Declaration = 2;
+ static const int CXTemplateArgumentKind_NullPtr = 3;
+ static const int CXTemplateArgumentKind_Integral = 4;
+ static const int CXTemplateArgumentKind_Template = 5;
+ static const int CXTemplateArgumentKind_TemplateExpansion = 6;
+ static const int CXTemplateArgumentKind_Expression = 7;
+ static const int CXTemplateArgumentKind_Pack = 8;
+ static const int CXTemplateArgumentKind_Invalid = 9;
+}
+
+class CXTypeNullabilityKind {
+ /// Values of this type can never be null.
+ static const int CXTypeNullability_NonNull = 0;
+
+ /// Values of this type can be null.
+ static const int CXTypeNullability_Nullable = 1;
+
+ /// Whether values of this type can be null is (explicitly) unspecified. This
+ /// captures a (fairly rare) case where we can't conclude anything about the
+ /// nullability of the type even though it has been considered.
+ static const int CXTypeNullability_Unspecified = 2;
+
+ /// Nullability is not applicable to this type.
+ static const int CXTypeNullability_Invalid = 3;
+}
+
+/// List the possible error codes for clang_Type_getSizeOf,
+/// clang_Type_getAlignOf, clang_Type_getOffsetOf and clang_Cursor_getOffsetOf.
+class CXTypeLayoutError {
+ /// Type is of kind CXType_Invalid.
+ static const int CXTypeLayoutError_Invalid = -1;
+
+ /// The type is an incomplete Type.
+ static const int CXTypeLayoutError_Incomplete = -2;
+
+ /// The type is a dependent Type.
+ static const int CXTypeLayoutError_Dependent = -3;
+
+ /// The type is not a constant size type.
+ static const int CXTypeLayoutError_NotConstantSize = -4;
+
+ /// The Field name is not valid for this record.
+ static const int CXTypeLayoutError_InvalidFieldName = -5;
+
+ /// The type is undeduced.
+ static const int CXTypeLayoutError_Undeduced = -6;
+}
+
+class CXRefQualifierKind {
+ /// No ref-qualifier was provided.
+ static const int CXRefQualifier_None = 0;
+
+ /// An lvalue ref-qualifier was provided ( &).
+ static const int CXRefQualifier_LValue = 1;
+
+ /// An rvalue ref-qualifier was provided ( &&).
+ static const int CXRefQualifier_RValue = 2;
+}
+
+/// Represents the C++ access control level to a base class for a cursor with
+/// kind CX_CXXBaseSpecifier.
+class CX_CXXAccessSpecifier {
+ static const int CX_CXXInvalidAccessSpecifier = 0;
+ static const int CX_CXXPublic = 1;
+ static const int CX_CXXProtected = 2;
+ static const int CX_CXXPrivate = 3;
+}
+
+/// Represents the storage classes as declared in the source. CX_SC_Invalid was
+/// added for the case that the passed cursor in not a declaration.
+class CX_StorageClass {
+ static const int CX_SC_Invalid = 0;
+ static const int CX_SC_None = 1;
+ static const int CX_SC_Extern = 2;
+ static const int CX_SC_Static = 3;
+ static const int CX_SC_PrivateExtern = 4;
+ static const int CX_SC_OpenCLWorkGroupLocal = 5;
+ static const int CX_SC_Auto = 6;
+ static const int CX_SC_Register = 7;
+}
+
+/// Describes how the traversal of the children of a particular cursor should
+/// proceed after visiting a particular child cursor.
+class CXChildVisitResult {
+ /// Terminates the cursor traversal.
+ static const int CXChildVisit_Break = 0;
+
+ /// Continues the cursor traversal with the next sibling of the cursor just
+ /// visited, without visiting its children.
+ static const int CXChildVisit_Continue = 1;
+
+ /// Recursively traverse the children of this cursor, using the same visitor
+ /// and client data.
+ static const int CXChildVisit_Recurse = 2;
+}
+
+/// Properties for the printing policy.
+class CXPrintingPolicyProperty {
+ static const int CXPrintingPolicy_Indentation = 0;
+ static const int CXPrintingPolicy_SuppressSpecifiers = 1;
+ static const int CXPrintingPolicy_SuppressTagKeyword = 2;
+ static const int CXPrintingPolicy_IncludeTagDefinition = 3;
+ static const int CXPrintingPolicy_SuppressScope = 4;
+ static const int CXPrintingPolicy_SuppressUnwrittenScope = 5;
+ static const int CXPrintingPolicy_SuppressInitializers = 6;
+ static const int CXPrintingPolicy_ConstantArraySizeAsWritten = 7;
+ static const int CXPrintingPolicy_AnonymousTagLocations = 8;
+ static const int CXPrintingPolicy_SuppressStrongLifetime = 9;
+ static const int CXPrintingPolicy_SuppressLifetimeQualifiers = 10;
+ static const int CXPrintingPolicy_SuppressTemplateArgsInCXXConstructors = 11;
+ static const int CXPrintingPolicy_Bool = 12;
+ static const int CXPrintingPolicy_Restrict = 13;
+ static const int CXPrintingPolicy_Alignof = 14;
+ static const int CXPrintingPolicy_UnderscoreAlignof = 15;
+ static const int CXPrintingPolicy_UseVoidForZeroParams = 16;
+ static const int CXPrintingPolicy_TerseOutput = 17;
+ static const int CXPrintingPolicy_PolishForDeclaration = 18;
+ static const int CXPrintingPolicy_Half = 19;
+ static const int CXPrintingPolicy_MSWChar = 20;
+ static const int CXPrintingPolicy_IncludeNewlines = 21;
+ static const int CXPrintingPolicy_MSVCFormatting = 22;
+ static const int CXPrintingPolicy_ConstantsAsWritten = 23;
+ static const int CXPrintingPolicy_SuppressImplicitBase = 24;
+ static const int CXPrintingPolicy_FullyQualifiedName = 25;
+ static const int CXPrintingPolicy_LastProperty = 25;
+}
+
+/// Property attributes for a CXCursor_ObjCPropertyDecl.
+class CXObjCPropertyAttrKind {
+ static const int CXObjCPropertyAttr_noattr = 0;
+ static const int CXObjCPropertyAttr_readonly = 1;
+ static const int CXObjCPropertyAttr_getter = 2;
+ static const int CXObjCPropertyAttr_assign = 4;
+ static const int CXObjCPropertyAttr_readwrite = 8;
+ static const int CXObjCPropertyAttr_retain = 16;
+ static const int CXObjCPropertyAttr_copy = 32;
+ static const int CXObjCPropertyAttr_nonatomic = 64;
+ static const int CXObjCPropertyAttr_setter = 128;
+ static const int CXObjCPropertyAttr_atomic = 256;
+ static const int CXObjCPropertyAttr_weak = 512;
+ static const int CXObjCPropertyAttr_strong = 1024;
+ static const int CXObjCPropertyAttr_unsafe_unretained = 2048;
+ static const int CXObjCPropertyAttr_class = 4096;
+}
+
+/// 'Qualifiers' written next to the return and parameter types in Objective-C
+/// method declarations.
+class CXObjCDeclQualifierKind {
+ static const int CXObjCDeclQualifier_None = 0;
+ static const int CXObjCDeclQualifier_In = 1;
+ static const int CXObjCDeclQualifier_Inout = 2;
+ static const int CXObjCDeclQualifier_Out = 4;
+ static const int CXObjCDeclQualifier_Bycopy = 8;
+ static const int CXObjCDeclQualifier_Byref = 16;
+ static const int CXObjCDeclQualifier_Oneway = 32;
+}
+
+class CXNameRefFlags {
+ /// Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the range.
+ static const int CXNameRange_WantQualifier = 1;
+
+ /// Include the explicit template arguments, e.g. <int> in x.f<int>, in the
+ /// range.
+ static const int CXNameRange_WantTemplateArgs = 2;
+
+ /// If the name is non-contiguous, return the full spanning range.
+ static const int CXNameRange_WantSinglePiece = 4;
+}
+
+/// Describes a kind of token.
+class CXTokenKind {
+ /// A token that contains some kind of punctuation.
+ static const int CXToken_Punctuation = 0;
+
+ /// A language keyword.
+ static const int CXToken_Keyword = 1;
+
+ /// An identifier (that is not a keyword).
+ static const int CXToken_Identifier = 2;
+
+ /// A numeric, string, or character literal.
+ static const int CXToken_Literal = 3;
+
+ /// A comment.
+ static const int CXToken_Comment = 4;
+}
+
+/// Describes a single preprocessing token.
+class CXToken extends ffi.Struct {
+ @ffi.Uint32()
+ int _unique_int_data_item_0;
+ @ffi.Uint32()
+ int _unique_int_data_item_1;
+ @ffi.Uint32()
+ int _unique_int_data_item_2;
+ @ffi.Uint32()
+ int _unique_int_data_item_3;
+
+ /// Helper for array `int_data`.
+ ArrayHelper_CXToken_int_data_level0 get int_data =>
+ ArrayHelper_CXToken_int_data_level0(this, [4], 0, 0);
+ ffi.Pointer<ffi.Void> ptr_data;
+}
+
+/// Helper for array `int_data` in struct `CXToken`.
+class ArrayHelper_CXToken_int_data_level0 {
+ final CXToken _struct;
+ final List<int> dimensions;
+ final int level;
+ final int _absoluteIndex;
+ int get length => dimensions[level];
+ ArrayHelper_CXToken_int_data_level0(
+ this._struct, this.dimensions, this.level, this._absoluteIndex);
+ void _checkBounds(int index) {
+ if (index >= length || index < 0) {
+ throw RangeError(
+ 'Dimension $level: index not in range 0..${length} exclusive.');
+ }
+ }
+
+ int operator [](int index) {
+ _checkBounds(index);
+ switch (_absoluteIndex + index) {
+ case 0:
+ return _struct._unique_int_data_item_0;
+ case 1:
+ return _struct._unique_int_data_item_1;
+ case 2:
+ return _struct._unique_int_data_item_2;
+ case 3:
+ return _struct._unique_int_data_item_3;
+ default:
+ throw Exception('Invalid Array Helper generated.');
+ }
+ }
+
+ void operator []=(int index, int value) {
+ _checkBounds(index);
+ switch (_absoluteIndex + index) {
+ case 0:
+ _struct._unique_int_data_item_0 = value;
+ break;
+ case 1:
+ _struct._unique_int_data_item_1 = value;
+ break;
+ case 2:
+ _struct._unique_int_data_item_2 = value;
+ break;
+ case 3:
+ _struct._unique_int_data_item_3 = value;
+ break;
+ default:
+ throw Exception('Invalid Array Helper generated.');
+ }
+ }
+}
+
+/// A single result of code completion.
+class CXCompletionResult extends ffi.Struct {
+ /// The kind of entity that this completion refers to.
+ @ffi.Int32()
+ int CursorKind;
+
+ /// The code-completion string that describes how to insert this
+ /// code-completion result into the editing buffer.
+ ffi.Pointer<ffi.Void> CompletionString;
+}
+
+/// Describes a single piece of text within a code-completion string.
+class CXCompletionChunkKind {
+ /// A code-completion string that describes "optional" text that could be a
+ /// part of the template (but is not required).
+ static const int CXCompletionChunk_Optional = 0;
+
+ /// Text that a user would be expected to type to get this code-completion
+ /// result.
+ static const int CXCompletionChunk_TypedText = 1;
+
+ /// Text that should be inserted as part of a code-completion result.
+ static const int CXCompletionChunk_Text = 2;
+
+ /// Placeholder text that should be replaced by the user.
+ static const int CXCompletionChunk_Placeholder = 3;
+
+ /// Informative text that should be displayed but never inserted as part of
+ /// the template.
+ static const int CXCompletionChunk_Informative = 4;
+
+ /// Text that describes the current parameter when code-completion is
+ /// referring to function call, message send, or template specialization.
+ static const int CXCompletionChunk_CurrentParameter = 5;
+
+ /// A left parenthesis ('('), used to initiate a function call or signal the
+ /// beginning of a function parameter list.
+ static const int CXCompletionChunk_LeftParen = 6;
+
+ /// A right parenthesis (')'), used to finish a function call or signal the
+ /// end of a function parameter list.
+ static const int CXCompletionChunk_RightParen = 7;
+
+ /// A left bracket ('[').
+ static const int CXCompletionChunk_LeftBracket = 8;
+
+ /// A right bracket (']').
+ static const int CXCompletionChunk_RightBracket = 9;
+
+ /// A left brace ('{').
+ static const int CXCompletionChunk_LeftBrace = 10;
+
+ /// A right brace ('}').
+ static const int CXCompletionChunk_RightBrace = 11;
+
+ /// A left angle bracket ('<').
+ static const int CXCompletionChunk_LeftAngle = 12;
+
+ /// A right angle bracket ('>').
+ static const int CXCompletionChunk_RightAngle = 13;
+
+ /// A comma separator (',').
+ static const int CXCompletionChunk_Comma = 14;
+
+ /// Text that specifies the result type of a given result.
+ static const int CXCompletionChunk_ResultType = 15;
+
+ /// A colon (':').
+ static const int CXCompletionChunk_Colon = 16;
+
+ /// A semicolon (';').
+ static const int CXCompletionChunk_SemiColon = 17;
+
+ /// An '=' sign.
+ static const int CXCompletionChunk_Equal = 18;
+
+ /// Horizontal space (' ').
+ static const int CXCompletionChunk_HorizontalSpace = 19;
+
+ /// Vertical space ('\n'), after which it is generally a good idea to perform
+ /// indentation.
+ static const int CXCompletionChunk_VerticalSpace = 20;
+}
+
+/// Contains the results of code-completion.
+class CXCodeCompleteResults extends ffi.Struct {
+ /// The code-completion results.
+ ffi.Pointer<CXCompletionResult> Results;
+
+ /// The number of code-completion results stored in the Results array.
+ @ffi.Uint32()
+ int NumResults;
+}
+
+/// Flags that can be passed to clang_codeCompleteAt() to modify its behavior.
+class CXCodeComplete_Flags {
+ /// Whether to include macros within the set of code completions returned.
+ static const int CXCodeComplete_IncludeMacros = 1;
+
+ /// Whether to include code patterns for language constructs within the set of
+ /// code completions, e.g., for loops.
+ static const int CXCodeComplete_IncludeCodePatterns = 2;
+
+ /// Whether to include brief documentation within the set of code completions
+ /// returned.
+ static const int CXCodeComplete_IncludeBriefComments = 4;
+
+ /// Whether to speed up completion by omitting top- or namespace-level
+ /// entities defined in the preamble. There's no guarantee any particular
+ /// entity is omitted. This may be useful if the headers are indexed
+ /// externally.
+ static const int CXCodeComplete_SkipPreamble = 8;
+
+ /// Whether to include completions with small fix-its, e.g. change '.' to '->'
+ /// on member access, etc.
+ static const int CXCodeComplete_IncludeCompletionsWithFixIts = 16;
+}
+
+/// Bits that represent the context under which completion is occurring.
+class CXCompletionContext {
+ /// The context for completions is unexposed, as only Clang results should be
+ /// included. (This is equivalent to having no context bits set.)
+ static const int CXCompletionContext_Unexposed = 0;
+
+ /// Completions for any possible type should be included in the results.
+ static const int CXCompletionContext_AnyType = 1;
+
+ /// Completions for any possible value (variables, function calls, etc.)
+ /// should be included in the results.
+ static const int CXCompletionContext_AnyValue = 2;
+
+ /// Completions for values that resolve to an Objective-C object should be
+ /// included in the results.
+ static const int CXCompletionContext_ObjCObjectValue = 4;
+
+ /// Completions for values that resolve to an Objective-C selector should be
+ /// included in the results.
+ static const int CXCompletionContext_ObjCSelectorValue = 8;
+
+ /// Completions for values that resolve to a C++ class type should be included
+ /// in the results.
+ static const int CXCompletionContext_CXXClassTypeValue = 16;
+
+ /// Completions for fields of the member being accessed using the dot operator
+ /// should be included in the results.
+ static const int CXCompletionContext_DotMemberAccess = 32;
+
+ /// Completions for fields of the member being accessed using the arrow
+ /// operator should be included in the results.
+ static const int CXCompletionContext_ArrowMemberAccess = 64;
+
+ /// Completions for properties of the Objective-C object being accessed using
+ /// the dot operator should be included in the results.
+ static const int CXCompletionContext_ObjCPropertyAccess = 128;
+
+ /// Completions for enum tags should be included in the results.
+ static const int CXCompletionContext_EnumTag = 256;
+
+ /// Completions for union tags should be included in the results.
+ static const int CXCompletionContext_UnionTag = 512;
+
+ /// Completions for struct tags should be included in the results.
+ static const int CXCompletionContext_StructTag = 1024;
+
+ /// Completions for C++ class names should be included in the results.
+ static const int CXCompletionContext_ClassTag = 2048;
+
+ /// Completions for C++ namespaces and namespace aliases should be included in
+ /// the results.
+ static const int CXCompletionContext_Namespace = 4096;
+
+ /// Completions for C++ nested name specifiers should be included in the
+ /// results.
+ static const int CXCompletionContext_NestedNameSpecifier = 8192;
+
+ /// Completions for Objective-C interfaces (classes) should be included in the
+ /// results.
+ static const int CXCompletionContext_ObjCInterface = 16384;
+
+ /// Completions for Objective-C protocols should be included in the results.
+ static const int CXCompletionContext_ObjCProtocol = 32768;
+
+ /// Completions for Objective-C categories should be included in the results.
+ static const int CXCompletionContext_ObjCCategory = 65536;
+
+ /// Completions for Objective-C instance messages should be included in the
+ /// results.
+ static const int CXCompletionContext_ObjCInstanceMessage = 131072;
+
+ /// Completions for Objective-C class messages should be included in the
+ /// results.
+ static const int CXCompletionContext_ObjCClassMessage = 262144;
+
+ /// Completions for Objective-C selector names should be included in the
+ /// results.
+ static const int CXCompletionContext_ObjCSelectorName = 524288;
+
+ /// Completions for preprocessor macro names should be included in the
+ /// results.
+ static const int CXCompletionContext_MacroName = 1048576;
+
+ /// Natural language completions should be included in the results.
+ static const int CXCompletionContext_NaturalLanguage = 2097152;
+
+ /// #include file completions should be included in the results.
+ static const int CXCompletionContext_IncludedFile = 4194304;
+
+ /// The current context is unknown, so set all contexts.
+ static const int CXCompletionContext_Unknown = 8388607;
+}
+
+class CXEvalResultKind {
+ static const int CXEval_Int = 1;
+ static const int CXEval_Float = 2;
+ static const int CXEval_ObjCStrLiteral = 3;
+ static const int CXEval_StrLiteral = 4;
+ static const int CXEval_CFStr = 5;
+ static const int CXEval_Other = 6;
+ static const int CXEval_UnExposed = 0;
+}
+
+/// @{
+class CXVisitorResult {
+ static const int CXVisit_Break = 0;
+ static const int CXVisit_Continue = 1;
+}
+
+class CXCursorAndRangeVisitor extends ffi.Struct {}
+
+class CXResult {
+ /// Function returned successfully.
+ static const int CXResult_Success = 0;
+
+ /// One of the parameters was invalid for the function.
+ static const int CXResult_Invalid = 1;
+
+ /// The function was terminated by a callback (e.g. it returned CXVisit_Break)
+ static const int CXResult_VisitBreak = 2;
+}
+
+/// Source location passed to index callbacks.
+class CXIdxLoc extends ffi.Struct {
+ ffi.Pointer<ffi.Void> _unique_ptr_data_item_0;
+ ffi.Pointer<ffi.Void> _unique_ptr_data_item_1;
+
+ /// Helper for array `ptr_data`.
+ ArrayHelper_CXIdxLoc_ptr_data_level0 get ptr_data =>
+ ArrayHelper_CXIdxLoc_ptr_data_level0(this, [2], 0, 0);
+ @ffi.Uint32()
+ int int_data;
+}
+
+/// Helper for array `ptr_data` in struct `CXIdxLoc`.
+class ArrayHelper_CXIdxLoc_ptr_data_level0 {
+ final CXIdxLoc _struct;
+ final List<int> dimensions;
+ final int level;
+ final int _absoluteIndex;
+ int get length => dimensions[level];
+ ArrayHelper_CXIdxLoc_ptr_data_level0(
+ this._struct, this.dimensions, this.level, this._absoluteIndex);
+ void _checkBounds(int index) {
+ if (index >= length || index < 0) {
+ throw RangeError(
+ 'Dimension $level: index not in range 0..${length} exclusive.');
+ }
+ }
+
+ ffi.Pointer<ffi.Void> operator [](int index) {
+ _checkBounds(index);
+ switch (_absoluteIndex + index) {
+ case 0:
+ return _struct._unique_ptr_data_item_0;
+ case 1:
+ return _struct._unique_ptr_data_item_1;
+ default:
+ throw Exception('Invalid Array Helper generated.');
+ }
+ }
+
+ void operator []=(int index, ffi.Pointer<ffi.Void> value) {
+ _checkBounds(index);
+ switch (_absoluteIndex + index) {
+ case 0:
+ _struct._unique_ptr_data_item_0 = value;
+ break;
+ case 1:
+ _struct._unique_ptr_data_item_1 = value;
+ break;
+ default:
+ throw Exception('Invalid Array Helper generated.');
+ }
+ }
+}
+
+/// Data for ppIncludedFile callback.
+class CXIdxIncludedFileInfo extends ffi.Struct {}
+
+/// Data for IndexerCallbacks#importedASTFile.
+class CXIdxImportedASTFileInfo extends ffi.Struct {}
+
+class CXIdxEntityKind {
+ static const int CXIdxEntity_Unexposed = 0;
+ static const int CXIdxEntity_Typedef = 1;
+ static const int CXIdxEntity_Function = 2;
+ static const int CXIdxEntity_Variable = 3;
+ static const int CXIdxEntity_Field = 4;
+ static const int CXIdxEntity_EnumConstant = 5;
+ static const int CXIdxEntity_ObjCClass = 6;
+ static const int CXIdxEntity_ObjCProtocol = 7;
+ static const int CXIdxEntity_ObjCCategory = 8;
+ static const int CXIdxEntity_ObjCInstanceMethod = 9;
+ static const int CXIdxEntity_ObjCClassMethod = 10;
+ static const int CXIdxEntity_ObjCProperty = 11;
+ static const int CXIdxEntity_ObjCIvar = 12;
+ static const int CXIdxEntity_Enum = 13;
+ static const int CXIdxEntity_Struct = 14;
+ static const int CXIdxEntity_Union = 15;
+ static const int CXIdxEntity_CXXClass = 16;
+ static const int CXIdxEntity_CXXNamespace = 17;
+ static const int CXIdxEntity_CXXNamespaceAlias = 18;
+ static const int CXIdxEntity_CXXStaticVariable = 19;
+ static const int CXIdxEntity_CXXStaticMethod = 20;
+ static const int CXIdxEntity_CXXInstanceMethod = 21;
+ static const int CXIdxEntity_CXXConstructor = 22;
+ static const int CXIdxEntity_CXXDestructor = 23;
+ static const int CXIdxEntity_CXXConversionFunction = 24;
+ static const int CXIdxEntity_CXXTypeAlias = 25;
+ static const int CXIdxEntity_CXXInterface = 26;
+}
+
+class CXIdxEntityLanguage {
+ static const int CXIdxEntityLang_None = 0;
+ static const int CXIdxEntityLang_C = 1;
+ static const int CXIdxEntityLang_ObjC = 2;
+ static const int CXIdxEntityLang_CXX = 3;
+ static const int CXIdxEntityLang_Swift = 4;
+}
+
+/// Extra C++ template information for an entity. This can apply to:
+/// CXIdxEntity_Function CXIdxEntity_CXXClass CXIdxEntity_CXXStaticMethod
+/// CXIdxEntity_CXXInstanceMethod CXIdxEntity_CXXConstructor
+/// CXIdxEntity_CXXConversionFunction CXIdxEntity_CXXTypeAlias
+class CXIdxEntityCXXTemplateKind {
+ static const int CXIdxEntity_NonTemplate = 0;
+ static const int CXIdxEntity_Template = 1;
+ static const int CXIdxEntity_TemplatePartialSpecialization = 2;
+ static const int CXIdxEntity_TemplateSpecialization = 3;
+}
+
+class CXIdxAttrKind {
+ static const int CXIdxAttr_Unexposed = 0;
+ static const int CXIdxAttr_IBAction = 1;
+ static const int CXIdxAttr_IBOutlet = 2;
+ static const int CXIdxAttr_IBOutletCollection = 3;
+}
+
+class CXIdxAttrInfo extends ffi.Struct {}
+
+class CXIdxEntityInfo extends ffi.Struct {}
+
+class CXIdxContainerInfo extends ffi.Struct {}
+
+class CXIdxIBOutletCollectionAttrInfo extends ffi.Struct {}
+
+class CXIdxDeclInfoFlags {
+ static const int CXIdxDeclFlag_Skipped = 1;
+}
+
+class CXIdxDeclInfo extends ffi.Struct {}
+
+class CXIdxObjCContainerKind {
+ static const int CXIdxObjCContainer_ForwardRef = 0;
+ static const int CXIdxObjCContainer_Interface = 1;
+ static const int CXIdxObjCContainer_Implementation = 2;
+}
+
+class CXIdxObjCContainerDeclInfo extends ffi.Struct {
+ ffi.Pointer<CXIdxDeclInfo> declInfo;
+
+ @ffi.Int32()
+ int kind;
+}
+
+class CXIdxBaseClassInfo extends ffi.Struct {}
+
+class CXIdxObjCProtocolRefInfo extends ffi.Struct {}
+
+class CXIdxObjCProtocolRefListInfo extends ffi.Struct {
+ ffi.Pointer<ffi.Pointer<CXIdxObjCProtocolRefInfo>> protocols;
+
+ @ffi.Uint32()
+ int numProtocols;
+}
+
+class CXIdxObjCInterfaceDeclInfo extends ffi.Struct {
+ ffi.Pointer<CXIdxObjCContainerDeclInfo> containerInfo;
+
+ ffi.Pointer<CXIdxBaseClassInfo> superInfo;
+
+ ffi.Pointer<CXIdxObjCProtocolRefListInfo> protocols;
+}
+
+class CXIdxObjCCategoryDeclInfo extends ffi.Struct {}
+
+class CXIdxObjCPropertyDeclInfo extends ffi.Struct {
+ ffi.Pointer<CXIdxDeclInfo> declInfo;
+
+ ffi.Pointer<CXIdxEntityInfo> getter;
+
+ ffi.Pointer<CXIdxEntityInfo> setter;
+}
+
+class CXIdxCXXClassDeclInfo extends ffi.Struct {
+ ffi.Pointer<CXIdxDeclInfo> declInfo;
+
+ ffi.Pointer<ffi.Pointer<CXIdxBaseClassInfo>> bases;
+
+ @ffi.Uint32()
+ int numBases;
+}
+
+/// Data for IndexerCallbacks#indexEntityReference.
+class CXIdxEntityRefKind {
+ /// The entity is referenced directly in user's code.
+ static const int CXIdxEntityRef_Direct = 1;
+
+ /// An implicit reference, e.g. a reference of an Objective-C method via the
+ /// dot syntax.
+ static const int CXIdxEntityRef_Implicit = 2;
+}
+
+/// Roles that are attributed to symbol occurrences.
+class CXSymbolRole {
+ static const int CXSymbolRole_None = 0;
+ static const int CXSymbolRole_Declaration = 1;
+ static const int CXSymbolRole_Definition = 2;
+ static const int CXSymbolRole_Reference = 4;
+ static const int CXSymbolRole_Read = 8;
+ static const int CXSymbolRole_Write = 16;
+ static const int CXSymbolRole_Call = 32;
+ static const int CXSymbolRole_Dynamic = 64;
+ static const int CXSymbolRole_AddressOf = 128;
+ static const int CXSymbolRole_Implicit = 256;
+}
+
+/// Data for IndexerCallbacks#indexEntityReference.
+class CXIdxEntityRefInfo extends ffi.Struct {}
+
+/// A group of callbacks used by #clang_indexSourceFile and
+/// #clang_indexTranslationUnit.
+class IndexerCallbacks extends ffi.Struct {
+ /// Called periodically to check whether indexing should be aborted. Should
+ /// return 0 to continue, and non-zero to abort.
+ ffi.Pointer<ffi.NativeFunction<_typedefC_3>> abortQuery;
+
+ /// Called at the end of indexing; passes the complete diagnostic set.
+ ffi.Pointer<ffi.NativeFunction<_typedefC_4>> diagnostic;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_5>> enteredMainFile;
+
+ /// Called when a file gets #included/#imported.
+ ffi.Pointer<ffi.NativeFunction<_typedefC_6>> ppIncludedFile;
+
+ /// Called when a AST file (PCH or module) gets imported.
+ ffi.Pointer<ffi.NativeFunction<_typedefC_7>> importedASTFile;
+
+ /// Called at the beginning of indexing a translation unit.
+ ffi.Pointer<ffi.NativeFunction<_typedefC_8>> startedTranslationUnit;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_9>> indexDeclaration;
+
+ /// Called to index a reference of an entity.
+ ffi.Pointer<ffi.NativeFunction<_typedefC_10>> indexEntityReference;
+}
+
+class CXIndexOptFlags {
+ /// Used to indicate that no special indexing options are needed.
+ static const int CXIndexOpt_None = 0;
+
+ /// Used to indicate that IndexerCallbacks#indexEntityReference should be
+ /// invoked for only one reference of an entity per source file that does not
+ /// also include a declaration/definition of the entity.
+ static const int CXIndexOpt_SuppressRedundantRefs = 1;
+
+ /// Function-local symbols should be indexed. If this is not set
+ /// function-local symbols will be ignored.
+ static const int CXIndexOpt_IndexFunctionLocalSymbols = 2;
+
+ /// Implicit function/class template instantiations should be indexed. If this
+ /// is not set, implicit instantiations will be ignored.
+ static const int CXIndexOpt_IndexImplicitTemplateInstantiations = 4;
+
+ /// Suppress all compiler warnings when parsing for indexing.
+ static const int CXIndexOpt_SuppressWarnings = 8;
+
+ /// Skip a function/method body that was already parsed during an indexing
+ /// session associated with a CXIndexAction object. Bodies in system headers
+ /// are always skipped.
+ static const int CXIndexOpt_SkipParsedBodiesInSession = 16;
+}
+
+typedef _c_clang_disposeStringSet = ffi.Void Function(
+ ffi.Pointer<CXStringSet> set,
+);
+
+typedef _dart_clang_disposeStringSet = void Function(
+ ffi.Pointer<CXStringSet> set,
+);
+
+typedef _c_clang_getBuildSessionTimestamp = ffi.Uint64 Function();
+
+typedef _dart_clang_getBuildSessionTimestamp = int Function();
+
+typedef _c_clang_VirtualFileOverlay_create
+ = ffi.Pointer<CXVirtualFileOverlayImpl> Function(
+ ffi.Uint32 options,
+);
+
+typedef _dart_clang_VirtualFileOverlay_create
+ = ffi.Pointer<CXVirtualFileOverlayImpl> Function(
+ int options,
+);
+
+typedef _c_clang_VirtualFileOverlay_addFileMapping = ffi.Int32 Function(
+ ffi.Pointer<CXVirtualFileOverlayImpl> arg0,
+ ffi.Pointer<ffi.Int8> virtualPath,
+ ffi.Pointer<ffi.Int8> realPath,
+);
+
+typedef _dart_clang_VirtualFileOverlay_addFileMapping = int Function(
+ ffi.Pointer<CXVirtualFileOverlayImpl> arg0,
+ ffi.Pointer<ffi.Int8> virtualPath,
+ ffi.Pointer<ffi.Int8> realPath,
+);
+
+typedef _c_clang_VirtualFileOverlay_setCaseSensitivity = ffi.Int32 Function(
+ ffi.Pointer<CXVirtualFileOverlayImpl> arg0,
+ ffi.Int32 caseSensitive,
+);
+
+typedef _dart_clang_VirtualFileOverlay_setCaseSensitivity = int Function(
+ ffi.Pointer<CXVirtualFileOverlayImpl> arg0,
+ int caseSensitive,
+);
+
+typedef _c_clang_VirtualFileOverlay_writeToBuffer = ffi.Int32 Function(
+ ffi.Pointer<CXVirtualFileOverlayImpl> arg0,
+ ffi.Uint32 options,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> out_buffer_ptr,
+ ffi.Pointer<ffi.Uint32> out_buffer_size,
+);
+
+typedef _dart_clang_VirtualFileOverlay_writeToBuffer = int Function(
+ ffi.Pointer<CXVirtualFileOverlayImpl> arg0,
+ int options,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> out_buffer_ptr,
+ ffi.Pointer<ffi.Uint32> out_buffer_size,
+);
+
+typedef _c_clang_free = ffi.Void Function(
+ ffi.Pointer<ffi.Void> buffer,
+);
+
+typedef _dart_clang_free = void Function(
+ ffi.Pointer<ffi.Void> buffer,
+);
+
+typedef _c_clang_VirtualFileOverlay_dispose = ffi.Void Function(
+ ffi.Pointer<CXVirtualFileOverlayImpl> arg0,
+);
+
+typedef _dart_clang_VirtualFileOverlay_dispose = void Function(
+ ffi.Pointer<CXVirtualFileOverlayImpl> arg0,
+);
+
+typedef _c_clang_ModuleMapDescriptor_create
+ = ffi.Pointer<CXModuleMapDescriptorImpl> Function(
+ ffi.Uint32 options,
+);
+
+typedef _dart_clang_ModuleMapDescriptor_create
+ = ffi.Pointer<CXModuleMapDescriptorImpl> Function(
+ int options,
+);
+
+typedef _c_clang_ModuleMapDescriptor_setFrameworkModuleName = ffi.Int32
+ Function(
+ ffi.Pointer<CXModuleMapDescriptorImpl> arg0,
+ ffi.Pointer<ffi.Int8> name,
+);
+
+typedef _dart_clang_ModuleMapDescriptor_setFrameworkModuleName = int Function(
+ ffi.Pointer<CXModuleMapDescriptorImpl> arg0,
+ ffi.Pointer<ffi.Int8> name,
+);
+
+typedef _c_clang_ModuleMapDescriptor_setUmbrellaHeader = ffi.Int32 Function(
+ ffi.Pointer<CXModuleMapDescriptorImpl> arg0,
+ ffi.Pointer<ffi.Int8> name,
+);
+
+typedef _dart_clang_ModuleMapDescriptor_setUmbrellaHeader = int Function(
+ ffi.Pointer<CXModuleMapDescriptorImpl> arg0,
+ ffi.Pointer<ffi.Int8> name,
+);
+
+typedef _c_clang_ModuleMapDescriptor_writeToBuffer = ffi.Int32 Function(
+ ffi.Pointer<CXModuleMapDescriptorImpl> arg0,
+ ffi.Uint32 options,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> out_buffer_ptr,
+ ffi.Pointer<ffi.Uint32> out_buffer_size,
+);
+
+typedef _dart_clang_ModuleMapDescriptor_writeToBuffer = int Function(
+ ffi.Pointer<CXModuleMapDescriptorImpl> arg0,
+ int options,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> out_buffer_ptr,
+ ffi.Pointer<ffi.Uint32> out_buffer_size,
+);
+
+typedef _c_clang_ModuleMapDescriptor_dispose = ffi.Void Function(
+ ffi.Pointer<CXModuleMapDescriptorImpl> arg0,
+);
+
+typedef _dart_clang_ModuleMapDescriptor_dispose = void Function(
+ ffi.Pointer<CXModuleMapDescriptorImpl> arg0,
+);
+
+typedef _c_clang_createIndex = ffi.Pointer<ffi.Void> Function(
+ ffi.Int32 excludeDeclarationsFromPCH,
+ ffi.Int32 displayDiagnostics,
+);
+
+typedef _dart_clang_createIndex = ffi.Pointer<ffi.Void> Function(
+ int excludeDeclarationsFromPCH,
+ int displayDiagnostics,
+);
+
+typedef _c_clang_disposeIndex = ffi.Void Function(
+ ffi.Pointer<ffi.Void> index,
+);
+
+typedef _dart_clang_disposeIndex = void Function(
+ ffi.Pointer<ffi.Void> index,
+);
+
+typedef _c_clang_CXIndex_setGlobalOptions = ffi.Void Function(
+ ffi.Pointer<ffi.Void> arg0,
+ ffi.Uint32 options,
+);
+
+typedef _dart_clang_CXIndex_setGlobalOptions = void Function(
+ ffi.Pointer<ffi.Void> arg0,
+ int options,
+);
+
+typedef _c_clang_CXIndex_getGlobalOptions = ffi.Uint32 Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _dart_clang_CXIndex_getGlobalOptions = int Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _c_clang_CXIndex_setInvocationEmissionPathOption = ffi.Void Function(
+ ffi.Pointer<ffi.Void> arg0,
+ ffi.Pointer<ffi.Int8> Path,
+);
+
+typedef _dart_clang_CXIndex_setInvocationEmissionPathOption = void Function(
+ ffi.Pointer<ffi.Void> arg0,
+ ffi.Pointer<ffi.Int8> Path,
+);
+
+typedef _c_clang_getFileTime = ffi.Int64 Function(
+ ffi.Pointer<ffi.Void> SFile,
+);
+
+typedef _dart_clang_getFileTime = int Function(
+ ffi.Pointer<ffi.Void> SFile,
+);
+
+typedef _c_clang_getFileUniqueID = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void> file,
+ ffi.Pointer<CXFileUniqueID> outID,
+);
+
+typedef _dart_clang_getFileUniqueID = int Function(
+ ffi.Pointer<ffi.Void> file,
+ ffi.Pointer<CXFileUniqueID> outID,
+);
+
+typedef _c_clang_isFileMultipleIncludeGuarded = ffi.Uint32 Function(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+ ffi.Pointer<ffi.Void> file,
+);
+
+typedef _dart_clang_isFileMultipleIncludeGuarded = int Function(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+ ffi.Pointer<ffi.Void> file,
+);
+
+typedef _c_clang_getFile = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+ ffi.Pointer<ffi.Int8> file_name,
+);
+
+typedef _dart_clang_getFile = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+ ffi.Pointer<ffi.Int8> file_name,
+);
+
+typedef _c_clang_getFileContents = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+ ffi.Pointer<ffi.Void> file,
+ ffi.Pointer<ffi.Uint64> size,
+);
+
+typedef _dart_clang_getFileContents = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+ ffi.Pointer<ffi.Void> file,
+ ffi.Pointer<ffi.Uint64> size,
+);
+
+typedef _c_clang_File_isEqual = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void> file1,
+ ffi.Pointer<ffi.Void> file2,
+);
+
+typedef _dart_clang_File_isEqual = int Function(
+ ffi.Pointer<ffi.Void> file1,
+ ffi.Pointer<ffi.Void> file2,
+);
+
+typedef _c_clang_getSkippedRanges = ffi.Pointer<CXSourceRangeList> Function(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+ ffi.Pointer<ffi.Void> file,
+);
+
+typedef _dart_clang_getSkippedRanges = ffi.Pointer<CXSourceRangeList> Function(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+ ffi.Pointer<ffi.Void> file,
+);
+
+typedef _c_clang_getAllSkippedRanges = ffi.Pointer<CXSourceRangeList> Function(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+);
+
+typedef _dart_clang_getAllSkippedRanges = ffi.Pointer<CXSourceRangeList>
+ Function(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+);
+
+typedef _c_clang_disposeSourceRangeList = ffi.Void Function(
+ ffi.Pointer<CXSourceRangeList> ranges,
+);
+
+typedef _dart_clang_disposeSourceRangeList = void Function(
+ ffi.Pointer<CXSourceRangeList> ranges,
+);
+
+typedef _c_clang_getNumDiagnosticsInSet = ffi.Uint32 Function(
+ ffi.Pointer<ffi.Void> Diags,
+);
+
+typedef _dart_clang_getNumDiagnosticsInSet = int Function(
+ ffi.Pointer<ffi.Void> Diags,
+);
+
+typedef _c_clang_getDiagnosticInSet = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void> Diags,
+ ffi.Uint32 Index,
+);
+
+typedef _dart_clang_getDiagnosticInSet = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void> Diags,
+ int Index,
+);
+
+typedef _c_clang_loadDiagnostics = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Int8> file,
+ ffi.Pointer<ffi.Int32> error,
+ ffi.Pointer<CXString> errorString,
+);
+
+typedef _dart_clang_loadDiagnostics = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Int8> file,
+ ffi.Pointer<ffi.Int32> error,
+ ffi.Pointer<CXString> errorString,
+);
+
+typedef _c_clang_disposeDiagnosticSet = ffi.Void Function(
+ ffi.Pointer<ffi.Void> Diags,
+);
+
+typedef _dart_clang_disposeDiagnosticSet = void Function(
+ ffi.Pointer<ffi.Void> Diags,
+);
+
+typedef _c_clang_getChildDiagnostics = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void> D,
+);
+
+typedef _dart_clang_getChildDiagnostics = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void> D,
+);
+
+typedef _c_clang_getNumDiagnostics = ffi.Uint32 Function(
+ ffi.Pointer<CXTranslationUnitImpl> Unit,
+);
+
+typedef _dart_clang_getNumDiagnostics = int Function(
+ ffi.Pointer<CXTranslationUnitImpl> Unit,
+);
+
+typedef _c_clang_getDiagnostic = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<CXTranslationUnitImpl> Unit,
+ ffi.Uint32 Index,
+);
+
+typedef _dart_clang_getDiagnostic = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<CXTranslationUnitImpl> Unit,
+ int Index,
+);
+
+typedef _c_clang_getDiagnosticSetFromTU = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<CXTranslationUnitImpl> Unit,
+);
+
+typedef _dart_clang_getDiagnosticSetFromTU = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<CXTranslationUnitImpl> Unit,
+);
+
+typedef _c_clang_disposeDiagnostic = ffi.Void Function(
+ ffi.Pointer<ffi.Void> Diagnostic,
+);
+
+typedef _dart_clang_disposeDiagnostic = void Function(
+ ffi.Pointer<ffi.Void> Diagnostic,
+);
+
+typedef _c_clang_defaultDiagnosticDisplayOptions = ffi.Uint32 Function();
+
+typedef _dart_clang_defaultDiagnosticDisplayOptions = int Function();
+
+typedef _c_clang_getDiagnosticSeverity = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _dart_clang_getDiagnosticSeverity = int Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _c_clang_getDiagnosticCategory = ffi.Uint32 Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _dart_clang_getDiagnosticCategory = int Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _c_clang_getDiagnosticNumRanges = ffi.Uint32 Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _dart_clang_getDiagnosticNumRanges = int Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _c_clang_getDiagnosticNumFixIts = ffi.Uint32 Function(
+ ffi.Pointer<ffi.Void> Diagnostic,
+);
+
+typedef _dart_clang_getDiagnosticNumFixIts = int Function(
+ ffi.Pointer<ffi.Void> Diagnostic,
+);
+
+typedef _c_clang_createTranslationUnitFromSourceFile
+ = ffi.Pointer<CXTranslationUnitImpl> Function(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> source_filename,
+ ffi.Int32 num_clang_command_line_args,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> clang_command_line_args,
+ ffi.Uint32 num_unsaved_files,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+);
+
+typedef _dart_clang_createTranslationUnitFromSourceFile
+ = ffi.Pointer<CXTranslationUnitImpl> Function(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> source_filename,
+ int num_clang_command_line_args,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> clang_command_line_args,
+ int num_unsaved_files,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+);
+
+typedef _c_clang_createTranslationUnit = ffi.Pointer<CXTranslationUnitImpl>
+ Function(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> ast_filename,
+);
+
+typedef _dart_clang_createTranslationUnit = ffi.Pointer<CXTranslationUnitImpl>
+ Function(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> ast_filename,
+);
+
+typedef _c_clang_createTranslationUnit2 = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> ast_filename,
+ ffi.Pointer<ffi.Pointer<CXTranslationUnitImpl>> out_TU,
+);
+
+typedef _dart_clang_createTranslationUnit2 = int Function(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> ast_filename,
+ ffi.Pointer<ffi.Pointer<CXTranslationUnitImpl>> out_TU,
+);
+
+typedef _c_clang_defaultEditingTranslationUnitOptions = ffi.Uint32 Function();
+
+typedef _dart_clang_defaultEditingTranslationUnitOptions = int Function();
+
+typedef _c_clang_parseTranslationUnit = ffi.Pointer<CXTranslationUnitImpl>
+ Function(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> source_filename,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> command_line_args,
+ ffi.Int32 num_command_line_args,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ ffi.Uint32 num_unsaved_files,
+ ffi.Uint32 options,
+);
+
+typedef _dart_clang_parseTranslationUnit = ffi.Pointer<CXTranslationUnitImpl>
+ Function(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> source_filename,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> command_line_args,
+ int num_command_line_args,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ int num_unsaved_files,
+ int options,
+);
+
+typedef _c_clang_parseTranslationUnit2 = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> source_filename,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> command_line_args,
+ ffi.Int32 num_command_line_args,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ ffi.Uint32 num_unsaved_files,
+ ffi.Uint32 options,
+ ffi.Pointer<ffi.Pointer<CXTranslationUnitImpl>> out_TU,
+);
+
+typedef _dart_clang_parseTranslationUnit2 = int Function(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> source_filename,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> command_line_args,
+ int num_command_line_args,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ int num_unsaved_files,
+ int options,
+ ffi.Pointer<ffi.Pointer<CXTranslationUnitImpl>> out_TU,
+);
+
+typedef _c_clang_parseTranslationUnit2FullArgv = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> source_filename,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> command_line_args,
+ ffi.Int32 num_command_line_args,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ ffi.Uint32 num_unsaved_files,
+ ffi.Uint32 options,
+ ffi.Pointer<ffi.Pointer<CXTranslationUnitImpl>> out_TU,
+);
+
+typedef _dart_clang_parseTranslationUnit2FullArgv = int Function(
+ ffi.Pointer<ffi.Void> CIdx,
+ ffi.Pointer<ffi.Int8> source_filename,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> command_line_args,
+ int num_command_line_args,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ int num_unsaved_files,
+ int options,
+ ffi.Pointer<ffi.Pointer<CXTranslationUnitImpl>> out_TU,
+);
+
+typedef _c_clang_defaultSaveOptions = ffi.Uint32 Function(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+);
+
+typedef _dart_clang_defaultSaveOptions = int Function(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+);
+
+typedef _c_clang_saveTranslationUnit = ffi.Int32 Function(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+ ffi.Pointer<ffi.Int8> FileName,
+ ffi.Uint32 options,
+);
+
+typedef _dart_clang_saveTranslationUnit = int Function(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+ ffi.Pointer<ffi.Int8> FileName,
+ int options,
+);
+
+typedef _c_clang_suspendTranslationUnit = ffi.Uint32 Function(
+ ffi.Pointer<CXTranslationUnitImpl> arg0,
+);
+
+typedef _dart_clang_suspendTranslationUnit = int Function(
+ ffi.Pointer<CXTranslationUnitImpl> arg0,
+);
+
+typedef _c_clang_disposeTranslationUnit = ffi.Void Function(
+ ffi.Pointer<CXTranslationUnitImpl> arg0,
+);
+
+typedef _dart_clang_disposeTranslationUnit = void Function(
+ ffi.Pointer<CXTranslationUnitImpl> arg0,
+);
+
+typedef _c_clang_defaultReparseOptions = ffi.Uint32 Function(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+);
+
+typedef _dart_clang_defaultReparseOptions = int Function(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+);
+
+typedef _c_clang_reparseTranslationUnit = ffi.Int32 Function(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+ ffi.Uint32 num_unsaved_files,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ ffi.Uint32 options,
+);
+
+typedef _dart_clang_reparseTranslationUnit = int Function(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+ int num_unsaved_files,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ int options,
+);
+
+typedef _c_clang_getTUResourceUsageName = ffi.Pointer<ffi.Int8> Function(
+ ffi.Int32 kind,
+);
+
+typedef _dart_clang_getTUResourceUsageName = ffi.Pointer<ffi.Int8> Function(
+ int kind,
+);
+
+typedef _c_clang_getTranslationUnitTargetInfo = ffi.Pointer<CXTargetInfoImpl>
+ Function(
+ ffi.Pointer<CXTranslationUnitImpl> CTUnit,
+);
+
+typedef _dart_clang_getTranslationUnitTargetInfo = ffi.Pointer<CXTargetInfoImpl>
+ Function(
+ ffi.Pointer<CXTranslationUnitImpl> CTUnit,
+);
+
+typedef _c_clang_TargetInfo_dispose = ffi.Void Function(
+ ffi.Pointer<CXTargetInfoImpl> Info,
+);
+
+typedef _dart_clang_TargetInfo_dispose = void Function(
+ ffi.Pointer<CXTargetInfoImpl> Info,
+);
+
+typedef _c_clang_TargetInfo_getPointerWidth = ffi.Int32 Function(
+ ffi.Pointer<CXTargetInfoImpl> Info,
+);
+
+typedef _dart_clang_TargetInfo_getPointerWidth = int Function(
+ ffi.Pointer<CXTargetInfoImpl> Info,
+);
+
+typedef _c_clang_isDeclaration = ffi.Uint32 Function(
+ ffi.Int32 arg0,
+);
+
+typedef _dart_clang_isDeclaration = int Function(
+ int arg0,
+);
+
+typedef _c_clang_isReference = ffi.Uint32 Function(
+ ffi.Int32 arg0,
+);
+
+typedef _dart_clang_isReference = int Function(
+ int arg0,
+);
+
+typedef _c_clang_isExpression = ffi.Uint32 Function(
+ ffi.Int32 arg0,
+);
+
+typedef _dart_clang_isExpression = int Function(
+ int arg0,
+);
+
+typedef _c_clang_isStatement = ffi.Uint32 Function(
+ ffi.Int32 arg0,
+);
+
+typedef _dart_clang_isStatement = int Function(
+ int arg0,
+);
+
+typedef _c_clang_isAttribute = ffi.Uint32 Function(
+ ffi.Int32 arg0,
+);
+
+typedef _dart_clang_isAttribute = int Function(
+ int arg0,
+);
+
+typedef _c_clang_isInvalid = ffi.Uint32 Function(
+ ffi.Int32 arg0,
+);
+
+typedef _dart_clang_isInvalid = int Function(
+ int arg0,
+);
+
+typedef _c_clang_isTranslationUnit = ffi.Uint32 Function(
+ ffi.Int32 arg0,
+);
+
+typedef _dart_clang_isTranslationUnit = int Function(
+ int arg0,
+);
+
+typedef _c_clang_isPreprocessing = ffi.Uint32 Function(
+ ffi.Int32 arg0,
+);
+
+typedef _dart_clang_isPreprocessing = int Function(
+ int arg0,
+);
+
+typedef _c_clang_isUnexposed = ffi.Uint32 Function(
+ ffi.Int32 arg0,
+);
+
+typedef _dart_clang_isUnexposed = int Function(
+ int arg0,
+);
+
+typedef _c_clang_disposeCXPlatformAvailability = ffi.Void Function(
+ ffi.Pointer<CXPlatformAvailability> availability,
+);
+
+typedef _dart_clang_disposeCXPlatformAvailability = void Function(
+ ffi.Pointer<CXPlatformAvailability> availability,
+);
+
+typedef _c_clang_createCXCursorSet = ffi.Pointer<CXCursorSetImpl> Function();
+
+typedef _dart_clang_createCXCursorSet = ffi.Pointer<CXCursorSetImpl> Function();
+
+typedef _c_clang_disposeCXCursorSet = ffi.Void Function(
+ ffi.Pointer<CXCursorSetImpl> cset,
+);
+
+typedef _dart_clang_disposeCXCursorSet = void Function(
+ ffi.Pointer<CXCursorSetImpl> cset,
+);
+
+typedef _c_clang_disposeOverriddenCursors = ffi.Void Function(
+ ffi.Pointer<CXCursor> overridden,
+);
+
+typedef _dart_clang_disposeOverriddenCursors = void Function(
+ ffi.Pointer<CXCursor> overridden,
+);
+
+typedef _c_clang_PrintingPolicy_getProperty = ffi.Uint32 Function(
+ ffi.Pointer<ffi.Void> Policy,
+ ffi.Int32 Property,
+);
+
+typedef _dart_clang_PrintingPolicy_getProperty = int Function(
+ ffi.Pointer<ffi.Void> Policy,
+ int Property,
+);
+
+typedef _c_clang_PrintingPolicy_setProperty = ffi.Void Function(
+ ffi.Pointer<ffi.Void> Policy,
+ ffi.Int32 Property,
+ ffi.Uint32 Value,
+);
+
+typedef _dart_clang_PrintingPolicy_setProperty = void Function(
+ ffi.Pointer<ffi.Void> Policy,
+ int Property,
+ int Value,
+);
+
+typedef _c_clang_PrintingPolicy_dispose = ffi.Void Function(
+ ffi.Pointer<ffi.Void> Policy,
+);
+
+typedef _dart_clang_PrintingPolicy_dispose = void Function(
+ ffi.Pointer<ffi.Void> Policy,
+);
+
+typedef _c_clang_getModuleForFile = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<CXTranslationUnitImpl> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+);
+
+typedef _dart_clang_getModuleForFile = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<CXTranslationUnitImpl> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+);
+
+typedef _c_clang_Module_getASTFile = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void> Module,
+);
+
+typedef _dart_clang_Module_getASTFile = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void> Module,
+);
+
+typedef _c_clang_Module_getParent = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void> Module,
+);
+
+typedef _dart_clang_Module_getParent = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void> Module,
+);
+
+typedef _c_clang_Module_isSystem = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void> Module,
+);
+
+typedef _dart_clang_Module_isSystem = int Function(
+ ffi.Pointer<ffi.Void> Module,
+);
+
+typedef _c_clang_Module_getNumTopLevelHeaders = ffi.Uint32 Function(
+ ffi.Pointer<CXTranslationUnitImpl> arg0,
+ ffi.Pointer<ffi.Void> Module,
+);
+
+typedef _dart_clang_Module_getNumTopLevelHeaders = int Function(
+ ffi.Pointer<CXTranslationUnitImpl> arg0,
+ ffi.Pointer<ffi.Void> Module,
+);
+
+typedef _c_clang_Module_getTopLevelHeader = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<CXTranslationUnitImpl> arg0,
+ ffi.Pointer<ffi.Void> Module,
+ ffi.Uint32 Index,
+);
+
+typedef _dart_clang_Module_getTopLevelHeader = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<CXTranslationUnitImpl> arg0,
+ ffi.Pointer<ffi.Void> Module,
+ int Index,
+);
+
+typedef _c_clang_annotateTokens = ffi.Void Function(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+ ffi.Pointer<CXToken> Tokens,
+ ffi.Uint32 NumTokens,
+ ffi.Pointer<CXCursor> Cursors,
+);
+
+typedef _dart_clang_annotateTokens = void Function(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+ ffi.Pointer<CXToken> Tokens,
+ int NumTokens,
+ ffi.Pointer<CXCursor> Cursors,
+);
+
+typedef _c_clang_disposeTokens = ffi.Void Function(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+ ffi.Pointer<CXToken> Tokens,
+ ffi.Uint32 NumTokens,
+);
+
+typedef _dart_clang_disposeTokens = void Function(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+ ffi.Pointer<CXToken> Tokens,
+ int NumTokens,
+);
+
+typedef _c_clang_enableStackTraces = ffi.Void Function();
+
+typedef _dart_clang_enableStackTraces = void Function();
+
+typedef _typedefC_1 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_clang_executeOnThread = ffi.Void Function(
+ ffi.Pointer<ffi.NativeFunction<_typedefC_1>> fn,
+ ffi.Pointer<ffi.Void> user_data,
+ ffi.Uint32 stack_size,
+);
+
+typedef _dart_clang_executeOnThread = void Function(
+ ffi.Pointer<ffi.NativeFunction<_typedefC_1>> fn,
+ ffi.Pointer<ffi.Void> user_data,
+ int stack_size,
+);
+
+typedef _c_clang_getCompletionChunkKind = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void> completion_string,
+ ffi.Uint32 chunk_number,
+);
+
+typedef _dart_clang_getCompletionChunkKind = int Function(
+ ffi.Pointer<ffi.Void> completion_string,
+ int chunk_number,
+);
+
+typedef _c_clang_getCompletionChunkCompletionString = ffi.Pointer<ffi.Void>
+ Function(
+ ffi.Pointer<ffi.Void> completion_string,
+ ffi.Uint32 chunk_number,
+);
+
+typedef _dart_clang_getCompletionChunkCompletionString = ffi.Pointer<ffi.Void>
+ Function(
+ ffi.Pointer<ffi.Void> completion_string,
+ int chunk_number,
+);
+
+typedef _c_clang_getNumCompletionChunks = ffi.Uint32 Function(
+ ffi.Pointer<ffi.Void> completion_string,
+);
+
+typedef _dart_clang_getNumCompletionChunks = int Function(
+ ffi.Pointer<ffi.Void> completion_string,
+);
+
+typedef _c_clang_getCompletionPriority = ffi.Uint32 Function(
+ ffi.Pointer<ffi.Void> completion_string,
+);
+
+typedef _dart_clang_getCompletionPriority = int Function(
+ ffi.Pointer<ffi.Void> completion_string,
+);
+
+typedef _c_clang_getCompletionAvailability = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void> completion_string,
+);
+
+typedef _dart_clang_getCompletionAvailability = int Function(
+ ffi.Pointer<ffi.Void> completion_string,
+);
+
+typedef _c_clang_getCompletionNumAnnotations = ffi.Uint32 Function(
+ ffi.Pointer<ffi.Void> completion_string,
+);
+
+typedef _dart_clang_getCompletionNumAnnotations = int Function(
+ ffi.Pointer<ffi.Void> completion_string,
+);
+
+typedef _c_clang_getCompletionNumFixIts = ffi.Uint32 Function(
+ ffi.Pointer<CXCodeCompleteResults> results,
+ ffi.Uint32 completion_index,
+);
+
+typedef _dart_clang_getCompletionNumFixIts = int Function(
+ ffi.Pointer<CXCodeCompleteResults> results,
+ int completion_index,
+);
+
+typedef _c_clang_defaultCodeCompleteOptions = ffi.Uint32 Function();
+
+typedef _dart_clang_defaultCodeCompleteOptions = int Function();
+
+typedef _c_clang_codeCompleteAt = ffi.Pointer<CXCodeCompleteResults> Function(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+ ffi.Pointer<ffi.Int8> complete_filename,
+ ffi.Uint32 complete_line,
+ ffi.Uint32 complete_column,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ ffi.Uint32 num_unsaved_files,
+ ffi.Uint32 options,
+);
+
+typedef _dart_clang_codeCompleteAt = ffi.Pointer<CXCodeCompleteResults>
+ Function(
+ ffi.Pointer<CXTranslationUnitImpl> TU,
+ ffi.Pointer<ffi.Int8> complete_filename,
+ int complete_line,
+ int complete_column,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ int num_unsaved_files,
+ int options,
+);
+
+typedef _c_clang_sortCodeCompletionResults = ffi.Void Function(
+ ffi.Pointer<CXCompletionResult> Results,
+ ffi.Uint32 NumResults,
+);
+
+typedef _dart_clang_sortCodeCompletionResults = void Function(
+ ffi.Pointer<CXCompletionResult> Results,
+ int NumResults,
+);
+
+typedef _c_clang_disposeCodeCompleteResults = ffi.Void Function(
+ ffi.Pointer<CXCodeCompleteResults> Results,
+);
+
+typedef _dart_clang_disposeCodeCompleteResults = void Function(
+ ffi.Pointer<CXCodeCompleteResults> Results,
+);
+
+typedef _c_clang_codeCompleteGetNumDiagnostics = ffi.Uint32 Function(
+ ffi.Pointer<CXCodeCompleteResults> Results,
+);
+
+typedef _dart_clang_codeCompleteGetNumDiagnostics = int Function(
+ ffi.Pointer<CXCodeCompleteResults> Results,
+);
+
+typedef _c_clang_codeCompleteGetDiagnostic = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<CXCodeCompleteResults> Results,
+ ffi.Uint32 Index,
+);
+
+typedef _dart_clang_codeCompleteGetDiagnostic = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<CXCodeCompleteResults> Results,
+ int Index,
+);
+
+typedef _c_clang_codeCompleteGetContexts = ffi.Uint64 Function(
+ ffi.Pointer<CXCodeCompleteResults> Results,
+);
+
+typedef _dart_clang_codeCompleteGetContexts = int Function(
+ ffi.Pointer<CXCodeCompleteResults> Results,
+);
+
+typedef _c_clang_codeCompleteGetContainerKind = ffi.Int32 Function(
+ ffi.Pointer<CXCodeCompleteResults> Results,
+ ffi.Pointer<ffi.Uint32> IsIncomplete,
+);
+
+typedef _dart_clang_codeCompleteGetContainerKind = int Function(
+ ffi.Pointer<CXCodeCompleteResults> Results,
+ ffi.Pointer<ffi.Uint32> IsIncomplete,
+);
+
+typedef _c_clang_toggleCrashRecovery = ffi.Void Function(
+ ffi.Uint32 isEnabled,
+);
+
+typedef _dart_clang_toggleCrashRecovery = void Function(
+ int isEnabled,
+);
+
+typedef CXInclusionVisitor_1 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<CXSourceLocation>,
+ ffi.Uint32,
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_clang_getInclusions = ffi.Void Function(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+ ffi.Pointer<ffi.NativeFunction<CXInclusionVisitor_1>> visitor,
+ ffi.Pointer<ffi.Void> client_data,
+);
+
+typedef _dart_clang_getInclusions = void Function(
+ ffi.Pointer<CXTranslationUnitImpl> tu,
+ ffi.Pointer<ffi.NativeFunction<CXInclusionVisitor_1>> visitor,
+ ffi.Pointer<ffi.Void> client_data,
+);
+
+typedef _c_clang_EvalResult_getKind = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void> E,
+);
+
+typedef _dart_clang_EvalResult_getKind = int Function(
+ ffi.Pointer<ffi.Void> E,
+);
+
+typedef _c_clang_EvalResult_getAsInt = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void> E,
+);
+
+typedef _dart_clang_EvalResult_getAsInt = int Function(
+ ffi.Pointer<ffi.Void> E,
+);
+
+typedef _c_clang_EvalResult_getAsLongLong = ffi.Int64 Function(
+ ffi.Pointer<ffi.Void> E,
+);
+
+typedef _dart_clang_EvalResult_getAsLongLong = int Function(
+ ffi.Pointer<ffi.Void> E,
+);
+
+typedef _c_clang_EvalResult_isUnsignedInt = ffi.Uint32 Function(
+ ffi.Pointer<ffi.Void> E,
+);
+
+typedef _dart_clang_EvalResult_isUnsignedInt = int Function(
+ ffi.Pointer<ffi.Void> E,
+);
+
+typedef _c_clang_EvalResult_getAsUnsigned = ffi.Uint64 Function(
+ ffi.Pointer<ffi.Void> E,
+);
+
+typedef _dart_clang_EvalResult_getAsUnsigned = int Function(
+ ffi.Pointer<ffi.Void> E,
+);
+
+typedef _c_clang_EvalResult_getAsDouble = ffi.Double Function(
+ ffi.Pointer<ffi.Void> E,
+);
+
+typedef _dart_clang_EvalResult_getAsDouble = double Function(
+ ffi.Pointer<ffi.Void> E,
+);
+
+typedef _c_clang_EvalResult_getAsStr = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<ffi.Void> E,
+);
+
+typedef _dart_clang_EvalResult_getAsStr = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<ffi.Void> E,
+);
+
+typedef _c_clang_EvalResult_dispose = ffi.Void Function(
+ ffi.Pointer<ffi.Void> E,
+);
+
+typedef _dart_clang_EvalResult_dispose = void Function(
+ ffi.Pointer<ffi.Void> E,
+);
+
+typedef _c_clang_getRemappings = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Int8> path,
+);
+
+typedef _dart_clang_getRemappings = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Int8> path,
+);
+
+typedef _c_clang_getRemappingsFromFileList = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> filePaths,
+ ffi.Uint32 numFiles,
+);
+
+typedef _dart_clang_getRemappingsFromFileList = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> filePaths,
+ int numFiles,
+);
+
+typedef _c_clang_remap_getNumFiles = ffi.Uint32 Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _dart_clang_remap_getNumFiles = int Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _c_clang_remap_getFilenames = ffi.Void Function(
+ ffi.Pointer<ffi.Void> arg0,
+ ffi.Uint32 index,
+ ffi.Pointer<CXString> original,
+ ffi.Pointer<CXString> transformed,
+);
+
+typedef _dart_clang_remap_getFilenames = void Function(
+ ffi.Pointer<ffi.Void> arg0,
+ int index,
+ ffi.Pointer<CXString> original,
+ ffi.Pointer<CXString> transformed,
+);
+
+typedef _c_clang_remap_dispose = ffi.Void Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _dart_clang_remap_dispose = void Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _c_clang_index_isEntityObjCContainerKind = ffi.Int32 Function(
+ ffi.Int32 arg0,
+);
+
+typedef _dart_clang_index_isEntityObjCContainerKind = int Function(
+ int arg0,
+);
+
+typedef _c_clang_index_getObjCContainerDeclInfo
+ = ffi.Pointer<CXIdxObjCContainerDeclInfo> Function(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+);
+
+typedef _dart_clang_index_getObjCContainerDeclInfo
+ = ffi.Pointer<CXIdxObjCContainerDeclInfo> Function(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+);
+
+typedef _c_clang_index_getObjCInterfaceDeclInfo
+ = ffi.Pointer<CXIdxObjCInterfaceDeclInfo> Function(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+);
+
+typedef _dart_clang_index_getObjCInterfaceDeclInfo
+ = ffi.Pointer<CXIdxObjCInterfaceDeclInfo> Function(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+);
+
+typedef _c_clang_index_getObjCCategoryDeclInfo
+ = ffi.Pointer<CXIdxObjCCategoryDeclInfo> Function(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+);
+
+typedef _dart_clang_index_getObjCCategoryDeclInfo
+ = ffi.Pointer<CXIdxObjCCategoryDeclInfo> Function(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+);
+
+typedef _c_clang_index_getObjCProtocolRefListInfo
+ = ffi.Pointer<CXIdxObjCProtocolRefListInfo> Function(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+);
+
+typedef _dart_clang_index_getObjCProtocolRefListInfo
+ = ffi.Pointer<CXIdxObjCProtocolRefListInfo> Function(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+);
+
+typedef _c_clang_index_getObjCPropertyDeclInfo
+ = ffi.Pointer<CXIdxObjCPropertyDeclInfo> Function(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+);
+
+typedef _dart_clang_index_getObjCPropertyDeclInfo
+ = ffi.Pointer<CXIdxObjCPropertyDeclInfo> Function(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+);
+
+typedef _c_clang_index_getIBOutletCollectionAttrInfo
+ = ffi.Pointer<CXIdxIBOutletCollectionAttrInfo> Function(
+ ffi.Pointer<CXIdxAttrInfo> arg0,
+);
+
+typedef _dart_clang_index_getIBOutletCollectionAttrInfo
+ = ffi.Pointer<CXIdxIBOutletCollectionAttrInfo> Function(
+ ffi.Pointer<CXIdxAttrInfo> arg0,
+);
+
+typedef _c_clang_index_getCXXClassDeclInfo = ffi.Pointer<CXIdxCXXClassDeclInfo>
+ Function(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+);
+
+typedef _dart_clang_index_getCXXClassDeclInfo
+ = ffi.Pointer<CXIdxCXXClassDeclInfo> Function(
+ ffi.Pointer<CXIdxDeclInfo> arg0,
+);
+
+typedef _c_clang_index_getClientContainer = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<CXIdxContainerInfo> arg0,
+);
+
+typedef _dart_clang_index_getClientContainer = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<CXIdxContainerInfo> arg0,
+);
+
+typedef _c_clang_index_setClientContainer = ffi.Void Function(
+ ffi.Pointer<CXIdxContainerInfo> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+);
+
+typedef _dart_clang_index_setClientContainer = void Function(
+ ffi.Pointer<CXIdxContainerInfo> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+);
+
+typedef _c_clang_index_getClientEntity = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<CXIdxEntityInfo> arg0,
+);
+
+typedef _dart_clang_index_getClientEntity = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<CXIdxEntityInfo> arg0,
+);
+
+typedef _c_clang_index_setClientEntity = ffi.Void Function(
+ ffi.Pointer<CXIdxEntityInfo> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+);
+
+typedef _dart_clang_index_setClientEntity = void Function(
+ ffi.Pointer<CXIdxEntityInfo> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+);
+
+typedef _c_clang_IndexAction_create = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void> CIdx,
+);
+
+typedef _dart_clang_IndexAction_create = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void> CIdx,
+);
+
+typedef _c_clang_IndexAction_dispose = ffi.Void Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _dart_clang_IndexAction_dispose = void Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _c_clang_indexSourceFile = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void> arg0,
+ ffi.Pointer<ffi.Void> client_data,
+ ffi.Pointer<IndexerCallbacks> index_callbacks,
+ ffi.Uint32 index_callbacks_size,
+ ffi.Uint32 index_options,
+ ffi.Pointer<ffi.Int8> source_filename,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> command_line_args,
+ ffi.Int32 num_command_line_args,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ ffi.Uint32 num_unsaved_files,
+ ffi.Pointer<ffi.Pointer<CXTranslationUnitImpl>> out_TU,
+ ffi.Uint32 TU_options,
+);
+
+typedef _dart_clang_indexSourceFile = int Function(
+ ffi.Pointer<ffi.Void> arg0,
+ ffi.Pointer<ffi.Void> client_data,
+ ffi.Pointer<IndexerCallbacks> index_callbacks,
+ int index_callbacks_size,
+ int index_options,
+ ffi.Pointer<ffi.Int8> source_filename,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> command_line_args,
+ int num_command_line_args,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ int num_unsaved_files,
+ ffi.Pointer<ffi.Pointer<CXTranslationUnitImpl>> out_TU,
+ int TU_options,
+);
+
+typedef _c_clang_indexSourceFileFullArgv = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void> arg0,
+ ffi.Pointer<ffi.Void> client_data,
+ ffi.Pointer<IndexerCallbacks> index_callbacks,
+ ffi.Uint32 index_callbacks_size,
+ ffi.Uint32 index_options,
+ ffi.Pointer<ffi.Int8> source_filename,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> command_line_args,
+ ffi.Int32 num_command_line_args,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ ffi.Uint32 num_unsaved_files,
+ ffi.Pointer<ffi.Pointer<CXTranslationUnitImpl>> out_TU,
+ ffi.Uint32 TU_options,
+);
+
+typedef _dart_clang_indexSourceFileFullArgv = int Function(
+ ffi.Pointer<ffi.Void> arg0,
+ ffi.Pointer<ffi.Void> client_data,
+ ffi.Pointer<IndexerCallbacks> index_callbacks,
+ int index_callbacks_size,
+ int index_options,
+ ffi.Pointer<ffi.Int8> source_filename,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> command_line_args,
+ int num_command_line_args,
+ ffi.Pointer<CXUnsavedFile> unsaved_files,
+ int num_unsaved_files,
+ ffi.Pointer<ffi.Pointer<CXTranslationUnitImpl>> out_TU,
+ int TU_options,
+);
+
+typedef _c_clang_indexTranslationUnit = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void> arg0,
+ ffi.Pointer<ffi.Void> client_data,
+ ffi.Pointer<IndexerCallbacks> index_callbacks,
+ ffi.Uint32 index_callbacks_size,
+ ffi.Uint32 index_options,
+ ffi.Pointer<CXTranslationUnitImpl> arg5,
+);
+
+typedef _dart_clang_indexTranslationUnit = int Function(
+ ffi.Pointer<ffi.Void> arg0,
+ ffi.Pointer<ffi.Void> client_data,
+ ffi.Pointer<IndexerCallbacks> index_callbacks,
+ int index_callbacks_size,
+ int index_options,
+ ffi.Pointer<CXTranslationUnitImpl> arg5,
+);
+
+typedef _typedefC_3 = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _typedefC_4 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _typedefC_5 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _typedefC_6 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<CXIdxIncludedFileInfo>,
+);
+
+typedef _typedefC_7 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<CXIdxImportedASTFileInfo>,
+);
+
+typedef _typedefC_8 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _typedefC_9 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<CXIdxDeclInfo>,
+);
+
+typedef _typedefC_10 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<CXIdxEntityRefInfo>,
+);
diff --git a/test/large_integration_tests/_expected_sqlite_bindings.dart b/test/large_integration_tests/_expected_sqlite_bindings.dart
new file mode 100644
index 0000000..4f8ef6e
--- /dev/null
+++ b/test/large_integration_tests/_expected_sqlite_bindings.dart
@@ -0,0 +1,7751 @@
+/// AUTO GENERATED FILE, DO NOT EDIT.
+///
+/// Generated by `package:ffigen`.
+import 'dart:ffi' as ffi;
+
+/// Bindings to SQLite.
+class SQLite {
+ /// Holds the Dynamic library.
+ final ffi.DynamicLibrary _dylib;
+
+ /// The symbols are looked up in [dynamicLibrary].
+ SQLite(ffi.DynamicLibrary dynamicLibrary) : _dylib = dynamicLibrary;
+
+ ffi.Pointer<ffi.Int8> sqlite3_libversion() {
+ _sqlite3_libversion ??=
+ _dylib.lookupFunction<_c_sqlite3_libversion, _dart_sqlite3_libversion>(
+ 'sqlite3_libversion');
+ return _sqlite3_libversion();
+ }
+
+ _dart_sqlite3_libversion _sqlite3_libversion;
+
+ ffi.Pointer<ffi.Int8> sqlite3_sourceid() {
+ _sqlite3_sourceid ??=
+ _dylib.lookupFunction<_c_sqlite3_sourceid, _dart_sqlite3_sourceid>(
+ 'sqlite3_sourceid');
+ return _sqlite3_sourceid();
+ }
+
+ _dart_sqlite3_sourceid _sqlite3_sourceid;
+
+ int sqlite3_libversion_number() {
+ _sqlite3_libversion_number ??= _dylib.lookupFunction<
+ _c_sqlite3_libversion_number,
+ _dart_sqlite3_libversion_number>('sqlite3_libversion_number');
+ return _sqlite3_libversion_number();
+ }
+
+ _dart_sqlite3_libversion_number _sqlite3_libversion_number;
+
+ int sqlite3_compileoption_used(
+ ffi.Pointer<ffi.Int8> zOptName,
+ ) {
+ _sqlite3_compileoption_used ??= _dylib.lookupFunction<
+ _c_sqlite3_compileoption_used,
+ _dart_sqlite3_compileoption_used>('sqlite3_compileoption_used');
+ return _sqlite3_compileoption_used(
+ zOptName,
+ );
+ }
+
+ _dart_sqlite3_compileoption_used _sqlite3_compileoption_used;
+
+ ffi.Pointer<ffi.Int8> sqlite3_compileoption_get(
+ int N,
+ ) {
+ _sqlite3_compileoption_get ??= _dylib.lookupFunction<
+ _c_sqlite3_compileoption_get,
+ _dart_sqlite3_compileoption_get>('sqlite3_compileoption_get');
+ return _sqlite3_compileoption_get(
+ N,
+ );
+ }
+
+ _dart_sqlite3_compileoption_get _sqlite3_compileoption_get;
+
+ int sqlite3_threadsafe() {
+ _sqlite3_threadsafe ??=
+ _dylib.lookupFunction<_c_sqlite3_threadsafe, _dart_sqlite3_threadsafe>(
+ 'sqlite3_threadsafe');
+ return _sqlite3_threadsafe();
+ }
+
+ _dart_sqlite3_threadsafe _sqlite3_threadsafe;
+
+ int sqlite3_close(
+ ffi.Pointer<sqlite3> arg0,
+ ) {
+ _sqlite3_close ??= _dylib
+ .lookupFunction<_c_sqlite3_close, _dart_sqlite3_close>('sqlite3_close');
+ return _sqlite3_close(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_close _sqlite3_close;
+
+ int sqlite3_close_v2(
+ ffi.Pointer<sqlite3> arg0,
+ ) {
+ _sqlite3_close_v2 ??=
+ _dylib.lookupFunction<_c_sqlite3_close_v2, _dart_sqlite3_close_v2>(
+ 'sqlite3_close_v2');
+ return _sqlite3_close_v2(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_close_v2 _sqlite3_close_v2;
+
+ int sqlite3_exec(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> sql,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_13>> callback,
+ ffi.Pointer<ffi.Void> arg3,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> errmsg,
+ ) {
+ _sqlite3_exec ??= _dylib
+ .lookupFunction<_c_sqlite3_exec, _dart_sqlite3_exec>('sqlite3_exec');
+ return _sqlite3_exec(
+ arg0,
+ sql,
+ callback,
+ arg3,
+ errmsg,
+ );
+ }
+
+ _dart_sqlite3_exec _sqlite3_exec;
+
+ int sqlite3_initialize() {
+ _sqlite3_initialize ??=
+ _dylib.lookupFunction<_c_sqlite3_initialize, _dart_sqlite3_initialize>(
+ 'sqlite3_initialize');
+ return _sqlite3_initialize();
+ }
+
+ _dart_sqlite3_initialize _sqlite3_initialize;
+
+ int sqlite3_shutdown() {
+ _sqlite3_shutdown ??=
+ _dylib.lookupFunction<_c_sqlite3_shutdown, _dart_sqlite3_shutdown>(
+ 'sqlite3_shutdown');
+ return _sqlite3_shutdown();
+ }
+
+ _dart_sqlite3_shutdown _sqlite3_shutdown;
+
+ int sqlite3_os_init() {
+ _sqlite3_os_init ??=
+ _dylib.lookupFunction<_c_sqlite3_os_init, _dart_sqlite3_os_init>(
+ 'sqlite3_os_init');
+ return _sqlite3_os_init();
+ }
+
+ _dart_sqlite3_os_init _sqlite3_os_init;
+
+ int sqlite3_os_end() {
+ _sqlite3_os_end ??=
+ _dylib.lookupFunction<_c_sqlite3_os_end, _dart_sqlite3_os_end>(
+ 'sqlite3_os_end');
+ return _sqlite3_os_end();
+ }
+
+ _dart_sqlite3_os_end _sqlite3_os_end;
+
+ int sqlite3_config(
+ int arg0,
+ ) {
+ _sqlite3_config ??=
+ _dylib.lookupFunction<_c_sqlite3_config, _dart_sqlite3_config>(
+ 'sqlite3_config');
+ return _sqlite3_config(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_config _sqlite3_config;
+
+ int sqlite3_db_config(
+ ffi.Pointer<sqlite3> arg0,
+ int op,
+ ) {
+ _sqlite3_db_config ??=
+ _dylib.lookupFunction<_c_sqlite3_db_config, _dart_sqlite3_db_config>(
+ 'sqlite3_db_config');
+ return _sqlite3_db_config(
+ arg0,
+ op,
+ );
+ }
+
+ _dart_sqlite3_db_config _sqlite3_db_config;
+
+ int sqlite3_extended_result_codes(
+ ffi.Pointer<sqlite3> arg0,
+ int onoff,
+ ) {
+ _sqlite3_extended_result_codes ??= _dylib.lookupFunction<
+ _c_sqlite3_extended_result_codes,
+ _dart_sqlite3_extended_result_codes>('sqlite3_extended_result_codes');
+ return _sqlite3_extended_result_codes(
+ arg0,
+ onoff,
+ );
+ }
+
+ _dart_sqlite3_extended_result_codes _sqlite3_extended_result_codes;
+
+ int sqlite3_last_insert_rowid(
+ ffi.Pointer<sqlite3> arg0,
+ ) {
+ _sqlite3_last_insert_rowid ??= _dylib.lookupFunction<
+ _c_sqlite3_last_insert_rowid,
+ _dart_sqlite3_last_insert_rowid>('sqlite3_last_insert_rowid');
+ return _sqlite3_last_insert_rowid(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_last_insert_rowid _sqlite3_last_insert_rowid;
+
+ void sqlite3_set_last_insert_rowid(
+ ffi.Pointer<sqlite3> arg0,
+ int arg1,
+ ) {
+ _sqlite3_set_last_insert_rowid ??= _dylib.lookupFunction<
+ _c_sqlite3_set_last_insert_rowid,
+ _dart_sqlite3_set_last_insert_rowid>('sqlite3_set_last_insert_rowid');
+ return _sqlite3_set_last_insert_rowid(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_set_last_insert_rowid _sqlite3_set_last_insert_rowid;
+
+ int sqlite3_changes(
+ ffi.Pointer<sqlite3> arg0,
+ ) {
+ _sqlite3_changes ??=
+ _dylib.lookupFunction<_c_sqlite3_changes, _dart_sqlite3_changes>(
+ 'sqlite3_changes');
+ return _sqlite3_changes(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_changes _sqlite3_changes;
+
+ int sqlite3_total_changes(
+ ffi.Pointer<sqlite3> arg0,
+ ) {
+ _sqlite3_total_changes ??= _dylib.lookupFunction<_c_sqlite3_total_changes,
+ _dart_sqlite3_total_changes>('sqlite3_total_changes');
+ return _sqlite3_total_changes(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_total_changes _sqlite3_total_changes;
+
+ void sqlite3_interrupt(
+ ffi.Pointer<sqlite3> arg0,
+ ) {
+ _sqlite3_interrupt ??=
+ _dylib.lookupFunction<_c_sqlite3_interrupt, _dart_sqlite3_interrupt>(
+ 'sqlite3_interrupt');
+ return _sqlite3_interrupt(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_interrupt _sqlite3_interrupt;
+
+ int sqlite3_complete(
+ ffi.Pointer<ffi.Int8> sql,
+ ) {
+ _sqlite3_complete ??=
+ _dylib.lookupFunction<_c_sqlite3_complete, _dart_sqlite3_complete>(
+ 'sqlite3_complete');
+ return _sqlite3_complete(
+ sql,
+ );
+ }
+
+ _dart_sqlite3_complete _sqlite3_complete;
+
+ int sqlite3_complete16(
+ ffi.Pointer<ffi.Void> sql,
+ ) {
+ _sqlite3_complete16 ??=
+ _dylib.lookupFunction<_c_sqlite3_complete16, _dart_sqlite3_complete16>(
+ 'sqlite3_complete16');
+ return _sqlite3_complete16(
+ sql,
+ );
+ }
+
+ _dart_sqlite3_complete16 _sqlite3_complete16;
+
+ int sqlite3_busy_handler(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_32>> arg1,
+ ffi.Pointer<ffi.Void> arg2,
+ ) {
+ _sqlite3_busy_handler ??= _dylib.lookupFunction<_c_sqlite3_busy_handler,
+ _dart_sqlite3_busy_handler>('sqlite3_busy_handler');
+ return _sqlite3_busy_handler(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_busy_handler _sqlite3_busy_handler;
+
+ int sqlite3_busy_timeout(
+ ffi.Pointer<sqlite3> arg0,
+ int ms,
+ ) {
+ _sqlite3_busy_timeout ??= _dylib.lookupFunction<_c_sqlite3_busy_timeout,
+ _dart_sqlite3_busy_timeout>('sqlite3_busy_timeout');
+ return _sqlite3_busy_timeout(
+ arg0,
+ ms,
+ );
+ }
+
+ _dart_sqlite3_busy_timeout _sqlite3_busy_timeout;
+
+ int sqlite3_get_table(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSql,
+ ffi.Pointer<ffi.Pointer<ffi.Pointer<ffi.Int8>>> pazResult,
+ ffi.Pointer<ffi.Int32> pnRow,
+ ffi.Pointer<ffi.Int32> pnColumn,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzErrmsg,
+ ) {
+ _sqlite3_get_table ??=
+ _dylib.lookupFunction<_c_sqlite3_get_table, _dart_sqlite3_get_table>(
+ 'sqlite3_get_table');
+ return _sqlite3_get_table(
+ db,
+ zSql,
+ pazResult,
+ pnRow,
+ pnColumn,
+ pzErrmsg,
+ );
+ }
+
+ _dart_sqlite3_get_table _sqlite3_get_table;
+
+ void sqlite3_free_table(
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> result,
+ ) {
+ _sqlite3_free_table ??=
+ _dylib.lookupFunction<_c_sqlite3_free_table, _dart_sqlite3_free_table>(
+ 'sqlite3_free_table');
+ return _sqlite3_free_table(
+ result,
+ );
+ }
+
+ _dart_sqlite3_free_table _sqlite3_free_table;
+
+ ffi.Pointer<ffi.Int8> sqlite3_mprintf(
+ ffi.Pointer<ffi.Int8> arg0,
+ ) {
+ _sqlite3_mprintf ??=
+ _dylib.lookupFunction<_c_sqlite3_mprintf, _dart_sqlite3_mprintf>(
+ 'sqlite3_mprintf');
+ return _sqlite3_mprintf(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_mprintf _sqlite3_mprintf;
+
+ ffi.Pointer<ffi.Int8> sqlite3_snprintf(
+ int arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ ffi.Pointer<ffi.Int8> arg2,
+ ) {
+ _sqlite3_snprintf ??=
+ _dylib.lookupFunction<_c_sqlite3_snprintf, _dart_sqlite3_snprintf>(
+ 'sqlite3_snprintf');
+ return _sqlite3_snprintf(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_snprintf _sqlite3_snprintf;
+
+ ffi.Pointer<ffi.Void> sqlite3_malloc(
+ int arg0,
+ ) {
+ _sqlite3_malloc ??=
+ _dylib.lookupFunction<_c_sqlite3_malloc, _dart_sqlite3_malloc>(
+ 'sqlite3_malloc');
+ return _sqlite3_malloc(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_malloc _sqlite3_malloc;
+
+ ffi.Pointer<ffi.Void> sqlite3_malloc64(
+ int arg0,
+ ) {
+ _sqlite3_malloc64 ??=
+ _dylib.lookupFunction<_c_sqlite3_malloc64, _dart_sqlite3_malloc64>(
+ 'sqlite3_malloc64');
+ return _sqlite3_malloc64(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_malloc64 _sqlite3_malloc64;
+
+ ffi.Pointer<ffi.Void> sqlite3_realloc(
+ ffi.Pointer<ffi.Void> arg0,
+ int arg1,
+ ) {
+ _sqlite3_realloc ??=
+ _dylib.lookupFunction<_c_sqlite3_realloc, _dart_sqlite3_realloc>(
+ 'sqlite3_realloc');
+ return _sqlite3_realloc(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_realloc _sqlite3_realloc;
+
+ ffi.Pointer<ffi.Void> sqlite3_realloc64(
+ ffi.Pointer<ffi.Void> arg0,
+ int arg1,
+ ) {
+ _sqlite3_realloc64 ??=
+ _dylib.lookupFunction<_c_sqlite3_realloc64, _dart_sqlite3_realloc64>(
+ 'sqlite3_realloc64');
+ return _sqlite3_realloc64(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_realloc64 _sqlite3_realloc64;
+
+ void sqlite3_free(
+ ffi.Pointer<ffi.Void> arg0,
+ ) {
+ _sqlite3_free ??= _dylib
+ .lookupFunction<_c_sqlite3_free, _dart_sqlite3_free>('sqlite3_free');
+ return _sqlite3_free(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_free _sqlite3_free;
+
+ int sqlite3_msize(
+ ffi.Pointer<ffi.Void> arg0,
+ ) {
+ _sqlite3_msize ??= _dylib
+ .lookupFunction<_c_sqlite3_msize, _dart_sqlite3_msize>('sqlite3_msize');
+ return _sqlite3_msize(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_msize _sqlite3_msize;
+
+ int sqlite3_memory_used() {
+ _sqlite3_memory_used ??= _dylib.lookupFunction<_c_sqlite3_memory_used,
+ _dart_sqlite3_memory_used>('sqlite3_memory_used');
+ return _sqlite3_memory_used();
+ }
+
+ _dart_sqlite3_memory_used _sqlite3_memory_used;
+
+ int sqlite3_memory_highwater(
+ int resetFlag,
+ ) {
+ _sqlite3_memory_highwater ??= _dylib.lookupFunction<
+ _c_sqlite3_memory_highwater,
+ _dart_sqlite3_memory_highwater>('sqlite3_memory_highwater');
+ return _sqlite3_memory_highwater(
+ resetFlag,
+ );
+ }
+
+ _dart_sqlite3_memory_highwater _sqlite3_memory_highwater;
+
+ void sqlite3_randomness(
+ int N,
+ ffi.Pointer<ffi.Void> P,
+ ) {
+ _sqlite3_randomness ??=
+ _dylib.lookupFunction<_c_sqlite3_randomness, _dart_sqlite3_randomness>(
+ 'sqlite3_randomness');
+ return _sqlite3_randomness(
+ N,
+ P,
+ );
+ }
+
+ _dart_sqlite3_randomness _sqlite3_randomness;
+
+ int sqlite3_set_authorizer(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_33>> xAuth,
+ ffi.Pointer<ffi.Void> pUserData,
+ ) {
+ _sqlite3_set_authorizer ??= _dylib.lookupFunction<_c_sqlite3_set_authorizer,
+ _dart_sqlite3_set_authorizer>('sqlite3_set_authorizer');
+ return _sqlite3_set_authorizer(
+ arg0,
+ xAuth,
+ pUserData,
+ );
+ }
+
+ _dart_sqlite3_set_authorizer _sqlite3_set_authorizer;
+
+ ffi.Pointer<ffi.Void> sqlite3_trace(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_34>> xTrace,
+ ffi.Pointer<ffi.Void> arg2,
+ ) {
+ _sqlite3_trace ??= _dylib
+ .lookupFunction<_c_sqlite3_trace, _dart_sqlite3_trace>('sqlite3_trace');
+ return _sqlite3_trace(
+ arg0,
+ xTrace,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_trace _sqlite3_trace;
+
+ ffi.Pointer<ffi.Void> sqlite3_profile(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_35>> xProfile,
+ ffi.Pointer<ffi.Void> arg2,
+ ) {
+ _sqlite3_profile ??=
+ _dylib.lookupFunction<_c_sqlite3_profile, _dart_sqlite3_profile>(
+ 'sqlite3_profile');
+ return _sqlite3_profile(
+ arg0,
+ xProfile,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_profile _sqlite3_profile;
+
+ int sqlite3_trace_v2(
+ ffi.Pointer<sqlite3> arg0,
+ int uMask,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_36>> xCallback,
+ ffi.Pointer<ffi.Void> pCtx,
+ ) {
+ _sqlite3_trace_v2 ??=
+ _dylib.lookupFunction<_c_sqlite3_trace_v2, _dart_sqlite3_trace_v2>(
+ 'sqlite3_trace_v2');
+ return _sqlite3_trace_v2(
+ arg0,
+ uMask,
+ xCallback,
+ pCtx,
+ );
+ }
+
+ _dart_sqlite3_trace_v2 _sqlite3_trace_v2;
+
+ void sqlite3_progress_handler(
+ ffi.Pointer<sqlite3> arg0,
+ int arg1,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_37>> arg2,
+ ffi.Pointer<ffi.Void> arg3,
+ ) {
+ _sqlite3_progress_handler ??= _dylib.lookupFunction<
+ _c_sqlite3_progress_handler,
+ _dart_sqlite3_progress_handler>('sqlite3_progress_handler');
+ return _sqlite3_progress_handler(
+ arg0,
+ arg1,
+ arg2,
+ arg3,
+ );
+ }
+
+ _dart_sqlite3_progress_handler _sqlite3_progress_handler;
+
+ int sqlite3_open(
+ ffi.Pointer<ffi.Int8> filename,
+ ffi.Pointer<ffi.Pointer<sqlite3>> ppDb,
+ ) {
+ _sqlite3_open ??= _dylib
+ .lookupFunction<_c_sqlite3_open, _dart_sqlite3_open>('sqlite3_open');
+ return _sqlite3_open(
+ filename,
+ ppDb,
+ );
+ }
+
+ _dart_sqlite3_open _sqlite3_open;
+
+ int sqlite3_open16(
+ ffi.Pointer<ffi.Void> filename,
+ ffi.Pointer<ffi.Pointer<sqlite3>> ppDb,
+ ) {
+ _sqlite3_open16 ??=
+ _dylib.lookupFunction<_c_sqlite3_open16, _dart_sqlite3_open16>(
+ 'sqlite3_open16');
+ return _sqlite3_open16(
+ filename,
+ ppDb,
+ );
+ }
+
+ _dart_sqlite3_open16 _sqlite3_open16;
+
+ int sqlite3_open_v2(
+ ffi.Pointer<ffi.Int8> filename,
+ ffi.Pointer<ffi.Pointer<sqlite3>> ppDb,
+ int flags,
+ ffi.Pointer<ffi.Int8> zVfs,
+ ) {
+ _sqlite3_open_v2 ??=
+ _dylib.lookupFunction<_c_sqlite3_open_v2, _dart_sqlite3_open_v2>(
+ 'sqlite3_open_v2');
+ return _sqlite3_open_v2(
+ filename,
+ ppDb,
+ flags,
+ zVfs,
+ );
+ }
+
+ _dart_sqlite3_open_v2 _sqlite3_open_v2;
+
+ ffi.Pointer<ffi.Int8> sqlite3_uri_parameter(
+ ffi.Pointer<ffi.Int8> zFilename,
+ ffi.Pointer<ffi.Int8> zParam,
+ ) {
+ _sqlite3_uri_parameter ??= _dylib.lookupFunction<_c_sqlite3_uri_parameter,
+ _dart_sqlite3_uri_parameter>('sqlite3_uri_parameter');
+ return _sqlite3_uri_parameter(
+ zFilename,
+ zParam,
+ );
+ }
+
+ _dart_sqlite3_uri_parameter _sqlite3_uri_parameter;
+
+ int sqlite3_uri_boolean(
+ ffi.Pointer<ffi.Int8> zFile,
+ ffi.Pointer<ffi.Int8> zParam,
+ int bDefault,
+ ) {
+ _sqlite3_uri_boolean ??= _dylib.lookupFunction<_c_sqlite3_uri_boolean,
+ _dart_sqlite3_uri_boolean>('sqlite3_uri_boolean');
+ return _sqlite3_uri_boolean(
+ zFile,
+ zParam,
+ bDefault,
+ );
+ }
+
+ _dart_sqlite3_uri_boolean _sqlite3_uri_boolean;
+
+ int sqlite3_uri_int64(
+ ffi.Pointer<ffi.Int8> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ int arg2,
+ ) {
+ _sqlite3_uri_int64 ??=
+ _dylib.lookupFunction<_c_sqlite3_uri_int64, _dart_sqlite3_uri_int64>(
+ 'sqlite3_uri_int64');
+ return _sqlite3_uri_int64(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_uri_int64 _sqlite3_uri_int64;
+
+ ffi.Pointer<ffi.Int8> sqlite3_uri_key(
+ ffi.Pointer<ffi.Int8> zFilename,
+ int N,
+ ) {
+ _sqlite3_uri_key ??=
+ _dylib.lookupFunction<_c_sqlite3_uri_key, _dart_sqlite3_uri_key>(
+ 'sqlite3_uri_key');
+ return _sqlite3_uri_key(
+ zFilename,
+ N,
+ );
+ }
+
+ _dart_sqlite3_uri_key _sqlite3_uri_key;
+
+ ffi.Pointer<ffi.Int8> sqlite3_filename_database(
+ ffi.Pointer<ffi.Int8> arg0,
+ ) {
+ _sqlite3_filename_database ??= _dylib.lookupFunction<
+ _c_sqlite3_filename_database,
+ _dart_sqlite3_filename_database>('sqlite3_filename_database');
+ return _sqlite3_filename_database(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_filename_database _sqlite3_filename_database;
+
+ ffi.Pointer<ffi.Int8> sqlite3_filename_journal(
+ ffi.Pointer<ffi.Int8> arg0,
+ ) {
+ _sqlite3_filename_journal ??= _dylib.lookupFunction<
+ _c_sqlite3_filename_journal,
+ _dart_sqlite3_filename_journal>('sqlite3_filename_journal');
+ return _sqlite3_filename_journal(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_filename_journal _sqlite3_filename_journal;
+
+ ffi.Pointer<ffi.Int8> sqlite3_filename_wal(
+ ffi.Pointer<ffi.Int8> arg0,
+ ) {
+ _sqlite3_filename_wal ??= _dylib.lookupFunction<_c_sqlite3_filename_wal,
+ _dart_sqlite3_filename_wal>('sqlite3_filename_wal');
+ return _sqlite3_filename_wal(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_filename_wal _sqlite3_filename_wal;
+
+ ffi.Pointer<sqlite3_file> sqlite3_database_file_object(
+ ffi.Pointer<ffi.Int8> arg0,
+ ) {
+ _sqlite3_database_file_object ??= _dylib.lookupFunction<
+ _c_sqlite3_database_file_object,
+ _dart_sqlite3_database_file_object>('sqlite3_database_file_object');
+ return _sqlite3_database_file_object(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_database_file_object _sqlite3_database_file_object;
+
+ ffi.Pointer<ffi.Int8> sqlite3_create_filename(
+ ffi.Pointer<ffi.Int8> zDatabase,
+ ffi.Pointer<ffi.Int8> zJournal,
+ ffi.Pointer<ffi.Int8> zWal,
+ int nParam,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> azParam,
+ ) {
+ _sqlite3_create_filename ??= _dylib.lookupFunction<
+ _c_sqlite3_create_filename,
+ _dart_sqlite3_create_filename>('sqlite3_create_filename');
+ return _sqlite3_create_filename(
+ zDatabase,
+ zJournal,
+ zWal,
+ nParam,
+ azParam,
+ );
+ }
+
+ _dart_sqlite3_create_filename _sqlite3_create_filename;
+
+ void sqlite3_free_filename(
+ ffi.Pointer<ffi.Int8> arg0,
+ ) {
+ _sqlite3_free_filename ??= _dylib.lookupFunction<_c_sqlite3_free_filename,
+ _dart_sqlite3_free_filename>('sqlite3_free_filename');
+ return _sqlite3_free_filename(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_free_filename _sqlite3_free_filename;
+
+ int sqlite3_errcode(
+ ffi.Pointer<sqlite3> db,
+ ) {
+ _sqlite3_errcode ??=
+ _dylib.lookupFunction<_c_sqlite3_errcode, _dart_sqlite3_errcode>(
+ 'sqlite3_errcode');
+ return _sqlite3_errcode(
+ db,
+ );
+ }
+
+ _dart_sqlite3_errcode _sqlite3_errcode;
+
+ int sqlite3_extended_errcode(
+ ffi.Pointer<sqlite3> db,
+ ) {
+ _sqlite3_extended_errcode ??= _dylib.lookupFunction<
+ _c_sqlite3_extended_errcode,
+ _dart_sqlite3_extended_errcode>('sqlite3_extended_errcode');
+ return _sqlite3_extended_errcode(
+ db,
+ );
+ }
+
+ _dart_sqlite3_extended_errcode _sqlite3_extended_errcode;
+
+ ffi.Pointer<ffi.Int8> sqlite3_errmsg(
+ ffi.Pointer<sqlite3> arg0,
+ ) {
+ _sqlite3_errmsg ??=
+ _dylib.lookupFunction<_c_sqlite3_errmsg, _dart_sqlite3_errmsg>(
+ 'sqlite3_errmsg');
+ return _sqlite3_errmsg(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_errmsg _sqlite3_errmsg;
+
+ ffi.Pointer<ffi.Void> sqlite3_errmsg16(
+ ffi.Pointer<sqlite3> arg0,
+ ) {
+ _sqlite3_errmsg16 ??=
+ _dylib.lookupFunction<_c_sqlite3_errmsg16, _dart_sqlite3_errmsg16>(
+ 'sqlite3_errmsg16');
+ return _sqlite3_errmsg16(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_errmsg16 _sqlite3_errmsg16;
+
+ ffi.Pointer<ffi.Int8> sqlite3_errstr(
+ int arg0,
+ ) {
+ _sqlite3_errstr ??=
+ _dylib.lookupFunction<_c_sqlite3_errstr, _dart_sqlite3_errstr>(
+ 'sqlite3_errstr');
+ return _sqlite3_errstr(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_errstr _sqlite3_errstr;
+
+ int sqlite3_limit(
+ ffi.Pointer<sqlite3> arg0,
+ int id,
+ int newVal,
+ ) {
+ _sqlite3_limit ??= _dylib
+ .lookupFunction<_c_sqlite3_limit, _dart_sqlite3_limit>('sqlite3_limit');
+ return _sqlite3_limit(
+ arg0,
+ id,
+ newVal,
+ );
+ }
+
+ _dart_sqlite3_limit _sqlite3_limit;
+
+ int sqlite3_prepare(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSql,
+ int nByte,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzTail,
+ ) {
+ _sqlite3_prepare ??=
+ _dylib.lookupFunction<_c_sqlite3_prepare, _dart_sqlite3_prepare>(
+ 'sqlite3_prepare');
+ return _sqlite3_prepare(
+ db,
+ zSql,
+ nByte,
+ ppStmt,
+ pzTail,
+ );
+ }
+
+ _dart_sqlite3_prepare _sqlite3_prepare;
+
+ int sqlite3_prepare_v2(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSql,
+ int nByte,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzTail,
+ ) {
+ _sqlite3_prepare_v2 ??=
+ _dylib.lookupFunction<_c_sqlite3_prepare_v2, _dart_sqlite3_prepare_v2>(
+ 'sqlite3_prepare_v2');
+ return _sqlite3_prepare_v2(
+ db,
+ zSql,
+ nByte,
+ ppStmt,
+ pzTail,
+ );
+ }
+
+ _dart_sqlite3_prepare_v2 _sqlite3_prepare_v2;
+
+ int sqlite3_prepare_v3(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSql,
+ int nByte,
+ int prepFlags,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzTail,
+ ) {
+ _sqlite3_prepare_v3 ??=
+ _dylib.lookupFunction<_c_sqlite3_prepare_v3, _dart_sqlite3_prepare_v3>(
+ 'sqlite3_prepare_v3');
+ return _sqlite3_prepare_v3(
+ db,
+ zSql,
+ nByte,
+ prepFlags,
+ ppStmt,
+ pzTail,
+ );
+ }
+
+ _dart_sqlite3_prepare_v3 _sqlite3_prepare_v3;
+
+ int sqlite3_prepare16(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Void> zSql,
+ int nByte,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Void>> pzTail,
+ ) {
+ _sqlite3_prepare16 ??=
+ _dylib.lookupFunction<_c_sqlite3_prepare16, _dart_sqlite3_prepare16>(
+ 'sqlite3_prepare16');
+ return _sqlite3_prepare16(
+ db,
+ zSql,
+ nByte,
+ ppStmt,
+ pzTail,
+ );
+ }
+
+ _dart_sqlite3_prepare16 _sqlite3_prepare16;
+
+ int sqlite3_prepare16_v2(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Void> zSql,
+ int nByte,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Void>> pzTail,
+ ) {
+ _sqlite3_prepare16_v2 ??= _dylib.lookupFunction<_c_sqlite3_prepare16_v2,
+ _dart_sqlite3_prepare16_v2>('sqlite3_prepare16_v2');
+ return _sqlite3_prepare16_v2(
+ db,
+ zSql,
+ nByte,
+ ppStmt,
+ pzTail,
+ );
+ }
+
+ _dart_sqlite3_prepare16_v2 _sqlite3_prepare16_v2;
+
+ int sqlite3_prepare16_v3(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Void> zSql,
+ int nByte,
+ int prepFlags,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Void>> pzTail,
+ ) {
+ _sqlite3_prepare16_v3 ??= _dylib.lookupFunction<_c_sqlite3_prepare16_v3,
+ _dart_sqlite3_prepare16_v3>('sqlite3_prepare16_v3');
+ return _sqlite3_prepare16_v3(
+ db,
+ zSql,
+ nByte,
+ prepFlags,
+ ppStmt,
+ pzTail,
+ );
+ }
+
+ _dart_sqlite3_prepare16_v3 _sqlite3_prepare16_v3;
+
+ ffi.Pointer<ffi.Int8> sqlite3_sql(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+ ) {
+ _sqlite3_sql ??=
+ _dylib.lookupFunction<_c_sqlite3_sql, _dart_sqlite3_sql>('sqlite3_sql');
+ return _sqlite3_sql(
+ pStmt,
+ );
+ }
+
+ _dart_sqlite3_sql _sqlite3_sql;
+
+ ffi.Pointer<ffi.Int8> sqlite3_expanded_sql(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+ ) {
+ _sqlite3_expanded_sql ??= _dylib.lookupFunction<_c_sqlite3_expanded_sql,
+ _dart_sqlite3_expanded_sql>('sqlite3_expanded_sql');
+ return _sqlite3_expanded_sql(
+ pStmt,
+ );
+ }
+
+ _dart_sqlite3_expanded_sql _sqlite3_expanded_sql;
+
+ ffi.Pointer<ffi.Int8> sqlite3_normalized_sql(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+ ) {
+ _sqlite3_normalized_sql ??= _dylib.lookupFunction<_c_sqlite3_normalized_sql,
+ _dart_sqlite3_normalized_sql>('sqlite3_normalized_sql');
+ return _sqlite3_normalized_sql(
+ pStmt,
+ );
+ }
+
+ _dart_sqlite3_normalized_sql _sqlite3_normalized_sql;
+
+ int sqlite3_stmt_readonly(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+ ) {
+ _sqlite3_stmt_readonly ??= _dylib.lookupFunction<_c_sqlite3_stmt_readonly,
+ _dart_sqlite3_stmt_readonly>('sqlite3_stmt_readonly');
+ return _sqlite3_stmt_readonly(
+ pStmt,
+ );
+ }
+
+ _dart_sqlite3_stmt_readonly _sqlite3_stmt_readonly;
+
+ int sqlite3_stmt_isexplain(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+ ) {
+ _sqlite3_stmt_isexplain ??= _dylib.lookupFunction<_c_sqlite3_stmt_isexplain,
+ _dart_sqlite3_stmt_isexplain>('sqlite3_stmt_isexplain');
+ return _sqlite3_stmt_isexplain(
+ pStmt,
+ );
+ }
+
+ _dart_sqlite3_stmt_isexplain _sqlite3_stmt_isexplain;
+
+ int sqlite3_stmt_busy(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ) {
+ _sqlite3_stmt_busy ??=
+ _dylib.lookupFunction<_c_sqlite3_stmt_busy, _dart_sqlite3_stmt_busy>(
+ 'sqlite3_stmt_busy');
+ return _sqlite3_stmt_busy(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_stmt_busy _sqlite3_stmt_busy;
+
+ int sqlite3_bind_blob(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ffi.Pointer<ffi.Void> arg2,
+ int n,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_38>> arg4,
+ ) {
+ _sqlite3_bind_blob ??=
+ _dylib.lookupFunction<_c_sqlite3_bind_blob, _dart_sqlite3_bind_blob>(
+ 'sqlite3_bind_blob');
+ return _sqlite3_bind_blob(
+ arg0,
+ arg1,
+ arg2,
+ n,
+ arg4,
+ );
+ }
+
+ _dart_sqlite3_bind_blob _sqlite3_bind_blob;
+
+ int sqlite3_bind_blob64(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ffi.Pointer<ffi.Void> arg2,
+ int arg3,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_39>> arg4,
+ ) {
+ _sqlite3_bind_blob64 ??= _dylib.lookupFunction<_c_sqlite3_bind_blob64,
+ _dart_sqlite3_bind_blob64>('sqlite3_bind_blob64');
+ return _sqlite3_bind_blob64(
+ arg0,
+ arg1,
+ arg2,
+ arg3,
+ arg4,
+ );
+ }
+
+ _dart_sqlite3_bind_blob64 _sqlite3_bind_blob64;
+
+ int sqlite3_bind_double(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ double arg2,
+ ) {
+ _sqlite3_bind_double ??= _dylib.lookupFunction<_c_sqlite3_bind_double,
+ _dart_sqlite3_bind_double>('sqlite3_bind_double');
+ return _sqlite3_bind_double(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_bind_double _sqlite3_bind_double;
+
+ int sqlite3_bind_int(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ int arg2,
+ ) {
+ _sqlite3_bind_int ??=
+ _dylib.lookupFunction<_c_sqlite3_bind_int, _dart_sqlite3_bind_int>(
+ 'sqlite3_bind_int');
+ return _sqlite3_bind_int(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_bind_int _sqlite3_bind_int;
+
+ int sqlite3_bind_int64(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ int arg2,
+ ) {
+ _sqlite3_bind_int64 ??=
+ _dylib.lookupFunction<_c_sqlite3_bind_int64, _dart_sqlite3_bind_int64>(
+ 'sqlite3_bind_int64');
+ return _sqlite3_bind_int64(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_bind_int64 _sqlite3_bind_int64;
+
+ int sqlite3_bind_null(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ) {
+ _sqlite3_bind_null ??=
+ _dylib.lookupFunction<_c_sqlite3_bind_null, _dart_sqlite3_bind_null>(
+ 'sqlite3_bind_null');
+ return _sqlite3_bind_null(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_bind_null _sqlite3_bind_null;
+
+ int sqlite3_bind_text(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ffi.Pointer<ffi.Int8> arg2,
+ int arg3,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_40>> arg4,
+ ) {
+ _sqlite3_bind_text ??=
+ _dylib.lookupFunction<_c_sqlite3_bind_text, _dart_sqlite3_bind_text>(
+ 'sqlite3_bind_text');
+ return _sqlite3_bind_text(
+ arg0,
+ arg1,
+ arg2,
+ arg3,
+ arg4,
+ );
+ }
+
+ _dart_sqlite3_bind_text _sqlite3_bind_text;
+
+ int sqlite3_bind_text16(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ffi.Pointer<ffi.Void> arg2,
+ int arg3,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_41>> arg4,
+ ) {
+ _sqlite3_bind_text16 ??= _dylib.lookupFunction<_c_sqlite3_bind_text16,
+ _dart_sqlite3_bind_text16>('sqlite3_bind_text16');
+ return _sqlite3_bind_text16(
+ arg0,
+ arg1,
+ arg2,
+ arg3,
+ arg4,
+ );
+ }
+
+ _dart_sqlite3_bind_text16 _sqlite3_bind_text16;
+
+ int sqlite3_bind_text64(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ffi.Pointer<ffi.Int8> arg2,
+ int arg3,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_42>> arg4,
+ int encoding,
+ ) {
+ _sqlite3_bind_text64 ??= _dylib.lookupFunction<_c_sqlite3_bind_text64,
+ _dart_sqlite3_bind_text64>('sqlite3_bind_text64');
+ return _sqlite3_bind_text64(
+ arg0,
+ arg1,
+ arg2,
+ arg3,
+ arg4,
+ encoding,
+ );
+ }
+
+ _dart_sqlite3_bind_text64 _sqlite3_bind_text64;
+
+ int sqlite3_bind_value(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ffi.Pointer<sqlite3_value> arg2,
+ ) {
+ _sqlite3_bind_value ??=
+ _dylib.lookupFunction<_c_sqlite3_bind_value, _dart_sqlite3_bind_value>(
+ 'sqlite3_bind_value');
+ return _sqlite3_bind_value(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_bind_value _sqlite3_bind_value;
+
+ int sqlite3_bind_pointer(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ffi.Pointer<ffi.Void> arg2,
+ ffi.Pointer<ffi.Int8> arg3,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_43>> arg4,
+ ) {
+ _sqlite3_bind_pointer ??= _dylib.lookupFunction<_c_sqlite3_bind_pointer,
+ _dart_sqlite3_bind_pointer>('sqlite3_bind_pointer');
+ return _sqlite3_bind_pointer(
+ arg0,
+ arg1,
+ arg2,
+ arg3,
+ arg4,
+ );
+ }
+
+ _dart_sqlite3_bind_pointer _sqlite3_bind_pointer;
+
+ int sqlite3_bind_zeroblob(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ int n,
+ ) {
+ _sqlite3_bind_zeroblob ??= _dylib.lookupFunction<_c_sqlite3_bind_zeroblob,
+ _dart_sqlite3_bind_zeroblob>('sqlite3_bind_zeroblob');
+ return _sqlite3_bind_zeroblob(
+ arg0,
+ arg1,
+ n,
+ );
+ }
+
+ _dart_sqlite3_bind_zeroblob _sqlite3_bind_zeroblob;
+
+ int sqlite3_bind_zeroblob64(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ int arg2,
+ ) {
+ _sqlite3_bind_zeroblob64 ??= _dylib.lookupFunction<
+ _c_sqlite3_bind_zeroblob64,
+ _dart_sqlite3_bind_zeroblob64>('sqlite3_bind_zeroblob64');
+ return _sqlite3_bind_zeroblob64(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_bind_zeroblob64 _sqlite3_bind_zeroblob64;
+
+ int sqlite3_bind_parameter_count(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ) {
+ _sqlite3_bind_parameter_count ??= _dylib.lookupFunction<
+ _c_sqlite3_bind_parameter_count,
+ _dart_sqlite3_bind_parameter_count>('sqlite3_bind_parameter_count');
+ return _sqlite3_bind_parameter_count(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_bind_parameter_count _sqlite3_bind_parameter_count;
+
+ ffi.Pointer<ffi.Int8> sqlite3_bind_parameter_name(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ) {
+ _sqlite3_bind_parameter_name ??= _dylib.lookupFunction<
+ _c_sqlite3_bind_parameter_name,
+ _dart_sqlite3_bind_parameter_name>('sqlite3_bind_parameter_name');
+ return _sqlite3_bind_parameter_name(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_bind_parameter_name _sqlite3_bind_parameter_name;
+
+ int sqlite3_bind_parameter_index(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Pointer<ffi.Int8> zName,
+ ) {
+ _sqlite3_bind_parameter_index ??= _dylib.lookupFunction<
+ _c_sqlite3_bind_parameter_index,
+ _dart_sqlite3_bind_parameter_index>('sqlite3_bind_parameter_index');
+ return _sqlite3_bind_parameter_index(
+ arg0,
+ zName,
+ );
+ }
+
+ _dart_sqlite3_bind_parameter_index _sqlite3_bind_parameter_index;
+
+ int sqlite3_clear_bindings(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ) {
+ _sqlite3_clear_bindings ??= _dylib.lookupFunction<_c_sqlite3_clear_bindings,
+ _dart_sqlite3_clear_bindings>('sqlite3_clear_bindings');
+ return _sqlite3_clear_bindings(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_clear_bindings _sqlite3_clear_bindings;
+
+ int sqlite3_column_count(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+ ) {
+ _sqlite3_column_count ??= _dylib.lookupFunction<_c_sqlite3_column_count,
+ _dart_sqlite3_column_count>('sqlite3_column_count');
+ return _sqlite3_column_count(
+ pStmt,
+ );
+ }
+
+ _dart_sqlite3_column_count _sqlite3_column_count;
+
+ ffi.Pointer<ffi.Int8> sqlite3_column_name(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int N,
+ ) {
+ _sqlite3_column_name ??= _dylib.lookupFunction<_c_sqlite3_column_name,
+ _dart_sqlite3_column_name>('sqlite3_column_name');
+ return _sqlite3_column_name(
+ arg0,
+ N,
+ );
+ }
+
+ _dart_sqlite3_column_name _sqlite3_column_name;
+
+ ffi.Pointer<ffi.Void> sqlite3_column_name16(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int N,
+ ) {
+ _sqlite3_column_name16 ??= _dylib.lookupFunction<_c_sqlite3_column_name16,
+ _dart_sqlite3_column_name16>('sqlite3_column_name16');
+ return _sqlite3_column_name16(
+ arg0,
+ N,
+ );
+ }
+
+ _dart_sqlite3_column_name16 _sqlite3_column_name16;
+
+ ffi.Pointer<ffi.Int8> sqlite3_column_database_name(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ) {
+ _sqlite3_column_database_name ??= _dylib.lookupFunction<
+ _c_sqlite3_column_database_name,
+ _dart_sqlite3_column_database_name>('sqlite3_column_database_name');
+ return _sqlite3_column_database_name(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_column_database_name _sqlite3_column_database_name;
+
+ ffi.Pointer<ffi.Void> sqlite3_column_database_name16(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ) {
+ _sqlite3_column_database_name16 ??= _dylib.lookupFunction<
+ _c_sqlite3_column_database_name16,
+ _dart_sqlite3_column_database_name16>('sqlite3_column_database_name16');
+ return _sqlite3_column_database_name16(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_column_database_name16 _sqlite3_column_database_name16;
+
+ ffi.Pointer<ffi.Int8> sqlite3_column_table_name(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ) {
+ _sqlite3_column_table_name ??= _dylib.lookupFunction<
+ _c_sqlite3_column_table_name,
+ _dart_sqlite3_column_table_name>('sqlite3_column_table_name');
+ return _sqlite3_column_table_name(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_column_table_name _sqlite3_column_table_name;
+
+ ffi.Pointer<ffi.Void> sqlite3_column_table_name16(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ) {
+ _sqlite3_column_table_name16 ??= _dylib.lookupFunction<
+ _c_sqlite3_column_table_name16,
+ _dart_sqlite3_column_table_name16>('sqlite3_column_table_name16');
+ return _sqlite3_column_table_name16(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_column_table_name16 _sqlite3_column_table_name16;
+
+ ffi.Pointer<ffi.Int8> sqlite3_column_origin_name(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ) {
+ _sqlite3_column_origin_name ??= _dylib.lookupFunction<
+ _c_sqlite3_column_origin_name,
+ _dart_sqlite3_column_origin_name>('sqlite3_column_origin_name');
+ return _sqlite3_column_origin_name(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_column_origin_name _sqlite3_column_origin_name;
+
+ ffi.Pointer<ffi.Void> sqlite3_column_origin_name16(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ) {
+ _sqlite3_column_origin_name16 ??= _dylib.lookupFunction<
+ _c_sqlite3_column_origin_name16,
+ _dart_sqlite3_column_origin_name16>('sqlite3_column_origin_name16');
+ return _sqlite3_column_origin_name16(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_column_origin_name16 _sqlite3_column_origin_name16;
+
+ ffi.Pointer<ffi.Int8> sqlite3_column_decltype(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ) {
+ _sqlite3_column_decltype ??= _dylib.lookupFunction<
+ _c_sqlite3_column_decltype,
+ _dart_sqlite3_column_decltype>('sqlite3_column_decltype');
+ return _sqlite3_column_decltype(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_column_decltype _sqlite3_column_decltype;
+
+ ffi.Pointer<ffi.Void> sqlite3_column_decltype16(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ) {
+ _sqlite3_column_decltype16 ??= _dylib.lookupFunction<
+ _c_sqlite3_column_decltype16,
+ _dart_sqlite3_column_decltype16>('sqlite3_column_decltype16');
+ return _sqlite3_column_decltype16(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_column_decltype16 _sqlite3_column_decltype16;
+
+ int sqlite3_step(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ) {
+ _sqlite3_step ??= _dylib
+ .lookupFunction<_c_sqlite3_step, _dart_sqlite3_step>('sqlite3_step');
+ return _sqlite3_step(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_step _sqlite3_step;
+
+ int sqlite3_data_count(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+ ) {
+ _sqlite3_data_count ??=
+ _dylib.lookupFunction<_c_sqlite3_data_count, _dart_sqlite3_data_count>(
+ 'sqlite3_data_count');
+ return _sqlite3_data_count(
+ pStmt,
+ );
+ }
+
+ _dart_sqlite3_data_count _sqlite3_data_count;
+
+ ffi.Pointer<ffi.Void> sqlite3_column_blob(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+ ) {
+ _sqlite3_column_blob ??= _dylib.lookupFunction<_c_sqlite3_column_blob,
+ _dart_sqlite3_column_blob>('sqlite3_column_blob');
+ return _sqlite3_column_blob(
+ arg0,
+ iCol,
+ );
+ }
+
+ _dart_sqlite3_column_blob _sqlite3_column_blob;
+
+ double sqlite3_column_double(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+ ) {
+ _sqlite3_column_double ??= _dylib.lookupFunction<_c_sqlite3_column_double,
+ _dart_sqlite3_column_double>('sqlite3_column_double');
+ return _sqlite3_column_double(
+ arg0,
+ iCol,
+ );
+ }
+
+ _dart_sqlite3_column_double _sqlite3_column_double;
+
+ int sqlite3_column_int(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+ ) {
+ _sqlite3_column_int ??=
+ _dylib.lookupFunction<_c_sqlite3_column_int, _dart_sqlite3_column_int>(
+ 'sqlite3_column_int');
+ return _sqlite3_column_int(
+ arg0,
+ iCol,
+ );
+ }
+
+ _dart_sqlite3_column_int _sqlite3_column_int;
+
+ int sqlite3_column_int64(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+ ) {
+ _sqlite3_column_int64 ??= _dylib.lookupFunction<_c_sqlite3_column_int64,
+ _dart_sqlite3_column_int64>('sqlite3_column_int64');
+ return _sqlite3_column_int64(
+ arg0,
+ iCol,
+ );
+ }
+
+ _dart_sqlite3_column_int64 _sqlite3_column_int64;
+
+ ffi.Pointer<ffi.Uint8> sqlite3_column_text(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+ ) {
+ _sqlite3_column_text ??= _dylib.lookupFunction<_c_sqlite3_column_text,
+ _dart_sqlite3_column_text>('sqlite3_column_text');
+ return _sqlite3_column_text(
+ arg0,
+ iCol,
+ );
+ }
+
+ _dart_sqlite3_column_text _sqlite3_column_text;
+
+ ffi.Pointer<ffi.Void> sqlite3_column_text16(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+ ) {
+ _sqlite3_column_text16 ??= _dylib.lookupFunction<_c_sqlite3_column_text16,
+ _dart_sqlite3_column_text16>('sqlite3_column_text16');
+ return _sqlite3_column_text16(
+ arg0,
+ iCol,
+ );
+ }
+
+ _dart_sqlite3_column_text16 _sqlite3_column_text16;
+
+ ffi.Pointer<sqlite3_value> sqlite3_column_value(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+ ) {
+ _sqlite3_column_value ??= _dylib.lookupFunction<_c_sqlite3_column_value,
+ _dart_sqlite3_column_value>('sqlite3_column_value');
+ return _sqlite3_column_value(
+ arg0,
+ iCol,
+ );
+ }
+
+ _dart_sqlite3_column_value _sqlite3_column_value;
+
+ int sqlite3_column_bytes(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+ ) {
+ _sqlite3_column_bytes ??= _dylib.lookupFunction<_c_sqlite3_column_bytes,
+ _dart_sqlite3_column_bytes>('sqlite3_column_bytes');
+ return _sqlite3_column_bytes(
+ arg0,
+ iCol,
+ );
+ }
+
+ _dart_sqlite3_column_bytes _sqlite3_column_bytes;
+
+ int sqlite3_column_bytes16(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+ ) {
+ _sqlite3_column_bytes16 ??= _dylib.lookupFunction<_c_sqlite3_column_bytes16,
+ _dart_sqlite3_column_bytes16>('sqlite3_column_bytes16');
+ return _sqlite3_column_bytes16(
+ arg0,
+ iCol,
+ );
+ }
+
+ _dart_sqlite3_column_bytes16 _sqlite3_column_bytes16;
+
+ int sqlite3_column_type(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+ ) {
+ _sqlite3_column_type ??= _dylib.lookupFunction<_c_sqlite3_column_type,
+ _dart_sqlite3_column_type>('sqlite3_column_type');
+ return _sqlite3_column_type(
+ arg0,
+ iCol,
+ );
+ }
+
+ _dart_sqlite3_column_type _sqlite3_column_type;
+
+ int sqlite3_finalize(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+ ) {
+ _sqlite3_finalize ??=
+ _dylib.lookupFunction<_c_sqlite3_finalize, _dart_sqlite3_finalize>(
+ 'sqlite3_finalize');
+ return _sqlite3_finalize(
+ pStmt,
+ );
+ }
+
+ _dart_sqlite3_finalize _sqlite3_finalize;
+
+ int sqlite3_reset(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+ ) {
+ _sqlite3_reset ??= _dylib
+ .lookupFunction<_c_sqlite3_reset, _dart_sqlite3_reset>('sqlite3_reset');
+ return _sqlite3_reset(
+ pStmt,
+ );
+ }
+
+ _dart_sqlite3_reset _sqlite3_reset;
+
+ int sqlite3_create_function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zFunctionName,
+ int nArg,
+ int eTextRep,
+ ffi.Pointer<ffi.Void> pApp,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_44>> xFunc,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_45>> xStep,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_46>> xFinal,
+ ) {
+ _sqlite3_create_function ??= _dylib.lookupFunction<
+ _c_sqlite3_create_function,
+ _dart_sqlite3_create_function>('sqlite3_create_function');
+ return _sqlite3_create_function(
+ db,
+ zFunctionName,
+ nArg,
+ eTextRep,
+ pApp,
+ xFunc,
+ xStep,
+ xFinal,
+ );
+ }
+
+ _dart_sqlite3_create_function _sqlite3_create_function;
+
+ int sqlite3_create_function16(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Void> zFunctionName,
+ int nArg,
+ int eTextRep,
+ ffi.Pointer<ffi.Void> pApp,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_47>> xFunc,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_48>> xStep,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_49>> xFinal,
+ ) {
+ _sqlite3_create_function16 ??= _dylib.lookupFunction<
+ _c_sqlite3_create_function16,
+ _dart_sqlite3_create_function16>('sqlite3_create_function16');
+ return _sqlite3_create_function16(
+ db,
+ zFunctionName,
+ nArg,
+ eTextRep,
+ pApp,
+ xFunc,
+ xStep,
+ xFinal,
+ );
+ }
+
+ _dart_sqlite3_create_function16 _sqlite3_create_function16;
+
+ int sqlite3_create_function_v2(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zFunctionName,
+ int nArg,
+ int eTextRep,
+ ffi.Pointer<ffi.Void> pApp,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_50>> xFunc,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_51>> xStep,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_52>> xFinal,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_53>> xDestroy,
+ ) {
+ _sqlite3_create_function_v2 ??= _dylib.lookupFunction<
+ _c_sqlite3_create_function_v2,
+ _dart_sqlite3_create_function_v2>('sqlite3_create_function_v2');
+ return _sqlite3_create_function_v2(
+ db,
+ zFunctionName,
+ nArg,
+ eTextRep,
+ pApp,
+ xFunc,
+ xStep,
+ xFinal,
+ xDestroy,
+ );
+ }
+
+ _dart_sqlite3_create_function_v2 _sqlite3_create_function_v2;
+
+ int sqlite3_create_window_function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zFunctionName,
+ int nArg,
+ int eTextRep,
+ ffi.Pointer<ffi.Void> pApp,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_54>> xStep,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_55>> xFinal,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_56>> xValue,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_57>> xInverse,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_58>> xDestroy,
+ ) {
+ _sqlite3_create_window_function ??= _dylib.lookupFunction<
+ _c_sqlite3_create_window_function,
+ _dart_sqlite3_create_window_function>('sqlite3_create_window_function');
+ return _sqlite3_create_window_function(
+ db,
+ zFunctionName,
+ nArg,
+ eTextRep,
+ pApp,
+ xStep,
+ xFinal,
+ xValue,
+ xInverse,
+ xDestroy,
+ );
+ }
+
+ _dart_sqlite3_create_window_function _sqlite3_create_window_function;
+
+ int sqlite3_aggregate_count(
+ ffi.Pointer<sqlite3_context> arg0,
+ ) {
+ _sqlite3_aggregate_count ??= _dylib.lookupFunction<
+ _c_sqlite3_aggregate_count,
+ _dart_sqlite3_aggregate_count>('sqlite3_aggregate_count');
+ return _sqlite3_aggregate_count(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_aggregate_count _sqlite3_aggregate_count;
+
+ int sqlite3_expired(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ) {
+ _sqlite3_expired ??=
+ _dylib.lookupFunction<_c_sqlite3_expired, _dart_sqlite3_expired>(
+ 'sqlite3_expired');
+ return _sqlite3_expired(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_expired _sqlite3_expired;
+
+ int sqlite3_transfer_bindings(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Pointer<sqlite3_stmt> arg1,
+ ) {
+ _sqlite3_transfer_bindings ??= _dylib.lookupFunction<
+ _c_sqlite3_transfer_bindings,
+ _dart_sqlite3_transfer_bindings>('sqlite3_transfer_bindings');
+ return _sqlite3_transfer_bindings(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_transfer_bindings _sqlite3_transfer_bindings;
+
+ int sqlite3_global_recover() {
+ _sqlite3_global_recover ??= _dylib.lookupFunction<_c_sqlite3_global_recover,
+ _dart_sqlite3_global_recover>('sqlite3_global_recover');
+ return _sqlite3_global_recover();
+ }
+
+ _dart_sqlite3_global_recover _sqlite3_global_recover;
+
+ void sqlite3_thread_cleanup() {
+ _sqlite3_thread_cleanup ??= _dylib.lookupFunction<_c_sqlite3_thread_cleanup,
+ _dart_sqlite3_thread_cleanup>('sqlite3_thread_cleanup');
+ return _sqlite3_thread_cleanup();
+ }
+
+ _dart_sqlite3_thread_cleanup _sqlite3_thread_cleanup;
+
+ int sqlite3_memory_alarm(
+ ffi.Pointer<ffi.NativeFunction<_typedefC_59>> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ int arg2,
+ ) {
+ _sqlite3_memory_alarm ??= _dylib.lookupFunction<_c_sqlite3_memory_alarm,
+ _dart_sqlite3_memory_alarm>('sqlite3_memory_alarm');
+ return _sqlite3_memory_alarm(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_memory_alarm _sqlite3_memory_alarm;
+
+ ffi.Pointer<ffi.Void> sqlite3_value_blob(
+ ffi.Pointer<sqlite3_value> arg0,
+ ) {
+ _sqlite3_value_blob ??=
+ _dylib.lookupFunction<_c_sqlite3_value_blob, _dart_sqlite3_value_blob>(
+ 'sqlite3_value_blob');
+ return _sqlite3_value_blob(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_value_blob _sqlite3_value_blob;
+
+ double sqlite3_value_double(
+ ffi.Pointer<sqlite3_value> arg0,
+ ) {
+ _sqlite3_value_double ??= _dylib.lookupFunction<_c_sqlite3_value_double,
+ _dart_sqlite3_value_double>('sqlite3_value_double');
+ return _sqlite3_value_double(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_value_double _sqlite3_value_double;
+
+ int sqlite3_value_int(
+ ffi.Pointer<sqlite3_value> arg0,
+ ) {
+ _sqlite3_value_int ??=
+ _dylib.lookupFunction<_c_sqlite3_value_int, _dart_sqlite3_value_int>(
+ 'sqlite3_value_int');
+ return _sqlite3_value_int(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_value_int _sqlite3_value_int;
+
+ int sqlite3_value_int64(
+ ffi.Pointer<sqlite3_value> arg0,
+ ) {
+ _sqlite3_value_int64 ??= _dylib.lookupFunction<_c_sqlite3_value_int64,
+ _dart_sqlite3_value_int64>('sqlite3_value_int64');
+ return _sqlite3_value_int64(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_value_int64 _sqlite3_value_int64;
+
+ ffi.Pointer<ffi.Void> sqlite3_value_pointer(
+ ffi.Pointer<sqlite3_value> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ ) {
+ _sqlite3_value_pointer ??= _dylib.lookupFunction<_c_sqlite3_value_pointer,
+ _dart_sqlite3_value_pointer>('sqlite3_value_pointer');
+ return _sqlite3_value_pointer(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_value_pointer _sqlite3_value_pointer;
+
+ ffi.Pointer<ffi.Uint8> sqlite3_value_text(
+ ffi.Pointer<sqlite3_value> arg0,
+ ) {
+ _sqlite3_value_text ??=
+ _dylib.lookupFunction<_c_sqlite3_value_text, _dart_sqlite3_value_text>(
+ 'sqlite3_value_text');
+ return _sqlite3_value_text(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_value_text _sqlite3_value_text;
+
+ ffi.Pointer<ffi.Void> sqlite3_value_text16(
+ ffi.Pointer<sqlite3_value> arg0,
+ ) {
+ _sqlite3_value_text16 ??= _dylib.lookupFunction<_c_sqlite3_value_text16,
+ _dart_sqlite3_value_text16>('sqlite3_value_text16');
+ return _sqlite3_value_text16(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_value_text16 _sqlite3_value_text16;
+
+ ffi.Pointer<ffi.Void> sqlite3_value_text16le(
+ ffi.Pointer<sqlite3_value> arg0,
+ ) {
+ _sqlite3_value_text16le ??= _dylib.lookupFunction<_c_sqlite3_value_text16le,
+ _dart_sqlite3_value_text16le>('sqlite3_value_text16le');
+ return _sqlite3_value_text16le(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_value_text16le _sqlite3_value_text16le;
+
+ ffi.Pointer<ffi.Void> sqlite3_value_text16be(
+ ffi.Pointer<sqlite3_value> arg0,
+ ) {
+ _sqlite3_value_text16be ??= _dylib.lookupFunction<_c_sqlite3_value_text16be,
+ _dart_sqlite3_value_text16be>('sqlite3_value_text16be');
+ return _sqlite3_value_text16be(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_value_text16be _sqlite3_value_text16be;
+
+ int sqlite3_value_bytes(
+ ffi.Pointer<sqlite3_value> arg0,
+ ) {
+ _sqlite3_value_bytes ??= _dylib.lookupFunction<_c_sqlite3_value_bytes,
+ _dart_sqlite3_value_bytes>('sqlite3_value_bytes');
+ return _sqlite3_value_bytes(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_value_bytes _sqlite3_value_bytes;
+
+ int sqlite3_value_bytes16(
+ ffi.Pointer<sqlite3_value> arg0,
+ ) {
+ _sqlite3_value_bytes16 ??= _dylib.lookupFunction<_c_sqlite3_value_bytes16,
+ _dart_sqlite3_value_bytes16>('sqlite3_value_bytes16');
+ return _sqlite3_value_bytes16(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_value_bytes16 _sqlite3_value_bytes16;
+
+ int sqlite3_value_type(
+ ffi.Pointer<sqlite3_value> arg0,
+ ) {
+ _sqlite3_value_type ??=
+ _dylib.lookupFunction<_c_sqlite3_value_type, _dart_sqlite3_value_type>(
+ 'sqlite3_value_type');
+ return _sqlite3_value_type(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_value_type _sqlite3_value_type;
+
+ int sqlite3_value_numeric_type(
+ ffi.Pointer<sqlite3_value> arg0,
+ ) {
+ _sqlite3_value_numeric_type ??= _dylib.lookupFunction<
+ _c_sqlite3_value_numeric_type,
+ _dart_sqlite3_value_numeric_type>('sqlite3_value_numeric_type');
+ return _sqlite3_value_numeric_type(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_value_numeric_type _sqlite3_value_numeric_type;
+
+ int sqlite3_value_nochange(
+ ffi.Pointer<sqlite3_value> arg0,
+ ) {
+ _sqlite3_value_nochange ??= _dylib.lookupFunction<_c_sqlite3_value_nochange,
+ _dart_sqlite3_value_nochange>('sqlite3_value_nochange');
+ return _sqlite3_value_nochange(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_value_nochange _sqlite3_value_nochange;
+
+ int sqlite3_value_frombind(
+ ffi.Pointer<sqlite3_value> arg0,
+ ) {
+ _sqlite3_value_frombind ??= _dylib.lookupFunction<_c_sqlite3_value_frombind,
+ _dart_sqlite3_value_frombind>('sqlite3_value_frombind');
+ return _sqlite3_value_frombind(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_value_frombind _sqlite3_value_frombind;
+
+ int sqlite3_value_subtype(
+ ffi.Pointer<sqlite3_value> arg0,
+ ) {
+ _sqlite3_value_subtype ??= _dylib.lookupFunction<_c_sqlite3_value_subtype,
+ _dart_sqlite3_value_subtype>('sqlite3_value_subtype');
+ return _sqlite3_value_subtype(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_value_subtype _sqlite3_value_subtype;
+
+ ffi.Pointer<sqlite3_value> sqlite3_value_dup(
+ ffi.Pointer<sqlite3_value> arg0,
+ ) {
+ _sqlite3_value_dup ??=
+ _dylib.lookupFunction<_c_sqlite3_value_dup, _dart_sqlite3_value_dup>(
+ 'sqlite3_value_dup');
+ return _sqlite3_value_dup(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_value_dup _sqlite3_value_dup;
+
+ void sqlite3_value_free(
+ ffi.Pointer<sqlite3_value> arg0,
+ ) {
+ _sqlite3_value_free ??=
+ _dylib.lookupFunction<_c_sqlite3_value_free, _dart_sqlite3_value_free>(
+ 'sqlite3_value_free');
+ return _sqlite3_value_free(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_value_free _sqlite3_value_free;
+
+ ffi.Pointer<ffi.Void> sqlite3_aggregate_context(
+ ffi.Pointer<sqlite3_context> arg0,
+ int nBytes,
+ ) {
+ _sqlite3_aggregate_context ??= _dylib.lookupFunction<
+ _c_sqlite3_aggregate_context,
+ _dart_sqlite3_aggregate_context>('sqlite3_aggregate_context');
+ return _sqlite3_aggregate_context(
+ arg0,
+ nBytes,
+ );
+ }
+
+ _dart_sqlite3_aggregate_context _sqlite3_aggregate_context;
+
+ ffi.Pointer<ffi.Void> sqlite3_user_data(
+ ffi.Pointer<sqlite3_context> arg0,
+ ) {
+ _sqlite3_user_data ??=
+ _dylib.lookupFunction<_c_sqlite3_user_data, _dart_sqlite3_user_data>(
+ 'sqlite3_user_data');
+ return _sqlite3_user_data(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_user_data _sqlite3_user_data;
+
+ ffi.Pointer<sqlite3> sqlite3_context_db_handle(
+ ffi.Pointer<sqlite3_context> arg0,
+ ) {
+ _sqlite3_context_db_handle ??= _dylib.lookupFunction<
+ _c_sqlite3_context_db_handle,
+ _dart_sqlite3_context_db_handle>('sqlite3_context_db_handle');
+ return _sqlite3_context_db_handle(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_context_db_handle _sqlite3_context_db_handle;
+
+ ffi.Pointer<ffi.Void> sqlite3_get_auxdata(
+ ffi.Pointer<sqlite3_context> arg0,
+ int N,
+ ) {
+ _sqlite3_get_auxdata ??= _dylib.lookupFunction<_c_sqlite3_get_auxdata,
+ _dart_sqlite3_get_auxdata>('sqlite3_get_auxdata');
+ return _sqlite3_get_auxdata(
+ arg0,
+ N,
+ );
+ }
+
+ _dart_sqlite3_get_auxdata _sqlite3_get_auxdata;
+
+ void sqlite3_set_auxdata(
+ ffi.Pointer<sqlite3_context> arg0,
+ int N,
+ ffi.Pointer<ffi.Void> arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_60>> arg3,
+ ) {
+ _sqlite3_set_auxdata ??= _dylib.lookupFunction<_c_sqlite3_set_auxdata,
+ _dart_sqlite3_set_auxdata>('sqlite3_set_auxdata');
+ return _sqlite3_set_auxdata(
+ arg0,
+ N,
+ arg2,
+ arg3,
+ );
+ }
+
+ _dart_sqlite3_set_auxdata _sqlite3_set_auxdata;
+
+ void sqlite3_result_blob(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ int arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_61>> arg3,
+ ) {
+ _sqlite3_result_blob ??= _dylib.lookupFunction<_c_sqlite3_result_blob,
+ _dart_sqlite3_result_blob>('sqlite3_result_blob');
+ return _sqlite3_result_blob(
+ arg0,
+ arg1,
+ arg2,
+ arg3,
+ );
+ }
+
+ _dart_sqlite3_result_blob _sqlite3_result_blob;
+
+ void sqlite3_result_blob64(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ int arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_62>> arg3,
+ ) {
+ _sqlite3_result_blob64 ??= _dylib.lookupFunction<_c_sqlite3_result_blob64,
+ _dart_sqlite3_result_blob64>('sqlite3_result_blob64');
+ return _sqlite3_result_blob64(
+ arg0,
+ arg1,
+ arg2,
+ arg3,
+ );
+ }
+
+ _dart_sqlite3_result_blob64 _sqlite3_result_blob64;
+
+ void sqlite3_result_double(
+ ffi.Pointer<sqlite3_context> arg0,
+ double arg1,
+ ) {
+ _sqlite3_result_double ??= _dylib.lookupFunction<_c_sqlite3_result_double,
+ _dart_sqlite3_result_double>('sqlite3_result_double');
+ return _sqlite3_result_double(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_result_double _sqlite3_result_double;
+
+ void sqlite3_result_error(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ int arg2,
+ ) {
+ _sqlite3_result_error ??= _dylib.lookupFunction<_c_sqlite3_result_error,
+ _dart_sqlite3_result_error>('sqlite3_result_error');
+ return _sqlite3_result_error(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_result_error _sqlite3_result_error;
+
+ void sqlite3_result_error16(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ int arg2,
+ ) {
+ _sqlite3_result_error16 ??= _dylib.lookupFunction<_c_sqlite3_result_error16,
+ _dart_sqlite3_result_error16>('sqlite3_result_error16');
+ return _sqlite3_result_error16(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_result_error16 _sqlite3_result_error16;
+
+ void sqlite3_result_error_toobig(
+ ffi.Pointer<sqlite3_context> arg0,
+ ) {
+ _sqlite3_result_error_toobig ??= _dylib.lookupFunction<
+ _c_sqlite3_result_error_toobig,
+ _dart_sqlite3_result_error_toobig>('sqlite3_result_error_toobig');
+ return _sqlite3_result_error_toobig(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_result_error_toobig _sqlite3_result_error_toobig;
+
+ void sqlite3_result_error_nomem(
+ ffi.Pointer<sqlite3_context> arg0,
+ ) {
+ _sqlite3_result_error_nomem ??= _dylib.lookupFunction<
+ _c_sqlite3_result_error_nomem,
+ _dart_sqlite3_result_error_nomem>('sqlite3_result_error_nomem');
+ return _sqlite3_result_error_nomem(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_result_error_nomem _sqlite3_result_error_nomem;
+
+ void sqlite3_result_error_code(
+ ffi.Pointer<sqlite3_context> arg0,
+ int arg1,
+ ) {
+ _sqlite3_result_error_code ??= _dylib.lookupFunction<
+ _c_sqlite3_result_error_code,
+ _dart_sqlite3_result_error_code>('sqlite3_result_error_code');
+ return _sqlite3_result_error_code(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_result_error_code _sqlite3_result_error_code;
+
+ void sqlite3_result_int(
+ ffi.Pointer<sqlite3_context> arg0,
+ int arg1,
+ ) {
+ _sqlite3_result_int ??=
+ _dylib.lookupFunction<_c_sqlite3_result_int, _dart_sqlite3_result_int>(
+ 'sqlite3_result_int');
+ return _sqlite3_result_int(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_result_int _sqlite3_result_int;
+
+ void sqlite3_result_int64(
+ ffi.Pointer<sqlite3_context> arg0,
+ int arg1,
+ ) {
+ _sqlite3_result_int64 ??= _dylib.lookupFunction<_c_sqlite3_result_int64,
+ _dart_sqlite3_result_int64>('sqlite3_result_int64');
+ return _sqlite3_result_int64(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_result_int64 _sqlite3_result_int64;
+
+ void sqlite3_result_null(
+ ffi.Pointer<sqlite3_context> arg0,
+ ) {
+ _sqlite3_result_null ??= _dylib.lookupFunction<_c_sqlite3_result_null,
+ _dart_sqlite3_result_null>('sqlite3_result_null');
+ return _sqlite3_result_null(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_result_null _sqlite3_result_null;
+
+ void sqlite3_result_text(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ int arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_63>> arg3,
+ ) {
+ _sqlite3_result_text ??= _dylib.lookupFunction<_c_sqlite3_result_text,
+ _dart_sqlite3_result_text>('sqlite3_result_text');
+ return _sqlite3_result_text(
+ arg0,
+ arg1,
+ arg2,
+ arg3,
+ );
+ }
+
+ _dart_sqlite3_result_text _sqlite3_result_text;
+
+ void sqlite3_result_text64(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ int arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_64>> arg3,
+ int encoding,
+ ) {
+ _sqlite3_result_text64 ??= _dylib.lookupFunction<_c_sqlite3_result_text64,
+ _dart_sqlite3_result_text64>('sqlite3_result_text64');
+ return _sqlite3_result_text64(
+ arg0,
+ arg1,
+ arg2,
+ arg3,
+ encoding,
+ );
+ }
+
+ _dart_sqlite3_result_text64 _sqlite3_result_text64;
+
+ void sqlite3_result_text16(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ int arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_65>> arg3,
+ ) {
+ _sqlite3_result_text16 ??= _dylib.lookupFunction<_c_sqlite3_result_text16,
+ _dart_sqlite3_result_text16>('sqlite3_result_text16');
+ return _sqlite3_result_text16(
+ arg0,
+ arg1,
+ arg2,
+ arg3,
+ );
+ }
+
+ _dart_sqlite3_result_text16 _sqlite3_result_text16;
+
+ void sqlite3_result_text16le(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ int arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_66>> arg3,
+ ) {
+ _sqlite3_result_text16le ??= _dylib.lookupFunction<
+ _c_sqlite3_result_text16le,
+ _dart_sqlite3_result_text16le>('sqlite3_result_text16le');
+ return _sqlite3_result_text16le(
+ arg0,
+ arg1,
+ arg2,
+ arg3,
+ );
+ }
+
+ _dart_sqlite3_result_text16le _sqlite3_result_text16le;
+
+ void sqlite3_result_text16be(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ int arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_67>> arg3,
+ ) {
+ _sqlite3_result_text16be ??= _dylib.lookupFunction<
+ _c_sqlite3_result_text16be,
+ _dart_sqlite3_result_text16be>('sqlite3_result_text16be');
+ return _sqlite3_result_text16be(
+ arg0,
+ arg1,
+ arg2,
+ arg3,
+ );
+ }
+
+ _dart_sqlite3_result_text16be _sqlite3_result_text16be;
+
+ void sqlite3_result_value(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<sqlite3_value> arg1,
+ ) {
+ _sqlite3_result_value ??= _dylib.lookupFunction<_c_sqlite3_result_value,
+ _dart_sqlite3_result_value>('sqlite3_result_value');
+ return _sqlite3_result_value(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_result_value _sqlite3_result_value;
+
+ void sqlite3_result_pointer(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ffi.Pointer<ffi.Int8> arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_68>> arg3,
+ ) {
+ _sqlite3_result_pointer ??= _dylib.lookupFunction<_c_sqlite3_result_pointer,
+ _dart_sqlite3_result_pointer>('sqlite3_result_pointer');
+ return _sqlite3_result_pointer(
+ arg0,
+ arg1,
+ arg2,
+ arg3,
+ );
+ }
+
+ _dart_sqlite3_result_pointer _sqlite3_result_pointer;
+
+ void sqlite3_result_zeroblob(
+ ffi.Pointer<sqlite3_context> arg0,
+ int n,
+ ) {
+ _sqlite3_result_zeroblob ??= _dylib.lookupFunction<
+ _c_sqlite3_result_zeroblob,
+ _dart_sqlite3_result_zeroblob>('sqlite3_result_zeroblob');
+ return _sqlite3_result_zeroblob(
+ arg0,
+ n,
+ );
+ }
+
+ _dart_sqlite3_result_zeroblob _sqlite3_result_zeroblob;
+
+ int sqlite3_result_zeroblob64(
+ ffi.Pointer<sqlite3_context> arg0,
+ int n,
+ ) {
+ _sqlite3_result_zeroblob64 ??= _dylib.lookupFunction<
+ _c_sqlite3_result_zeroblob64,
+ _dart_sqlite3_result_zeroblob64>('sqlite3_result_zeroblob64');
+ return _sqlite3_result_zeroblob64(
+ arg0,
+ n,
+ );
+ }
+
+ _dart_sqlite3_result_zeroblob64 _sqlite3_result_zeroblob64;
+
+ void sqlite3_result_subtype(
+ ffi.Pointer<sqlite3_context> arg0,
+ int arg1,
+ ) {
+ _sqlite3_result_subtype ??= _dylib.lookupFunction<_c_sqlite3_result_subtype,
+ _dart_sqlite3_result_subtype>('sqlite3_result_subtype');
+ return _sqlite3_result_subtype(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_result_subtype _sqlite3_result_subtype;
+
+ int sqlite3_create_collation(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zName,
+ int eTextRep,
+ ffi.Pointer<ffi.Void> pArg,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_69>> xCompare,
+ ) {
+ _sqlite3_create_collation ??= _dylib.lookupFunction<
+ _c_sqlite3_create_collation,
+ _dart_sqlite3_create_collation>('sqlite3_create_collation');
+ return _sqlite3_create_collation(
+ arg0,
+ zName,
+ eTextRep,
+ pArg,
+ xCompare,
+ );
+ }
+
+ _dart_sqlite3_create_collation _sqlite3_create_collation;
+
+ int sqlite3_create_collation_v2(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zName,
+ int eTextRep,
+ ffi.Pointer<ffi.Void> pArg,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_70>> xCompare,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_71>> xDestroy,
+ ) {
+ _sqlite3_create_collation_v2 ??= _dylib.lookupFunction<
+ _c_sqlite3_create_collation_v2,
+ _dart_sqlite3_create_collation_v2>('sqlite3_create_collation_v2');
+ return _sqlite3_create_collation_v2(
+ arg0,
+ zName,
+ eTextRep,
+ pArg,
+ xCompare,
+ xDestroy,
+ );
+ }
+
+ _dart_sqlite3_create_collation_v2 _sqlite3_create_collation_v2;
+
+ int sqlite3_create_collation16(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Void> zName,
+ int eTextRep,
+ ffi.Pointer<ffi.Void> pArg,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_72>> xCompare,
+ ) {
+ _sqlite3_create_collation16 ??= _dylib.lookupFunction<
+ _c_sqlite3_create_collation16,
+ _dart_sqlite3_create_collation16>('sqlite3_create_collation16');
+ return _sqlite3_create_collation16(
+ arg0,
+ zName,
+ eTextRep,
+ pArg,
+ xCompare,
+ );
+ }
+
+ _dart_sqlite3_create_collation16 _sqlite3_create_collation16;
+
+ int sqlite3_collation_needed(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_73>> arg2,
+ ) {
+ _sqlite3_collation_needed ??= _dylib.lookupFunction<
+ _c_sqlite3_collation_needed,
+ _dart_sqlite3_collation_needed>('sqlite3_collation_needed');
+ return _sqlite3_collation_needed(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_collation_needed _sqlite3_collation_needed;
+
+ int sqlite3_collation_needed16(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_74>> arg2,
+ ) {
+ _sqlite3_collation_needed16 ??= _dylib.lookupFunction<
+ _c_sqlite3_collation_needed16,
+ _dart_sqlite3_collation_needed16>('sqlite3_collation_needed16');
+ return _sqlite3_collation_needed16(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_collation_needed16 _sqlite3_collation_needed16;
+
+ int sqlite3_sleep(
+ int arg0,
+ ) {
+ _sqlite3_sleep ??= _dylib
+ .lookupFunction<_c_sqlite3_sleep, _dart_sqlite3_sleep>('sqlite3_sleep');
+ return _sqlite3_sleep(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_sleep _sqlite3_sleep;
+
+ int sqlite3_win32_set_directory(
+ int type,
+ ffi.Pointer<ffi.Void> zValue,
+ ) {
+ _sqlite3_win32_set_directory ??= _dylib.lookupFunction<
+ _c_sqlite3_win32_set_directory,
+ _dart_sqlite3_win32_set_directory>('sqlite3_win32_set_directory');
+ return _sqlite3_win32_set_directory(
+ type,
+ zValue,
+ );
+ }
+
+ _dart_sqlite3_win32_set_directory _sqlite3_win32_set_directory;
+
+ int sqlite3_win32_set_directory8(
+ int type,
+ ffi.Pointer<ffi.Int8> zValue,
+ ) {
+ _sqlite3_win32_set_directory8 ??= _dylib.lookupFunction<
+ _c_sqlite3_win32_set_directory8,
+ _dart_sqlite3_win32_set_directory8>('sqlite3_win32_set_directory8');
+ return _sqlite3_win32_set_directory8(
+ type,
+ zValue,
+ );
+ }
+
+ _dart_sqlite3_win32_set_directory8 _sqlite3_win32_set_directory8;
+
+ int sqlite3_win32_set_directory16(
+ int type,
+ ffi.Pointer<ffi.Void> zValue,
+ ) {
+ _sqlite3_win32_set_directory16 ??= _dylib.lookupFunction<
+ _c_sqlite3_win32_set_directory16,
+ _dart_sqlite3_win32_set_directory16>('sqlite3_win32_set_directory16');
+ return _sqlite3_win32_set_directory16(
+ type,
+ zValue,
+ );
+ }
+
+ _dart_sqlite3_win32_set_directory16 _sqlite3_win32_set_directory16;
+
+ int sqlite3_get_autocommit(
+ ffi.Pointer<sqlite3> arg0,
+ ) {
+ _sqlite3_get_autocommit ??= _dylib.lookupFunction<_c_sqlite3_get_autocommit,
+ _dart_sqlite3_get_autocommit>('sqlite3_get_autocommit');
+ return _sqlite3_get_autocommit(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_get_autocommit _sqlite3_get_autocommit;
+
+ ffi.Pointer<sqlite3> sqlite3_db_handle(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ) {
+ _sqlite3_db_handle ??=
+ _dylib.lookupFunction<_c_sqlite3_db_handle, _dart_sqlite3_db_handle>(
+ 'sqlite3_db_handle');
+ return _sqlite3_db_handle(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_db_handle _sqlite3_db_handle;
+
+ ffi.Pointer<ffi.Int8> sqlite3_db_filename(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDbName,
+ ) {
+ _sqlite3_db_filename ??= _dylib.lookupFunction<_c_sqlite3_db_filename,
+ _dart_sqlite3_db_filename>('sqlite3_db_filename');
+ return _sqlite3_db_filename(
+ db,
+ zDbName,
+ );
+ }
+
+ _dart_sqlite3_db_filename _sqlite3_db_filename;
+
+ int sqlite3_db_readonly(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDbName,
+ ) {
+ _sqlite3_db_readonly ??= _dylib.lookupFunction<_c_sqlite3_db_readonly,
+ _dart_sqlite3_db_readonly>('sqlite3_db_readonly');
+ return _sqlite3_db_readonly(
+ db,
+ zDbName,
+ );
+ }
+
+ _dart_sqlite3_db_readonly _sqlite3_db_readonly;
+
+ ffi.Pointer<sqlite3_stmt> sqlite3_next_stmt(
+ ffi.Pointer<sqlite3> pDb,
+ ffi.Pointer<sqlite3_stmt> pStmt,
+ ) {
+ _sqlite3_next_stmt ??=
+ _dylib.lookupFunction<_c_sqlite3_next_stmt, _dart_sqlite3_next_stmt>(
+ 'sqlite3_next_stmt');
+ return _sqlite3_next_stmt(
+ pDb,
+ pStmt,
+ );
+ }
+
+ _dart_sqlite3_next_stmt _sqlite3_next_stmt;
+
+ ffi.Pointer<ffi.Void> sqlite3_commit_hook(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_75>> arg1,
+ ffi.Pointer<ffi.Void> arg2,
+ ) {
+ _sqlite3_commit_hook ??= _dylib.lookupFunction<_c_sqlite3_commit_hook,
+ _dart_sqlite3_commit_hook>('sqlite3_commit_hook');
+ return _sqlite3_commit_hook(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_commit_hook _sqlite3_commit_hook;
+
+ ffi.Pointer<ffi.Void> sqlite3_rollback_hook(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_76>> arg1,
+ ffi.Pointer<ffi.Void> arg2,
+ ) {
+ _sqlite3_rollback_hook ??= _dylib.lookupFunction<_c_sqlite3_rollback_hook,
+ _dart_sqlite3_rollback_hook>('sqlite3_rollback_hook');
+ return _sqlite3_rollback_hook(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_rollback_hook _sqlite3_rollback_hook;
+
+ ffi.Pointer<ffi.Void> sqlite3_update_hook(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_77>> arg1,
+ ffi.Pointer<ffi.Void> arg2,
+ ) {
+ _sqlite3_update_hook ??= _dylib.lookupFunction<_c_sqlite3_update_hook,
+ _dart_sqlite3_update_hook>('sqlite3_update_hook');
+ return _sqlite3_update_hook(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_update_hook _sqlite3_update_hook;
+
+ int sqlite3_enable_shared_cache(
+ int arg0,
+ ) {
+ _sqlite3_enable_shared_cache ??= _dylib.lookupFunction<
+ _c_sqlite3_enable_shared_cache,
+ _dart_sqlite3_enable_shared_cache>('sqlite3_enable_shared_cache');
+ return _sqlite3_enable_shared_cache(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_enable_shared_cache _sqlite3_enable_shared_cache;
+
+ int sqlite3_release_memory(
+ int arg0,
+ ) {
+ _sqlite3_release_memory ??= _dylib.lookupFunction<_c_sqlite3_release_memory,
+ _dart_sqlite3_release_memory>('sqlite3_release_memory');
+ return _sqlite3_release_memory(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_release_memory _sqlite3_release_memory;
+
+ int sqlite3_db_release_memory(
+ ffi.Pointer<sqlite3> arg0,
+ ) {
+ _sqlite3_db_release_memory ??= _dylib.lookupFunction<
+ _c_sqlite3_db_release_memory,
+ _dart_sqlite3_db_release_memory>('sqlite3_db_release_memory');
+ return _sqlite3_db_release_memory(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_db_release_memory _sqlite3_db_release_memory;
+
+ int sqlite3_soft_heap_limit64(
+ int N,
+ ) {
+ _sqlite3_soft_heap_limit64 ??= _dylib.lookupFunction<
+ _c_sqlite3_soft_heap_limit64,
+ _dart_sqlite3_soft_heap_limit64>('sqlite3_soft_heap_limit64');
+ return _sqlite3_soft_heap_limit64(
+ N,
+ );
+ }
+
+ _dart_sqlite3_soft_heap_limit64 _sqlite3_soft_heap_limit64;
+
+ int sqlite3_hard_heap_limit64(
+ int N,
+ ) {
+ _sqlite3_hard_heap_limit64 ??= _dylib.lookupFunction<
+ _c_sqlite3_hard_heap_limit64,
+ _dart_sqlite3_hard_heap_limit64>('sqlite3_hard_heap_limit64');
+ return _sqlite3_hard_heap_limit64(
+ N,
+ );
+ }
+
+ _dart_sqlite3_hard_heap_limit64 _sqlite3_hard_heap_limit64;
+
+ void sqlite3_soft_heap_limit(
+ int N,
+ ) {
+ _sqlite3_soft_heap_limit ??= _dylib.lookupFunction<
+ _c_sqlite3_soft_heap_limit,
+ _dart_sqlite3_soft_heap_limit>('sqlite3_soft_heap_limit');
+ return _sqlite3_soft_heap_limit(
+ N,
+ );
+ }
+
+ _dart_sqlite3_soft_heap_limit _sqlite3_soft_heap_limit;
+
+ int sqlite3_table_column_metadata(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDbName,
+ ffi.Pointer<ffi.Int8> zTableName,
+ ffi.Pointer<ffi.Int8> zColumnName,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzDataType,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzCollSeq,
+ ffi.Pointer<ffi.Int32> pNotNull,
+ ffi.Pointer<ffi.Int32> pPrimaryKey,
+ ffi.Pointer<ffi.Int32> pAutoinc,
+ ) {
+ _sqlite3_table_column_metadata ??= _dylib.lookupFunction<
+ _c_sqlite3_table_column_metadata,
+ _dart_sqlite3_table_column_metadata>('sqlite3_table_column_metadata');
+ return _sqlite3_table_column_metadata(
+ db,
+ zDbName,
+ zTableName,
+ zColumnName,
+ pzDataType,
+ pzCollSeq,
+ pNotNull,
+ pPrimaryKey,
+ pAutoinc,
+ );
+ }
+
+ _dart_sqlite3_table_column_metadata _sqlite3_table_column_metadata;
+
+ int sqlite3_load_extension(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zFile,
+ ffi.Pointer<ffi.Int8> zProc,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzErrMsg,
+ ) {
+ _sqlite3_load_extension ??= _dylib.lookupFunction<_c_sqlite3_load_extension,
+ _dart_sqlite3_load_extension>('sqlite3_load_extension');
+ return _sqlite3_load_extension(
+ db,
+ zFile,
+ zProc,
+ pzErrMsg,
+ );
+ }
+
+ _dart_sqlite3_load_extension _sqlite3_load_extension;
+
+ int sqlite3_enable_load_extension(
+ ffi.Pointer<sqlite3> db,
+ int onoff,
+ ) {
+ _sqlite3_enable_load_extension ??= _dylib.lookupFunction<
+ _c_sqlite3_enable_load_extension,
+ _dart_sqlite3_enable_load_extension>('sqlite3_enable_load_extension');
+ return _sqlite3_enable_load_extension(
+ db,
+ onoff,
+ );
+ }
+
+ _dart_sqlite3_enable_load_extension _sqlite3_enable_load_extension;
+
+ int sqlite3_auto_extension(
+ ffi.Pointer<ffi.NativeFunction<_typedefC_78>> xEntryPoint,
+ ) {
+ _sqlite3_auto_extension ??= _dylib.lookupFunction<_c_sqlite3_auto_extension,
+ _dart_sqlite3_auto_extension>('sqlite3_auto_extension');
+ return _sqlite3_auto_extension(
+ xEntryPoint,
+ );
+ }
+
+ _dart_sqlite3_auto_extension _sqlite3_auto_extension;
+
+ int sqlite3_cancel_auto_extension(
+ ffi.Pointer<ffi.NativeFunction<_typedefC_79>> xEntryPoint,
+ ) {
+ _sqlite3_cancel_auto_extension ??= _dylib.lookupFunction<
+ _c_sqlite3_cancel_auto_extension,
+ _dart_sqlite3_cancel_auto_extension>('sqlite3_cancel_auto_extension');
+ return _sqlite3_cancel_auto_extension(
+ xEntryPoint,
+ );
+ }
+
+ _dart_sqlite3_cancel_auto_extension _sqlite3_cancel_auto_extension;
+
+ void sqlite3_reset_auto_extension() {
+ _sqlite3_reset_auto_extension ??= _dylib.lookupFunction<
+ _c_sqlite3_reset_auto_extension,
+ _dart_sqlite3_reset_auto_extension>('sqlite3_reset_auto_extension');
+ return _sqlite3_reset_auto_extension();
+ }
+
+ _dart_sqlite3_reset_auto_extension _sqlite3_reset_auto_extension;
+
+ int sqlite3_create_module(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zName,
+ ffi.Pointer<sqlite3_module> p,
+ ffi.Pointer<ffi.Void> pClientData,
+ ) {
+ _sqlite3_create_module ??= _dylib.lookupFunction<_c_sqlite3_create_module,
+ _dart_sqlite3_create_module>('sqlite3_create_module');
+ return _sqlite3_create_module(
+ db,
+ zName,
+ p,
+ pClientData,
+ );
+ }
+
+ _dart_sqlite3_create_module _sqlite3_create_module;
+
+ int sqlite3_create_module_v2(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zName,
+ ffi.Pointer<sqlite3_module> p,
+ ffi.Pointer<ffi.Void> pClientData,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_80>> xDestroy,
+ ) {
+ _sqlite3_create_module_v2 ??= _dylib.lookupFunction<
+ _c_sqlite3_create_module_v2,
+ _dart_sqlite3_create_module_v2>('sqlite3_create_module_v2');
+ return _sqlite3_create_module_v2(
+ db,
+ zName,
+ p,
+ pClientData,
+ xDestroy,
+ );
+ }
+
+ _dart_sqlite3_create_module_v2 _sqlite3_create_module_v2;
+
+ int sqlite3_drop_modules(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> azKeep,
+ ) {
+ _sqlite3_drop_modules ??= _dylib.lookupFunction<_c_sqlite3_drop_modules,
+ _dart_sqlite3_drop_modules>('sqlite3_drop_modules');
+ return _sqlite3_drop_modules(
+ db,
+ azKeep,
+ );
+ }
+
+ _dart_sqlite3_drop_modules _sqlite3_drop_modules;
+
+ int sqlite3_declare_vtab(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zSQL,
+ ) {
+ _sqlite3_declare_vtab ??= _dylib.lookupFunction<_c_sqlite3_declare_vtab,
+ _dart_sqlite3_declare_vtab>('sqlite3_declare_vtab');
+ return _sqlite3_declare_vtab(
+ arg0,
+ zSQL,
+ );
+ }
+
+ _dart_sqlite3_declare_vtab _sqlite3_declare_vtab;
+
+ int sqlite3_overload_function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zFuncName,
+ int nArg,
+ ) {
+ _sqlite3_overload_function ??= _dylib.lookupFunction<
+ _c_sqlite3_overload_function,
+ _dart_sqlite3_overload_function>('sqlite3_overload_function');
+ return _sqlite3_overload_function(
+ arg0,
+ zFuncName,
+ nArg,
+ );
+ }
+
+ _dart_sqlite3_overload_function _sqlite3_overload_function;
+
+ int sqlite3_blob_open(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zDb,
+ ffi.Pointer<ffi.Int8> zTable,
+ ffi.Pointer<ffi.Int8> zColumn,
+ int iRow,
+ int flags,
+ ffi.Pointer<ffi.Pointer<sqlite3_blob>> ppBlob,
+ ) {
+ _sqlite3_blob_open ??=
+ _dylib.lookupFunction<_c_sqlite3_blob_open, _dart_sqlite3_blob_open>(
+ 'sqlite3_blob_open');
+ return _sqlite3_blob_open(
+ arg0,
+ zDb,
+ zTable,
+ zColumn,
+ iRow,
+ flags,
+ ppBlob,
+ );
+ }
+
+ _dart_sqlite3_blob_open _sqlite3_blob_open;
+
+ int sqlite3_blob_reopen(
+ ffi.Pointer<sqlite3_blob> arg0,
+ int arg1,
+ ) {
+ _sqlite3_blob_reopen ??= _dylib.lookupFunction<_c_sqlite3_blob_reopen,
+ _dart_sqlite3_blob_reopen>('sqlite3_blob_reopen');
+ return _sqlite3_blob_reopen(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_blob_reopen _sqlite3_blob_reopen;
+
+ int sqlite3_blob_close(
+ ffi.Pointer<sqlite3_blob> arg0,
+ ) {
+ _sqlite3_blob_close ??=
+ _dylib.lookupFunction<_c_sqlite3_blob_close, _dart_sqlite3_blob_close>(
+ 'sqlite3_blob_close');
+ return _sqlite3_blob_close(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_blob_close _sqlite3_blob_close;
+
+ int sqlite3_blob_bytes(
+ ffi.Pointer<sqlite3_blob> arg0,
+ ) {
+ _sqlite3_blob_bytes ??=
+ _dylib.lookupFunction<_c_sqlite3_blob_bytes, _dart_sqlite3_blob_bytes>(
+ 'sqlite3_blob_bytes');
+ return _sqlite3_blob_bytes(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_blob_bytes _sqlite3_blob_bytes;
+
+ int sqlite3_blob_read(
+ ffi.Pointer<sqlite3_blob> arg0,
+ ffi.Pointer<ffi.Void> Z,
+ int N,
+ int iOffset,
+ ) {
+ _sqlite3_blob_read ??=
+ _dylib.lookupFunction<_c_sqlite3_blob_read, _dart_sqlite3_blob_read>(
+ 'sqlite3_blob_read');
+ return _sqlite3_blob_read(
+ arg0,
+ Z,
+ N,
+ iOffset,
+ );
+ }
+
+ _dart_sqlite3_blob_read _sqlite3_blob_read;
+
+ int sqlite3_blob_write(
+ ffi.Pointer<sqlite3_blob> arg0,
+ ffi.Pointer<ffi.Void> z,
+ int n,
+ int iOffset,
+ ) {
+ _sqlite3_blob_write ??=
+ _dylib.lookupFunction<_c_sqlite3_blob_write, _dart_sqlite3_blob_write>(
+ 'sqlite3_blob_write');
+ return _sqlite3_blob_write(
+ arg0,
+ z,
+ n,
+ iOffset,
+ );
+ }
+
+ _dart_sqlite3_blob_write _sqlite3_blob_write;
+
+ ffi.Pointer<sqlite3_vfs> sqlite3_vfs_find(
+ ffi.Pointer<ffi.Int8> zVfsName,
+ ) {
+ _sqlite3_vfs_find ??=
+ _dylib.lookupFunction<_c_sqlite3_vfs_find, _dart_sqlite3_vfs_find>(
+ 'sqlite3_vfs_find');
+ return _sqlite3_vfs_find(
+ zVfsName,
+ );
+ }
+
+ _dart_sqlite3_vfs_find _sqlite3_vfs_find;
+
+ int sqlite3_vfs_register(
+ ffi.Pointer<sqlite3_vfs> arg0,
+ int makeDflt,
+ ) {
+ _sqlite3_vfs_register ??= _dylib.lookupFunction<_c_sqlite3_vfs_register,
+ _dart_sqlite3_vfs_register>('sqlite3_vfs_register');
+ return _sqlite3_vfs_register(
+ arg0,
+ makeDflt,
+ );
+ }
+
+ _dart_sqlite3_vfs_register _sqlite3_vfs_register;
+
+ int sqlite3_vfs_unregister(
+ ffi.Pointer<sqlite3_vfs> arg0,
+ ) {
+ _sqlite3_vfs_unregister ??= _dylib.lookupFunction<_c_sqlite3_vfs_unregister,
+ _dart_sqlite3_vfs_unregister>('sqlite3_vfs_unregister');
+ return _sqlite3_vfs_unregister(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_vfs_unregister _sqlite3_vfs_unregister;
+
+ ffi.Pointer<sqlite3_mutex> sqlite3_mutex_alloc(
+ int arg0,
+ ) {
+ _sqlite3_mutex_alloc ??= _dylib.lookupFunction<_c_sqlite3_mutex_alloc,
+ _dart_sqlite3_mutex_alloc>('sqlite3_mutex_alloc');
+ return _sqlite3_mutex_alloc(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_mutex_alloc _sqlite3_mutex_alloc;
+
+ void sqlite3_mutex_free(
+ ffi.Pointer<sqlite3_mutex> arg0,
+ ) {
+ _sqlite3_mutex_free ??=
+ _dylib.lookupFunction<_c_sqlite3_mutex_free, _dart_sqlite3_mutex_free>(
+ 'sqlite3_mutex_free');
+ return _sqlite3_mutex_free(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_mutex_free _sqlite3_mutex_free;
+
+ void sqlite3_mutex_enter(
+ ffi.Pointer<sqlite3_mutex> arg0,
+ ) {
+ _sqlite3_mutex_enter ??= _dylib.lookupFunction<_c_sqlite3_mutex_enter,
+ _dart_sqlite3_mutex_enter>('sqlite3_mutex_enter');
+ return _sqlite3_mutex_enter(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_mutex_enter _sqlite3_mutex_enter;
+
+ int sqlite3_mutex_try(
+ ffi.Pointer<sqlite3_mutex> arg0,
+ ) {
+ _sqlite3_mutex_try ??=
+ _dylib.lookupFunction<_c_sqlite3_mutex_try, _dart_sqlite3_mutex_try>(
+ 'sqlite3_mutex_try');
+ return _sqlite3_mutex_try(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_mutex_try _sqlite3_mutex_try;
+
+ void sqlite3_mutex_leave(
+ ffi.Pointer<sqlite3_mutex> arg0,
+ ) {
+ _sqlite3_mutex_leave ??= _dylib.lookupFunction<_c_sqlite3_mutex_leave,
+ _dart_sqlite3_mutex_leave>('sqlite3_mutex_leave');
+ return _sqlite3_mutex_leave(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_mutex_leave _sqlite3_mutex_leave;
+
+ int sqlite3_mutex_held(
+ ffi.Pointer<sqlite3_mutex> arg0,
+ ) {
+ _sqlite3_mutex_held ??=
+ _dylib.lookupFunction<_c_sqlite3_mutex_held, _dart_sqlite3_mutex_held>(
+ 'sqlite3_mutex_held');
+ return _sqlite3_mutex_held(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_mutex_held _sqlite3_mutex_held;
+
+ int sqlite3_mutex_notheld(
+ ffi.Pointer<sqlite3_mutex> arg0,
+ ) {
+ _sqlite3_mutex_notheld ??= _dylib.lookupFunction<_c_sqlite3_mutex_notheld,
+ _dart_sqlite3_mutex_notheld>('sqlite3_mutex_notheld');
+ return _sqlite3_mutex_notheld(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_mutex_notheld _sqlite3_mutex_notheld;
+
+ ffi.Pointer<sqlite3_mutex> sqlite3_db_mutex(
+ ffi.Pointer<sqlite3> arg0,
+ ) {
+ _sqlite3_db_mutex ??=
+ _dylib.lookupFunction<_c_sqlite3_db_mutex, _dart_sqlite3_db_mutex>(
+ 'sqlite3_db_mutex');
+ return _sqlite3_db_mutex(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_db_mutex _sqlite3_db_mutex;
+
+ int sqlite3_file_control(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zDbName,
+ int op,
+ ffi.Pointer<ffi.Void> arg3,
+ ) {
+ _sqlite3_file_control ??= _dylib.lookupFunction<_c_sqlite3_file_control,
+ _dart_sqlite3_file_control>('sqlite3_file_control');
+ return _sqlite3_file_control(
+ arg0,
+ zDbName,
+ op,
+ arg3,
+ );
+ }
+
+ _dart_sqlite3_file_control _sqlite3_file_control;
+
+ int sqlite3_test_control(
+ int op,
+ ) {
+ _sqlite3_test_control ??= _dylib.lookupFunction<_c_sqlite3_test_control,
+ _dart_sqlite3_test_control>('sqlite3_test_control');
+ return _sqlite3_test_control(
+ op,
+ );
+ }
+
+ _dart_sqlite3_test_control _sqlite3_test_control;
+
+ int sqlite3_keyword_count() {
+ _sqlite3_keyword_count ??= _dylib.lookupFunction<_c_sqlite3_keyword_count,
+ _dart_sqlite3_keyword_count>('sqlite3_keyword_count');
+ return _sqlite3_keyword_count();
+ }
+
+ _dart_sqlite3_keyword_count _sqlite3_keyword_count;
+
+ int sqlite3_keyword_name(
+ int arg0,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> arg1,
+ ffi.Pointer<ffi.Int32> arg2,
+ ) {
+ _sqlite3_keyword_name ??= _dylib.lookupFunction<_c_sqlite3_keyword_name,
+ _dart_sqlite3_keyword_name>('sqlite3_keyword_name');
+ return _sqlite3_keyword_name(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_keyword_name _sqlite3_keyword_name;
+
+ int sqlite3_keyword_check(
+ ffi.Pointer<ffi.Int8> arg0,
+ int arg1,
+ ) {
+ _sqlite3_keyword_check ??= _dylib.lookupFunction<_c_sqlite3_keyword_check,
+ _dart_sqlite3_keyword_check>('sqlite3_keyword_check');
+ return _sqlite3_keyword_check(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_keyword_check _sqlite3_keyword_check;
+
+ ffi.Pointer<sqlite3_str> sqlite3_str_new(
+ ffi.Pointer<sqlite3> arg0,
+ ) {
+ _sqlite3_str_new ??=
+ _dylib.lookupFunction<_c_sqlite3_str_new, _dart_sqlite3_str_new>(
+ 'sqlite3_str_new');
+ return _sqlite3_str_new(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_str_new _sqlite3_str_new;
+
+ ffi.Pointer<ffi.Int8> sqlite3_str_finish(
+ ffi.Pointer<sqlite3_str> arg0,
+ ) {
+ _sqlite3_str_finish ??=
+ _dylib.lookupFunction<_c_sqlite3_str_finish, _dart_sqlite3_str_finish>(
+ 'sqlite3_str_finish');
+ return _sqlite3_str_finish(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_str_finish _sqlite3_str_finish;
+
+ void sqlite3_str_appendf(
+ ffi.Pointer<sqlite3_str> arg0,
+ ffi.Pointer<ffi.Int8> zFormat,
+ ) {
+ _sqlite3_str_appendf ??= _dylib.lookupFunction<_c_sqlite3_str_appendf,
+ _dart_sqlite3_str_appendf>('sqlite3_str_appendf');
+ return _sqlite3_str_appendf(
+ arg0,
+ zFormat,
+ );
+ }
+
+ _dart_sqlite3_str_appendf _sqlite3_str_appendf;
+
+ void sqlite3_str_append(
+ ffi.Pointer<sqlite3_str> arg0,
+ ffi.Pointer<ffi.Int8> zIn,
+ int N,
+ ) {
+ _sqlite3_str_append ??=
+ _dylib.lookupFunction<_c_sqlite3_str_append, _dart_sqlite3_str_append>(
+ 'sqlite3_str_append');
+ return _sqlite3_str_append(
+ arg0,
+ zIn,
+ N,
+ );
+ }
+
+ _dart_sqlite3_str_append _sqlite3_str_append;
+
+ void sqlite3_str_appendall(
+ ffi.Pointer<sqlite3_str> arg0,
+ ffi.Pointer<ffi.Int8> zIn,
+ ) {
+ _sqlite3_str_appendall ??= _dylib.lookupFunction<_c_sqlite3_str_appendall,
+ _dart_sqlite3_str_appendall>('sqlite3_str_appendall');
+ return _sqlite3_str_appendall(
+ arg0,
+ zIn,
+ );
+ }
+
+ _dart_sqlite3_str_appendall _sqlite3_str_appendall;
+
+ void sqlite3_str_appendchar(
+ ffi.Pointer<sqlite3_str> arg0,
+ int N,
+ int C,
+ ) {
+ _sqlite3_str_appendchar ??= _dylib.lookupFunction<_c_sqlite3_str_appendchar,
+ _dart_sqlite3_str_appendchar>('sqlite3_str_appendchar');
+ return _sqlite3_str_appendchar(
+ arg0,
+ N,
+ C,
+ );
+ }
+
+ _dart_sqlite3_str_appendchar _sqlite3_str_appendchar;
+
+ void sqlite3_str_reset(
+ ffi.Pointer<sqlite3_str> arg0,
+ ) {
+ _sqlite3_str_reset ??=
+ _dylib.lookupFunction<_c_sqlite3_str_reset, _dart_sqlite3_str_reset>(
+ 'sqlite3_str_reset');
+ return _sqlite3_str_reset(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_str_reset _sqlite3_str_reset;
+
+ int sqlite3_str_errcode(
+ ffi.Pointer<sqlite3_str> arg0,
+ ) {
+ _sqlite3_str_errcode ??= _dylib.lookupFunction<_c_sqlite3_str_errcode,
+ _dart_sqlite3_str_errcode>('sqlite3_str_errcode');
+ return _sqlite3_str_errcode(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_str_errcode _sqlite3_str_errcode;
+
+ int sqlite3_str_length(
+ ffi.Pointer<sqlite3_str> arg0,
+ ) {
+ _sqlite3_str_length ??=
+ _dylib.lookupFunction<_c_sqlite3_str_length, _dart_sqlite3_str_length>(
+ 'sqlite3_str_length');
+ return _sqlite3_str_length(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_str_length _sqlite3_str_length;
+
+ ffi.Pointer<ffi.Int8> sqlite3_str_value(
+ ffi.Pointer<sqlite3_str> arg0,
+ ) {
+ _sqlite3_str_value ??=
+ _dylib.lookupFunction<_c_sqlite3_str_value, _dart_sqlite3_str_value>(
+ 'sqlite3_str_value');
+ return _sqlite3_str_value(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_str_value _sqlite3_str_value;
+
+ int sqlite3_status(
+ int op,
+ ffi.Pointer<ffi.Int32> pCurrent,
+ ffi.Pointer<ffi.Int32> pHighwater,
+ int resetFlag,
+ ) {
+ _sqlite3_status ??=
+ _dylib.lookupFunction<_c_sqlite3_status, _dart_sqlite3_status>(
+ 'sqlite3_status');
+ return _sqlite3_status(
+ op,
+ pCurrent,
+ pHighwater,
+ resetFlag,
+ );
+ }
+
+ _dart_sqlite3_status _sqlite3_status;
+
+ int sqlite3_status64(
+ int op,
+ ffi.Pointer<ffi.Int64> pCurrent,
+ ffi.Pointer<ffi.Int64> pHighwater,
+ int resetFlag,
+ ) {
+ _sqlite3_status64 ??=
+ _dylib.lookupFunction<_c_sqlite3_status64, _dart_sqlite3_status64>(
+ 'sqlite3_status64');
+ return _sqlite3_status64(
+ op,
+ pCurrent,
+ pHighwater,
+ resetFlag,
+ );
+ }
+
+ _dart_sqlite3_status64 _sqlite3_status64;
+
+ int sqlite3_db_status(
+ ffi.Pointer<sqlite3> arg0,
+ int op,
+ ffi.Pointer<ffi.Int32> pCur,
+ ffi.Pointer<ffi.Int32> pHiwtr,
+ int resetFlg,
+ ) {
+ _sqlite3_db_status ??=
+ _dylib.lookupFunction<_c_sqlite3_db_status, _dart_sqlite3_db_status>(
+ 'sqlite3_db_status');
+ return _sqlite3_db_status(
+ arg0,
+ op,
+ pCur,
+ pHiwtr,
+ resetFlg,
+ );
+ }
+
+ _dart_sqlite3_db_status _sqlite3_db_status;
+
+ int sqlite3_stmt_status(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int op,
+ int resetFlg,
+ ) {
+ _sqlite3_stmt_status ??= _dylib.lookupFunction<_c_sqlite3_stmt_status,
+ _dart_sqlite3_stmt_status>('sqlite3_stmt_status');
+ return _sqlite3_stmt_status(
+ arg0,
+ op,
+ resetFlg,
+ );
+ }
+
+ _dart_sqlite3_stmt_status _sqlite3_stmt_status;
+
+ ffi.Pointer<sqlite3_backup> sqlite3_backup_init(
+ ffi.Pointer<sqlite3> pDest,
+ ffi.Pointer<ffi.Int8> zDestName,
+ ffi.Pointer<sqlite3> pSource,
+ ffi.Pointer<ffi.Int8> zSourceName,
+ ) {
+ _sqlite3_backup_init ??= _dylib.lookupFunction<_c_sqlite3_backup_init,
+ _dart_sqlite3_backup_init>('sqlite3_backup_init');
+ return _sqlite3_backup_init(
+ pDest,
+ zDestName,
+ pSource,
+ zSourceName,
+ );
+ }
+
+ _dart_sqlite3_backup_init _sqlite3_backup_init;
+
+ int sqlite3_backup_step(
+ ffi.Pointer<sqlite3_backup> p,
+ int nPage,
+ ) {
+ _sqlite3_backup_step ??= _dylib.lookupFunction<_c_sqlite3_backup_step,
+ _dart_sqlite3_backup_step>('sqlite3_backup_step');
+ return _sqlite3_backup_step(
+ p,
+ nPage,
+ );
+ }
+
+ _dart_sqlite3_backup_step _sqlite3_backup_step;
+
+ int sqlite3_backup_finish(
+ ffi.Pointer<sqlite3_backup> p,
+ ) {
+ _sqlite3_backup_finish ??= _dylib.lookupFunction<_c_sqlite3_backup_finish,
+ _dart_sqlite3_backup_finish>('sqlite3_backup_finish');
+ return _sqlite3_backup_finish(
+ p,
+ );
+ }
+
+ _dart_sqlite3_backup_finish _sqlite3_backup_finish;
+
+ int sqlite3_backup_remaining(
+ ffi.Pointer<sqlite3_backup> p,
+ ) {
+ _sqlite3_backup_remaining ??= _dylib.lookupFunction<
+ _c_sqlite3_backup_remaining,
+ _dart_sqlite3_backup_remaining>('sqlite3_backup_remaining');
+ return _sqlite3_backup_remaining(
+ p,
+ );
+ }
+
+ _dart_sqlite3_backup_remaining _sqlite3_backup_remaining;
+
+ int sqlite3_backup_pagecount(
+ ffi.Pointer<sqlite3_backup> p,
+ ) {
+ _sqlite3_backup_pagecount ??= _dylib.lookupFunction<
+ _c_sqlite3_backup_pagecount,
+ _dart_sqlite3_backup_pagecount>('sqlite3_backup_pagecount');
+ return _sqlite3_backup_pagecount(
+ p,
+ );
+ }
+
+ _dart_sqlite3_backup_pagecount _sqlite3_backup_pagecount;
+
+ int sqlite3_unlock_notify(
+ ffi.Pointer<sqlite3> pBlocked,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_81>> xNotify,
+ ffi.Pointer<ffi.Void> pNotifyArg,
+ ) {
+ _sqlite3_unlock_notify ??= _dylib.lookupFunction<_c_sqlite3_unlock_notify,
+ _dart_sqlite3_unlock_notify>('sqlite3_unlock_notify');
+ return _sqlite3_unlock_notify(
+ pBlocked,
+ xNotify,
+ pNotifyArg,
+ );
+ }
+
+ _dart_sqlite3_unlock_notify _sqlite3_unlock_notify;
+
+ int sqlite3_stricmp(
+ ffi.Pointer<ffi.Int8> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ ) {
+ _sqlite3_stricmp ??=
+ _dylib.lookupFunction<_c_sqlite3_stricmp, _dart_sqlite3_stricmp>(
+ 'sqlite3_stricmp');
+ return _sqlite3_stricmp(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_stricmp _sqlite3_stricmp;
+
+ int sqlite3_strnicmp(
+ ffi.Pointer<ffi.Int8> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ int arg2,
+ ) {
+ _sqlite3_strnicmp ??=
+ _dylib.lookupFunction<_c_sqlite3_strnicmp, _dart_sqlite3_strnicmp>(
+ 'sqlite3_strnicmp');
+ return _sqlite3_strnicmp(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_strnicmp _sqlite3_strnicmp;
+
+ int sqlite3_strglob(
+ ffi.Pointer<ffi.Int8> zGlob,
+ ffi.Pointer<ffi.Int8> zStr,
+ ) {
+ _sqlite3_strglob ??=
+ _dylib.lookupFunction<_c_sqlite3_strglob, _dart_sqlite3_strglob>(
+ 'sqlite3_strglob');
+ return _sqlite3_strglob(
+ zGlob,
+ zStr,
+ );
+ }
+
+ _dart_sqlite3_strglob _sqlite3_strglob;
+
+ int sqlite3_strlike(
+ ffi.Pointer<ffi.Int8> zGlob,
+ ffi.Pointer<ffi.Int8> zStr,
+ int cEsc,
+ ) {
+ _sqlite3_strlike ??=
+ _dylib.lookupFunction<_c_sqlite3_strlike, _dart_sqlite3_strlike>(
+ 'sqlite3_strlike');
+ return _sqlite3_strlike(
+ zGlob,
+ zStr,
+ cEsc,
+ );
+ }
+
+ _dart_sqlite3_strlike _sqlite3_strlike;
+
+ void sqlite3_log(
+ int iErrCode,
+ ffi.Pointer<ffi.Int8> zFormat,
+ ) {
+ _sqlite3_log ??=
+ _dylib.lookupFunction<_c_sqlite3_log, _dart_sqlite3_log>('sqlite3_log');
+ return _sqlite3_log(
+ iErrCode,
+ zFormat,
+ );
+ }
+
+ _dart_sqlite3_log _sqlite3_log;
+
+ ffi.Pointer<ffi.Void> sqlite3_wal_hook(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_82>> arg1,
+ ffi.Pointer<ffi.Void> arg2,
+ ) {
+ _sqlite3_wal_hook ??=
+ _dylib.lookupFunction<_c_sqlite3_wal_hook, _dart_sqlite3_wal_hook>(
+ 'sqlite3_wal_hook');
+ return _sqlite3_wal_hook(
+ arg0,
+ arg1,
+ arg2,
+ );
+ }
+
+ _dart_sqlite3_wal_hook _sqlite3_wal_hook;
+
+ int sqlite3_wal_autocheckpoint(
+ ffi.Pointer<sqlite3> db,
+ int N,
+ ) {
+ _sqlite3_wal_autocheckpoint ??= _dylib.lookupFunction<
+ _c_sqlite3_wal_autocheckpoint,
+ _dart_sqlite3_wal_autocheckpoint>('sqlite3_wal_autocheckpoint');
+ return _sqlite3_wal_autocheckpoint(
+ db,
+ N,
+ );
+ }
+
+ _dart_sqlite3_wal_autocheckpoint _sqlite3_wal_autocheckpoint;
+
+ int sqlite3_wal_checkpoint(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDb,
+ ) {
+ _sqlite3_wal_checkpoint ??= _dylib.lookupFunction<_c_sqlite3_wal_checkpoint,
+ _dart_sqlite3_wal_checkpoint>('sqlite3_wal_checkpoint');
+ return _sqlite3_wal_checkpoint(
+ db,
+ zDb,
+ );
+ }
+
+ _dart_sqlite3_wal_checkpoint _sqlite3_wal_checkpoint;
+
+ int sqlite3_wal_checkpoint_v2(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDb,
+ int eMode,
+ ffi.Pointer<ffi.Int32> pnLog,
+ ffi.Pointer<ffi.Int32> pnCkpt,
+ ) {
+ _sqlite3_wal_checkpoint_v2 ??= _dylib.lookupFunction<
+ _c_sqlite3_wal_checkpoint_v2,
+ _dart_sqlite3_wal_checkpoint_v2>('sqlite3_wal_checkpoint_v2');
+ return _sqlite3_wal_checkpoint_v2(
+ db,
+ zDb,
+ eMode,
+ pnLog,
+ pnCkpt,
+ );
+ }
+
+ _dart_sqlite3_wal_checkpoint_v2 _sqlite3_wal_checkpoint_v2;
+
+ int sqlite3_vtab_config(
+ ffi.Pointer<sqlite3> arg0,
+ int op,
+ ) {
+ _sqlite3_vtab_config ??= _dylib.lookupFunction<_c_sqlite3_vtab_config,
+ _dart_sqlite3_vtab_config>('sqlite3_vtab_config');
+ return _sqlite3_vtab_config(
+ arg0,
+ op,
+ );
+ }
+
+ _dart_sqlite3_vtab_config _sqlite3_vtab_config;
+
+ int sqlite3_vtab_on_conflict(
+ ffi.Pointer<sqlite3> arg0,
+ ) {
+ _sqlite3_vtab_on_conflict ??= _dylib.lookupFunction<
+ _c_sqlite3_vtab_on_conflict,
+ _dart_sqlite3_vtab_on_conflict>('sqlite3_vtab_on_conflict');
+ return _sqlite3_vtab_on_conflict(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_vtab_on_conflict _sqlite3_vtab_on_conflict;
+
+ int sqlite3_vtab_nochange(
+ ffi.Pointer<sqlite3_context> arg0,
+ ) {
+ _sqlite3_vtab_nochange ??= _dylib.lookupFunction<_c_sqlite3_vtab_nochange,
+ _dart_sqlite3_vtab_nochange>('sqlite3_vtab_nochange');
+ return _sqlite3_vtab_nochange(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_vtab_nochange _sqlite3_vtab_nochange;
+
+ ffi.Pointer<ffi.Int8> sqlite3_vtab_collation(
+ ffi.Pointer<sqlite3_index_info> arg0,
+ int arg1,
+ ) {
+ _sqlite3_vtab_collation ??= _dylib.lookupFunction<_c_sqlite3_vtab_collation,
+ _dart_sqlite3_vtab_collation>('sqlite3_vtab_collation');
+ return _sqlite3_vtab_collation(
+ arg0,
+ arg1,
+ );
+ }
+
+ _dart_sqlite3_vtab_collation _sqlite3_vtab_collation;
+
+ int sqlite3_stmt_scanstatus(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+ int idx,
+ int iScanStatusOp,
+ ffi.Pointer<ffi.Void> pOut,
+ ) {
+ _sqlite3_stmt_scanstatus ??= _dylib.lookupFunction<
+ _c_sqlite3_stmt_scanstatus,
+ _dart_sqlite3_stmt_scanstatus>('sqlite3_stmt_scanstatus');
+ return _sqlite3_stmt_scanstatus(
+ pStmt,
+ idx,
+ iScanStatusOp,
+ pOut,
+ );
+ }
+
+ _dart_sqlite3_stmt_scanstatus _sqlite3_stmt_scanstatus;
+
+ void sqlite3_stmt_scanstatus_reset(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ) {
+ _sqlite3_stmt_scanstatus_reset ??= _dylib.lookupFunction<
+ _c_sqlite3_stmt_scanstatus_reset,
+ _dart_sqlite3_stmt_scanstatus_reset>('sqlite3_stmt_scanstatus_reset');
+ return _sqlite3_stmt_scanstatus_reset(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_stmt_scanstatus_reset _sqlite3_stmt_scanstatus_reset;
+
+ int sqlite3_db_cacheflush(
+ ffi.Pointer<sqlite3> arg0,
+ ) {
+ _sqlite3_db_cacheflush ??= _dylib.lookupFunction<_c_sqlite3_db_cacheflush,
+ _dart_sqlite3_db_cacheflush>('sqlite3_db_cacheflush');
+ return _sqlite3_db_cacheflush(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_db_cacheflush _sqlite3_db_cacheflush;
+
+ int sqlite3_system_errno(
+ ffi.Pointer<sqlite3> arg0,
+ ) {
+ _sqlite3_system_errno ??= _dylib.lookupFunction<_c_sqlite3_system_errno,
+ _dart_sqlite3_system_errno>('sqlite3_system_errno');
+ return _sqlite3_system_errno(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_system_errno _sqlite3_system_errno;
+
+ int sqlite3_snapshot_get(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSchema,
+ ffi.Pointer<ffi.Pointer<sqlite3_snapshot>> ppSnapshot,
+ ) {
+ _sqlite3_snapshot_get ??= _dylib.lookupFunction<_c_sqlite3_snapshot_get,
+ _dart_sqlite3_snapshot_get>('sqlite3_snapshot_get');
+ return _sqlite3_snapshot_get(
+ db,
+ zSchema,
+ ppSnapshot,
+ );
+ }
+
+ _dart_sqlite3_snapshot_get _sqlite3_snapshot_get;
+
+ int sqlite3_snapshot_open(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSchema,
+ ffi.Pointer<sqlite3_snapshot> pSnapshot,
+ ) {
+ _sqlite3_snapshot_open ??= _dylib.lookupFunction<_c_sqlite3_snapshot_open,
+ _dart_sqlite3_snapshot_open>('sqlite3_snapshot_open');
+ return _sqlite3_snapshot_open(
+ db,
+ zSchema,
+ pSnapshot,
+ );
+ }
+
+ _dart_sqlite3_snapshot_open _sqlite3_snapshot_open;
+
+ void sqlite3_snapshot_free(
+ ffi.Pointer<sqlite3_snapshot> arg0,
+ ) {
+ _sqlite3_snapshot_free ??= _dylib.lookupFunction<_c_sqlite3_snapshot_free,
+ _dart_sqlite3_snapshot_free>('sqlite3_snapshot_free');
+ return _sqlite3_snapshot_free(
+ arg0,
+ );
+ }
+
+ _dart_sqlite3_snapshot_free _sqlite3_snapshot_free;
+
+ int sqlite3_snapshot_cmp(
+ ffi.Pointer<sqlite3_snapshot> p1,
+ ffi.Pointer<sqlite3_snapshot> p2,
+ ) {
+ _sqlite3_snapshot_cmp ??= _dylib.lookupFunction<_c_sqlite3_snapshot_cmp,
+ _dart_sqlite3_snapshot_cmp>('sqlite3_snapshot_cmp');
+ return _sqlite3_snapshot_cmp(
+ p1,
+ p2,
+ );
+ }
+
+ _dart_sqlite3_snapshot_cmp _sqlite3_snapshot_cmp;
+
+ int sqlite3_snapshot_recover(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDb,
+ ) {
+ _sqlite3_snapshot_recover ??= _dylib.lookupFunction<
+ _c_sqlite3_snapshot_recover,
+ _dart_sqlite3_snapshot_recover>('sqlite3_snapshot_recover');
+ return _sqlite3_snapshot_recover(
+ db,
+ zDb,
+ );
+ }
+
+ _dart_sqlite3_snapshot_recover _sqlite3_snapshot_recover;
+
+ ffi.Pointer<ffi.Uint8> sqlite3_serialize(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSchema,
+ ffi.Pointer<ffi.Int64> piSize,
+ int mFlags,
+ ) {
+ _sqlite3_serialize ??=
+ _dylib.lookupFunction<_c_sqlite3_serialize, _dart_sqlite3_serialize>(
+ 'sqlite3_serialize');
+ return _sqlite3_serialize(
+ db,
+ zSchema,
+ piSize,
+ mFlags,
+ );
+ }
+
+ _dart_sqlite3_serialize _sqlite3_serialize;
+
+ int sqlite3_deserialize(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSchema,
+ ffi.Pointer<ffi.Uint8> pData,
+ int szDb,
+ int szBuf,
+ int mFlags,
+ ) {
+ _sqlite3_deserialize ??= _dylib.lookupFunction<_c_sqlite3_deserialize,
+ _dart_sqlite3_deserialize>('sqlite3_deserialize');
+ return _sqlite3_deserialize(
+ db,
+ zSchema,
+ pData,
+ szDb,
+ szBuf,
+ mFlags,
+ );
+ }
+
+ _dart_sqlite3_deserialize _sqlite3_deserialize;
+
+ int sqlite3_rtree_geometry_callback(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zGeom,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_83>> xGeom,
+ ffi.Pointer<ffi.Void> pContext,
+ ) {
+ _sqlite3_rtree_geometry_callback ??= _dylib.lookupFunction<
+ _c_sqlite3_rtree_geometry_callback,
+ _dart_sqlite3_rtree_geometry_callback>(
+ 'sqlite3_rtree_geometry_callback');
+ return _sqlite3_rtree_geometry_callback(
+ db,
+ zGeom,
+ xGeom,
+ pContext,
+ );
+ }
+
+ _dart_sqlite3_rtree_geometry_callback _sqlite3_rtree_geometry_callback;
+
+ int sqlite3_rtree_query_callback(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zQueryFunc,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_84>> xQueryFunc,
+ ffi.Pointer<ffi.Void> pContext,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_85>> xDestructor,
+ ) {
+ _sqlite3_rtree_query_callback ??= _dylib.lookupFunction<
+ _c_sqlite3_rtree_query_callback,
+ _dart_sqlite3_rtree_query_callback>('sqlite3_rtree_query_callback');
+ return _sqlite3_rtree_query_callback(
+ db,
+ zQueryFunc,
+ xQueryFunc,
+ pContext,
+ xDestructor,
+ );
+ }
+
+ _dart_sqlite3_rtree_query_callback _sqlite3_rtree_query_callback;
+}
+
+class sqlite3 extends ffi.Struct {}
+
+class sqlite3_file extends ffi.Struct {}
+
+class sqlite3_io_methods extends ffi.Struct {
+ @ffi.Int32()
+ int iVersion;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_14>> xClose;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_15>> xRead;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_16>> xWrite;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_17>> xTruncate;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_18>> xSync;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_19>> xFileSize;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_20>> xLock;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_21>> xUnlock;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_22>> xCheckReservedLock;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_23>> xFileControl;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_24>> xSectorSize;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_25>> xDeviceCharacteristics;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_26>> xShmMap;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_27>> xShmLock;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_28>> xShmBarrier;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_29>> xShmUnmap;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_30>> xFetch;
+
+ ffi.Pointer<ffi.NativeFunction<_typedefC_31>> xUnfetch;
+}
+
+class sqlite3_mutex extends ffi.Struct {}
+
+class sqlite3_api_routines extends ffi.Struct {}
+
+class sqlite3_vfs extends ffi.Struct {}
+
+class sqlite3_mem_methods extends ffi.Struct {}
+
+class sqlite3_stmt extends ffi.Struct {}
+
+class sqlite3_value extends ffi.Struct {}
+
+class sqlite3_context extends ffi.Struct {}
+
+class sqlite3_vtab extends ffi.Struct {}
+
+class sqlite3_index_info extends ffi.Struct {}
+
+class sqlite3_vtab_cursor extends ffi.Struct {}
+
+class sqlite3_module extends ffi.Struct {}
+
+class sqlite3_blob extends ffi.Struct {}
+
+class sqlite3_mutex_methods extends ffi.Struct {}
+
+class sqlite3_str extends ffi.Struct {}
+
+class sqlite3_pcache extends ffi.Struct {}
+
+class sqlite3_pcache_page extends ffi.Struct {}
+
+class sqlite3_pcache_methods2 extends ffi.Struct {}
+
+class sqlite3_pcache_methods extends ffi.Struct {}
+
+class sqlite3_backup extends ffi.Struct {}
+
+class sqlite3_snapshot extends ffi.Struct {
+ @ffi.Uint8()
+ int _unique_hidden_item_0;
+ @ffi.Uint8()
+ int _unique_hidden_item_1;
+ @ffi.Uint8()
+ int _unique_hidden_item_2;
+ @ffi.Uint8()
+ int _unique_hidden_item_3;
+ @ffi.Uint8()
+ int _unique_hidden_item_4;
+ @ffi.Uint8()
+ int _unique_hidden_item_5;
+ @ffi.Uint8()
+ int _unique_hidden_item_6;
+ @ffi.Uint8()
+ int _unique_hidden_item_7;
+ @ffi.Uint8()
+ int _unique_hidden_item_8;
+ @ffi.Uint8()
+ int _unique_hidden_item_9;
+ @ffi.Uint8()
+ int _unique_hidden_item_10;
+ @ffi.Uint8()
+ int _unique_hidden_item_11;
+ @ffi.Uint8()
+ int _unique_hidden_item_12;
+ @ffi.Uint8()
+ int _unique_hidden_item_13;
+ @ffi.Uint8()
+ int _unique_hidden_item_14;
+ @ffi.Uint8()
+ int _unique_hidden_item_15;
+ @ffi.Uint8()
+ int _unique_hidden_item_16;
+ @ffi.Uint8()
+ int _unique_hidden_item_17;
+ @ffi.Uint8()
+ int _unique_hidden_item_18;
+ @ffi.Uint8()
+ int _unique_hidden_item_19;
+ @ffi.Uint8()
+ int _unique_hidden_item_20;
+ @ffi.Uint8()
+ int _unique_hidden_item_21;
+ @ffi.Uint8()
+ int _unique_hidden_item_22;
+ @ffi.Uint8()
+ int _unique_hidden_item_23;
+ @ffi.Uint8()
+ int _unique_hidden_item_24;
+ @ffi.Uint8()
+ int _unique_hidden_item_25;
+ @ffi.Uint8()
+ int _unique_hidden_item_26;
+ @ffi.Uint8()
+ int _unique_hidden_item_27;
+ @ffi.Uint8()
+ int _unique_hidden_item_28;
+ @ffi.Uint8()
+ int _unique_hidden_item_29;
+ @ffi.Uint8()
+ int _unique_hidden_item_30;
+ @ffi.Uint8()
+ int _unique_hidden_item_31;
+ @ffi.Uint8()
+ int _unique_hidden_item_32;
+ @ffi.Uint8()
+ int _unique_hidden_item_33;
+ @ffi.Uint8()
+ int _unique_hidden_item_34;
+ @ffi.Uint8()
+ int _unique_hidden_item_35;
+ @ffi.Uint8()
+ int _unique_hidden_item_36;
+ @ffi.Uint8()
+ int _unique_hidden_item_37;
+ @ffi.Uint8()
+ int _unique_hidden_item_38;
+ @ffi.Uint8()
+ int _unique_hidden_item_39;
+ @ffi.Uint8()
+ int _unique_hidden_item_40;
+ @ffi.Uint8()
+ int _unique_hidden_item_41;
+ @ffi.Uint8()
+ int _unique_hidden_item_42;
+ @ffi.Uint8()
+ int _unique_hidden_item_43;
+ @ffi.Uint8()
+ int _unique_hidden_item_44;
+ @ffi.Uint8()
+ int _unique_hidden_item_45;
+ @ffi.Uint8()
+ int _unique_hidden_item_46;
+ @ffi.Uint8()
+ int _unique_hidden_item_47;
+
+ /// Helper for array `hidden`.
+ ArrayHelper_sqlite3_snapshot_hidden_level0 get hidden =>
+ ArrayHelper_sqlite3_snapshot_hidden_level0(this, [48], 0, 0);
+}
+
+/// Helper for array `hidden` in struct `sqlite3_snapshot`.
+class ArrayHelper_sqlite3_snapshot_hidden_level0 {
+ final sqlite3_snapshot _struct;
+ final List<int> dimensions;
+ final int level;
+ final int _absoluteIndex;
+ int get length => dimensions[level];
+ ArrayHelper_sqlite3_snapshot_hidden_level0(
+ this._struct, this.dimensions, this.level, this._absoluteIndex);
+ void _checkBounds(int index) {
+ if (index >= length || index < 0) {
+ throw RangeError(
+ 'Dimension $level: index not in range 0..${length} exclusive.');
+ }
+ }
+
+ int operator [](int index) {
+ _checkBounds(index);
+ switch (_absoluteIndex + index) {
+ case 0:
+ return _struct._unique_hidden_item_0;
+ case 1:
+ return _struct._unique_hidden_item_1;
+ case 2:
+ return _struct._unique_hidden_item_2;
+ case 3:
+ return _struct._unique_hidden_item_3;
+ case 4:
+ return _struct._unique_hidden_item_4;
+ case 5:
+ return _struct._unique_hidden_item_5;
+ case 6:
+ return _struct._unique_hidden_item_6;
+ case 7:
+ return _struct._unique_hidden_item_7;
+ case 8:
+ return _struct._unique_hidden_item_8;
+ case 9:
+ return _struct._unique_hidden_item_9;
+ case 10:
+ return _struct._unique_hidden_item_10;
+ case 11:
+ return _struct._unique_hidden_item_11;
+ case 12:
+ return _struct._unique_hidden_item_12;
+ case 13:
+ return _struct._unique_hidden_item_13;
+ case 14:
+ return _struct._unique_hidden_item_14;
+ case 15:
+ return _struct._unique_hidden_item_15;
+ case 16:
+ return _struct._unique_hidden_item_16;
+ case 17:
+ return _struct._unique_hidden_item_17;
+ case 18:
+ return _struct._unique_hidden_item_18;
+ case 19:
+ return _struct._unique_hidden_item_19;
+ case 20:
+ return _struct._unique_hidden_item_20;
+ case 21:
+ return _struct._unique_hidden_item_21;
+ case 22:
+ return _struct._unique_hidden_item_22;
+ case 23:
+ return _struct._unique_hidden_item_23;
+ case 24:
+ return _struct._unique_hidden_item_24;
+ case 25:
+ return _struct._unique_hidden_item_25;
+ case 26:
+ return _struct._unique_hidden_item_26;
+ case 27:
+ return _struct._unique_hidden_item_27;
+ case 28:
+ return _struct._unique_hidden_item_28;
+ case 29:
+ return _struct._unique_hidden_item_29;
+ case 30:
+ return _struct._unique_hidden_item_30;
+ case 31:
+ return _struct._unique_hidden_item_31;
+ case 32:
+ return _struct._unique_hidden_item_32;
+ case 33:
+ return _struct._unique_hidden_item_33;
+ case 34:
+ return _struct._unique_hidden_item_34;
+ case 35:
+ return _struct._unique_hidden_item_35;
+ case 36:
+ return _struct._unique_hidden_item_36;
+ case 37:
+ return _struct._unique_hidden_item_37;
+ case 38:
+ return _struct._unique_hidden_item_38;
+ case 39:
+ return _struct._unique_hidden_item_39;
+ case 40:
+ return _struct._unique_hidden_item_40;
+ case 41:
+ return _struct._unique_hidden_item_41;
+ case 42:
+ return _struct._unique_hidden_item_42;
+ case 43:
+ return _struct._unique_hidden_item_43;
+ case 44:
+ return _struct._unique_hidden_item_44;
+ case 45:
+ return _struct._unique_hidden_item_45;
+ case 46:
+ return _struct._unique_hidden_item_46;
+ case 47:
+ return _struct._unique_hidden_item_47;
+ default:
+ throw Exception('Invalid Array Helper generated.');
+ }
+ }
+
+ void operator []=(int index, int value) {
+ _checkBounds(index);
+ switch (_absoluteIndex + index) {
+ case 0:
+ _struct._unique_hidden_item_0 = value;
+ break;
+ case 1:
+ _struct._unique_hidden_item_1 = value;
+ break;
+ case 2:
+ _struct._unique_hidden_item_2 = value;
+ break;
+ case 3:
+ _struct._unique_hidden_item_3 = value;
+ break;
+ case 4:
+ _struct._unique_hidden_item_4 = value;
+ break;
+ case 5:
+ _struct._unique_hidden_item_5 = value;
+ break;
+ case 6:
+ _struct._unique_hidden_item_6 = value;
+ break;
+ case 7:
+ _struct._unique_hidden_item_7 = value;
+ break;
+ case 8:
+ _struct._unique_hidden_item_8 = value;
+ break;
+ case 9:
+ _struct._unique_hidden_item_9 = value;
+ break;
+ case 10:
+ _struct._unique_hidden_item_10 = value;
+ break;
+ case 11:
+ _struct._unique_hidden_item_11 = value;
+ break;
+ case 12:
+ _struct._unique_hidden_item_12 = value;
+ break;
+ case 13:
+ _struct._unique_hidden_item_13 = value;
+ break;
+ case 14:
+ _struct._unique_hidden_item_14 = value;
+ break;
+ case 15:
+ _struct._unique_hidden_item_15 = value;
+ break;
+ case 16:
+ _struct._unique_hidden_item_16 = value;
+ break;
+ case 17:
+ _struct._unique_hidden_item_17 = value;
+ break;
+ case 18:
+ _struct._unique_hidden_item_18 = value;
+ break;
+ case 19:
+ _struct._unique_hidden_item_19 = value;
+ break;
+ case 20:
+ _struct._unique_hidden_item_20 = value;
+ break;
+ case 21:
+ _struct._unique_hidden_item_21 = value;
+ break;
+ case 22:
+ _struct._unique_hidden_item_22 = value;
+ break;
+ case 23:
+ _struct._unique_hidden_item_23 = value;
+ break;
+ case 24:
+ _struct._unique_hidden_item_24 = value;
+ break;
+ case 25:
+ _struct._unique_hidden_item_25 = value;
+ break;
+ case 26:
+ _struct._unique_hidden_item_26 = value;
+ break;
+ case 27:
+ _struct._unique_hidden_item_27 = value;
+ break;
+ case 28:
+ _struct._unique_hidden_item_28 = value;
+ break;
+ case 29:
+ _struct._unique_hidden_item_29 = value;
+ break;
+ case 30:
+ _struct._unique_hidden_item_30 = value;
+ break;
+ case 31:
+ _struct._unique_hidden_item_31 = value;
+ break;
+ case 32:
+ _struct._unique_hidden_item_32 = value;
+ break;
+ case 33:
+ _struct._unique_hidden_item_33 = value;
+ break;
+ case 34:
+ _struct._unique_hidden_item_34 = value;
+ break;
+ case 35:
+ _struct._unique_hidden_item_35 = value;
+ break;
+ case 36:
+ _struct._unique_hidden_item_36 = value;
+ break;
+ case 37:
+ _struct._unique_hidden_item_37 = value;
+ break;
+ case 38:
+ _struct._unique_hidden_item_38 = value;
+ break;
+ case 39:
+ _struct._unique_hidden_item_39 = value;
+ break;
+ case 40:
+ _struct._unique_hidden_item_40 = value;
+ break;
+ case 41:
+ _struct._unique_hidden_item_41 = value;
+ break;
+ case 42:
+ _struct._unique_hidden_item_42 = value;
+ break;
+ case 43:
+ _struct._unique_hidden_item_43 = value;
+ break;
+ case 44:
+ _struct._unique_hidden_item_44 = value;
+ break;
+ case 45:
+ _struct._unique_hidden_item_45 = value;
+ break;
+ case 46:
+ _struct._unique_hidden_item_46 = value;
+ break;
+ case 47:
+ _struct._unique_hidden_item_47 = value;
+ break;
+ default:
+ throw Exception('Invalid Array Helper generated.');
+ }
+ }
+}
+
+class sqlite3_rtree_geometry extends ffi.Struct {}
+
+class sqlite3_rtree_query_info extends ffi.Struct {}
+
+class Fts5ExtensionApi extends ffi.Struct {}
+
+class Fts5Context extends ffi.Struct {}
+
+class Fts5PhraseIter extends ffi.Struct {}
+
+class Fts5Tokenizer extends ffi.Struct {}
+
+class fts5_tokenizer extends ffi.Struct {}
+
+class fts5_api extends ffi.Struct {}
+
+typedef _c_sqlite3_libversion = ffi.Pointer<ffi.Int8> Function();
+
+typedef _dart_sqlite3_libversion = ffi.Pointer<ffi.Int8> Function();
+
+typedef _c_sqlite3_sourceid = ffi.Pointer<ffi.Int8> Function();
+
+typedef _dart_sqlite3_sourceid = ffi.Pointer<ffi.Int8> Function();
+
+typedef _c_sqlite3_libversion_number = ffi.Int32 Function();
+
+typedef _dart_sqlite3_libversion_number = int Function();
+
+typedef _c_sqlite3_compileoption_used = ffi.Int32 Function(
+ ffi.Pointer<ffi.Int8> zOptName,
+);
+
+typedef _dart_sqlite3_compileoption_used = int Function(
+ ffi.Pointer<ffi.Int8> zOptName,
+);
+
+typedef _c_sqlite3_compileoption_get = ffi.Pointer<ffi.Int8> Function(
+ ffi.Int32 N,
+);
+
+typedef _dart_sqlite3_compileoption_get = ffi.Pointer<ffi.Int8> Function(
+ int N,
+);
+
+typedef _c_sqlite3_threadsafe = ffi.Int32 Function();
+
+typedef _dart_sqlite3_threadsafe = int Function();
+
+typedef _c_sqlite3_close = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _dart_sqlite3_close = int Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _c_sqlite3_close_v2 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _dart_sqlite3_close_v2 = int Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _typedefC_13 = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>>,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>>,
+);
+
+typedef _c_sqlite3_exec = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> sql,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_13>> callback,
+ ffi.Pointer<ffi.Void> arg3,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> errmsg,
+);
+
+typedef _dart_sqlite3_exec = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> sql,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_13>> callback,
+ ffi.Pointer<ffi.Void> arg3,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> errmsg,
+);
+
+typedef _c_sqlite3_initialize = ffi.Int32 Function();
+
+typedef _dart_sqlite3_initialize = int Function();
+
+typedef _c_sqlite3_shutdown = ffi.Int32 Function();
+
+typedef _dart_sqlite3_shutdown = int Function();
+
+typedef _c_sqlite3_os_init = ffi.Int32 Function();
+
+typedef _dart_sqlite3_os_init = int Function();
+
+typedef _c_sqlite3_os_end = ffi.Int32 Function();
+
+typedef _dart_sqlite3_os_end = int Function();
+
+typedef _c_sqlite3_config = ffi.Int32 Function(
+ ffi.Int32 arg0,
+);
+
+typedef _dart_sqlite3_config = int Function(
+ int arg0,
+);
+
+typedef _c_sqlite3_db_config = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Int32 op,
+);
+
+typedef _dart_sqlite3_db_config = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ int op,
+);
+
+typedef _c_sqlite3_extended_result_codes = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Int32 onoff,
+);
+
+typedef _dart_sqlite3_extended_result_codes = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ int onoff,
+);
+
+typedef _c_sqlite3_last_insert_rowid = ffi.Int64 Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _dart_sqlite3_last_insert_rowid = int Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _c_sqlite3_set_last_insert_rowid = ffi.Void Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Int64 arg1,
+);
+
+typedef _dart_sqlite3_set_last_insert_rowid = void Function(
+ ffi.Pointer<sqlite3> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_changes = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _dart_sqlite3_changes = int Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _c_sqlite3_total_changes = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _dart_sqlite3_total_changes = int Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _c_sqlite3_interrupt = ffi.Void Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _dart_sqlite3_interrupt = void Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _c_sqlite3_complete = ffi.Int32 Function(
+ ffi.Pointer<ffi.Int8> sql,
+);
+
+typedef _dart_sqlite3_complete = int Function(
+ ffi.Pointer<ffi.Int8> sql,
+);
+
+typedef _c_sqlite3_complete16 = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void> sql,
+);
+
+typedef _dart_sqlite3_complete16 = int Function(
+ ffi.Pointer<ffi.Void> sql,
+);
+
+typedef _typedefC_32 = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Int32,
+);
+
+typedef _c_sqlite3_busy_handler = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_32>> arg1,
+ ffi.Pointer<ffi.Void> arg2,
+);
+
+typedef _dart_sqlite3_busy_handler = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_32>> arg1,
+ ffi.Pointer<ffi.Void> arg2,
+);
+
+typedef _c_sqlite3_busy_timeout = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Int32 ms,
+);
+
+typedef _dart_sqlite3_busy_timeout = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ int ms,
+);
+
+typedef _c_sqlite3_get_table = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSql,
+ ffi.Pointer<ffi.Pointer<ffi.Pointer<ffi.Int8>>> pazResult,
+ ffi.Pointer<ffi.Int32> pnRow,
+ ffi.Pointer<ffi.Int32> pnColumn,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzErrmsg,
+);
+
+typedef _dart_sqlite3_get_table = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSql,
+ ffi.Pointer<ffi.Pointer<ffi.Pointer<ffi.Int8>>> pazResult,
+ ffi.Pointer<ffi.Int32> pnRow,
+ ffi.Pointer<ffi.Int32> pnColumn,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzErrmsg,
+);
+
+typedef _c_sqlite3_free_table = ffi.Void Function(
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> result,
+);
+
+typedef _dart_sqlite3_free_table = void Function(
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> result,
+);
+
+typedef _c_sqlite3_mprintf = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<ffi.Int8> arg0,
+);
+
+typedef _dart_sqlite3_mprintf = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<ffi.Int8> arg0,
+);
+
+typedef _c_sqlite3_snprintf = ffi.Pointer<ffi.Int8> Function(
+ ffi.Int32 arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ ffi.Pointer<ffi.Int8> arg2,
+);
+
+typedef _dart_sqlite3_snprintf = ffi.Pointer<ffi.Int8> Function(
+ int arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ ffi.Pointer<ffi.Int8> arg2,
+);
+
+typedef _c_sqlite3_malloc = ffi.Pointer<ffi.Void> Function(
+ ffi.Int32 arg0,
+);
+
+typedef _dart_sqlite3_malloc = ffi.Pointer<ffi.Void> Function(
+ int arg0,
+);
+
+typedef _c_sqlite3_malloc64 = ffi.Pointer<ffi.Void> Function(
+ ffi.Uint64 arg0,
+);
+
+typedef _dart_sqlite3_malloc64 = ffi.Pointer<ffi.Void> Function(
+ int arg0,
+);
+
+typedef _c_sqlite3_realloc = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void> arg0,
+ ffi.Int32 arg1,
+);
+
+typedef _dart_sqlite3_realloc = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_realloc64 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void> arg0,
+ ffi.Uint64 arg1,
+);
+
+typedef _dart_sqlite3_realloc64 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<ffi.Void> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_free = ffi.Void Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _dart_sqlite3_free = void Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _c_sqlite3_msize = ffi.Uint64 Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _dart_sqlite3_msize = int Function(
+ ffi.Pointer<ffi.Void> arg0,
+);
+
+typedef _c_sqlite3_memory_used = ffi.Int64 Function();
+
+typedef _dart_sqlite3_memory_used = int Function();
+
+typedef _c_sqlite3_memory_highwater = ffi.Int64 Function(
+ ffi.Int32 resetFlag,
+);
+
+typedef _dart_sqlite3_memory_highwater = int Function(
+ int resetFlag,
+);
+
+typedef _c_sqlite3_randomness = ffi.Void Function(
+ ffi.Int32 N,
+ ffi.Pointer<ffi.Void> P,
+);
+
+typedef _dart_sqlite3_randomness = void Function(
+ int N,
+ ffi.Pointer<ffi.Void> P,
+);
+
+typedef _typedefC_33 = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Int8>,
+ ffi.Pointer<ffi.Int8>,
+ ffi.Pointer<ffi.Int8>,
+ ffi.Pointer<ffi.Int8>,
+);
+
+typedef _c_sqlite3_set_authorizer = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_33>> xAuth,
+ ffi.Pointer<ffi.Void> pUserData,
+);
+
+typedef _dart_sqlite3_set_authorizer = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_33>> xAuth,
+ ffi.Pointer<ffi.Void> pUserData,
+);
+
+typedef _typedefC_34 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<ffi.Int8>,
+);
+
+typedef _c_sqlite3_trace = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_34>> xTrace,
+ ffi.Pointer<ffi.Void> arg2,
+);
+
+typedef _dart_sqlite3_trace = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_34>> xTrace,
+ ffi.Pointer<ffi.Void> arg2,
+);
+
+typedef _typedefC_35 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<ffi.Int8>,
+ ffi.Uint64,
+);
+
+typedef _c_sqlite3_profile = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_35>> xProfile,
+ ffi.Pointer<ffi.Void> arg2,
+);
+
+typedef _dart_sqlite3_profile = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_35>> xProfile,
+ ffi.Pointer<ffi.Void> arg2,
+);
+
+typedef _typedefC_36 = ffi.Int32 Function(
+ ffi.Uint32,
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_trace_v2 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Uint32 uMask,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_36>> xCallback,
+ ffi.Pointer<ffi.Void> pCtx,
+);
+
+typedef _dart_sqlite3_trace_v2 = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ int uMask,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_36>> xCallback,
+ ffi.Pointer<ffi.Void> pCtx,
+);
+
+typedef _typedefC_37 = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_progress_handler = ffi.Void Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Int32 arg1,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_37>> arg2,
+ ffi.Pointer<ffi.Void> arg3,
+);
+
+typedef _dart_sqlite3_progress_handler = void Function(
+ ffi.Pointer<sqlite3> arg0,
+ int arg1,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_37>> arg2,
+ ffi.Pointer<ffi.Void> arg3,
+);
+
+typedef _c_sqlite3_open = ffi.Int32 Function(
+ ffi.Pointer<ffi.Int8> filename,
+ ffi.Pointer<ffi.Pointer<sqlite3>> ppDb,
+);
+
+typedef _dart_sqlite3_open = int Function(
+ ffi.Pointer<ffi.Int8> filename,
+ ffi.Pointer<ffi.Pointer<sqlite3>> ppDb,
+);
+
+typedef _c_sqlite3_open16 = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void> filename,
+ ffi.Pointer<ffi.Pointer<sqlite3>> ppDb,
+);
+
+typedef _dart_sqlite3_open16 = int Function(
+ ffi.Pointer<ffi.Void> filename,
+ ffi.Pointer<ffi.Pointer<sqlite3>> ppDb,
+);
+
+typedef _c_sqlite3_open_v2 = ffi.Int32 Function(
+ ffi.Pointer<ffi.Int8> filename,
+ ffi.Pointer<ffi.Pointer<sqlite3>> ppDb,
+ ffi.Int32 flags,
+ ffi.Pointer<ffi.Int8> zVfs,
+);
+
+typedef _dart_sqlite3_open_v2 = int Function(
+ ffi.Pointer<ffi.Int8> filename,
+ ffi.Pointer<ffi.Pointer<sqlite3>> ppDb,
+ int flags,
+ ffi.Pointer<ffi.Int8> zVfs,
+);
+
+typedef _c_sqlite3_uri_parameter = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<ffi.Int8> zFilename,
+ ffi.Pointer<ffi.Int8> zParam,
+);
+
+typedef _dart_sqlite3_uri_parameter = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<ffi.Int8> zFilename,
+ ffi.Pointer<ffi.Int8> zParam,
+);
+
+typedef _c_sqlite3_uri_boolean = ffi.Int32 Function(
+ ffi.Pointer<ffi.Int8> zFile,
+ ffi.Pointer<ffi.Int8> zParam,
+ ffi.Int32 bDefault,
+);
+
+typedef _dart_sqlite3_uri_boolean = int Function(
+ ffi.Pointer<ffi.Int8> zFile,
+ ffi.Pointer<ffi.Int8> zParam,
+ int bDefault,
+);
+
+typedef _c_sqlite3_uri_int64 = ffi.Int64 Function(
+ ffi.Pointer<ffi.Int8> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ ffi.Int64 arg2,
+);
+
+typedef _dart_sqlite3_uri_int64 = int Function(
+ ffi.Pointer<ffi.Int8> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ int arg2,
+);
+
+typedef _c_sqlite3_uri_key = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<ffi.Int8> zFilename,
+ ffi.Int32 N,
+);
+
+typedef _dart_sqlite3_uri_key = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<ffi.Int8> zFilename,
+ int N,
+);
+
+typedef _c_sqlite3_filename_database = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<ffi.Int8> arg0,
+);
+
+typedef _dart_sqlite3_filename_database = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<ffi.Int8> arg0,
+);
+
+typedef _c_sqlite3_filename_journal = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<ffi.Int8> arg0,
+);
+
+typedef _dart_sqlite3_filename_journal = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<ffi.Int8> arg0,
+);
+
+typedef _c_sqlite3_filename_wal = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<ffi.Int8> arg0,
+);
+
+typedef _dart_sqlite3_filename_wal = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<ffi.Int8> arg0,
+);
+
+typedef _c_sqlite3_database_file_object = ffi.Pointer<sqlite3_file> Function(
+ ffi.Pointer<ffi.Int8> arg0,
+);
+
+typedef _dart_sqlite3_database_file_object = ffi.Pointer<sqlite3_file> Function(
+ ffi.Pointer<ffi.Int8> arg0,
+);
+
+typedef _c_sqlite3_create_filename = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<ffi.Int8> zDatabase,
+ ffi.Pointer<ffi.Int8> zJournal,
+ ffi.Pointer<ffi.Int8> zWal,
+ ffi.Int32 nParam,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> azParam,
+);
+
+typedef _dart_sqlite3_create_filename = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<ffi.Int8> zDatabase,
+ ffi.Pointer<ffi.Int8> zJournal,
+ ffi.Pointer<ffi.Int8> zWal,
+ int nParam,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> azParam,
+);
+
+typedef _c_sqlite3_free_filename = ffi.Void Function(
+ ffi.Pointer<ffi.Int8> arg0,
+);
+
+typedef _dart_sqlite3_free_filename = void Function(
+ ffi.Pointer<ffi.Int8> arg0,
+);
+
+typedef _c_sqlite3_errcode = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+);
+
+typedef _dart_sqlite3_errcode = int Function(
+ ffi.Pointer<sqlite3> db,
+);
+
+typedef _c_sqlite3_extended_errcode = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+);
+
+typedef _dart_sqlite3_extended_errcode = int Function(
+ ffi.Pointer<sqlite3> db,
+);
+
+typedef _c_sqlite3_errmsg = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _dart_sqlite3_errmsg = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _c_sqlite3_errmsg16 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _dart_sqlite3_errmsg16 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _c_sqlite3_errstr = ffi.Pointer<ffi.Int8> Function(
+ ffi.Int32 arg0,
+);
+
+typedef _dart_sqlite3_errstr = ffi.Pointer<ffi.Int8> Function(
+ int arg0,
+);
+
+typedef _c_sqlite3_limit = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Int32 id,
+ ffi.Int32 newVal,
+);
+
+typedef _dart_sqlite3_limit = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ int id,
+ int newVal,
+);
+
+typedef _c_sqlite3_prepare = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSql,
+ ffi.Int32 nByte,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzTail,
+);
+
+typedef _dart_sqlite3_prepare = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSql,
+ int nByte,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzTail,
+);
+
+typedef _c_sqlite3_prepare_v2 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSql,
+ ffi.Int32 nByte,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzTail,
+);
+
+typedef _dart_sqlite3_prepare_v2 = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSql,
+ int nByte,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzTail,
+);
+
+typedef _c_sqlite3_prepare_v3 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSql,
+ ffi.Int32 nByte,
+ ffi.Uint32 prepFlags,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzTail,
+);
+
+typedef _dart_sqlite3_prepare_v3 = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSql,
+ int nByte,
+ int prepFlags,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzTail,
+);
+
+typedef _c_sqlite3_prepare16 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Void> zSql,
+ ffi.Int32 nByte,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Void>> pzTail,
+);
+
+typedef _dart_sqlite3_prepare16 = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Void> zSql,
+ int nByte,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Void>> pzTail,
+);
+
+typedef _c_sqlite3_prepare16_v2 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Void> zSql,
+ ffi.Int32 nByte,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Void>> pzTail,
+);
+
+typedef _dart_sqlite3_prepare16_v2 = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Void> zSql,
+ int nByte,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Void>> pzTail,
+);
+
+typedef _c_sqlite3_prepare16_v3 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Void> zSql,
+ ffi.Int32 nByte,
+ ffi.Uint32 prepFlags,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Void>> pzTail,
+);
+
+typedef _dart_sqlite3_prepare16_v3 = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Void> zSql,
+ int nByte,
+ int prepFlags,
+ ffi.Pointer<ffi.Pointer<sqlite3_stmt>> ppStmt,
+ ffi.Pointer<ffi.Pointer<ffi.Void>> pzTail,
+);
+
+typedef _c_sqlite3_sql = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _dart_sqlite3_sql = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _c_sqlite3_expanded_sql = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _dart_sqlite3_expanded_sql = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _c_sqlite3_normalized_sql = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _dart_sqlite3_normalized_sql = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _c_sqlite3_stmt_readonly = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _dart_sqlite3_stmt_readonly = int Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _c_sqlite3_stmt_isexplain = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _dart_sqlite3_stmt_isexplain = int Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _c_sqlite3_stmt_busy = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+);
+
+typedef _dart_sqlite3_stmt_busy = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+);
+
+typedef _typedefC_38 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_bind_blob = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+ ffi.Pointer<ffi.Void> arg2,
+ ffi.Int32 n,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_38>> arg4,
+);
+
+typedef _dart_sqlite3_bind_blob = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ffi.Pointer<ffi.Void> arg2,
+ int n,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_38>> arg4,
+);
+
+typedef _typedefC_39 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_bind_blob64 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+ ffi.Pointer<ffi.Void> arg2,
+ ffi.Uint64 arg3,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_39>> arg4,
+);
+
+typedef _dart_sqlite3_bind_blob64 = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ffi.Pointer<ffi.Void> arg2,
+ int arg3,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_39>> arg4,
+);
+
+typedef _c_sqlite3_bind_double = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+ ffi.Double arg2,
+);
+
+typedef _dart_sqlite3_bind_double = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ double arg2,
+);
+
+typedef _c_sqlite3_bind_int = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+ ffi.Int32 arg2,
+);
+
+typedef _dart_sqlite3_bind_int = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ int arg2,
+);
+
+typedef _c_sqlite3_bind_int64 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+ ffi.Int64 arg2,
+);
+
+typedef _dart_sqlite3_bind_int64 = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ int arg2,
+);
+
+typedef _c_sqlite3_bind_null = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+);
+
+typedef _dart_sqlite3_bind_null = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+);
+
+typedef _typedefC_40 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_bind_text = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+ ffi.Pointer<ffi.Int8> arg2,
+ ffi.Int32 arg3,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_40>> arg4,
+);
+
+typedef _dart_sqlite3_bind_text = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ffi.Pointer<ffi.Int8> arg2,
+ int arg3,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_40>> arg4,
+);
+
+typedef _typedefC_41 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_bind_text16 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+ ffi.Pointer<ffi.Void> arg2,
+ ffi.Int32 arg3,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_41>> arg4,
+);
+
+typedef _dart_sqlite3_bind_text16 = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ffi.Pointer<ffi.Void> arg2,
+ int arg3,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_41>> arg4,
+);
+
+typedef _typedefC_42 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_bind_text64 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+ ffi.Pointer<ffi.Int8> arg2,
+ ffi.Uint64 arg3,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_42>> arg4,
+ ffi.Uint8 encoding,
+);
+
+typedef _dart_sqlite3_bind_text64 = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ffi.Pointer<ffi.Int8> arg2,
+ int arg3,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_42>> arg4,
+ int encoding,
+);
+
+typedef _c_sqlite3_bind_value = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+ ffi.Pointer<sqlite3_value> arg2,
+);
+
+typedef _dart_sqlite3_bind_value = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ffi.Pointer<sqlite3_value> arg2,
+);
+
+typedef _typedefC_43 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_bind_pointer = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+ ffi.Pointer<ffi.Void> arg2,
+ ffi.Pointer<ffi.Int8> arg3,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_43>> arg4,
+);
+
+typedef _dart_sqlite3_bind_pointer = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ ffi.Pointer<ffi.Void> arg2,
+ ffi.Pointer<ffi.Int8> arg3,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_43>> arg4,
+);
+
+typedef _c_sqlite3_bind_zeroblob = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+ ffi.Int32 n,
+);
+
+typedef _dart_sqlite3_bind_zeroblob = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ int n,
+);
+
+typedef _c_sqlite3_bind_zeroblob64 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+ ffi.Uint64 arg2,
+);
+
+typedef _dart_sqlite3_bind_zeroblob64 = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+ int arg2,
+);
+
+typedef _c_sqlite3_bind_parameter_count = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+);
+
+typedef _dart_sqlite3_bind_parameter_count = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+);
+
+typedef _c_sqlite3_bind_parameter_name = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+);
+
+typedef _dart_sqlite3_bind_parameter_name = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_bind_parameter_index = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Pointer<ffi.Int8> zName,
+);
+
+typedef _dart_sqlite3_bind_parameter_index = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Pointer<ffi.Int8> zName,
+);
+
+typedef _c_sqlite3_clear_bindings = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+);
+
+typedef _dart_sqlite3_clear_bindings = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+);
+
+typedef _c_sqlite3_column_count = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _dart_sqlite3_column_count = int Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _c_sqlite3_column_name = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 N,
+);
+
+typedef _dart_sqlite3_column_name = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int N,
+);
+
+typedef _c_sqlite3_column_name16 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 N,
+);
+
+typedef _dart_sqlite3_column_name16 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int N,
+);
+
+typedef _c_sqlite3_column_database_name = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+);
+
+typedef _dart_sqlite3_column_database_name = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_column_database_name16 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+);
+
+typedef _dart_sqlite3_column_database_name16 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_column_table_name = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+);
+
+typedef _dart_sqlite3_column_table_name = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_column_table_name16 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+);
+
+typedef _dart_sqlite3_column_table_name16 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_column_origin_name = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+);
+
+typedef _dart_sqlite3_column_origin_name = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_column_origin_name16 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+);
+
+typedef _dart_sqlite3_column_origin_name16 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_column_decltype = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+);
+
+typedef _dart_sqlite3_column_decltype = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_column_decltype16 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 arg1,
+);
+
+typedef _dart_sqlite3_column_decltype16 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_step = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+);
+
+typedef _dart_sqlite3_step = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+);
+
+typedef _c_sqlite3_data_count = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _dart_sqlite3_data_count = int Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _c_sqlite3_column_blob = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 iCol,
+);
+
+typedef _dart_sqlite3_column_blob = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+);
+
+typedef _c_sqlite3_column_double = ffi.Double Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 iCol,
+);
+
+typedef _dart_sqlite3_column_double = double Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+);
+
+typedef _c_sqlite3_column_int = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 iCol,
+);
+
+typedef _dart_sqlite3_column_int = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+);
+
+typedef _c_sqlite3_column_int64 = ffi.Int64 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 iCol,
+);
+
+typedef _dart_sqlite3_column_int64 = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+);
+
+typedef _c_sqlite3_column_text = ffi.Pointer<ffi.Uint8> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 iCol,
+);
+
+typedef _dart_sqlite3_column_text = ffi.Pointer<ffi.Uint8> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+);
+
+typedef _c_sqlite3_column_text16 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 iCol,
+);
+
+typedef _dart_sqlite3_column_text16 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+);
+
+typedef _c_sqlite3_column_value = ffi.Pointer<sqlite3_value> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 iCol,
+);
+
+typedef _dart_sqlite3_column_value = ffi.Pointer<sqlite3_value> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+);
+
+typedef _c_sqlite3_column_bytes = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 iCol,
+);
+
+typedef _dart_sqlite3_column_bytes = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+);
+
+typedef _c_sqlite3_column_bytes16 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 iCol,
+);
+
+typedef _dart_sqlite3_column_bytes16 = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+);
+
+typedef _c_sqlite3_column_type = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 iCol,
+);
+
+typedef _dart_sqlite3_column_type = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int iCol,
+);
+
+typedef _c_sqlite3_finalize = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _dart_sqlite3_finalize = int Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _c_sqlite3_reset = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _dart_sqlite3_reset = int Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _typedefC_44 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Pointer<sqlite3_value>>,
+);
+
+typedef _typedefC_45 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Pointer<sqlite3_value>>,
+);
+
+typedef _typedefC_46 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context>,
+);
+
+typedef _c_sqlite3_create_function = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zFunctionName,
+ ffi.Int32 nArg,
+ ffi.Int32 eTextRep,
+ ffi.Pointer<ffi.Void> pApp,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_44>> xFunc,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_45>> xStep,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_46>> xFinal,
+);
+
+typedef _dart_sqlite3_create_function = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zFunctionName,
+ int nArg,
+ int eTextRep,
+ ffi.Pointer<ffi.Void> pApp,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_44>> xFunc,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_45>> xStep,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_46>> xFinal,
+);
+
+typedef _typedefC_47 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Pointer<sqlite3_value>>,
+);
+
+typedef _typedefC_48 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Pointer<sqlite3_value>>,
+);
+
+typedef _typedefC_49 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context>,
+);
+
+typedef _c_sqlite3_create_function16 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Void> zFunctionName,
+ ffi.Int32 nArg,
+ ffi.Int32 eTextRep,
+ ffi.Pointer<ffi.Void> pApp,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_47>> xFunc,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_48>> xStep,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_49>> xFinal,
+);
+
+typedef _dart_sqlite3_create_function16 = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Void> zFunctionName,
+ int nArg,
+ int eTextRep,
+ ffi.Pointer<ffi.Void> pApp,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_47>> xFunc,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_48>> xStep,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_49>> xFinal,
+);
+
+typedef _typedefC_50 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Pointer<sqlite3_value>>,
+);
+
+typedef _typedefC_51 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Pointer<sqlite3_value>>,
+);
+
+typedef _typedefC_52 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context>,
+);
+
+typedef _typedefC_53 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_create_function_v2 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zFunctionName,
+ ffi.Int32 nArg,
+ ffi.Int32 eTextRep,
+ ffi.Pointer<ffi.Void> pApp,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_50>> xFunc,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_51>> xStep,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_52>> xFinal,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_53>> xDestroy,
+);
+
+typedef _dart_sqlite3_create_function_v2 = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zFunctionName,
+ int nArg,
+ int eTextRep,
+ ffi.Pointer<ffi.Void> pApp,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_50>> xFunc,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_51>> xStep,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_52>> xFinal,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_53>> xDestroy,
+);
+
+typedef _typedefC_54 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Pointer<sqlite3_value>>,
+);
+
+typedef _typedefC_55 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context>,
+);
+
+typedef _typedefC_56 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context>,
+);
+
+typedef _typedefC_57 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Pointer<sqlite3_value>>,
+);
+
+typedef _typedefC_58 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_create_window_function = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zFunctionName,
+ ffi.Int32 nArg,
+ ffi.Int32 eTextRep,
+ ffi.Pointer<ffi.Void> pApp,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_54>> xStep,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_55>> xFinal,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_56>> xValue,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_57>> xInverse,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_58>> xDestroy,
+);
+
+typedef _dart_sqlite3_create_window_function = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zFunctionName,
+ int nArg,
+ int eTextRep,
+ ffi.Pointer<ffi.Void> pApp,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_54>> xStep,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_55>> xFinal,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_56>> xValue,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_57>> xInverse,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_58>> xDestroy,
+);
+
+typedef _c_sqlite3_aggregate_count = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_context> arg0,
+);
+
+typedef _dart_sqlite3_aggregate_count = int Function(
+ ffi.Pointer<sqlite3_context> arg0,
+);
+
+typedef _c_sqlite3_expired = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+);
+
+typedef _dart_sqlite3_expired = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+);
+
+typedef _c_sqlite3_transfer_bindings = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Pointer<sqlite3_stmt> arg1,
+);
+
+typedef _dart_sqlite3_transfer_bindings = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Pointer<sqlite3_stmt> arg1,
+);
+
+typedef _c_sqlite3_global_recover = ffi.Int32 Function();
+
+typedef _dart_sqlite3_global_recover = int Function();
+
+typedef _c_sqlite3_thread_cleanup = ffi.Void Function();
+
+typedef _dart_sqlite3_thread_cleanup = void Function();
+
+typedef _typedefC_59 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Int64,
+ ffi.Int32,
+);
+
+typedef _c_sqlite3_memory_alarm = ffi.Int32 Function(
+ ffi.Pointer<ffi.NativeFunction<_typedefC_59>> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ffi.Int64 arg2,
+);
+
+typedef _dart_sqlite3_memory_alarm = int Function(
+ ffi.Pointer<ffi.NativeFunction<_typedefC_59>> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ int arg2,
+);
+
+typedef _c_sqlite3_value_blob = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _dart_sqlite3_value_blob = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _c_sqlite3_value_double = ffi.Double Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _dart_sqlite3_value_double = double Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _c_sqlite3_value_int = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _dart_sqlite3_value_int = int Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _c_sqlite3_value_int64 = ffi.Int64 Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _dart_sqlite3_value_int64 = int Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _c_sqlite3_value_pointer = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_value> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+);
+
+typedef _dart_sqlite3_value_pointer = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_value> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+);
+
+typedef _c_sqlite3_value_text = ffi.Pointer<ffi.Uint8> Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _dart_sqlite3_value_text = ffi.Pointer<ffi.Uint8> Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _c_sqlite3_value_text16 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _dart_sqlite3_value_text16 = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _c_sqlite3_value_text16le = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _dart_sqlite3_value_text16le = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _c_sqlite3_value_text16be = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _dart_sqlite3_value_text16be = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _c_sqlite3_value_bytes = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _dart_sqlite3_value_bytes = int Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _c_sqlite3_value_bytes16 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _dart_sqlite3_value_bytes16 = int Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _c_sqlite3_value_type = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _dart_sqlite3_value_type = int Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _c_sqlite3_value_numeric_type = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _dart_sqlite3_value_numeric_type = int Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _c_sqlite3_value_nochange = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _dart_sqlite3_value_nochange = int Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _c_sqlite3_value_frombind = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _dart_sqlite3_value_frombind = int Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _c_sqlite3_value_subtype = ffi.Uint32 Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _dart_sqlite3_value_subtype = int Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _c_sqlite3_value_dup = ffi.Pointer<sqlite3_value> Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _dart_sqlite3_value_dup = ffi.Pointer<sqlite3_value> Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _c_sqlite3_value_free = ffi.Void Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _dart_sqlite3_value_free = void Function(
+ ffi.Pointer<sqlite3_value> arg0,
+);
+
+typedef _c_sqlite3_aggregate_context = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Int32 nBytes,
+);
+
+typedef _dart_sqlite3_aggregate_context = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ int nBytes,
+);
+
+typedef _c_sqlite3_user_data = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_context> arg0,
+);
+
+typedef _dart_sqlite3_user_data = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_context> arg0,
+);
+
+typedef _c_sqlite3_context_db_handle = ffi.Pointer<sqlite3> Function(
+ ffi.Pointer<sqlite3_context> arg0,
+);
+
+typedef _dart_sqlite3_context_db_handle = ffi.Pointer<sqlite3> Function(
+ ffi.Pointer<sqlite3_context> arg0,
+);
+
+typedef _c_sqlite3_get_auxdata = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Int32 N,
+);
+
+typedef _dart_sqlite3_get_auxdata = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ int N,
+);
+
+typedef _typedefC_60 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_set_auxdata = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Int32 N,
+ ffi.Pointer<ffi.Void> arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_60>> arg3,
+);
+
+typedef _dart_sqlite3_set_auxdata = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ int N,
+ ffi.Pointer<ffi.Void> arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_60>> arg3,
+);
+
+typedef _typedefC_61 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_result_blob = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ffi.Int32 arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_61>> arg3,
+);
+
+typedef _dart_sqlite3_result_blob = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ int arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_61>> arg3,
+);
+
+typedef _typedefC_62 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_result_blob64 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ffi.Uint64 arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_62>> arg3,
+);
+
+typedef _dart_sqlite3_result_blob64 = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ int arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_62>> arg3,
+);
+
+typedef _c_sqlite3_result_double = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Double arg1,
+);
+
+typedef _dart_sqlite3_result_double = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ double arg1,
+);
+
+typedef _c_sqlite3_result_error = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ ffi.Int32 arg2,
+);
+
+typedef _dart_sqlite3_result_error = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ int arg2,
+);
+
+typedef _c_sqlite3_result_error16 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ffi.Int32 arg2,
+);
+
+typedef _dart_sqlite3_result_error16 = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ int arg2,
+);
+
+typedef _c_sqlite3_result_error_toobig = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+);
+
+typedef _dart_sqlite3_result_error_toobig = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+);
+
+typedef _c_sqlite3_result_error_nomem = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+);
+
+typedef _dart_sqlite3_result_error_nomem = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+);
+
+typedef _c_sqlite3_result_error_code = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Int32 arg1,
+);
+
+typedef _dart_sqlite3_result_error_code = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_result_int = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Int32 arg1,
+);
+
+typedef _dart_sqlite3_result_int = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_result_int64 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Int64 arg1,
+);
+
+typedef _dart_sqlite3_result_int64 = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_result_null = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+);
+
+typedef _dart_sqlite3_result_null = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+);
+
+typedef _typedefC_63 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_result_text = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ ffi.Int32 arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_63>> arg3,
+);
+
+typedef _dart_sqlite3_result_text = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ int arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_63>> arg3,
+);
+
+typedef _typedefC_64 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_result_text64 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ ffi.Uint64 arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_64>> arg3,
+ ffi.Uint8 encoding,
+);
+
+typedef _dart_sqlite3_result_text64 = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ int arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_64>> arg3,
+ int encoding,
+);
+
+typedef _typedefC_65 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_result_text16 = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ffi.Int32 arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_65>> arg3,
+);
+
+typedef _dart_sqlite3_result_text16 = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ int arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_65>> arg3,
+);
+
+typedef _typedefC_66 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_result_text16le = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ffi.Int32 arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_66>> arg3,
+);
+
+typedef _dart_sqlite3_result_text16le = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ int arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_66>> arg3,
+);
+
+typedef _typedefC_67 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_result_text16be = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ffi.Int32 arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_67>> arg3,
+);
+
+typedef _dart_sqlite3_result_text16be = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ int arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_67>> arg3,
+);
+
+typedef _c_sqlite3_result_value = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<sqlite3_value> arg1,
+);
+
+typedef _dart_sqlite3_result_value = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<sqlite3_value> arg1,
+);
+
+typedef _typedefC_68 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_result_pointer = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ffi.Pointer<ffi.Int8> arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_68>> arg3,
+);
+
+typedef _dart_sqlite3_result_pointer = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ffi.Pointer<ffi.Int8> arg2,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_68>> arg3,
+);
+
+typedef _c_sqlite3_result_zeroblob = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Int32 n,
+);
+
+typedef _dart_sqlite3_result_zeroblob = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ int n,
+);
+
+typedef _c_sqlite3_result_zeroblob64 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Uint64 n,
+);
+
+typedef _dart_sqlite3_result_zeroblob64 = int Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ int n,
+);
+
+typedef _c_sqlite3_result_subtype = ffi.Void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ ffi.Uint32 arg1,
+);
+
+typedef _dart_sqlite3_result_subtype = void Function(
+ ffi.Pointer<sqlite3_context> arg0,
+ int arg1,
+);
+
+typedef _typedefC_69 = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Void>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_create_collation = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zName,
+ ffi.Int32 eTextRep,
+ ffi.Pointer<ffi.Void> pArg,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_69>> xCompare,
+);
+
+typedef _dart_sqlite3_create_collation = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zName,
+ int eTextRep,
+ ffi.Pointer<ffi.Void> pArg,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_69>> xCompare,
+);
+
+typedef _typedefC_70 = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Void>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _typedefC_71 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_create_collation_v2 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zName,
+ ffi.Int32 eTextRep,
+ ffi.Pointer<ffi.Void> pArg,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_70>> xCompare,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_71>> xDestroy,
+);
+
+typedef _dart_sqlite3_create_collation_v2 = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zName,
+ int eTextRep,
+ ffi.Pointer<ffi.Void> pArg,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_70>> xCompare,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_71>> xDestroy,
+);
+
+typedef _typedefC_72 = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Void>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_create_collation16 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Void> zName,
+ ffi.Int32 eTextRep,
+ ffi.Pointer<ffi.Void> pArg,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_72>> xCompare,
+);
+
+typedef _dart_sqlite3_create_collation16 = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Void> zName,
+ int eTextRep,
+ ffi.Pointer<ffi.Void> pArg,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_72>> xCompare,
+);
+
+typedef _typedefC_73 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<sqlite3>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Int8>,
+);
+
+typedef _c_sqlite3_collation_needed = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_73>> arg2,
+);
+
+typedef _dart_sqlite3_collation_needed = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_73>> arg2,
+);
+
+typedef _typedefC_74 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<sqlite3>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_collation_needed16 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_74>> arg2,
+);
+
+typedef _dart_sqlite3_collation_needed16 = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Void> arg1,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_74>> arg2,
+);
+
+typedef _c_sqlite3_sleep = ffi.Int32 Function(
+ ffi.Int32 arg0,
+);
+
+typedef _dart_sqlite3_sleep = int Function(
+ int arg0,
+);
+
+typedef _c_sqlite3_win32_set_directory = ffi.Int32 Function(
+ ffi.Uint64 type,
+ ffi.Pointer<ffi.Void> zValue,
+);
+
+typedef _dart_sqlite3_win32_set_directory = int Function(
+ int type,
+ ffi.Pointer<ffi.Void> zValue,
+);
+
+typedef _c_sqlite3_win32_set_directory8 = ffi.Int32 Function(
+ ffi.Uint64 type,
+ ffi.Pointer<ffi.Int8> zValue,
+);
+
+typedef _dart_sqlite3_win32_set_directory8 = int Function(
+ int type,
+ ffi.Pointer<ffi.Int8> zValue,
+);
+
+typedef _c_sqlite3_win32_set_directory16 = ffi.Int32 Function(
+ ffi.Uint64 type,
+ ffi.Pointer<ffi.Void> zValue,
+);
+
+typedef _dart_sqlite3_win32_set_directory16 = int Function(
+ int type,
+ ffi.Pointer<ffi.Void> zValue,
+);
+
+typedef _c_sqlite3_get_autocommit = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _dart_sqlite3_get_autocommit = int Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _c_sqlite3_db_handle = ffi.Pointer<sqlite3> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+);
+
+typedef _dart_sqlite3_db_handle = ffi.Pointer<sqlite3> Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+);
+
+typedef _c_sqlite3_db_filename = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDbName,
+);
+
+typedef _dart_sqlite3_db_filename = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDbName,
+);
+
+typedef _c_sqlite3_db_readonly = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDbName,
+);
+
+typedef _dart_sqlite3_db_readonly = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDbName,
+);
+
+typedef _c_sqlite3_next_stmt = ffi.Pointer<sqlite3_stmt> Function(
+ ffi.Pointer<sqlite3> pDb,
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _dart_sqlite3_next_stmt = ffi.Pointer<sqlite3_stmt> Function(
+ ffi.Pointer<sqlite3> pDb,
+ ffi.Pointer<sqlite3_stmt> pStmt,
+);
+
+typedef _typedefC_75 = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_commit_hook = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_75>> arg1,
+ ffi.Pointer<ffi.Void> arg2,
+);
+
+typedef _dart_sqlite3_commit_hook = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_75>> arg1,
+ ffi.Pointer<ffi.Void> arg2,
+);
+
+typedef _typedefC_76 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_rollback_hook = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_76>> arg1,
+ ffi.Pointer<ffi.Void> arg2,
+);
+
+typedef _dart_sqlite3_rollback_hook = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_76>> arg1,
+ ffi.Pointer<ffi.Void> arg2,
+);
+
+typedef _typedefC_77 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Int8>,
+ ffi.Pointer<ffi.Int8>,
+ ffi.Int64,
+);
+
+typedef _c_sqlite3_update_hook = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_77>> arg1,
+ ffi.Pointer<ffi.Void> arg2,
+);
+
+typedef _dart_sqlite3_update_hook = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_77>> arg1,
+ ffi.Pointer<ffi.Void> arg2,
+);
+
+typedef _c_sqlite3_enable_shared_cache = ffi.Int32 Function(
+ ffi.Int32 arg0,
+);
+
+typedef _dart_sqlite3_enable_shared_cache = int Function(
+ int arg0,
+);
+
+typedef _c_sqlite3_release_memory = ffi.Int32 Function(
+ ffi.Int32 arg0,
+);
+
+typedef _dart_sqlite3_release_memory = int Function(
+ int arg0,
+);
+
+typedef _c_sqlite3_db_release_memory = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _dart_sqlite3_db_release_memory = int Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _c_sqlite3_soft_heap_limit64 = ffi.Int64 Function(
+ ffi.Int64 N,
+);
+
+typedef _dart_sqlite3_soft_heap_limit64 = int Function(
+ int N,
+);
+
+typedef _c_sqlite3_hard_heap_limit64 = ffi.Int64 Function(
+ ffi.Int64 N,
+);
+
+typedef _dart_sqlite3_hard_heap_limit64 = int Function(
+ int N,
+);
+
+typedef _c_sqlite3_soft_heap_limit = ffi.Void Function(
+ ffi.Int32 N,
+);
+
+typedef _dart_sqlite3_soft_heap_limit = void Function(
+ int N,
+);
+
+typedef _c_sqlite3_table_column_metadata = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDbName,
+ ffi.Pointer<ffi.Int8> zTableName,
+ ffi.Pointer<ffi.Int8> zColumnName,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzDataType,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzCollSeq,
+ ffi.Pointer<ffi.Int32> pNotNull,
+ ffi.Pointer<ffi.Int32> pPrimaryKey,
+ ffi.Pointer<ffi.Int32> pAutoinc,
+);
+
+typedef _dart_sqlite3_table_column_metadata = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDbName,
+ ffi.Pointer<ffi.Int8> zTableName,
+ ffi.Pointer<ffi.Int8> zColumnName,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzDataType,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzCollSeq,
+ ffi.Pointer<ffi.Int32> pNotNull,
+ ffi.Pointer<ffi.Int32> pPrimaryKey,
+ ffi.Pointer<ffi.Int32> pAutoinc,
+);
+
+typedef _c_sqlite3_load_extension = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zFile,
+ ffi.Pointer<ffi.Int8> zProc,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzErrMsg,
+);
+
+typedef _dart_sqlite3_load_extension = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zFile,
+ ffi.Pointer<ffi.Int8> zProc,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> pzErrMsg,
+);
+
+typedef _c_sqlite3_enable_load_extension = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Int32 onoff,
+);
+
+typedef _dart_sqlite3_enable_load_extension = int Function(
+ ffi.Pointer<sqlite3> db,
+ int onoff,
+);
+
+typedef _typedefC_78 = ffi.Void Function();
+
+typedef _c_sqlite3_auto_extension = ffi.Int32 Function(
+ ffi.Pointer<ffi.NativeFunction<_typedefC_78>> xEntryPoint,
+);
+
+typedef _dart_sqlite3_auto_extension = int Function(
+ ffi.Pointer<ffi.NativeFunction<_typedefC_78>> xEntryPoint,
+);
+
+typedef _typedefC_79 = ffi.Void Function();
+
+typedef _c_sqlite3_cancel_auto_extension = ffi.Int32 Function(
+ ffi.Pointer<ffi.NativeFunction<_typedefC_79>> xEntryPoint,
+);
+
+typedef _dart_sqlite3_cancel_auto_extension = int Function(
+ ffi.Pointer<ffi.NativeFunction<_typedefC_79>> xEntryPoint,
+);
+
+typedef _c_sqlite3_reset_auto_extension = ffi.Void Function();
+
+typedef _dart_sqlite3_reset_auto_extension = void Function();
+
+typedef _c_sqlite3_create_module = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zName,
+ ffi.Pointer<sqlite3_module> p,
+ ffi.Pointer<ffi.Void> pClientData,
+);
+
+typedef _dart_sqlite3_create_module = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zName,
+ ffi.Pointer<sqlite3_module> p,
+ ffi.Pointer<ffi.Void> pClientData,
+);
+
+typedef _typedefC_80 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_create_module_v2 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zName,
+ ffi.Pointer<sqlite3_module> p,
+ ffi.Pointer<ffi.Void> pClientData,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_80>> xDestroy,
+);
+
+typedef _dart_sqlite3_create_module_v2 = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zName,
+ ffi.Pointer<sqlite3_module> p,
+ ffi.Pointer<ffi.Void> pClientData,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_80>> xDestroy,
+);
+
+typedef _c_sqlite3_drop_modules = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> azKeep,
+);
+
+typedef _dart_sqlite3_drop_modules = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> azKeep,
+);
+
+typedef _c_sqlite3_declare_vtab = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zSQL,
+);
+
+typedef _dart_sqlite3_declare_vtab = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zSQL,
+);
+
+typedef _c_sqlite3_overload_function = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zFuncName,
+ ffi.Int32 nArg,
+);
+
+typedef _dart_sqlite3_overload_function = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zFuncName,
+ int nArg,
+);
+
+typedef _c_sqlite3_blob_open = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zDb,
+ ffi.Pointer<ffi.Int8> zTable,
+ ffi.Pointer<ffi.Int8> zColumn,
+ ffi.Int64 iRow,
+ ffi.Int32 flags,
+ ffi.Pointer<ffi.Pointer<sqlite3_blob>> ppBlob,
+);
+
+typedef _dart_sqlite3_blob_open = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zDb,
+ ffi.Pointer<ffi.Int8> zTable,
+ ffi.Pointer<ffi.Int8> zColumn,
+ int iRow,
+ int flags,
+ ffi.Pointer<ffi.Pointer<sqlite3_blob>> ppBlob,
+);
+
+typedef _c_sqlite3_blob_reopen = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_blob> arg0,
+ ffi.Int64 arg1,
+);
+
+typedef _dart_sqlite3_blob_reopen = int Function(
+ ffi.Pointer<sqlite3_blob> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_blob_close = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_blob> arg0,
+);
+
+typedef _dart_sqlite3_blob_close = int Function(
+ ffi.Pointer<sqlite3_blob> arg0,
+);
+
+typedef _c_sqlite3_blob_bytes = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_blob> arg0,
+);
+
+typedef _dart_sqlite3_blob_bytes = int Function(
+ ffi.Pointer<sqlite3_blob> arg0,
+);
+
+typedef _c_sqlite3_blob_read = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_blob> arg0,
+ ffi.Pointer<ffi.Void> Z,
+ ffi.Int32 N,
+ ffi.Int32 iOffset,
+);
+
+typedef _dart_sqlite3_blob_read = int Function(
+ ffi.Pointer<sqlite3_blob> arg0,
+ ffi.Pointer<ffi.Void> Z,
+ int N,
+ int iOffset,
+);
+
+typedef _c_sqlite3_blob_write = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_blob> arg0,
+ ffi.Pointer<ffi.Void> z,
+ ffi.Int32 n,
+ ffi.Int32 iOffset,
+);
+
+typedef _dart_sqlite3_blob_write = int Function(
+ ffi.Pointer<sqlite3_blob> arg0,
+ ffi.Pointer<ffi.Void> z,
+ int n,
+ int iOffset,
+);
+
+typedef _c_sqlite3_vfs_find = ffi.Pointer<sqlite3_vfs> Function(
+ ffi.Pointer<ffi.Int8> zVfsName,
+);
+
+typedef _dart_sqlite3_vfs_find = ffi.Pointer<sqlite3_vfs> Function(
+ ffi.Pointer<ffi.Int8> zVfsName,
+);
+
+typedef _c_sqlite3_vfs_register = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_vfs> arg0,
+ ffi.Int32 makeDflt,
+);
+
+typedef _dart_sqlite3_vfs_register = int Function(
+ ffi.Pointer<sqlite3_vfs> arg0,
+ int makeDflt,
+);
+
+typedef _c_sqlite3_vfs_unregister = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_vfs> arg0,
+);
+
+typedef _dart_sqlite3_vfs_unregister = int Function(
+ ffi.Pointer<sqlite3_vfs> arg0,
+);
+
+typedef _c_sqlite3_mutex_alloc = ffi.Pointer<sqlite3_mutex> Function(
+ ffi.Int32 arg0,
+);
+
+typedef _dart_sqlite3_mutex_alloc = ffi.Pointer<sqlite3_mutex> Function(
+ int arg0,
+);
+
+typedef _c_sqlite3_mutex_free = ffi.Void Function(
+ ffi.Pointer<sqlite3_mutex> arg0,
+);
+
+typedef _dart_sqlite3_mutex_free = void Function(
+ ffi.Pointer<sqlite3_mutex> arg0,
+);
+
+typedef _c_sqlite3_mutex_enter = ffi.Void Function(
+ ffi.Pointer<sqlite3_mutex> arg0,
+);
+
+typedef _dart_sqlite3_mutex_enter = void Function(
+ ffi.Pointer<sqlite3_mutex> arg0,
+);
+
+typedef _c_sqlite3_mutex_try = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_mutex> arg0,
+);
+
+typedef _dart_sqlite3_mutex_try = int Function(
+ ffi.Pointer<sqlite3_mutex> arg0,
+);
+
+typedef _c_sqlite3_mutex_leave = ffi.Void Function(
+ ffi.Pointer<sqlite3_mutex> arg0,
+);
+
+typedef _dart_sqlite3_mutex_leave = void Function(
+ ffi.Pointer<sqlite3_mutex> arg0,
+);
+
+typedef _c_sqlite3_mutex_held = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_mutex> arg0,
+);
+
+typedef _dart_sqlite3_mutex_held = int Function(
+ ffi.Pointer<sqlite3_mutex> arg0,
+);
+
+typedef _c_sqlite3_mutex_notheld = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_mutex> arg0,
+);
+
+typedef _dart_sqlite3_mutex_notheld = int Function(
+ ffi.Pointer<sqlite3_mutex> arg0,
+);
+
+typedef _c_sqlite3_db_mutex = ffi.Pointer<sqlite3_mutex> Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _dart_sqlite3_db_mutex = ffi.Pointer<sqlite3_mutex> Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _c_sqlite3_file_control = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zDbName,
+ ffi.Int32 op,
+ ffi.Pointer<ffi.Void> arg3,
+);
+
+typedef _dart_sqlite3_file_control = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.Int8> zDbName,
+ int op,
+ ffi.Pointer<ffi.Void> arg3,
+);
+
+typedef _c_sqlite3_test_control = ffi.Int32 Function(
+ ffi.Int32 op,
+);
+
+typedef _dart_sqlite3_test_control = int Function(
+ int op,
+);
+
+typedef _c_sqlite3_keyword_count = ffi.Int32 Function();
+
+typedef _dart_sqlite3_keyword_count = int Function();
+
+typedef _c_sqlite3_keyword_name = ffi.Int32 Function(
+ ffi.Int32 arg0,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> arg1,
+ ffi.Pointer<ffi.Int32> arg2,
+);
+
+typedef _dart_sqlite3_keyword_name = int Function(
+ int arg0,
+ ffi.Pointer<ffi.Pointer<ffi.Int8>> arg1,
+ ffi.Pointer<ffi.Int32> arg2,
+);
+
+typedef _c_sqlite3_keyword_check = ffi.Int32 Function(
+ ffi.Pointer<ffi.Int8> arg0,
+ ffi.Int32 arg1,
+);
+
+typedef _dart_sqlite3_keyword_check = int Function(
+ ffi.Pointer<ffi.Int8> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_str_new = ffi.Pointer<sqlite3_str> Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _dart_sqlite3_str_new = ffi.Pointer<sqlite3_str> Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _c_sqlite3_str_finish = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_str> arg0,
+);
+
+typedef _dart_sqlite3_str_finish = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_str> arg0,
+);
+
+typedef _c_sqlite3_str_appendf = ffi.Void Function(
+ ffi.Pointer<sqlite3_str> arg0,
+ ffi.Pointer<ffi.Int8> zFormat,
+);
+
+typedef _dart_sqlite3_str_appendf = void Function(
+ ffi.Pointer<sqlite3_str> arg0,
+ ffi.Pointer<ffi.Int8> zFormat,
+);
+
+typedef _c_sqlite3_str_append = ffi.Void Function(
+ ffi.Pointer<sqlite3_str> arg0,
+ ffi.Pointer<ffi.Int8> zIn,
+ ffi.Int32 N,
+);
+
+typedef _dart_sqlite3_str_append = void Function(
+ ffi.Pointer<sqlite3_str> arg0,
+ ffi.Pointer<ffi.Int8> zIn,
+ int N,
+);
+
+typedef _c_sqlite3_str_appendall = ffi.Void Function(
+ ffi.Pointer<sqlite3_str> arg0,
+ ffi.Pointer<ffi.Int8> zIn,
+);
+
+typedef _dart_sqlite3_str_appendall = void Function(
+ ffi.Pointer<sqlite3_str> arg0,
+ ffi.Pointer<ffi.Int8> zIn,
+);
+
+typedef _c_sqlite3_str_appendchar = ffi.Void Function(
+ ffi.Pointer<sqlite3_str> arg0,
+ ffi.Int32 N,
+ ffi.Int8 C,
+);
+
+typedef _dart_sqlite3_str_appendchar = void Function(
+ ffi.Pointer<sqlite3_str> arg0,
+ int N,
+ int C,
+);
+
+typedef _c_sqlite3_str_reset = ffi.Void Function(
+ ffi.Pointer<sqlite3_str> arg0,
+);
+
+typedef _dart_sqlite3_str_reset = void Function(
+ ffi.Pointer<sqlite3_str> arg0,
+);
+
+typedef _c_sqlite3_str_errcode = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_str> arg0,
+);
+
+typedef _dart_sqlite3_str_errcode = int Function(
+ ffi.Pointer<sqlite3_str> arg0,
+);
+
+typedef _c_sqlite3_str_length = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_str> arg0,
+);
+
+typedef _dart_sqlite3_str_length = int Function(
+ ffi.Pointer<sqlite3_str> arg0,
+);
+
+typedef _c_sqlite3_str_value = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_str> arg0,
+);
+
+typedef _dart_sqlite3_str_value = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_str> arg0,
+);
+
+typedef _c_sqlite3_status = ffi.Int32 Function(
+ ffi.Int32 op,
+ ffi.Pointer<ffi.Int32> pCurrent,
+ ffi.Pointer<ffi.Int32> pHighwater,
+ ffi.Int32 resetFlag,
+);
+
+typedef _dart_sqlite3_status = int Function(
+ int op,
+ ffi.Pointer<ffi.Int32> pCurrent,
+ ffi.Pointer<ffi.Int32> pHighwater,
+ int resetFlag,
+);
+
+typedef _c_sqlite3_status64 = ffi.Int32 Function(
+ ffi.Int32 op,
+ ffi.Pointer<ffi.Int64> pCurrent,
+ ffi.Pointer<ffi.Int64> pHighwater,
+ ffi.Int32 resetFlag,
+);
+
+typedef _dart_sqlite3_status64 = int Function(
+ int op,
+ ffi.Pointer<ffi.Int64> pCurrent,
+ ffi.Pointer<ffi.Int64> pHighwater,
+ int resetFlag,
+);
+
+typedef _c_sqlite3_db_status = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Int32 op,
+ ffi.Pointer<ffi.Int32> pCur,
+ ffi.Pointer<ffi.Int32> pHiwtr,
+ ffi.Int32 resetFlg,
+);
+
+typedef _dart_sqlite3_db_status = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ int op,
+ ffi.Pointer<ffi.Int32> pCur,
+ ffi.Pointer<ffi.Int32> pHiwtr,
+ int resetFlg,
+);
+
+typedef _c_sqlite3_stmt_status = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ ffi.Int32 op,
+ ffi.Int32 resetFlg,
+);
+
+typedef _dart_sqlite3_stmt_status = int Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+ int op,
+ int resetFlg,
+);
+
+typedef _c_sqlite3_backup_init = ffi.Pointer<sqlite3_backup> Function(
+ ffi.Pointer<sqlite3> pDest,
+ ffi.Pointer<ffi.Int8> zDestName,
+ ffi.Pointer<sqlite3> pSource,
+ ffi.Pointer<ffi.Int8> zSourceName,
+);
+
+typedef _dart_sqlite3_backup_init = ffi.Pointer<sqlite3_backup> Function(
+ ffi.Pointer<sqlite3> pDest,
+ ffi.Pointer<ffi.Int8> zDestName,
+ ffi.Pointer<sqlite3> pSource,
+ ffi.Pointer<ffi.Int8> zSourceName,
+);
+
+typedef _c_sqlite3_backup_step = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_backup> p,
+ ffi.Int32 nPage,
+);
+
+typedef _dart_sqlite3_backup_step = int Function(
+ ffi.Pointer<sqlite3_backup> p,
+ int nPage,
+);
+
+typedef _c_sqlite3_backup_finish = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_backup> p,
+);
+
+typedef _dart_sqlite3_backup_finish = int Function(
+ ffi.Pointer<sqlite3_backup> p,
+);
+
+typedef _c_sqlite3_backup_remaining = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_backup> p,
+);
+
+typedef _dart_sqlite3_backup_remaining = int Function(
+ ffi.Pointer<sqlite3_backup> p,
+);
+
+typedef _c_sqlite3_backup_pagecount = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_backup> p,
+);
+
+typedef _dart_sqlite3_backup_pagecount = int Function(
+ ffi.Pointer<sqlite3_backup> p,
+);
+
+typedef _typedefC_81 = ffi.Void Function(
+ ffi.Pointer<ffi.Pointer<ffi.Void>>,
+ ffi.Int32,
+);
+
+typedef _c_sqlite3_unlock_notify = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> pBlocked,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_81>> xNotify,
+ ffi.Pointer<ffi.Void> pNotifyArg,
+);
+
+typedef _dart_sqlite3_unlock_notify = int Function(
+ ffi.Pointer<sqlite3> pBlocked,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_81>> xNotify,
+ ffi.Pointer<ffi.Void> pNotifyArg,
+);
+
+typedef _c_sqlite3_stricmp = ffi.Int32 Function(
+ ffi.Pointer<ffi.Int8> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+);
+
+typedef _dart_sqlite3_stricmp = int Function(
+ ffi.Pointer<ffi.Int8> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+);
+
+typedef _c_sqlite3_strnicmp = ffi.Int32 Function(
+ ffi.Pointer<ffi.Int8> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ ffi.Int32 arg2,
+);
+
+typedef _dart_sqlite3_strnicmp = int Function(
+ ffi.Pointer<ffi.Int8> arg0,
+ ffi.Pointer<ffi.Int8> arg1,
+ int arg2,
+);
+
+typedef _c_sqlite3_strglob = ffi.Int32 Function(
+ ffi.Pointer<ffi.Int8> zGlob,
+ ffi.Pointer<ffi.Int8> zStr,
+);
+
+typedef _dart_sqlite3_strglob = int Function(
+ ffi.Pointer<ffi.Int8> zGlob,
+ ffi.Pointer<ffi.Int8> zStr,
+);
+
+typedef _c_sqlite3_strlike = ffi.Int32 Function(
+ ffi.Pointer<ffi.Int8> zGlob,
+ ffi.Pointer<ffi.Int8> zStr,
+ ffi.Uint32 cEsc,
+);
+
+typedef _dart_sqlite3_strlike = int Function(
+ ffi.Pointer<ffi.Int8> zGlob,
+ ffi.Pointer<ffi.Int8> zStr,
+ int cEsc,
+);
+
+typedef _c_sqlite3_log = ffi.Void Function(
+ ffi.Int32 iErrCode,
+ ffi.Pointer<ffi.Int8> zFormat,
+);
+
+typedef _dart_sqlite3_log = void Function(
+ int iErrCode,
+ ffi.Pointer<ffi.Int8> zFormat,
+);
+
+typedef _typedefC_82 = ffi.Int32 Function(
+ ffi.Pointer<ffi.Void>,
+ ffi.Pointer<sqlite3>,
+ ffi.Pointer<ffi.Int8>,
+ ffi.Int32,
+);
+
+typedef _c_sqlite3_wal_hook = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_82>> arg1,
+ ffi.Pointer<ffi.Void> arg2,
+);
+
+typedef _dart_sqlite3_wal_hook = ffi.Pointer<ffi.Void> Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_82>> arg1,
+ ffi.Pointer<ffi.Void> arg2,
+);
+
+typedef _c_sqlite3_wal_autocheckpoint = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Int32 N,
+);
+
+typedef _dart_sqlite3_wal_autocheckpoint = int Function(
+ ffi.Pointer<sqlite3> db,
+ int N,
+);
+
+typedef _c_sqlite3_wal_checkpoint = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDb,
+);
+
+typedef _dart_sqlite3_wal_checkpoint = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDb,
+);
+
+typedef _c_sqlite3_wal_checkpoint_v2 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDb,
+ ffi.Int32 eMode,
+ ffi.Pointer<ffi.Int32> pnLog,
+ ffi.Pointer<ffi.Int32> pnCkpt,
+);
+
+typedef _dart_sqlite3_wal_checkpoint_v2 = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDb,
+ int eMode,
+ ffi.Pointer<ffi.Int32> pnLog,
+ ffi.Pointer<ffi.Int32> pnCkpt,
+);
+
+typedef _c_sqlite3_vtab_config = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+ ffi.Int32 op,
+);
+
+typedef _dart_sqlite3_vtab_config = int Function(
+ ffi.Pointer<sqlite3> arg0,
+ int op,
+);
+
+typedef _c_sqlite3_vtab_on_conflict = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _dart_sqlite3_vtab_on_conflict = int Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _c_sqlite3_vtab_nochange = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_context> arg0,
+);
+
+typedef _dart_sqlite3_vtab_nochange = int Function(
+ ffi.Pointer<sqlite3_context> arg0,
+);
+
+typedef _c_sqlite3_vtab_collation = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_index_info> arg0,
+ ffi.Int32 arg1,
+);
+
+typedef _dart_sqlite3_vtab_collation = ffi.Pointer<ffi.Int8> Function(
+ ffi.Pointer<sqlite3_index_info> arg0,
+ int arg1,
+);
+
+typedef _c_sqlite3_stmt_scanstatus = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+ ffi.Int32 idx,
+ ffi.Int32 iScanStatusOp,
+ ffi.Pointer<ffi.Void> pOut,
+);
+
+typedef _dart_sqlite3_stmt_scanstatus = int Function(
+ ffi.Pointer<sqlite3_stmt> pStmt,
+ int idx,
+ int iScanStatusOp,
+ ffi.Pointer<ffi.Void> pOut,
+);
+
+typedef _c_sqlite3_stmt_scanstatus_reset = ffi.Void Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+);
+
+typedef _dart_sqlite3_stmt_scanstatus_reset = void Function(
+ ffi.Pointer<sqlite3_stmt> arg0,
+);
+
+typedef _c_sqlite3_db_cacheflush = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _dart_sqlite3_db_cacheflush = int Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _c_sqlite3_system_errno = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _dart_sqlite3_system_errno = int Function(
+ ffi.Pointer<sqlite3> arg0,
+);
+
+typedef _c_sqlite3_snapshot_get = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSchema,
+ ffi.Pointer<ffi.Pointer<sqlite3_snapshot>> ppSnapshot,
+);
+
+typedef _dart_sqlite3_snapshot_get = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSchema,
+ ffi.Pointer<ffi.Pointer<sqlite3_snapshot>> ppSnapshot,
+);
+
+typedef _c_sqlite3_snapshot_open = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSchema,
+ ffi.Pointer<sqlite3_snapshot> pSnapshot,
+);
+
+typedef _dart_sqlite3_snapshot_open = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSchema,
+ ffi.Pointer<sqlite3_snapshot> pSnapshot,
+);
+
+typedef _c_sqlite3_snapshot_free = ffi.Void Function(
+ ffi.Pointer<sqlite3_snapshot> arg0,
+);
+
+typedef _dart_sqlite3_snapshot_free = void Function(
+ ffi.Pointer<sqlite3_snapshot> arg0,
+);
+
+typedef _c_sqlite3_snapshot_cmp = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_snapshot> p1,
+ ffi.Pointer<sqlite3_snapshot> p2,
+);
+
+typedef _dart_sqlite3_snapshot_cmp = int Function(
+ ffi.Pointer<sqlite3_snapshot> p1,
+ ffi.Pointer<sqlite3_snapshot> p2,
+);
+
+typedef _c_sqlite3_snapshot_recover = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDb,
+);
+
+typedef _dart_sqlite3_snapshot_recover = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zDb,
+);
+
+typedef _c_sqlite3_serialize = ffi.Pointer<ffi.Uint8> Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSchema,
+ ffi.Pointer<ffi.Int64> piSize,
+ ffi.Uint32 mFlags,
+);
+
+typedef _dart_sqlite3_serialize = ffi.Pointer<ffi.Uint8> Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSchema,
+ ffi.Pointer<ffi.Int64> piSize,
+ int mFlags,
+);
+
+typedef _c_sqlite3_deserialize = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSchema,
+ ffi.Pointer<ffi.Uint8> pData,
+ ffi.Int64 szDb,
+ ffi.Int64 szBuf,
+ ffi.Uint32 mFlags,
+);
+
+typedef _dart_sqlite3_deserialize = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zSchema,
+ ffi.Pointer<ffi.Uint8> pData,
+ int szDb,
+ int szBuf,
+ int mFlags,
+);
+
+typedef _typedefC_83 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_rtree_geometry>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Double>,
+ ffi.Pointer<ffi.Int32>,
+);
+
+typedef _c_sqlite3_rtree_geometry_callback = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zGeom,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_83>> xGeom,
+ ffi.Pointer<ffi.Void> pContext,
+);
+
+typedef _dart_sqlite3_rtree_geometry_callback = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zGeom,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_83>> xGeom,
+ ffi.Pointer<ffi.Void> pContext,
+);
+
+typedef _typedefC_84 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_rtree_query_info>,
+);
+
+typedef _typedefC_85 = ffi.Void Function(
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _c_sqlite3_rtree_query_callback = ffi.Int32 Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zQueryFunc,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_84>> xQueryFunc,
+ ffi.Pointer<ffi.Void> pContext,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_85>> xDestructor,
+);
+
+typedef _dart_sqlite3_rtree_query_callback = int Function(
+ ffi.Pointer<sqlite3> db,
+ ffi.Pointer<ffi.Int8> zQueryFunc,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_84>> xQueryFunc,
+ ffi.Pointer<ffi.Void> pContext,
+ ffi.Pointer<ffi.NativeFunction<_typedefC_85>> xDestructor,
+);
+
+typedef _typedefC_14 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_file>,
+);
+
+typedef _typedefC_15 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_file>,
+ ffi.Pointer<ffi.Void>,
+ ffi.Int32,
+ ffi.Int64,
+);
+
+typedef _typedefC_16 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_file>,
+ ffi.Pointer<ffi.Void>,
+ ffi.Int32,
+ ffi.Int64,
+);
+
+typedef _typedefC_17 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_file>,
+ ffi.Int64,
+);
+
+typedef _typedefC_18 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_file>,
+ ffi.Int32,
+);
+
+typedef _typedefC_19 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_file>,
+ ffi.Pointer<ffi.Int64>,
+);
+
+typedef _typedefC_20 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_file>,
+ ffi.Int32,
+);
+
+typedef _typedefC_21 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_file>,
+ ffi.Int32,
+);
+
+typedef _typedefC_22 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_file>,
+ ffi.Pointer<ffi.Int32>,
+);
+
+typedef _typedefC_23 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_file>,
+ ffi.Int32,
+ ffi.Pointer<ffi.Void>,
+);
+
+typedef _typedefC_24 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_file>,
+);
+
+typedef _typedefC_25 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_file>,
+);
+
+typedef _typedefC_26 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_file>,
+ ffi.Int32,
+ ffi.Int32,
+ ffi.Int32,
+ ffi.Pointer<ffi.Pointer<ffi.Void>>,
+);
+
+typedef _typedefC_27 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_file>,
+ ffi.Int32,
+ ffi.Int32,
+ ffi.Int32,
+);
+
+typedef _typedefC_28 = ffi.Void Function(
+ ffi.Pointer<sqlite3_file>,
+);
+
+typedef _typedefC_29 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_file>,
+ ffi.Int32,
+);
+
+typedef _typedefC_30 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_file>,
+ ffi.Int64,
+ ffi.Int32,
+ ffi.Pointer<ffi.Pointer<ffi.Void>>,
+);
+
+typedef _typedefC_31 = ffi.Int32 Function(
+ ffi.Pointer<sqlite3_file>,
+ ffi.Int64,
+ ffi.Pointer<ffi.Void>,
+);
diff --git a/test/large_integration_tests/large_test.dart b/test/large_integration_tests/large_test.dart
new file mode 100644
index 0000000..87d9f2e
--- /dev/null
+++ b/test/large_integration_tests/large_test.dart
@@ -0,0 +1,135 @@
+// Copyright (c) 2020, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'dart:io';
+
+import 'package:ffigen/src/header_parser.dart';
+import 'package:yaml/yaml.dart';
+import 'package:ffigen/src/config_provider/config.dart';
+import 'package:test/test.dart';
+import 'package:ffigen/src/strings.dart' as strings;
+import 'package:path/path.dart' as path;
+
+void main() {
+ group('large_test', () {
+ test('Libclang test', () {
+ final config = Config.fromYaml(loadYaml('''
+${strings.name}: LibClang
+${strings.description}: Bindings to LibClang.
+${strings.output}: unused
+${strings.libclang_dylib_folder}: tool/wrapped_libclang
+${strings.compilerOpts}: -I${path.join('third_party', 'libclang', 'include')}
+${strings.arrayWorkaround}: true
+${strings.headers}:
+ - third_party/libclang/include/clang-c/Index.h
+${strings.headerFilter}:
+ include:
+ - 'BuildSystem.h'
+ - 'CXCompilationDatabase.h'
+ - 'CXErrorCode.h'
+ - 'CXString.h'
+ - 'Documentation.h'
+ - 'FataErrorHandler.h'
+ - 'Index.h'
+ ''') as YamlMap);
+ final library = parse(config);
+ final file = File(
+ path.join('test', 'debug_generated', 'large_test_libclang.dart'),
+ );
+ library.generateFile(file);
+
+ try {
+ final actual = file.readAsStringSync();
+ final expected = File(path.join('test', 'large_integration_tests',
+ '_expected_libclang_bindings.dart'))
+ .readAsStringSync();
+ expect(actual, expected);
+ if (file.existsSync()) {
+ file.delete();
+ }
+ } catch (e) {
+ print('Failed test: Debug generated file: ${file.absolute?.path}');
+ rethrow;
+ }
+ });
+
+ test('CJSON test', () {
+ final config = Config.fromYaml(loadYaml('''
+${strings.name}: CJson
+${strings.description}: Bindings to Cjson.
+${strings.output}: unused
+${strings.comments}: full
+${strings.libclang_dylib_folder}: tool/wrapped_libclang
+${strings.arrayWorkaround}: true
+${strings.headers}:
+ - third_party/cjson_library/cJSON.h
+${strings.headerFilter}:
+ include:
+ - 'cJSON.h'
+ ''') as YamlMap);
+ final library = parse(config);
+ final file = File(
+ path.join('test', 'debug_generated', 'large_test_cjson.dart'),
+ );
+ library.generateFile(file);
+
+ try {
+ final actual = file.readAsStringSync();
+ final expected = File(path.join('test', 'large_integration_tests',
+ '_expected_cjson_bindings.dart'))
+ .readAsStringSync();
+ expect(actual, expected);
+ if (file.existsSync()) {
+ file.delete();
+ }
+ } catch (e) {
+ print('Failed test: Debug generated file: ${file.absolute?.path}');
+ rethrow;
+ }
+ });
+
+ test('SQLite test', () {
+ // Excluding functions that use 'va_list' because it can either be a
+ // Pointer<__va_list_tag> or int depending on the OS.
+ final config = Config.fromYaml(loadYaml('''
+${strings.name}: SQLite
+${strings.description}: Bindings to SQLite.
+${strings.output}: unused
+${strings.libclang_dylib_folder}: tool/wrapped_libclang
+${strings.arrayWorkaround}: true
+${strings.comments}: full
+${strings.headers}:
+ - third_party/sqlite/sqlite3.h
+${strings.headerFilter}:
+ ${strings.include}:
+ - 'sqlite3.h'
+${strings.functions}:
+ ${strings.exclude}:
+ ${strings.names}:
+ - sqlite3_vmprintf
+ - sqlite3_vsnprintf
+ - sqlite3_str_vappendf
+ ''') as YamlMap);
+ final library = parse(config);
+ final file = File(
+ path.join('test', 'debug_generated', 'large_test_sqlite.dart'),
+ );
+ library.generateFile(file);
+
+ try {
+ final actual = file.readAsStringSync();
+ final expected = File(path.join('test', 'large_integration_tests',
+ '_expected_sqlite_bindings.dart'))
+ .readAsStringSync();
+ expect(actual, expected);
+ if (file.existsSync()) {
+ file.delete();
+ }
+ } catch (e) {
+ print('Failed test: Debug generated file: ${file.absolute?.path}');
+ rethrow;
+ }
+ });
+ });
+}
diff --git a/test/native_test/native_test.dart b/test/native_test/native_test.dart
index 11e18a8..eab5dfe 100644
--- a/test/native_test/native_test.dart
+++ b/test/native_test/native_test.dart
@@ -10,7 +10,7 @@
import 'native_test_bindings.dart' as bindings;
void main() {
- group('Tests for native functions', () {
+ group('native_test', () {
setUpAll(() {
var dylibName = 'test/native_test/native_test.so';
if (Platform.isMacOS) {
diff --git a/test/native_test/native_test.def b/test/native_test/native_test.def
index f2d6f91..f6853d1 100644
--- a/test/native_test/native_test.def
+++ b/test/native_test/native_test.def
@@ -13,4 +13,5 @@
Function1Int64
Function1IntPtr
Function1Float
-Function1Double
\ No newline at end of file
+Function1Double
+getStruct1
diff --git a/test/prefix_tests/prefix_test.dart b/test/prefix_tests/prefix_test.dart
index 0f91327..0031c3b 100644
--- a/test/prefix_tests/prefix_test.dart
+++ b/test/prefix_tests/prefix_test.dart
@@ -1,14 +1,16 @@
// Copyright (c) 2020, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
+
import 'package:ffigen/src/code_generator.dart';
import 'package:ffigen/src/header_parser.dart' as parser;
import 'package:ffigen/src/config_provider.dart';
-import 'package:logging/logging.dart';
import 'package:test/test.dart';
import 'package:yaml/yaml.dart' as yaml;
import 'package:ffigen/src/strings.dart' as strings;
+import '../test_utils.dart';
+
Library actual, expected;
final functionPrefix = 'fff';
final structPrefix = 'sss';
@@ -19,14 +21,8 @@
final enumPrefixReplacedWith = 're';
void main() {
- group('Global Prefix Test', () {
+ group('prefix_test', () {
setUpAll(() {
- Logger.root.onRecord.listen((log) {
- if (log.level > Level.INFO) {
- print(
- 'prefix_test.dart: ${log.level.name.padRight(8)}: ${log.message}');
- }
- });
expected = expectedLibrary();
actual = parser.parse(Config.fromYaml(yaml.loadYaml('''
${strings.name}: 'NativeLibrary'
@@ -58,45 +54,41 @@
});
test('Function prefix', () {
- expect(binding(actual, '${functionPrefix}func1'),
- binding(expected, '${functionPrefix}func1'));
+ expect(actual.getBindingAsString('${functionPrefix}func1'),
+ expected.getBindingAsString('${functionPrefix}func1'));
});
test('Struct prefix', () {
- expect(binding(actual, '${structPrefix}Struct1'),
- binding(expected, '${structPrefix}Struct1'));
+ expect(actual.getBindingAsString('${structPrefix}Struct1'),
+ expected.getBindingAsString('${structPrefix}Struct1'));
});
test('Enum prefix', () {
- expect(binding(actual, '${enumPrefix}Enum1'),
- binding(expected, '${enumPrefix}Enum1'));
+ expect(actual.getBindingAsString('${enumPrefix}Enum1'),
+ expected.getBindingAsString('${enumPrefix}Enum1'));
});
test('Function prefix-replacement', () {
expect(
- binding(
- actual, '${functionPrefix}${functionPrefixReplacedWith}func2'),
- binding(
- expected, '${functionPrefix}${functionPrefixReplacedWith}func2'));
+ actual.getBindingAsString(
+ '${functionPrefix}${functionPrefixReplacedWith}func2'),
+ expected.getBindingAsString(
+ '${functionPrefix}${functionPrefixReplacedWith}func2'));
});
test('Struct prefix-replacement', () {
expect(
- binding(actual, '${structPrefix}${structPrefixReplacedWith}Struct2'),
- binding(
- expected, '${structPrefix}${structPrefixReplacedWith}Struct2'));
+ actual.getBindingAsString(
+ '${structPrefix}${structPrefixReplacedWith}Struct2'),
+ expected.getBindingAsString(
+ '${structPrefix}${structPrefixReplacedWith}Struct2'));
});
test('Enum prefix-replacement', () {
- expect(binding(actual, '${enumPrefix}${enumPrefixReplacedWith}Enum2'),
- binding(expected, '${enumPrefix}${enumPrefixReplacedWith}Enum2'));
+ expect(
+ actual.getBindingAsString(
+ '${enumPrefix}${enumPrefixReplacedWith}Enum2'),
+ expected.getBindingAsString(
+ '${enumPrefix}${enumPrefixReplacedWith}Enum2'));
});
});
}
-/// Extracts a binding's string with a given name from a library.
-String binding(Library lib, String name) {
- return lib.bindings
- .firstWhere((element) => element.name == name)
- .toBindingString(lib.writer)
- .string;
-}
-
Library expectedLibrary() {
final struc1 = Struc(name: '${structPrefix}Struct1');
final struc2 =
@@ -106,7 +98,7 @@
bindings: [
Func(
name: '${functionPrefix}func1',
- lookupSymbolName: 'func1',
+ originalName: 'func1',
returnType: Type.nativeType(
SupportedNativeType.Void,
),
@@ -119,7 +111,7 @@
),
Func(
name: '${functionPrefix}${functionPrefixReplacedWith}func2',
- lookupSymbolName: 'test_func2',
+ originalName: 'test_func2',
returnType: Type.nativeType(
SupportedNativeType.Void,
),
diff --git a/test/test_utils.dart b/test/test_utils.dart
new file mode 100644
index 0000000..4b9d9eb
--- /dev/null
+++ b/test/test_utils.dart
@@ -0,0 +1,49 @@
+// Copyright (c) 2020, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'package:ffigen/src/code_generator.dart';
+import 'package:logging/logging.dart';
+
+/// Extracts a binding's string from a library.
+
+extension LibraryTestExt on Library {
+ /// Get a [Binding]'s generated string with a given name.
+ String getBindingAsString(String name) {
+ final b = bindings.firstWhere((element) => element.name == name,
+ orElse: () => null);
+ if (b == null) {
+ throw NotFoundException("Binding '$name' not found.");
+ } else {
+ return b.toBindingString(writer).string;
+ }
+ }
+
+ /// Get a [Binding] with a given name.
+ Binding getBinding(String name) {
+ final b = bindings.firstWhere((element) => element.name == name,
+ orElse: () => null);
+ if (b == null) {
+ throw NotFoundException("Binding '$name' not found.");
+ } else {
+ return b;
+ }
+ }
+}
+
+class NotFoundException implements Exception {
+ final String message;
+ NotFoundException(this.message);
+
+ @override
+ String toString() {
+ return message;
+ }
+}
+
+void logWarnings() {
+ Logger.root.level = Level.WARNING;
+ Logger.root.onRecord.listen((record) {
+ print('${record.level.name.padRight(8)}: ${record.message}');
+ });
+}
diff --git a/third_party/libclang/include/clang-c/BuildSystem.h b/third_party/libclang/include/clang-c/BuildSystem.h
new file mode 100644
index 0000000..4e9f6de
--- /dev/null
+++ b/third_party/libclang/include/clang-c/BuildSystem.h
@@ -0,0 +1,153 @@
+/*==-- clang-c/BuildSystem.h - Utilities for use by build systems -*- C -*-===*\
+|* *|
+|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
+|* Exceptions. *|
+|* See https://llvm.org/LICENSE.txt for license information. *|
+|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
+|* *|
+|*===----------------------------------------------------------------------===*|
+|* *|
+|* This header provides various utilities for use by build systems. *|
+|* *|
+\*===----------------------------------------------------------------------===*/
+
+#ifndef LLVM_CLANG_C_BUILDSYSTEM_H
+#define LLVM_CLANG_C_BUILDSYSTEM_H
+
+#include "clang-c/CXErrorCode.h"
+#include "clang-c/CXString.h"
+#include "clang-c/ExternC.h"
+#include "clang-c/Platform.h"
+
+LLVM_CLANG_C_EXTERN_C_BEGIN
+
+/**
+ * \defgroup BUILD_SYSTEM Build system utilities
+ * @{
+ */
+
+/**
+ * Return the timestamp for use with Clang's
+ * \c -fbuild-session-timestamp= option.
+ */
+CINDEX_LINKAGE unsigned long long clang_getBuildSessionTimestamp(void);
+
+/**
+ * Object encapsulating information about overlaying virtual
+ * file/directories over the real file system.
+ */
+typedef struct CXVirtualFileOverlayImpl *CXVirtualFileOverlay;
+
+/**
+ * Create a \c CXVirtualFileOverlay object.
+ * Must be disposed with \c clang_VirtualFileOverlay_dispose().
+ *
+ * \param options is reserved, always pass 0.
+ */
+CINDEX_LINKAGE CXVirtualFileOverlay
+clang_VirtualFileOverlay_create(unsigned options);
+
+/**
+ * Map an absolute virtual file path to an absolute real one.
+ * The virtual path must be canonicalized (not contain "."/"..").
+ * \returns 0 for success, non-zero to indicate an error.
+ */
+CINDEX_LINKAGE enum CXErrorCode
+clang_VirtualFileOverlay_addFileMapping(CXVirtualFileOverlay,
+ const char *virtualPath,
+ const char *realPath);
+
+/**
+ * Set the case sensitivity for the \c CXVirtualFileOverlay object.
+ * The \c CXVirtualFileOverlay object is case-sensitive by default, this
+ * option can be used to override the default.
+ * \returns 0 for success, non-zero to indicate an error.
+ */
+CINDEX_LINKAGE enum CXErrorCode
+clang_VirtualFileOverlay_setCaseSensitivity(CXVirtualFileOverlay,
+ int caseSensitive);
+
+/**
+ * Write out the \c CXVirtualFileOverlay object to a char buffer.
+ *
+ * \param options is reserved, always pass 0.
+ * \param out_buffer_ptr pointer to receive the buffer pointer, which should be
+ * disposed using \c clang_free().
+ * \param out_buffer_size pointer to receive the buffer size.
+ * \returns 0 for success, non-zero to indicate an error.
+ */
+CINDEX_LINKAGE enum CXErrorCode
+clang_VirtualFileOverlay_writeToBuffer(CXVirtualFileOverlay, unsigned options,
+ char **out_buffer_ptr,
+ unsigned *out_buffer_size);
+
+/**
+ * free memory allocated by libclang, such as the buffer returned by
+ * \c CXVirtualFileOverlay() or \c clang_ModuleMapDescriptor_writeToBuffer().
+ *
+ * \param buffer memory pointer to free.
+ */
+CINDEX_LINKAGE void clang_free(void *buffer);
+
+/**
+ * Dispose a \c CXVirtualFileOverlay object.
+ */
+CINDEX_LINKAGE void clang_VirtualFileOverlay_dispose(CXVirtualFileOverlay);
+
+/**
+ * Object encapsulating information about a module.map file.
+ */
+typedef struct CXModuleMapDescriptorImpl *CXModuleMapDescriptor;
+
+/**
+ * Create a \c CXModuleMapDescriptor object.
+ * Must be disposed with \c clang_ModuleMapDescriptor_dispose().
+ *
+ * \param options is reserved, always pass 0.
+ */
+CINDEX_LINKAGE CXModuleMapDescriptor
+clang_ModuleMapDescriptor_create(unsigned options);
+
+/**
+ * Sets the framework module name that the module.map describes.
+ * \returns 0 for success, non-zero to indicate an error.
+ */
+CINDEX_LINKAGE enum CXErrorCode
+clang_ModuleMapDescriptor_setFrameworkModuleName(CXModuleMapDescriptor,
+ const char *name);
+
+/**
+ * Sets the umbrealla header name that the module.map describes.
+ * \returns 0 for success, non-zero to indicate an error.
+ */
+CINDEX_LINKAGE enum CXErrorCode
+clang_ModuleMapDescriptor_setUmbrellaHeader(CXModuleMapDescriptor,
+ const char *name);
+
+/**
+ * Write out the \c CXModuleMapDescriptor object to a char buffer.
+ *
+ * \param options is reserved, always pass 0.
+ * \param out_buffer_ptr pointer to receive the buffer pointer, which should be
+ * disposed using \c clang_free().
+ * \param out_buffer_size pointer to receive the buffer size.
+ * \returns 0 for success, non-zero to indicate an error.
+ */
+CINDEX_LINKAGE enum CXErrorCode
+clang_ModuleMapDescriptor_writeToBuffer(CXModuleMapDescriptor, unsigned options,
+ char **out_buffer_ptr,
+ unsigned *out_buffer_size);
+
+/**
+ * Dispose a \c CXModuleMapDescriptor object.
+ */
+CINDEX_LINKAGE void clang_ModuleMapDescriptor_dispose(CXModuleMapDescriptor);
+
+/**
+ * @}
+ */
+
+LLVM_CLANG_C_EXTERN_C_END
+
+#endif /* CLANG_C_BUILD_SYSTEM_H */
+
diff --git a/third_party/libclang/include/clang-c/CXCompilationDatabase.h b/third_party/libclang/include/clang-c/CXCompilationDatabase.h
new file mode 100644
index 0000000..2b336e5
--- /dev/null
+++ b/third_party/libclang/include/clang-c/CXCompilationDatabase.h
@@ -0,0 +1,174 @@
+/*===-- clang-c/CXCompilationDatabase.h - Compilation database ---*- C -*-===*\
+|* *|
+|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
+|* Exceptions. *|
+|* See https://llvm.org/LICENSE.txt for license information. *|
+|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
+|* *|
+|*===----------------------------------------------------------------------===*|
+|* *|
+|* This header provides a public interface to use CompilationDatabase without *|
+|* the full Clang C++ API. *|
+|* *|
+\*===----------------------------------------------------------------------===*/
+
+#ifndef LLVM_CLANG_C_CXCOMPILATIONDATABASE_H
+#define LLVM_CLANG_C_CXCOMPILATIONDATABASE_H
+
+#include "clang-c/CXString.h"
+#include "clang-c/ExternC.h"
+#include "clang-c/Platform.h"
+
+LLVM_CLANG_C_EXTERN_C_BEGIN
+
+/** \defgroup COMPILATIONDB CompilationDatabase functions
+ * \ingroup CINDEX
+ *
+ * @{
+ */
+
+/**
+ * A compilation database holds all information used to compile files in a
+ * project. For each file in the database, it can be queried for the working
+ * directory or the command line used for the compiler invocation.
+ *
+ * Must be freed by \c clang_CompilationDatabase_dispose
+ */
+typedef void * CXCompilationDatabase;
+
+/**
+ * Contains the results of a search in the compilation database
+ *
+ * When searching for the compile command for a file, the compilation db can
+ * return several commands, as the file may have been compiled with
+ * different options in different places of the project. This choice of compile
+ * commands is wrapped in this opaque data structure. It must be freed by
+ * \c clang_CompileCommands_dispose.
+ */
+typedef void * CXCompileCommands;
+
+/**
+ * Represents the command line invocation to compile a specific file.
+ */
+typedef void * CXCompileCommand;
+
+/**
+ * Error codes for Compilation Database
+ */
+typedef enum {
+ /*
+ * No error occurred
+ */
+ CXCompilationDatabase_NoError = 0,
+
+ /*
+ * Database can not be loaded
+ */
+ CXCompilationDatabase_CanNotLoadDatabase = 1
+
+} CXCompilationDatabase_Error;
+
+/**
+ * Creates a compilation database from the database found in directory
+ * buildDir. For example, CMake can output a compile_commands.json which can
+ * be used to build the database.
+ *
+ * It must be freed by \c clang_CompilationDatabase_dispose.
+ */
+CINDEX_LINKAGE CXCompilationDatabase
+clang_CompilationDatabase_fromDirectory(const char *BuildDir,
+ CXCompilationDatabase_Error *ErrorCode);
+
+/**
+ * Free the given compilation database
+ */
+CINDEX_LINKAGE void
+clang_CompilationDatabase_dispose(CXCompilationDatabase);
+
+/**
+ * Find the compile commands used for a file. The compile commands
+ * must be freed by \c clang_CompileCommands_dispose.
+ */
+CINDEX_LINKAGE CXCompileCommands
+clang_CompilationDatabase_getCompileCommands(CXCompilationDatabase,
+ const char *CompleteFileName);
+
+/**
+ * Get all the compile commands in the given compilation database.
+ */
+CINDEX_LINKAGE CXCompileCommands
+clang_CompilationDatabase_getAllCompileCommands(CXCompilationDatabase);
+
+/**
+ * Free the given CompileCommands
+ */
+CINDEX_LINKAGE void clang_CompileCommands_dispose(CXCompileCommands);
+
+/**
+ * Get the number of CompileCommand we have for a file
+ */
+CINDEX_LINKAGE unsigned
+clang_CompileCommands_getSize(CXCompileCommands);
+
+/**
+ * Get the I'th CompileCommand for a file
+ *
+ * Note : 0 <= i < clang_CompileCommands_getSize(CXCompileCommands)
+ */
+CINDEX_LINKAGE CXCompileCommand
+clang_CompileCommands_getCommand(CXCompileCommands, unsigned I);
+
+/**
+ * Get the working directory where the CompileCommand was executed from
+ */
+CINDEX_LINKAGE CXString
+clang_CompileCommand_getDirectory(CXCompileCommand);
+
+/**
+ * Get the filename associated with the CompileCommand.
+ */
+CINDEX_LINKAGE CXString
+clang_CompileCommand_getFilename(CXCompileCommand);
+
+/**
+ * Get the number of arguments in the compiler invocation.
+ *
+ */
+CINDEX_LINKAGE unsigned
+clang_CompileCommand_getNumArgs(CXCompileCommand);
+
+/**
+ * Get the I'th argument value in the compiler invocations
+ *
+ * Invariant :
+ * - argument 0 is the compiler executable
+ */
+CINDEX_LINKAGE CXString
+clang_CompileCommand_getArg(CXCompileCommand, unsigned I);
+
+/**
+ * Get the number of source mappings for the compiler invocation.
+ */
+CINDEX_LINKAGE unsigned
+clang_CompileCommand_getNumMappedSources(CXCompileCommand);
+
+/**
+ * Get the I'th mapped source path for the compiler invocation.
+ */
+CINDEX_LINKAGE CXString
+clang_CompileCommand_getMappedSourcePath(CXCompileCommand, unsigned I);
+
+/**
+ * Get the I'th mapped source content for the compiler invocation.
+ */
+CINDEX_LINKAGE CXString
+clang_CompileCommand_getMappedSourceContent(CXCompileCommand, unsigned I);
+
+/**
+ * @}
+ */
+
+LLVM_CLANG_C_EXTERN_C_END
+
+#endif
+
diff --git a/third_party/libclang/include/clang-c/CXErrorCode.h b/third_party/libclang/include/clang-c/CXErrorCode.h
new file mode 100644
index 0000000..b3a0b9d
--- /dev/null
+++ b/third_party/libclang/include/clang-c/CXErrorCode.h
@@ -0,0 +1,62 @@
+/*===-- clang-c/CXErrorCode.h - C Index Error Codes --------------*- C -*-===*\
+|* *|
+|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
+|* Exceptions. *|
+|* See https://llvm.org/LICENSE.txt for license information. *|
+|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
+|* *|
+|*===----------------------------------------------------------------------===*|
+|* *|
+|* This header provides the CXErrorCode enumerators. *|
+|* *|
+\*===----------------------------------------------------------------------===*/
+
+#ifndef LLVM_CLANG_C_CXERRORCODE_H
+#define LLVM_CLANG_C_CXERRORCODE_H
+
+#include "clang-c/ExternC.h"
+#include "clang-c/Platform.h"
+
+LLVM_CLANG_C_EXTERN_C_BEGIN
+
+/**
+ * Error codes returned by libclang routines.
+ *
+ * Zero (\c CXError_Success) is the only error code indicating success. Other
+ * error codes, including not yet assigned non-zero values, indicate errors.
+ */
+enum CXErrorCode {
+ /**
+ * No error.
+ */
+ CXError_Success = 0,
+
+ /**
+ * A generic error code, no further details are available.
+ *
+ * Errors of this kind can get their own specific error codes in future
+ * libclang versions.
+ */
+ CXError_Failure = 1,
+
+ /**
+ * libclang crashed while performing the requested operation.
+ */
+ CXError_Crashed = 2,
+
+ /**
+ * The function detected that the arguments violate the function
+ * contract.
+ */
+ CXError_InvalidArguments = 3,
+
+ /**
+ * An AST deserialization error has occurred.
+ */
+ CXError_ASTReadError = 4
+};
+
+LLVM_CLANG_C_EXTERN_C_END
+
+#endif
+
diff --git a/third_party/libclang/include/clang-c/CXString.h b/third_party/libclang/include/clang-c/CXString.h
new file mode 100644
index 0000000..f117010
--- /dev/null
+++ b/third_party/libclang/include/clang-c/CXString.h
@@ -0,0 +1,69 @@
+/*===-- clang-c/CXString.h - C Index strings --------------------*- C -*-===*\
+|* *|
+|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
+|* Exceptions. *|
+|* See https://llvm.org/LICENSE.txt for license information. *|
+|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
+|* *|
+|*===----------------------------------------------------------------------===*|
+|* *|
+|* This header provides the interface to C Index strings. *|
+|* *|
+\*===----------------------------------------------------------------------===*/
+
+#ifndef LLVM_CLANG_C_CXSTRING_H
+#define LLVM_CLANG_C_CXSTRING_H
+
+#include "clang-c/ExternC.h"
+#include "clang-c/Platform.h"
+
+LLVM_CLANG_C_EXTERN_C_BEGIN
+
+/**
+ * \defgroup CINDEX_STRING String manipulation routines
+ * \ingroup CINDEX
+ *
+ * @{
+ */
+
+/**
+ * A character string.
+ *
+ * The \c CXString type is used to return strings from the interface when
+ * the ownership of that string might differ from one call to the next.
+ * Use \c clang_getCString() to retrieve the string data and, once finished
+ * with the string data, call \c clang_disposeString() to free the string.
+ */
+typedef struct {
+ const void *data;
+ unsigned private_flags;
+} CXString;
+
+typedef struct {
+ CXString *Strings;
+ unsigned Count;
+} CXStringSet;
+
+/**
+ * Retrieve the character data associated with the given string.
+ */
+CINDEX_LINKAGE const char *clang_getCString(CXString string);
+
+/**
+ * Free the given string.
+ */
+CINDEX_LINKAGE void clang_disposeString(CXString string);
+
+/**
+ * Free the given string set.
+ */
+CINDEX_LINKAGE void clang_disposeStringSet(CXStringSet *set);
+
+/**
+ * @}
+ */
+
+LLVM_CLANG_C_EXTERN_C_END
+
+#endif
+
diff --git a/third_party/libclang/include/clang-c/Documentation.h b/third_party/libclang/include/clang-c/Documentation.h
new file mode 100644
index 0000000..5bece2c
--- /dev/null
+++ b/third_party/libclang/include/clang-c/Documentation.h
@@ -0,0 +1,555 @@
+/*==-- clang-c/Documentation.h - Utilities for comment processing -*- C -*-===*\
+|* *|
+|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
+|* Exceptions. *|
+|* See https://llvm.org/LICENSE.txt for license information. *|
+|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
+|* *|
+|*===----------------------------------------------------------------------===*|
+|* *|
+|* This header provides a supplementary interface for inspecting *|
+|* documentation comments. *|
+|* *|
+\*===----------------------------------------------------------------------===*/
+
+#ifndef LLVM_CLANG_C_DOCUMENTATION_H
+#define LLVM_CLANG_C_DOCUMENTATION_H
+
+#include "clang-c/ExternC.h"
+#include "clang-c/Index.h"
+
+LLVM_CLANG_C_EXTERN_C_BEGIN
+
+/**
+ * \defgroup CINDEX_COMMENT Comment introspection
+ *
+ * The routines in this group provide access to information in documentation
+ * comments. These facilities are distinct from the core and may be subject to
+ * their own schedule of stability and deprecation.
+ *
+ * @{
+ */
+
+/**
+ * A parsed comment.
+ */
+typedef struct {
+ const void *ASTNode;
+ CXTranslationUnit TranslationUnit;
+} CXComment;
+
+/**
+ * Given a cursor that represents a documentable entity (e.g.,
+ * declaration), return the associated parsed comment as a
+ * \c CXComment_FullComment AST node.
+ */
+CINDEX_LINKAGE CXComment clang_Cursor_getParsedComment(CXCursor C);
+
+/**
+ * Describes the type of the comment AST node (\c CXComment). A comment
+ * node can be considered block content (e. g., paragraph), inline content
+ * (plain text) or neither (the root AST node).
+ */
+enum CXCommentKind {
+ /**
+ * Null comment. No AST node is constructed at the requested location
+ * because there is no text or a syntax error.
+ */
+ CXComment_Null = 0,
+
+ /**
+ * Plain text. Inline content.
+ */
+ CXComment_Text = 1,
+
+ /**
+ * A command with word-like arguments that is considered inline content.
+ *
+ * For example: \\c command.
+ */
+ CXComment_InlineCommand = 2,
+
+ /**
+ * HTML start tag with attributes (name-value pairs). Considered
+ * inline content.
+ *
+ * For example:
+ * \verbatim
+ * <br> <br /> <a href="http://example.org/">
+ * \endverbatim
+ */
+ CXComment_HTMLStartTag = 3,
+
+ /**
+ * HTML end tag. Considered inline content.
+ *
+ * For example:
+ * \verbatim
+ * </a>
+ * \endverbatim
+ */
+ CXComment_HTMLEndTag = 4,
+
+ /**
+ * A paragraph, contains inline comment. The paragraph itself is
+ * block content.
+ */
+ CXComment_Paragraph = 5,
+
+ /**
+ * A command that has zero or more word-like arguments (number of
+ * word-like arguments depends on command name) and a paragraph as an
+ * argument. Block command is block content.
+ *
+ * Paragraph argument is also a child of the block command.
+ *
+ * For example: \has 0 word-like arguments and a paragraph argument.
+ *
+ * AST nodes of special kinds that parser knows about (e. g., \\param
+ * command) have their own node kinds.
+ */
+ CXComment_BlockCommand = 6,
+
+ /**
+ * A \\param or \\arg command that describes the function parameter
+ * (name, passing direction, description).
+ *
+ * For example: \\param [in] ParamName description.
+ */
+ CXComment_ParamCommand = 7,
+
+ /**
+ * A \\tparam command that describes a template parameter (name and
+ * description).
+ *
+ * For example: \\tparam T description.
+ */
+ CXComment_TParamCommand = 8,
+
+ /**
+ * A verbatim block command (e. g., preformatted code). Verbatim
+ * block has an opening and a closing command and contains multiple lines of
+ * text (\c CXComment_VerbatimBlockLine child nodes).
+ *
+ * For example:
+ * \\verbatim
+ * aaa
+ * \\endverbatim
+ */
+ CXComment_VerbatimBlockCommand = 9,
+
+ /**
+ * A line of text that is contained within a
+ * CXComment_VerbatimBlockCommand node.
+ */
+ CXComment_VerbatimBlockLine = 10,
+
+ /**
+ * A verbatim line command. Verbatim line has an opening command,
+ * a single line of text (up to the newline after the opening command) and
+ * has no closing command.
+ */
+ CXComment_VerbatimLine = 11,
+
+ /**
+ * A full comment attached to a declaration, contains block content.
+ */
+ CXComment_FullComment = 12
+};
+
+/**
+ * The most appropriate rendering mode for an inline command, chosen on
+ * command semantics in Doxygen.
+ */
+enum CXCommentInlineCommandRenderKind {
+ /**
+ * Command argument should be rendered in a normal font.
+ */
+ CXCommentInlineCommandRenderKind_Normal,
+
+ /**
+ * Command argument should be rendered in a bold font.
+ */
+ CXCommentInlineCommandRenderKind_Bold,
+
+ /**
+ * Command argument should be rendered in a monospaced font.
+ */
+ CXCommentInlineCommandRenderKind_Monospaced,
+
+ /**
+ * Command argument should be rendered emphasized (typically italic
+ * font).
+ */
+ CXCommentInlineCommandRenderKind_Emphasized,
+
+ /**
+ * Command argument should not be rendered (since it only defines an anchor).
+ */
+ CXCommentInlineCommandRenderKind_Anchor
+};
+
+/**
+ * Describes parameter passing direction for \\param or \\arg command.
+ */
+enum CXCommentParamPassDirection {
+ /**
+ * The parameter is an input parameter.
+ */
+ CXCommentParamPassDirection_In,
+
+ /**
+ * The parameter is an output parameter.
+ */
+ CXCommentParamPassDirection_Out,
+
+ /**
+ * The parameter is an input and output parameter.
+ */
+ CXCommentParamPassDirection_InOut
+};
+
+/**
+ * \param Comment AST node of any kind.
+ *
+ * \returns the type of the AST node.
+ */
+CINDEX_LINKAGE enum CXCommentKind clang_Comment_getKind(CXComment Comment);
+
+/**
+ * \param Comment AST node of any kind.
+ *
+ * \returns number of children of the AST node.
+ */
+CINDEX_LINKAGE unsigned clang_Comment_getNumChildren(CXComment Comment);
+
+/**
+ * \param Comment AST node of any kind.
+ *
+ * \param ChildIdx child index (zero-based).
+ *
+ * \returns the specified child of the AST node.
+ */
+CINDEX_LINKAGE
+CXComment clang_Comment_getChild(CXComment Comment, unsigned ChildIdx);
+
+/**
+ * A \c CXComment_Paragraph node is considered whitespace if it contains
+ * only \c CXComment_Text nodes that are empty or whitespace.
+ *
+ * Other AST nodes (except \c CXComment_Paragraph and \c CXComment_Text) are
+ * never considered whitespace.
+ *
+ * \returns non-zero if \c Comment is whitespace.
+ */
+CINDEX_LINKAGE unsigned clang_Comment_isWhitespace(CXComment Comment);
+
+/**
+ * \returns non-zero if \c Comment is inline content and has a newline
+ * immediately following it in the comment text. Newlines between paragraphs
+ * do not count.
+ */
+CINDEX_LINKAGE
+unsigned clang_InlineContentComment_hasTrailingNewline(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_Text AST node.
+ *
+ * \returns text contained in the AST node.
+ */
+CINDEX_LINKAGE CXString clang_TextComment_getText(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_InlineCommand AST node.
+ *
+ * \returns name of the inline command.
+ */
+CINDEX_LINKAGE
+CXString clang_InlineCommandComment_getCommandName(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_InlineCommand AST node.
+ *
+ * \returns the most appropriate rendering mode, chosen on command
+ * semantics in Doxygen.
+ */
+CINDEX_LINKAGE enum CXCommentInlineCommandRenderKind
+clang_InlineCommandComment_getRenderKind(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_InlineCommand AST node.
+ *
+ * \returns number of command arguments.
+ */
+CINDEX_LINKAGE
+unsigned clang_InlineCommandComment_getNumArgs(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_InlineCommand AST node.
+ *
+ * \param ArgIdx argument index (zero-based).
+ *
+ * \returns text of the specified argument.
+ */
+CINDEX_LINKAGE
+CXString clang_InlineCommandComment_getArgText(CXComment Comment,
+ unsigned ArgIdx);
+
+/**
+ * \param Comment a \c CXComment_HTMLStartTag or \c CXComment_HTMLEndTag AST
+ * node.
+ *
+ * \returns HTML tag name.
+ */
+CINDEX_LINKAGE CXString clang_HTMLTagComment_getTagName(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_HTMLStartTag AST node.
+ *
+ * \returns non-zero if tag is self-closing (for example, <br />).
+ */
+CINDEX_LINKAGE
+unsigned clang_HTMLStartTagComment_isSelfClosing(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_HTMLStartTag AST node.
+ *
+ * \returns number of attributes (name-value pairs) attached to the start tag.
+ */
+CINDEX_LINKAGE unsigned clang_HTMLStartTag_getNumAttrs(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_HTMLStartTag AST node.
+ *
+ * \param AttrIdx attribute index (zero-based).
+ *
+ * \returns name of the specified attribute.
+ */
+CINDEX_LINKAGE
+CXString clang_HTMLStartTag_getAttrName(CXComment Comment, unsigned AttrIdx);
+
+/**
+ * \param Comment a \c CXComment_HTMLStartTag AST node.
+ *
+ * \param AttrIdx attribute index (zero-based).
+ *
+ * \returns value of the specified attribute.
+ */
+CINDEX_LINKAGE
+CXString clang_HTMLStartTag_getAttrValue(CXComment Comment, unsigned AttrIdx);
+
+/**
+ * \param Comment a \c CXComment_BlockCommand AST node.
+ *
+ * \returns name of the block command.
+ */
+CINDEX_LINKAGE
+CXString clang_BlockCommandComment_getCommandName(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_BlockCommand AST node.
+ *
+ * \returns number of word-like arguments.
+ */
+CINDEX_LINKAGE
+unsigned clang_BlockCommandComment_getNumArgs(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_BlockCommand AST node.
+ *
+ * \param ArgIdx argument index (zero-based).
+ *
+ * \returns text of the specified word-like argument.
+ */
+CINDEX_LINKAGE
+CXString clang_BlockCommandComment_getArgText(CXComment Comment,
+ unsigned ArgIdx);
+
+/**
+ * \param Comment a \c CXComment_BlockCommand or
+ * \c CXComment_VerbatimBlockCommand AST node.
+ *
+ * \returns paragraph argument of the block command.
+ */
+CINDEX_LINKAGE
+CXComment clang_BlockCommandComment_getParagraph(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_ParamCommand AST node.
+ *
+ * \returns parameter name.
+ */
+CINDEX_LINKAGE
+CXString clang_ParamCommandComment_getParamName(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_ParamCommand AST node.
+ *
+ * \returns non-zero if the parameter that this AST node represents was found
+ * in the function prototype and \c clang_ParamCommandComment_getParamIndex
+ * function will return a meaningful value.
+ */
+CINDEX_LINKAGE
+unsigned clang_ParamCommandComment_isParamIndexValid(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_ParamCommand AST node.
+ *
+ * \returns zero-based parameter index in function prototype.
+ */
+CINDEX_LINKAGE
+unsigned clang_ParamCommandComment_getParamIndex(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_ParamCommand AST node.
+ *
+ * \returns non-zero if parameter passing direction was specified explicitly in
+ * the comment.
+ */
+CINDEX_LINKAGE
+unsigned clang_ParamCommandComment_isDirectionExplicit(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_ParamCommand AST node.
+ *
+ * \returns parameter passing direction.
+ */
+CINDEX_LINKAGE
+enum CXCommentParamPassDirection clang_ParamCommandComment_getDirection(
+ CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_TParamCommand AST node.
+ *
+ * \returns template parameter name.
+ */
+CINDEX_LINKAGE
+CXString clang_TParamCommandComment_getParamName(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_TParamCommand AST node.
+ *
+ * \returns non-zero if the parameter that this AST node represents was found
+ * in the template parameter list and
+ * \c clang_TParamCommandComment_getDepth and
+ * \c clang_TParamCommandComment_getIndex functions will return a meaningful
+ * value.
+ */
+CINDEX_LINKAGE
+unsigned clang_TParamCommandComment_isParamPositionValid(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_TParamCommand AST node.
+ *
+ * \returns zero-based nesting depth of this parameter in the template parameter list.
+ *
+ * For example,
+ * \verbatim
+ * template<typename C, template<typename T> class TT>
+ * void test(TT<int> aaa);
+ * \endverbatim
+ * for C and TT nesting depth is 0,
+ * for T nesting depth is 1.
+ */
+CINDEX_LINKAGE
+unsigned clang_TParamCommandComment_getDepth(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_TParamCommand AST node.
+ *
+ * \returns zero-based parameter index in the template parameter list at a
+ * given nesting depth.
+ *
+ * For example,
+ * \verbatim
+ * template<typename C, template<typename T> class TT>
+ * void test(TT<int> aaa);
+ * \endverbatim
+ * for C and TT nesting depth is 0, so we can ask for index at depth 0:
+ * at depth 0 C's index is 0, TT's index is 1.
+ *
+ * For T nesting depth is 1, so we can ask for index at depth 0 and 1:
+ * at depth 0 T's index is 1 (same as TT's),
+ * at depth 1 T's index is 0.
+ */
+CINDEX_LINKAGE
+unsigned clang_TParamCommandComment_getIndex(CXComment Comment, unsigned Depth);
+
+/**
+ * \param Comment a \c CXComment_VerbatimBlockLine AST node.
+ *
+ * \returns text contained in the AST node.
+ */
+CINDEX_LINKAGE
+CXString clang_VerbatimBlockLineComment_getText(CXComment Comment);
+
+/**
+ * \param Comment a \c CXComment_VerbatimLine AST node.
+ *
+ * \returns text contained in the AST node.
+ */
+CINDEX_LINKAGE CXString clang_VerbatimLineComment_getText(CXComment Comment);
+
+/**
+ * Convert an HTML tag AST node to string.
+ *
+ * \param Comment a \c CXComment_HTMLStartTag or \c CXComment_HTMLEndTag AST
+ * node.
+ *
+ * \returns string containing an HTML tag.
+ */
+CINDEX_LINKAGE CXString clang_HTMLTagComment_getAsString(CXComment Comment);
+
+/**
+ * Convert a given full parsed comment to an HTML fragment.
+ *
+ * Specific details of HTML layout are subject to change. Don't try to parse
+ * this HTML back into an AST, use other APIs instead.
+ *
+ * Currently the following CSS classes are used:
+ * \li "para-brief" for \paragraph and equivalent commands;
+ * \li "para-returns" for \\returns paragraph and equivalent commands;
+ * \li "word-returns" for the "Returns" word in \\returns paragraph.
+ *
+ * Function argument documentation is rendered as a \<dl\> list with arguments
+ * sorted in function prototype order. CSS classes used:
+ * \li "param-name-index-NUMBER" for parameter name (\<dt\>);
+ * \li "param-descr-index-NUMBER" for parameter description (\<dd\>);
+ * \li "param-name-index-invalid" and "param-descr-index-invalid" are used if
+ * parameter index is invalid.
+ *
+ * Template parameter documentation is rendered as a \<dl\> list with
+ * parameters sorted in template parameter list order. CSS classes used:
+ * \li "tparam-name-index-NUMBER" for parameter name (\<dt\>);
+ * \li "tparam-descr-index-NUMBER" for parameter description (\<dd\>);
+ * \li "tparam-name-index-other" and "tparam-descr-index-other" are used for
+ * names inside template template parameters;
+ * \li "tparam-name-index-invalid" and "tparam-descr-index-invalid" are used if
+ * parameter position is invalid.
+ *
+ * \param Comment a \c CXComment_FullComment AST node.
+ *
+ * \returns string containing an HTML fragment.
+ */
+CINDEX_LINKAGE CXString clang_FullComment_getAsHTML(CXComment Comment);
+
+/**
+ * Convert a given full parsed comment to an XML document.
+ *
+ * A Relax NG schema for the XML can be found in comment-xml-schema.rng file
+ * inside clang source tree.
+ *
+ * \param Comment a \c CXComment_FullComment AST node.
+ *
+ * \returns string containing an XML document.
+ */
+CINDEX_LINKAGE CXString clang_FullComment_getAsXML(CXComment Comment);
+
+/**
+ * @}
+ */
+
+LLVM_CLANG_C_EXTERN_C_END
+
+#endif /* CLANG_C_DOCUMENTATION_H */
+
diff --git a/third_party/libclang/include/clang-c/ExternC.h b/third_party/libclang/include/clang-c/ExternC.h
new file mode 100644
index 0000000..384f24d
--- /dev/null
+++ b/third_party/libclang/include/clang-c/ExternC.h
@@ -0,0 +1,39 @@
+/*===- clang-c/ExternC.h - Wrapper for 'extern "C"' ---------------*- C -*-===*\
+|* *|
+|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
+|* Exceptions. *|
+|* See https://llvm.org/LICENSE.txt for license information. *|
+|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
+|* *|
+|*===----------------------------------------------------------------------===*|
+|* *|
+|* This file defines an 'extern "C"' wrapper. *|
+|* *|
+\*===----------------------------------------------------------------------===*/
+
+#ifndef LLVM_CLANG_C_EXTERN_C_H
+#define LLVM_CLANG_C_EXTERN_C_H
+
+#ifdef __clang__
+#define LLVM_CLANG_C_STRICT_PROTOTYPES_BEGIN \
+ _Pragma("clang diagnostic push") \
+ _Pragma("clang diagnostic error \"-Wstrict-prototypes\"")
+#define LLVM_CLANG_C_STRICT_PROTOTYPES_END _Pragma("clang diagnostic pop")
+#else
+#define LLVM_CLANG_C_STRICT_PROTOTYPES_BEGIN
+#define LLVM_CLANG_C_STRICT_PROTOTYPES_END
+#endif
+
+#ifdef __cplusplus
+#define LLVM_CLANG_C_EXTERN_C_BEGIN \
+ extern "C" { \
+ LLVM_CLANG_C_STRICT_PROTOTYPES_BEGIN
+#define LLVM_CLANG_C_EXTERN_C_END \
+ LLVM_CLANG_C_STRICT_PROTOTYPES_END \
+ }
+#else
+#define LLVM_CLANG_C_EXTERN_C_BEGIN LLVM_CLANG_C_STRICT_PROTOTYPES_BEGIN
+#define LLVM_CLANG_C_EXTERN_C_END LLVM_CLANG_C_STRICT_PROTOTYPES_END
+#endif
+
+#endif
diff --git a/third_party/libclang/include/clang-c/FatalErrorHandler.h b/third_party/libclang/include/clang-c/FatalErrorHandler.h
new file mode 100644
index 0000000..22f34fa
--- /dev/null
+++ b/third_party/libclang/include/clang-c/FatalErrorHandler.h
@@ -0,0 +1,32 @@
+/*===-- clang-c/FatalErrorHandler.h - Fatal Error Handling --------*- C -*-===*\
+|* *|
+|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
+|* Exceptions. *|
+|* See https://llvm.org/LICENSE.txt for license information. *|
+|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
+|* *|
+\*===----------------------------------------------------------------------===*/
+
+#ifndef LLVM_CLANG_C_FATAL_ERROR_HANDLER_H
+#define LLVM_CLANG_C_FATAL_ERROR_HANDLER_H
+
+#include "clang-c/ExternC.h"
+
+LLVM_CLANG_C_EXTERN_C_BEGIN
+
+/**
+ * Installs error handler that prints error message to stderr and calls abort().
+ * Replaces currently installed error handler (if any).
+ */
+void clang_install_aborting_llvm_fatal_error_handler(void);
+
+/**
+ * Removes currently installed error handler (if any).
+ * If no error handler is intalled, the default strategy is to print error
+ * message to stderr and call exit(1).
+ */
+void clang_uninstall_llvm_fatal_error_handler(void);
+
+LLVM_CLANG_C_EXTERN_C_END
+
+#endif
diff --git a/third_party/libclang/include/clang-c/Index.h b/third_party/libclang/include/clang-c/Index.h
new file mode 100644
index 0000000..b653995
--- /dev/null
+++ b/third_party/libclang/include/clang-c/Index.h
@@ -0,0 +1,6782 @@
+/*===-- clang-c/Index.h - Indexing Public C Interface -------------*- C -*-===*\
+|* *|
+|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
+|* Exceptions. *|
+|* See https://llvm.org/LICENSE.txt for license information. *|
+|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
+|* *|
+|*===----------------------------------------------------------------------===*|
+|* *|
+|* This header provides a public interface to a Clang library for extracting *|
+|* high-level symbol information from source files without exposing the full *|
+|* Clang C++ API. *|
+|* *|
+\*===----------------------------------------------------------------------===*/
+
+#ifndef LLVM_CLANG_C_INDEX_H
+#define LLVM_CLANG_C_INDEX_H
+
+#include <time.h>
+
+#include "clang-c/BuildSystem.h"
+#include "clang-c/CXErrorCode.h"
+#include "clang-c/CXString.h"
+#include "clang-c/ExternC.h"
+#include "clang-c/Platform.h"
+
+/**
+ * The version constants for the libclang API.
+ * CINDEX_VERSION_MINOR should increase when there are API additions.
+ * CINDEX_VERSION_MAJOR is intended for "major" source/ABI breaking changes.
+ *
+ * The policy about the libclang API was always to keep it source and ABI
+ * compatible, thus CINDEX_VERSION_MAJOR is expected to remain stable.
+ */
+#define CINDEX_VERSION_MAJOR 0
+#define CINDEX_VERSION_MINOR 59
+
+#define CINDEX_VERSION_ENCODE(major, minor) ( \
+ ((major) * 10000) \
+ + ((minor) * 1))
+
+#define CINDEX_VERSION CINDEX_VERSION_ENCODE( \
+ CINDEX_VERSION_MAJOR, \
+ CINDEX_VERSION_MINOR )
+
+#define CINDEX_VERSION_STRINGIZE_(major, minor) \
+ #major"."#minor
+#define CINDEX_VERSION_STRINGIZE(major, minor) \
+ CINDEX_VERSION_STRINGIZE_(major, minor)
+
+#define CINDEX_VERSION_STRING CINDEX_VERSION_STRINGIZE( \
+ CINDEX_VERSION_MAJOR, \
+ CINDEX_VERSION_MINOR)
+
+LLVM_CLANG_C_EXTERN_C_BEGIN
+
+/** \defgroup CINDEX libclang: C Interface to Clang
+ *
+ * The C Interface to Clang provides a relatively small API that exposes
+ * facilities for parsing source code into an abstract syntax tree (AST),
+ * loading already-parsed ASTs, traversing the AST, associating
+ * physical source locations with elements within the AST, and other
+ * facilities that support Clang-based development tools.
+ *
+ * This C interface to Clang will never provide all of the information
+ * representation stored in Clang's C++ AST, nor should it: the intent is to
+ * maintain an API that is relatively stable from one release to the next,
+ * providing only the basic functionality needed to support development tools.
+ *
+ * To avoid namespace pollution, data types are prefixed with "CX" and
+ * functions are prefixed with "clang_".
+ *
+ * @{
+ */
+
+/**
+ * An "index" that consists of a set of translation units that would
+ * typically be linked together into an executable or library.
+ */
+typedef void *CXIndex;
+
+/**
+ * An opaque type representing target information for a given translation
+ * unit.
+ */
+typedef struct CXTargetInfoImpl *CXTargetInfo;
+
+/**
+ * A single translation unit, which resides in an index.
+ */
+typedef struct CXTranslationUnitImpl *CXTranslationUnit;
+
+/**
+ * Opaque pointer representing client data that will be passed through
+ * to various callbacks and visitors.
+ */
+typedef void *CXClientData;
+
+/**
+ * Provides the contents of a file that has not yet been saved to disk.
+ *
+ * Each CXUnsavedFile instance provides the name of a file on the
+ * system along with the current contents of that file that have not
+ * yet been saved to disk.
+ */
+struct CXUnsavedFile {
+ /**
+ * The file whose contents have not yet been saved.
+ *
+ * This file must already exist in the file system.
+ */
+ const char *Filename;
+
+ /**
+ * A buffer containing the unsaved contents of this file.
+ */
+ const char *Contents;
+
+ /**
+ * The length of the unsaved contents of this buffer.
+ */
+ unsigned long Length;
+};
+
+/**
+ * Describes the availability of a particular entity, which indicates
+ * whether the use of this entity will result in a warning or error due to
+ * it being deprecated or unavailable.
+ */
+enum CXAvailabilityKind {
+ /**
+ * The entity is available.
+ */
+ CXAvailability_Available,
+ /**
+ * The entity is available, but has been deprecated (and its use is
+ * not recommended).
+ */
+ CXAvailability_Deprecated,
+ /**
+ * The entity is not available; any use of it will be an error.
+ */
+ CXAvailability_NotAvailable,
+ /**
+ * The entity is available, but not accessible; any use of it will be
+ * an error.
+ */
+ CXAvailability_NotAccessible
+};
+
+/**
+ * Describes a version number of the form major.minor.subminor.
+ */
+typedef struct CXVersion {
+ /**
+ * The major version number, e.g., the '10' in '10.7.3'. A negative
+ * value indicates that there is no version number at all.
+ */
+ int Major;
+ /**
+ * The minor version number, e.g., the '7' in '10.7.3'. This value
+ * will be negative if no minor version number was provided, e.g., for
+ * version '10'.
+ */
+ int Minor;
+ /**
+ * The subminor version number, e.g., the '3' in '10.7.3'. This value
+ * will be negative if no minor or subminor version number was provided,
+ * e.g., in version '10' or '10.7'.
+ */
+ int Subminor;
+} CXVersion;
+
+/**
+ * Describes the exception specification of a cursor.
+ *
+ * A negative value indicates that the cursor is not a function declaration.
+ */
+enum CXCursor_ExceptionSpecificationKind {
+ /**
+ * The cursor has no exception specification.
+ */
+ CXCursor_ExceptionSpecificationKind_None,
+
+ /**
+ * The cursor has exception specification throw()
+ */
+ CXCursor_ExceptionSpecificationKind_DynamicNone,
+
+ /**
+ * The cursor has exception specification throw(T1, T2)
+ */
+ CXCursor_ExceptionSpecificationKind_Dynamic,
+
+ /**
+ * The cursor has exception specification throw(...).
+ */
+ CXCursor_ExceptionSpecificationKind_MSAny,
+
+ /**
+ * The cursor has exception specification basic noexcept.
+ */
+ CXCursor_ExceptionSpecificationKind_BasicNoexcept,
+
+ /**
+ * The cursor has exception specification computed noexcept.
+ */
+ CXCursor_ExceptionSpecificationKind_ComputedNoexcept,
+
+ /**
+ * The exception specification has not yet been evaluated.
+ */
+ CXCursor_ExceptionSpecificationKind_Unevaluated,
+
+ /**
+ * The exception specification has not yet been instantiated.
+ */
+ CXCursor_ExceptionSpecificationKind_Uninstantiated,
+
+ /**
+ * The exception specification has not been parsed yet.
+ */
+ CXCursor_ExceptionSpecificationKind_Unparsed,
+
+ /**
+ * The cursor has a __declspec(nothrow) exception specification.
+ */
+ CXCursor_ExceptionSpecificationKind_NoThrow
+};
+
+/**
+ * Provides a shared context for creating translation units.
+ *
+ * It provides two options:
+ *
+ * - excludeDeclarationsFromPCH: When non-zero, allows enumeration of "local"
+ * declarations (when loading any new translation units). A "local" declaration
+ * is one that belongs in the translation unit itself and not in a precompiled
+ * header that was used by the translation unit. If zero, all declarations
+ * will be enumerated.
+ *
+ * Here is an example:
+ *
+ * \code
+ * // excludeDeclsFromPCH = 1, displayDiagnostics=1
+ * Idx = clang_createIndex(1, 1);
+ *
+ * // IndexTest.pch was produced with the following command:
+ * // "clang -x c IndexTest.h -emit-ast -o IndexTest.pch"
+ * TU = clang_createTranslationUnit(Idx, "IndexTest.pch");
+ *
+ * // This will load all the symbols from 'IndexTest.pch'
+ * clang_visitChildren(clang_getTranslationUnitCursor(TU),
+ * TranslationUnitVisitor, 0);
+ * clang_disposeTranslationUnit(TU);
+ *
+ * // This will load all the symbols from 'IndexTest.c', excluding symbols
+ * // from 'IndexTest.pch'.
+ * char *args[] = { "-Xclang", "-include-pch=IndexTest.pch" };
+ * TU = clang_createTranslationUnitFromSourceFile(Idx, "IndexTest.c", 2, args,
+ * 0, 0);
+ * clang_visitChildren(clang_getTranslationUnitCursor(TU),
+ * TranslationUnitVisitor, 0);
+ * clang_disposeTranslationUnit(TU);
+ * \endcode
+ *
+ * This process of creating the 'pch', loading it separately, and using it (via
+ * -include-pch) allows 'excludeDeclsFromPCH' to remove redundant callbacks
+ * (which gives the indexer the same performance benefit as the compiler).
+ */
+CINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
+ int displayDiagnostics);
+
+/**
+ * Destroy the given index.
+ *
+ * The index must not be destroyed until all of the translation units created
+ * within that index have been destroyed.
+ */
+CINDEX_LINKAGE void clang_disposeIndex(CXIndex index);
+
+typedef enum {
+ /**
+ * Used to indicate that no special CXIndex options are needed.
+ */
+ CXGlobalOpt_None = 0x0,
+
+ /**
+ * Used to indicate that threads that libclang creates for indexing
+ * purposes should use background priority.
+ *
+ * Affects #clang_indexSourceFile, #clang_indexTranslationUnit,
+ * #clang_parseTranslationUnit, #clang_saveTranslationUnit.
+ */
+ CXGlobalOpt_ThreadBackgroundPriorityForIndexing = 0x1,
+
+ /**
+ * Used to indicate that threads that libclang creates for editing
+ * purposes should use background priority.
+ *
+ * Affects #clang_reparseTranslationUnit, #clang_codeCompleteAt,
+ * #clang_annotateTokens
+ */
+ CXGlobalOpt_ThreadBackgroundPriorityForEditing = 0x2,
+
+ /**
+ * Used to indicate that all threads that libclang creates should use
+ * background priority.
+ */
+ CXGlobalOpt_ThreadBackgroundPriorityForAll =
+ CXGlobalOpt_ThreadBackgroundPriorityForIndexing |
+ CXGlobalOpt_ThreadBackgroundPriorityForEditing
+
+} CXGlobalOptFlags;
+
+/**
+ * Sets general options associated with a CXIndex.
+ *
+ * For example:
+ * \code
+ * CXIndex idx = ...;
+ * clang_CXIndex_setGlobalOptions(idx,
+ * clang_CXIndex_getGlobalOptions(idx) |
+ * CXGlobalOpt_ThreadBackgroundPriorityForIndexing);
+ * \endcode
+ *
+ * \param options A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags.
+ */
+CINDEX_LINKAGE void clang_CXIndex_setGlobalOptions(CXIndex, unsigned options);
+
+/**
+ * Gets the general options associated with a CXIndex.
+ *
+ * \returns A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags that
+ * are associated with the given CXIndex object.
+ */
+CINDEX_LINKAGE unsigned clang_CXIndex_getGlobalOptions(CXIndex);
+
+/**
+ * Sets the invocation emission path option in a CXIndex.
+ *
+ * The invocation emission path specifies a path which will contain log
+ * files for certain libclang invocations. A null value (default) implies that
+ * libclang invocations are not logged..
+ */
+CINDEX_LINKAGE void
+clang_CXIndex_setInvocationEmissionPathOption(CXIndex, const char *Path);
+
+/**
+ * \defgroup CINDEX_FILES File manipulation routines
+ *
+ * @{
+ */
+
+/**
+ * A particular source file that is part of a translation unit.
+ */
+typedef void *CXFile;
+
+/**
+ * Retrieve the complete file and path name of the given file.
+ */
+CINDEX_LINKAGE CXString clang_getFileName(CXFile SFile);
+
+/**
+ * Retrieve the last modification time of the given file.
+ */
+CINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile);
+
+/**
+ * Uniquely identifies a CXFile, that refers to the same underlying file,
+ * across an indexing session.
+ */
+typedef struct {
+ unsigned long long data[3];
+} CXFileUniqueID;
+
+/**
+ * Retrieve the unique ID for the given \c file.
+ *
+ * \param file the file to get the ID for.
+ * \param outID stores the returned CXFileUniqueID.
+ * \returns If there was a failure getting the unique ID, returns non-zero,
+ * otherwise returns 0.
+*/
+CINDEX_LINKAGE int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID);
+
+/**
+ * Determine whether the given header is guarded against
+ * multiple inclusions, either with the conventional
+ * \#ifndef/\#define/\#endif macro guards or with \#pragma once.
+ */
+CINDEX_LINKAGE unsigned
+clang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file);
+
+/**
+ * Retrieve a file handle within the given translation unit.
+ *
+ * \param tu the translation unit
+ *
+ * \param file_name the name of the file.
+ *
+ * \returns the file handle for the named file in the translation unit \p tu,
+ * or a NULL file handle if the file was not a part of this translation unit.
+ */
+CINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu,
+ const char *file_name);
+
+/**
+ * Retrieve the buffer associated with the given file.
+ *
+ * \param tu the translation unit
+ *
+ * \param file the file for which to retrieve the buffer.
+ *
+ * \param size [out] if non-NULL, will be set to the size of the buffer.
+ *
+ * \returns a pointer to the buffer in memory that holds the contents of
+ * \p file, or a NULL pointer when the file is not loaded.
+ */
+CINDEX_LINKAGE const char *clang_getFileContents(CXTranslationUnit tu,
+ CXFile file, size_t *size);
+
+/**
+ * Returns non-zero if the \c file1 and \c file2 point to the same file,
+ * or they are both NULL.
+ */
+CINDEX_LINKAGE int clang_File_isEqual(CXFile file1, CXFile file2);
+
+/**
+ * Returns the real path name of \c file.
+ *
+ * An empty string may be returned. Use \c clang_getFileName() in that case.
+ */
+CINDEX_LINKAGE CXString clang_File_tryGetRealPathName(CXFile file);
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup CINDEX_LOCATIONS Physical source locations
+ *
+ * Clang represents physical source locations in its abstract syntax tree in
+ * great detail, with file, line, and column information for the majority of
+ * the tokens parsed in the source code. These data types and functions are
+ * used to represent source location information, either for a particular
+ * point in the program or for a range of points in the program, and extract
+ * specific location information from those data types.
+ *
+ * @{
+ */
+
+/**
+ * Identifies a specific source location within a translation
+ * unit.
+ *
+ * Use clang_getExpansionLocation() or clang_getSpellingLocation()
+ * to map a source location to a particular file, line, and column.
+ */
+typedef struct {
+ const void *ptr_data[2];
+ unsigned int_data;
+} CXSourceLocation;
+
+/**
+ * Identifies a half-open character range in the source code.
+ *
+ * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the
+ * starting and end locations from a source range, respectively.
+ */
+typedef struct {
+ const void *ptr_data[2];
+ unsigned begin_int_data;
+ unsigned end_int_data;
+} CXSourceRange;
+
+/**
+ * Retrieve a NULL (invalid) source location.
+ */
+CINDEX_LINKAGE CXSourceLocation clang_getNullLocation(void);
+
+/**
+ * Determine whether two source locations, which must refer into
+ * the same translation unit, refer to exactly the same point in the source
+ * code.
+ *
+ * \returns non-zero if the source locations refer to the same location, zero
+ * if they refer to different locations.
+ */
+CINDEX_LINKAGE unsigned clang_equalLocations(CXSourceLocation loc1,
+ CXSourceLocation loc2);
+
+/**
+ * Retrieves the source location associated with a given file/line/column
+ * in a particular translation unit.
+ */
+CINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu,
+ CXFile file,
+ unsigned line,
+ unsigned column);
+/**
+ * Retrieves the source location associated with a given character offset
+ * in a particular translation unit.
+ */
+CINDEX_LINKAGE CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu,
+ CXFile file,
+ unsigned offset);
+
+/**
+ * Returns non-zero if the given source location is in a system header.
+ */
+CINDEX_LINKAGE int clang_Location_isInSystemHeader(CXSourceLocation location);
+
+/**
+ * Returns non-zero if the given source location is in the main file of
+ * the corresponding translation unit.
+ */
+CINDEX_LINKAGE int clang_Location_isFromMainFile(CXSourceLocation location);
+
+/**
+ * Retrieve a NULL (invalid) source range.
+ */
+CINDEX_LINKAGE CXSourceRange clang_getNullRange(void);
+
+/**
+ * Retrieve a source range given the beginning and ending source
+ * locations.
+ */
+CINDEX_LINKAGE CXSourceRange clang_getRange(CXSourceLocation begin,
+ CXSourceLocation end);
+
+/**
+ * Determine whether two ranges are equivalent.
+ *
+ * \returns non-zero if the ranges are the same, zero if they differ.
+ */
+CINDEX_LINKAGE unsigned clang_equalRanges(CXSourceRange range1,
+ CXSourceRange range2);
+
+/**
+ * Returns non-zero if \p range is null.
+ */
+CINDEX_LINKAGE int clang_Range_isNull(CXSourceRange range);
+
+/**
+ * Retrieve the file, line, column, and offset represented by
+ * the given source location.
+ *
+ * If the location refers into a macro expansion, retrieves the
+ * location of the macro expansion.
+ *
+ * \param location the location within a source file that will be decomposed
+ * into its parts.
+ *
+ * \param file [out] if non-NULL, will be set to the file to which the given
+ * source location points.
+ *
+ * \param line [out] if non-NULL, will be set to the line to which the given
+ * source location points.
+ *
+ * \param column [out] if non-NULL, will be set to the column to which the given
+ * source location points.
+ *
+ * \param offset [out] if non-NULL, will be set to the offset into the
+ * buffer to which the given source location points.
+ */
+CINDEX_LINKAGE void clang_getExpansionLocation(CXSourceLocation location,
+ CXFile *file,
+ unsigned *line,
+ unsigned *column,
+ unsigned *offset);
+
+/**
+ * Retrieve the file, line and column represented by the given source
+ * location, as specified in a # line directive.
+ *
+ * Example: given the following source code in a file somefile.c
+ *
+ * \code
+ * #123 "dummy.c" 1
+ *
+ * static int func(void)
+ * {
+ * return 0;
+ * }
+ * \endcode
+ *
+ * the location information returned by this function would be
+ *
+ * File: dummy.c Line: 124 Column: 12
+ *
+ * whereas clang_getExpansionLocation would have returned
+ *
+ * File: somefile.c Line: 3 Column: 12
+ *
+ * \param location the location within a source file that will be decomposed
+ * into its parts.
+ *
+ * \param filename [out] if non-NULL, will be set to the filename of the
+ * source location. Note that filenames returned will be for "virtual" files,
+ * which don't necessarily exist on the machine running clang - e.g. when
+ * parsing preprocessed output obtained from a different environment. If
+ * a non-NULL value is passed in, remember to dispose of the returned value
+ * using \c clang_disposeString() once you've finished with it. For an invalid
+ * source location, an empty string is returned.
+ *
+ * \param line [out] if non-NULL, will be set to the line number of the
+ * source location. For an invalid source location, zero is returned.
+ *
+ * \param column [out] if non-NULL, will be set to the column number of the
+ * source location. For an invalid source location, zero is returned.
+ */
+CINDEX_LINKAGE void clang_getPresumedLocation(CXSourceLocation location,
+ CXString *filename,
+ unsigned *line,
+ unsigned *column);
+
+/**
+ * Legacy API to retrieve the file, line, column, and offset represented
+ * by the given source location.
+ *
+ * This interface has been replaced by the newer interface
+ * #clang_getExpansionLocation(). See that interface's documentation for
+ * details.
+ */
+CINDEX_LINKAGE void clang_getInstantiationLocation(CXSourceLocation location,
+ CXFile *file,
+ unsigned *line,
+ unsigned *column,
+ unsigned *offset);
+
+/**
+ * Retrieve the file, line, column, and offset represented by
+ * the given source location.
+ *
+ * If the location refers into a macro instantiation, return where the
+ * location was originally spelled in the source file.
+ *
+ * \param location the location within a source file that will be decomposed
+ * into its parts.
+ *
+ * \param file [out] if non-NULL, will be set to the file to which the given
+ * source location points.
+ *
+ * \param line [out] if non-NULL, will be set to the line to which the given
+ * source location points.
+ *
+ * \param column [out] if non-NULL, will be set to the column to which the given
+ * source location points.
+ *
+ * \param offset [out] if non-NULL, will be set to the offset into the
+ * buffer to which the given source location points.
+ */
+CINDEX_LINKAGE void clang_getSpellingLocation(CXSourceLocation location,
+ CXFile *file,
+ unsigned *line,
+ unsigned *column,
+ unsigned *offset);
+
+/**
+ * Retrieve the file, line, column, and offset represented by
+ * the given source location.
+ *
+ * If the location refers into a macro expansion, return where the macro was
+ * expanded or where the macro argument was written, if the location points at
+ * a macro argument.
+ *
+ * \param location the location within a source file that will be decomposed
+ * into its parts.
+ *
+ * \param file [out] if non-NULL, will be set to the file to which the given
+ * source location points.
+ *
+ * \param line [out] if non-NULL, will be set to the line to which the given
+ * source location points.
+ *
+ * \param column [out] if non-NULL, will be set to the column to which the given
+ * source location points.
+ *
+ * \param offset [out] if non-NULL, will be set to the offset into the
+ * buffer to which the given source location points.
+ */
+CINDEX_LINKAGE void clang_getFileLocation(CXSourceLocation location,
+ CXFile *file,
+ unsigned *line,
+ unsigned *column,
+ unsigned *offset);
+
+/**
+ * Retrieve a source location representing the first character within a
+ * source range.
+ */
+CINDEX_LINKAGE CXSourceLocation clang_getRangeStart(CXSourceRange range);
+
+/**
+ * Retrieve a source location representing the last character within a
+ * source range.
+ */
+CINDEX_LINKAGE CXSourceLocation clang_getRangeEnd(CXSourceRange range);
+
+/**
+ * Identifies an array of ranges.
+ */
+typedef struct {
+ /** The number of ranges in the \c ranges array. */
+ unsigned count;
+ /**
+ * An array of \c CXSourceRanges.
+ */
+ CXSourceRange *ranges;
+} CXSourceRangeList;
+
+/**
+ * Retrieve all ranges that were skipped by the preprocessor.
+ *
+ * The preprocessor will skip lines when they are surrounded by an
+ * if/ifdef/ifndef directive whose condition does not evaluate to true.
+ */
+CINDEX_LINKAGE CXSourceRangeList *clang_getSkippedRanges(CXTranslationUnit tu,
+ CXFile file);
+
+/**
+ * Retrieve all ranges from all files that were skipped by the
+ * preprocessor.
+ *
+ * The preprocessor will skip lines when they are surrounded by an
+ * if/ifdef/ifndef directive whose condition does not evaluate to true.
+ */
+CINDEX_LINKAGE CXSourceRangeList *clang_getAllSkippedRanges(CXTranslationUnit tu);
+
+/**
+ * Destroy the given \c CXSourceRangeList.
+ */
+CINDEX_LINKAGE void clang_disposeSourceRangeList(CXSourceRangeList *ranges);
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup CINDEX_DIAG Diagnostic reporting
+ *
+ * @{
+ */
+
+/**
+ * Describes the severity of a particular diagnostic.
+ */
+enum CXDiagnosticSeverity {
+ /**
+ * A diagnostic that has been suppressed, e.g., by a command-line
+ * option.
+ */
+ CXDiagnostic_Ignored = 0,
+
+ /**
+ * This diagnostic is a note that should be attached to the
+ * previous (non-note) diagnostic.
+ */
+ CXDiagnostic_Note = 1,
+
+ /**
+ * This diagnostic indicates suspicious code that may not be
+ * wrong.
+ */
+ CXDiagnostic_Warning = 2,
+
+ /**
+ * This diagnostic indicates that the code is ill-formed.
+ */
+ CXDiagnostic_Error = 3,
+
+ /**
+ * This diagnostic indicates that the code is ill-formed such
+ * that future parser recovery is unlikely to produce useful
+ * results.
+ */
+ CXDiagnostic_Fatal = 4
+};
+
+/**
+ * A single diagnostic, containing the diagnostic's severity,
+ * location, text, source ranges, and fix-it hints.
+ */
+typedef void *CXDiagnostic;
+
+/**
+ * A group of CXDiagnostics.
+ */
+typedef void *CXDiagnosticSet;
+
+/**
+ * Determine the number of diagnostics in a CXDiagnosticSet.
+ */
+CINDEX_LINKAGE unsigned clang_getNumDiagnosticsInSet(CXDiagnosticSet Diags);
+
+/**
+ * Retrieve a diagnostic associated with the given CXDiagnosticSet.
+ *
+ * \param Diags the CXDiagnosticSet to query.
+ * \param Index the zero-based diagnostic number to retrieve.
+ *
+ * \returns the requested diagnostic. This diagnostic must be freed
+ * via a call to \c clang_disposeDiagnostic().
+ */
+CINDEX_LINKAGE CXDiagnostic clang_getDiagnosticInSet(CXDiagnosticSet Diags,
+ unsigned Index);
+
+/**
+ * Describes the kind of error that occurred (if any) in a call to
+ * \c clang_loadDiagnostics.
+ */
+enum CXLoadDiag_Error {
+ /**
+ * Indicates that no error occurred.
+ */
+ CXLoadDiag_None = 0,
+
+ /**
+ * Indicates that an unknown error occurred while attempting to
+ * deserialize diagnostics.
+ */
+ CXLoadDiag_Unknown = 1,
+
+ /**
+ * Indicates that the file containing the serialized diagnostics
+ * could not be opened.
+ */
+ CXLoadDiag_CannotLoad = 2,
+
+ /**
+ * Indicates that the serialized diagnostics file is invalid or
+ * corrupt.
+ */
+ CXLoadDiag_InvalidFile = 3
+};
+
+/**
+ * Deserialize a set of diagnostics from a Clang diagnostics bitcode
+ * file.
+ *
+ * \param file The name of the file to deserialize.
+ * \param error A pointer to a enum value recording if there was a problem
+ * deserializing the diagnostics.
+ * \param errorString A pointer to a CXString for recording the error string
+ * if the file was not successfully loaded.
+ *
+ * \returns A loaded CXDiagnosticSet if successful, and NULL otherwise. These
+ * diagnostics should be released using clang_disposeDiagnosticSet().
+ */
+CINDEX_LINKAGE CXDiagnosticSet clang_loadDiagnostics(const char *file,
+ enum CXLoadDiag_Error *error,
+ CXString *errorString);
+
+/**
+ * Release a CXDiagnosticSet and all of its contained diagnostics.
+ */
+CINDEX_LINKAGE void clang_disposeDiagnosticSet(CXDiagnosticSet Diags);
+
+/**
+ * Retrieve the child diagnostics of a CXDiagnostic.
+ *
+ * This CXDiagnosticSet does not need to be released by
+ * clang_disposeDiagnosticSet.
+ */
+CINDEX_LINKAGE CXDiagnosticSet clang_getChildDiagnostics(CXDiagnostic D);
+
+/**
+ * Determine the number of diagnostics produced for the given
+ * translation unit.
+ */
+CINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit);
+
+/**
+ * Retrieve a diagnostic associated with the given translation unit.
+ *
+ * \param Unit the translation unit to query.
+ * \param Index the zero-based diagnostic number to retrieve.
+ *
+ * \returns the requested diagnostic. This diagnostic must be freed
+ * via a call to \c clang_disposeDiagnostic().
+ */
+CINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit,
+ unsigned Index);
+
+/**
+ * Retrieve the complete set of diagnostics associated with a
+ * translation unit.
+ *
+ * \param Unit the translation unit to query.
+ */
+CINDEX_LINKAGE CXDiagnosticSet
+ clang_getDiagnosticSetFromTU(CXTranslationUnit Unit);
+
+/**
+ * Destroy a diagnostic.
+ */
+CINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic);
+
+/**
+ * Options to control the display of diagnostics.
+ *
+ * The values in this enum are meant to be combined to customize the
+ * behavior of \c clang_formatDiagnostic().
+ */
+enum CXDiagnosticDisplayOptions {
+ /**
+ * Display the source-location information where the
+ * diagnostic was located.
+ *
+ * When set, diagnostics will be prefixed by the file, line, and
+ * (optionally) column to which the diagnostic refers. For example,
+ *
+ * \code
+ * test.c:28: warning: extra tokens at end of #endif directive
+ * \endcode
+ *
+ * This option corresponds to the clang flag \c -fshow-source-location.
+ */
+ CXDiagnostic_DisplaySourceLocation = 0x01,
+
+ /**
+ * If displaying the source-location information of the
+ * diagnostic, also include the column number.
+ *
+ * This option corresponds to the clang flag \c -fshow-column.
+ */
+ CXDiagnostic_DisplayColumn = 0x02,
+
+ /**
+ * If displaying the source-location information of the
+ * diagnostic, also include information about source ranges in a
+ * machine-parsable format.
+ *
+ * This option corresponds to the clang flag
+ * \c -fdiagnostics-print-source-range-info.
+ */
+ CXDiagnostic_DisplaySourceRanges = 0x04,
+
+ /**
+ * Display the option name associated with this diagnostic, if any.
+ *
+ * The option name displayed (e.g., -Wconversion) will be placed in brackets
+ * after the diagnostic text. This option corresponds to the clang flag
+ * \c -fdiagnostics-show-option.
+ */
+ CXDiagnostic_DisplayOption = 0x08,
+
+ /**
+ * Display the category number associated with this diagnostic, if any.
+ *
+ * The category number is displayed within brackets after the diagnostic text.
+ * This option corresponds to the clang flag
+ * \c -fdiagnostics-show-category=id.
+ */
+ CXDiagnostic_DisplayCategoryId = 0x10,
+
+ /**
+ * Display the category name associated with this diagnostic, if any.
+ *
+ * The category name is displayed within brackets after the diagnostic text.
+ * This option corresponds to the clang flag
+ * \c -fdiagnostics-show-category=name.
+ */
+ CXDiagnostic_DisplayCategoryName = 0x20
+};
+
+/**
+ * Format the given diagnostic in a manner that is suitable for display.
+ *
+ * This routine will format the given diagnostic to a string, rendering
+ * the diagnostic according to the various options given. The
+ * \c clang_defaultDiagnosticDisplayOptions() function returns the set of
+ * options that most closely mimics the behavior of the clang compiler.
+ *
+ * \param Diagnostic The diagnostic to print.
+ *
+ * \param Options A set of options that control the diagnostic display,
+ * created by combining \c CXDiagnosticDisplayOptions values.
+ *
+ * \returns A new string containing for formatted diagnostic.
+ */
+CINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic,
+ unsigned Options);
+
+/**
+ * Retrieve the set of display options most similar to the
+ * default behavior of the clang compiler.
+ *
+ * \returns A set of display options suitable for use with \c
+ * clang_formatDiagnostic().
+ */
+CINDEX_LINKAGE unsigned clang_defaultDiagnosticDisplayOptions(void);
+
+/**
+ * Determine the severity of the given diagnostic.
+ */
+CINDEX_LINKAGE enum CXDiagnosticSeverity
+clang_getDiagnosticSeverity(CXDiagnostic);
+
+/**
+ * Retrieve the source location of the given diagnostic.
+ *
+ * This location is where Clang would print the caret ('^') when
+ * displaying the diagnostic on the command line.
+ */
+CINDEX_LINKAGE CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic);
+
+/**
+ * Retrieve the text of the given diagnostic.
+ */
+CINDEX_LINKAGE CXString clang_getDiagnosticSpelling(CXDiagnostic);
+
+/**
+ * Retrieve the name of the command-line option that enabled this
+ * diagnostic.
+ *
+ * \param Diag The diagnostic to be queried.
+ *
+ * \param Disable If non-NULL, will be set to the option that disables this
+ * diagnostic (if any).
+ *
+ * \returns A string that contains the command-line option used to enable this
+ * warning, such as "-Wconversion" or "-pedantic".
+ */
+CINDEX_LINKAGE CXString clang_getDiagnosticOption(CXDiagnostic Diag,
+ CXString *Disable);
+
+/**
+ * Retrieve the category number for this diagnostic.
+ *
+ * Diagnostics can be categorized into groups along with other, related
+ * diagnostics (e.g., diagnostics under the same warning flag). This routine
+ * retrieves the category number for the given diagnostic.
+ *
+ * \returns The number of the category that contains this diagnostic, or zero
+ * if this diagnostic is uncategorized.
+ */
+CINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic);
+
+/**
+ * Retrieve the name of a particular diagnostic category. This
+ * is now deprecated. Use clang_getDiagnosticCategoryText()
+ * instead.
+ *
+ * \param Category A diagnostic category number, as returned by
+ * \c clang_getDiagnosticCategory().
+ *
+ * \returns The name of the given diagnostic category.
+ */
+CINDEX_DEPRECATED CINDEX_LINKAGE
+CXString clang_getDiagnosticCategoryName(unsigned Category);
+
+/**
+ * Retrieve the diagnostic category text for a given diagnostic.
+ *
+ * \returns The text of the given diagnostic category.
+ */
+CINDEX_LINKAGE CXString clang_getDiagnosticCategoryText(CXDiagnostic);
+
+/**
+ * Determine the number of source ranges associated with the given
+ * diagnostic.
+ */
+CINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic);
+
+/**
+ * Retrieve a source range associated with the diagnostic.
+ *
+ * A diagnostic's source ranges highlight important elements in the source
+ * code. On the command line, Clang displays source ranges by
+ * underlining them with '~' characters.
+ *
+ * \param Diagnostic the diagnostic whose range is being extracted.
+ *
+ * \param Range the zero-based index specifying which range to
+ *
+ * \returns the requested source range.
+ */
+CINDEX_LINKAGE CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic,
+ unsigned Range);
+
+/**
+ * Determine the number of fix-it hints associated with the
+ * given diagnostic.
+ */
+CINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic);
+
+/**
+ * Retrieve the replacement information for a given fix-it.
+ *
+ * Fix-its are described in terms of a source range whose contents
+ * should be replaced by a string. This approach generalizes over
+ * three kinds of operations: removal of source code (the range covers
+ * the code to be removed and the replacement string is empty),
+ * replacement of source code (the range covers the code to be
+ * replaced and the replacement string provides the new code), and
+ * insertion (both the start and end of the range point at the
+ * insertion location, and the replacement string provides the text to
+ * insert).
+ *
+ * \param Diagnostic The diagnostic whose fix-its are being queried.
+ *
+ * \param FixIt The zero-based index of the fix-it.
+ *
+ * \param ReplacementRange The source range whose contents will be
+ * replaced with the returned replacement string. Note that source
+ * ranges are half-open ranges [a, b), so the source code should be
+ * replaced from a and up to (but not including) b.
+ *
+ * \returns A string containing text that should be replace the source
+ * code indicated by the \c ReplacementRange.
+ */
+CINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic,
+ unsigned FixIt,
+ CXSourceRange *ReplacementRange);
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation
+ *
+ * The routines in this group provide the ability to create and destroy
+ * translation units from files, either by parsing the contents of the files or
+ * by reading in a serialized representation of a translation unit.
+ *
+ * @{
+ */
+
+/**
+ * Get the original translation unit source file name.
+ */
+CINDEX_LINKAGE CXString
+clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit);
+
+/**
+ * Return the CXTranslationUnit for a given source file and the provided
+ * command line arguments one would pass to the compiler.
+ *
+ * Note: The 'source_filename' argument is optional. If the caller provides a
+ * NULL pointer, the name of the source file is expected to reside in the
+ * specified command line arguments.
+ *
+ * Note: When encountered in 'clang_command_line_args', the following options
+ * are ignored:
+ *
+ * '-c'
+ * '-emit-ast'
+ * '-fsyntax-only'
+ * '-o \<output file>' (both '-o' and '\<output file>' are ignored)
+ *
+ * \param CIdx The index object with which the translation unit will be
+ * associated.
+ *
+ * \param source_filename The name of the source file to load, or NULL if the
+ * source file is included in \p clang_command_line_args.
+ *
+ * \param num_clang_command_line_args The number of command-line arguments in
+ * \p clang_command_line_args.
+ *
+ * \param clang_command_line_args The command-line arguments that would be
+ * passed to the \c clang executable if it were being invoked out-of-process.
+ * These command-line options will be parsed and will affect how the translation
+ * unit is parsed. Note that the following options are ignored: '-c',
+ * '-emit-ast', '-fsyntax-only' (which is the default), and '-o \<output file>'.
+ *
+ * \param num_unsaved_files the number of unsaved file entries in \p
+ * unsaved_files.
+ *
+ * \param unsaved_files the files that have not yet been saved to disk
+ * but may be required for code completion, including the contents of
+ * those files. The contents and name of these files (as specified by
+ * CXUnsavedFile) are copied when necessary, so the client only needs to
+ * guarantee their validity until the call to this function returns.
+ */
+CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnitFromSourceFile(
+ CXIndex CIdx,
+ const char *source_filename,
+ int num_clang_command_line_args,
+ const char * const *clang_command_line_args,
+ unsigned num_unsaved_files,
+ struct CXUnsavedFile *unsaved_files);
+
+/**
+ * Same as \c clang_createTranslationUnit2, but returns
+ * the \c CXTranslationUnit instead of an error code. In case of an error this
+ * routine returns a \c NULL \c CXTranslationUnit, without further detailed
+ * error codes.
+ */
+CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnit(
+ CXIndex CIdx,
+ const char *ast_filename);
+
+/**
+ * Create a translation unit from an AST file (\c -emit-ast).
+ *
+ * \param[out] out_TU A non-NULL pointer to store the created
+ * \c CXTranslationUnit.
+ *
+ * \returns Zero on success, otherwise returns an error code.
+ */
+CINDEX_LINKAGE enum CXErrorCode clang_createTranslationUnit2(
+ CXIndex CIdx,
+ const char *ast_filename,
+ CXTranslationUnit *out_TU);
+
+/**
+ * Flags that control the creation of translation units.
+ *
+ * The enumerators in this enumeration type are meant to be bitwise
+ * ORed together to specify which options should be used when
+ * constructing the translation unit.
+ */
+enum CXTranslationUnit_Flags {
+ /**
+ * Used to indicate that no special translation-unit options are
+ * needed.
+ */
+ CXTranslationUnit_None = 0x0,
+
+ /**
+ * Used to indicate that the parser should construct a "detailed"
+ * preprocessing record, including all macro definitions and instantiations.
+ *
+ * Constructing a detailed preprocessing record requires more memory
+ * and time to parse, since the information contained in the record
+ * is usually not retained. However, it can be useful for
+ * applications that require more detailed information about the
+ * behavior of the preprocessor.
+ */
+ CXTranslationUnit_DetailedPreprocessingRecord = 0x01,
+
+ /**
+ * Used to indicate that the translation unit is incomplete.
+ *
+ * When a translation unit is considered "incomplete", semantic
+ * analysis that is typically performed at the end of the
+ * translation unit will be suppressed. For example, this suppresses
+ * the completion of tentative declarations in C and of
+ * instantiation of implicitly-instantiation function templates in
+ * C++. This option is typically used when parsing a header with the
+ * intent of producing a precompiled header.
+ */
+ CXTranslationUnit_Incomplete = 0x02,
+
+ /**
+ * Used to indicate that the translation unit should be built with an
+ * implicit precompiled header for the preamble.
+ *
+ * An implicit precompiled header is used as an optimization when a
+ * particular translation unit is likely to be reparsed many times
+ * when the sources aren't changing that often. In this case, an
+ * implicit precompiled header will be built containing all of the
+ * initial includes at the top of the main file (what we refer to as
+ * the "preamble" of the file). In subsequent parses, if the
+ * preamble or the files in it have not changed, \c
+ * clang_reparseTranslationUnit() will re-use the implicit
+ * precompiled header to improve parsing performance.
+ */
+ CXTranslationUnit_PrecompiledPreamble = 0x04,
+
+ /**
+ * Used to indicate that the translation unit should cache some
+ * code-completion results with each reparse of the source file.
+ *
+ * Caching of code-completion results is a performance optimization that
+ * introduces some overhead to reparsing but improves the performance of
+ * code-completion operations.
+ */
+ CXTranslationUnit_CacheCompletionResults = 0x08,
+
+ /**
+ * Used to indicate that the translation unit will be serialized with
+ * \c clang_saveTranslationUnit.
+ *
+ * This option is typically used when parsing a header with the intent of
+ * producing a precompiled header.
+ */
+ CXTranslationUnit_ForSerialization = 0x10,
+
+ /**
+ * DEPRECATED: Enabled chained precompiled preambles in C++.
+ *
+ * Note: this is a *temporary* option that is available only while
+ * we are testing C++ precompiled preamble support. It is deprecated.
+ */
+ CXTranslationUnit_CXXChainedPCH = 0x20,
+
+ /**
+ * Used to indicate that function/method bodies should be skipped while
+ * parsing.
+ *
+ * This option can be used to search for declarations/definitions while
+ * ignoring the usages.
+ */
+ CXTranslationUnit_SkipFunctionBodies = 0x40,
+
+ /**
+ * Used to indicate that brief documentation comments should be
+ * included into the set of code completions returned from this translation
+ * unit.
+ */
+ CXTranslationUnit_IncludeBriefCommentsInCodeCompletion = 0x80,
+
+ /**
+ * Used to indicate that the precompiled preamble should be created on
+ * the first parse. Otherwise it will be created on the first reparse. This
+ * trades runtime on the first parse (serializing the preamble takes time) for
+ * reduced runtime on the second parse (can now reuse the preamble).
+ */
+ CXTranslationUnit_CreatePreambleOnFirstParse = 0x100,
+
+ /**
+ * Do not stop processing when fatal errors are encountered.
+ *
+ * When fatal errors are encountered while parsing a translation unit,
+ * semantic analysis is typically stopped early when compiling code. A common
+ * source for fatal errors are unresolvable include files. For the
+ * purposes of an IDE, this is undesirable behavior and as much information
+ * as possible should be reported. Use this flag to enable this behavior.
+ */
+ CXTranslationUnit_KeepGoing = 0x200,
+
+ /**
+ * Sets the preprocessor in a mode for parsing a single file only.
+ */
+ CXTranslationUnit_SingleFileParse = 0x400,
+
+ /**
+ * Used in combination with CXTranslationUnit_SkipFunctionBodies to
+ * constrain the skipping of function bodies to the preamble.
+ *
+ * The function bodies of the main file are not skipped.
+ */
+ CXTranslationUnit_LimitSkipFunctionBodiesToPreamble = 0x800,
+
+ /**
+ * Used to indicate that attributed types should be included in CXType.
+ */
+ CXTranslationUnit_IncludeAttributedTypes = 0x1000,
+
+ /**
+ * Used to indicate that implicit attributes should be visited.
+ */
+ CXTranslationUnit_VisitImplicitAttributes = 0x2000,
+
+ /**
+ * Used to indicate that non-errors from included files should be ignored.
+ *
+ * If set, clang_getDiagnosticSetFromTU() will not report e.g. warnings from
+ * included files anymore. This speeds up clang_getDiagnosticSetFromTU() for
+ * the case where these warnings are not of interest, as for an IDE for
+ * example, which typically shows only the diagnostics in the main file.
+ */
+ CXTranslationUnit_IgnoreNonErrorsFromIncludedFiles = 0x4000,
+
+ /**
+ * Tells the preprocessor not to skip excluded conditional blocks.
+ */
+ CXTranslationUnit_RetainExcludedConditionalBlocks = 0x8000
+};
+
+/**
+ * Returns the set of flags that is suitable for parsing a translation
+ * unit that is being edited.
+ *
+ * The set of flags returned provide options for \c clang_parseTranslationUnit()
+ * to indicate that the translation unit is likely to be reparsed many times,
+ * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly
+ * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag
+ * set contains an unspecified set of optimizations (e.g., the precompiled
+ * preamble) geared toward improving the performance of these routines. The
+ * set of optimizations enabled may change from one version to the next.
+ */
+CINDEX_LINKAGE unsigned clang_defaultEditingTranslationUnitOptions(void);
+
+/**
+ * Same as \c clang_parseTranslationUnit2, but returns
+ * the \c CXTranslationUnit instead of an error code. In case of an error this
+ * routine returns a \c NULL \c CXTranslationUnit, without further detailed
+ * error codes.
+ */
+CINDEX_LINKAGE CXTranslationUnit
+clang_parseTranslationUnit(CXIndex CIdx,
+ const char *source_filename,
+ const char *const *command_line_args,
+ int num_command_line_args,
+ struct CXUnsavedFile *unsaved_files,
+ unsigned num_unsaved_files,
+ unsigned options);
+
+/**
+ * Parse the given source file and the translation unit corresponding
+ * to that file.
+ *
+ * This routine is the main entry point for the Clang C API, providing the
+ * ability to parse a source file into a translation unit that can then be
+ * queried by other functions in the API. This routine accepts a set of
+ * command-line arguments so that the compilation can be configured in the same
+ * way that the compiler is configured on the command line.
+ *
+ * \param CIdx The index object with which the translation unit will be
+ * associated.
+ *
+ * \param source_filename The name of the source file to load, or NULL if the
+ * source file is included in \c command_line_args.
+ *
+ * \param command_line_args The command-line arguments that would be
+ * passed to the \c clang executable if it were being invoked out-of-process.
+ * These command-line options will be parsed and will affect how the translation
+ * unit is parsed. Note that the following options are ignored: '-c',
+ * '-emit-ast', '-fsyntax-only' (which is the default), and '-o \<output file>'.
+ *
+ * \param num_command_line_args The number of command-line arguments in
+ * \c command_line_args.
+ *
+ * \param unsaved_files the files that have not yet been saved to disk
+ * but may be required for parsing, including the contents of
+ * those files. The contents and name of these files (as specified by
+ * CXUnsavedFile) are copied when necessary, so the client only needs to
+ * guarantee their validity until the call to this function returns.
+ *
+ * \param num_unsaved_files the number of unsaved file entries in \p
+ * unsaved_files.
+ *
+ * \param options A bitmask of options that affects how the translation unit
+ * is managed but not its compilation. This should be a bitwise OR of the
+ * CXTranslationUnit_XXX flags.
+ *
+ * \param[out] out_TU A non-NULL pointer to store the created
+ * \c CXTranslationUnit, describing the parsed code and containing any
+ * diagnostics produced by the compiler.
+ *
+ * \returns Zero on success, otherwise returns an error code.
+ */
+CINDEX_LINKAGE enum CXErrorCode
+clang_parseTranslationUnit2(CXIndex CIdx,
+ const char *source_filename,
+ const char *const *command_line_args,
+ int num_command_line_args,
+ struct CXUnsavedFile *unsaved_files,
+ unsigned num_unsaved_files,
+ unsigned options,
+ CXTranslationUnit *out_TU);
+
+/**
+ * Same as clang_parseTranslationUnit2 but requires a full command line
+ * for \c command_line_args including argv[0]. This is useful if the standard
+ * library paths are relative to the binary.
+ */
+CINDEX_LINKAGE enum CXErrorCode clang_parseTranslationUnit2FullArgv(
+ CXIndex CIdx, const char *source_filename,
+ const char *const *command_line_args, int num_command_line_args,
+ struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
+ unsigned options, CXTranslationUnit *out_TU);
+
+/**
+ * Flags that control how translation units are saved.
+ *
+ * The enumerators in this enumeration type are meant to be bitwise
+ * ORed together to specify which options should be used when
+ * saving the translation unit.
+ */
+enum CXSaveTranslationUnit_Flags {
+ /**
+ * Used to indicate that no special saving options are needed.
+ */
+ CXSaveTranslationUnit_None = 0x0
+};
+
+/**
+ * Returns the set of flags that is suitable for saving a translation
+ * unit.
+ *
+ * The set of flags returned provide options for
+ * \c clang_saveTranslationUnit() by default. The returned flag
+ * set contains an unspecified set of options that save translation units with
+ * the most commonly-requested data.
+ */
+CINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU);
+
+/**
+ * Describes the kind of error that occurred (if any) in a call to
+ * \c clang_saveTranslationUnit().
+ */
+enum CXSaveError {
+ /**
+ * Indicates that no error occurred while saving a translation unit.
+ */
+ CXSaveError_None = 0,
+
+ /**
+ * Indicates that an unknown error occurred while attempting to save
+ * the file.
+ *
+ * This error typically indicates that file I/O failed when attempting to
+ * write the file.
+ */
+ CXSaveError_Unknown = 1,
+
+ /**
+ * Indicates that errors during translation prevented this attempt
+ * to save the translation unit.
+ *
+ * Errors that prevent the translation unit from being saved can be
+ * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic().
+ */
+ CXSaveError_TranslationErrors = 2,
+
+ /**
+ * Indicates that the translation unit to be saved was somehow
+ * invalid (e.g., NULL).
+ */
+ CXSaveError_InvalidTU = 3
+};
+
+/**
+ * Saves a translation unit into a serialized representation of
+ * that translation unit on disk.
+ *
+ * Any translation unit that was parsed without error can be saved
+ * into a file. The translation unit can then be deserialized into a
+ * new \c CXTranslationUnit with \c clang_createTranslationUnit() or,
+ * if it is an incomplete translation unit that corresponds to a
+ * header, used as a precompiled header when parsing other translation
+ * units.
+ *
+ * \param TU The translation unit to save.
+ *
+ * \param FileName The file to which the translation unit will be saved.
+ *
+ * \param options A bitmask of options that affects how the translation unit
+ * is saved. This should be a bitwise OR of the
+ * CXSaveTranslationUnit_XXX flags.
+ *
+ * \returns A value that will match one of the enumerators of the CXSaveError
+ * enumeration. Zero (CXSaveError_None) indicates that the translation unit was
+ * saved successfully, while a non-zero value indicates that a problem occurred.
+ */
+CINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU,
+ const char *FileName,
+ unsigned options);
+
+/**
+ * Suspend a translation unit in order to free memory associated with it.
+ *
+ * A suspended translation unit uses significantly less memory but on the other
+ * side does not support any other calls than \c clang_reparseTranslationUnit
+ * to resume it or \c clang_disposeTranslationUnit to dispose it completely.
+ */
+CINDEX_LINKAGE unsigned clang_suspendTranslationUnit(CXTranslationUnit);
+
+/**
+ * Destroy the specified CXTranslationUnit object.
+ */
+CINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit);
+
+/**
+ * Flags that control the reparsing of translation units.
+ *
+ * The enumerators in this enumeration type are meant to be bitwise
+ * ORed together to specify which options should be used when
+ * reparsing the translation unit.
+ */
+enum CXReparse_Flags {
+ /**
+ * Used to indicate that no special reparsing options are needed.
+ */
+ CXReparse_None = 0x0
+};
+
+/**
+ * Returns the set of flags that is suitable for reparsing a translation
+ * unit.
+ *
+ * The set of flags returned provide options for
+ * \c clang_reparseTranslationUnit() by default. The returned flag
+ * set contains an unspecified set of optimizations geared toward common uses
+ * of reparsing. The set of optimizations enabled may change from one version
+ * to the next.
+ */
+CINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU);
+
+/**
+ * Reparse the source files that produced this translation unit.
+ *
+ * This routine can be used to re-parse the source files that originally
+ * created the given translation unit, for example because those source files
+ * have changed (either on disk or as passed via \p unsaved_files). The
+ * source code will be reparsed with the same command-line options as it
+ * was originally parsed.
+ *
+ * Reparsing a translation unit invalidates all cursors and source locations
+ * that refer into that translation unit. This makes reparsing a translation
+ * unit semantically equivalent to destroying the translation unit and then
+ * creating a new translation unit with the same command-line arguments.
+ * However, it may be more efficient to reparse a translation
+ * unit using this routine.
+ *
+ * \param TU The translation unit whose contents will be re-parsed. The
+ * translation unit must originally have been built with
+ * \c clang_createTranslationUnitFromSourceFile().
+ *
+ * \param num_unsaved_files The number of unsaved file entries in \p
+ * unsaved_files.
+ *
+ * \param unsaved_files The files that have not yet been saved to disk
+ * but may be required for parsing, including the contents of
+ * those files. The contents and name of these files (as specified by
+ * CXUnsavedFile) are copied when necessary, so the client only needs to
+ * guarantee their validity until the call to this function returns.
+ *
+ * \param options A bitset of options composed of the flags in CXReparse_Flags.
+ * The function \c clang_defaultReparseOptions() produces a default set of
+ * options recommended for most uses, based on the translation unit.
+ *
+ * \returns 0 if the sources could be reparsed. A non-zero error code will be
+ * returned if reparsing was impossible, such that the translation unit is
+ * invalid. In such cases, the only valid call for \c TU is
+ * \c clang_disposeTranslationUnit(TU). The error codes returned by this
+ * routine are described by the \c CXErrorCode enum.
+ */
+CINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU,
+ unsigned num_unsaved_files,
+ struct CXUnsavedFile *unsaved_files,
+ unsigned options);
+
+/**
+ * Categorizes how memory is being used by a translation unit.
+ */
+enum CXTUResourceUsageKind {
+ CXTUResourceUsage_AST = 1,
+ CXTUResourceUsage_Identifiers = 2,
+ CXTUResourceUsage_Selectors = 3,
+ CXTUResourceUsage_GlobalCompletionResults = 4,
+ CXTUResourceUsage_SourceManagerContentCache = 5,
+ CXTUResourceUsage_AST_SideTables = 6,
+ CXTUResourceUsage_SourceManager_Membuffer_Malloc = 7,
+ CXTUResourceUsage_SourceManager_Membuffer_MMap = 8,
+ CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc = 9,
+ CXTUResourceUsage_ExternalASTSource_Membuffer_MMap = 10,
+ CXTUResourceUsage_Preprocessor = 11,
+ CXTUResourceUsage_PreprocessingRecord = 12,
+ CXTUResourceUsage_SourceManager_DataStructures = 13,
+ CXTUResourceUsage_Preprocessor_HeaderSearch = 14,
+ CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN = CXTUResourceUsage_AST,
+ CXTUResourceUsage_MEMORY_IN_BYTES_END =
+ CXTUResourceUsage_Preprocessor_HeaderSearch,
+
+ CXTUResourceUsage_First = CXTUResourceUsage_AST,
+ CXTUResourceUsage_Last = CXTUResourceUsage_Preprocessor_HeaderSearch
+};
+
+/**
+ * Returns the human-readable null-terminated C string that represents
+ * the name of the memory category. This string should never be freed.
+ */
+CINDEX_LINKAGE
+const char *clang_getTUResourceUsageName(enum CXTUResourceUsageKind kind);
+
+typedef struct CXTUResourceUsageEntry {
+ /* The memory usage category. */
+ enum CXTUResourceUsageKind kind;
+ /* Amount of resources used.
+ The units will depend on the resource kind. */
+ unsigned long amount;
+} CXTUResourceUsageEntry;
+
+/**
+ * The memory usage of a CXTranslationUnit, broken into categories.
+ */
+typedef struct CXTUResourceUsage {
+ /* Private data member, used for queries. */
+ void *data;
+
+ /* The number of entries in the 'entries' array. */
+ unsigned numEntries;
+
+ /* An array of key-value pairs, representing the breakdown of memory
+ usage. */
+ CXTUResourceUsageEntry *entries;
+
+} CXTUResourceUsage;
+
+/**
+ * Return the memory usage of a translation unit. This object
+ * should be released with clang_disposeCXTUResourceUsage().
+ */
+CINDEX_LINKAGE CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU);
+
+CINDEX_LINKAGE void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage);
+
+/**
+ * Get target information for this translation unit.
+ *
+ * The CXTargetInfo object cannot outlive the CXTranslationUnit object.
+ */
+CINDEX_LINKAGE CXTargetInfo
+clang_getTranslationUnitTargetInfo(CXTranslationUnit CTUnit);
+
+/**
+ * Destroy the CXTargetInfo object.
+ */
+CINDEX_LINKAGE void
+clang_TargetInfo_dispose(CXTargetInfo Info);
+
+/**
+ * Get the normalized target triple as a string.
+ *
+ * Returns the empty string in case of any error.
+ */
+CINDEX_LINKAGE CXString
+clang_TargetInfo_getTriple(CXTargetInfo Info);
+
+/**
+ * Get the pointer width of the target in bits.
+ *
+ * Returns -1 in case of error.
+ */
+CINDEX_LINKAGE int
+clang_TargetInfo_getPointerWidth(CXTargetInfo Info);
+
+/**
+ * @}
+ */
+
+/**
+ * Describes the kind of entity that a cursor refers to.
+ */
+enum CXCursorKind {
+ /* Declarations */
+ /**
+ * A declaration whose specific kind is not exposed via this
+ * interface.
+ *
+ * Unexposed declarations have the same operations as any other kind
+ * of declaration; one can extract their location information,
+ * spelling, find their definitions, etc. However, the specific kind
+ * of the declaration is not reported.
+ */
+ CXCursor_UnexposedDecl = 1,
+ /** A C or C++ struct. */
+ CXCursor_StructDecl = 2,
+ /** A C or C++ union. */
+ CXCursor_UnionDecl = 3,
+ /** A C++ class. */
+ CXCursor_ClassDecl = 4,
+ /** An enumeration. */
+ CXCursor_EnumDecl = 5,
+ /**
+ * A field (in C) or non-static data member (in C++) in a
+ * struct, union, or C++ class.
+ */
+ CXCursor_FieldDecl = 6,
+ /** An enumerator constant. */
+ CXCursor_EnumConstantDecl = 7,
+ /** A function. */
+ CXCursor_FunctionDecl = 8,
+ /** A variable. */
+ CXCursor_VarDecl = 9,
+ /** A function or method parameter. */
+ CXCursor_ParmDecl = 10,
+ /** An Objective-C \@interface. */
+ CXCursor_ObjCInterfaceDecl = 11,
+ /** An Objective-C \@interface for a category. */
+ CXCursor_ObjCCategoryDecl = 12,
+ /** An Objective-C \@protocol declaration. */
+ CXCursor_ObjCProtocolDecl = 13,
+ /** An Objective-C \@property declaration. */
+ CXCursor_ObjCPropertyDecl = 14,
+ /** An Objective-C instance variable. */
+ CXCursor_ObjCIvarDecl = 15,
+ /** An Objective-C instance method. */
+ CXCursor_ObjCInstanceMethodDecl = 16,
+ /** An Objective-C class method. */
+ CXCursor_ObjCClassMethodDecl = 17,
+ /** An Objective-C \@implementation. */
+ CXCursor_ObjCImplementationDecl = 18,
+ /** An Objective-C \@implementation for a category. */
+ CXCursor_ObjCCategoryImplDecl = 19,
+ /** A typedef. */
+ CXCursor_TypedefDecl = 20,
+ /** A C++ class method. */
+ CXCursor_CXXMethod = 21,
+ /** A C++ namespace. */
+ CXCursor_Namespace = 22,
+ /** A linkage specification, e.g. 'extern "C"'. */
+ CXCursor_LinkageSpec = 23,
+ /** A C++ constructor. */
+ CXCursor_Constructor = 24,
+ /** A C++ destructor. */
+ CXCursor_Destructor = 25,
+ /** A C++ conversion function. */
+ CXCursor_ConversionFunction = 26,
+ /** A C++ template type parameter. */
+ CXCursor_TemplateTypeParameter = 27,
+ /** A C++ non-type template parameter. */
+ CXCursor_NonTypeTemplateParameter = 28,
+ /** A C++ template template parameter. */
+ CXCursor_TemplateTemplateParameter = 29,
+ /** A C++ function template. */
+ CXCursor_FunctionTemplate = 30,
+ /** A C++ class template. */
+ CXCursor_ClassTemplate = 31,
+ /** A C++ class template partial specialization. */
+ CXCursor_ClassTemplatePartialSpecialization = 32,
+ /** A C++ namespace alias declaration. */
+ CXCursor_NamespaceAlias = 33,
+ /** A C++ using directive. */
+ CXCursor_UsingDirective = 34,
+ /** A C++ using declaration. */
+ CXCursor_UsingDeclaration = 35,
+ /** A C++ alias declaration */
+ CXCursor_TypeAliasDecl = 36,
+ /** An Objective-C \@synthesize definition. */
+ CXCursor_ObjCSynthesizeDecl = 37,
+ /** An Objective-C \@dynamic definition. */
+ CXCursor_ObjCDynamicDecl = 38,
+ /** An access specifier. */
+ CXCursor_CXXAccessSpecifier = 39,
+
+ CXCursor_FirstDecl = CXCursor_UnexposedDecl,
+ CXCursor_LastDecl = CXCursor_CXXAccessSpecifier,
+
+ /* References */
+ CXCursor_FirstRef = 40, /* Decl references */
+ CXCursor_ObjCSuperClassRef = 40,
+ CXCursor_ObjCProtocolRef = 41,
+ CXCursor_ObjCClassRef = 42,
+ /**
+ * A reference to a type declaration.
+ *
+ * A type reference occurs anywhere where a type is named but not
+ * declared. For example, given:
+ *
+ * \code
+ * typedef unsigned size_type;
+ * size_type size;
+ * \endcode
+ *
+ * The typedef is a declaration of size_type (CXCursor_TypedefDecl),
+ * while the type of the variable "size" is referenced. The cursor
+ * referenced by the type of size is the typedef for size_type.
+ */
+ CXCursor_TypeRef = 43,
+ CXCursor_CXXBaseSpecifier = 44,
+ /**
+ * A reference to a class template, function template, template
+ * template parameter, or class template partial specialization.
+ */
+ CXCursor_TemplateRef = 45,
+ /**
+ * A reference to a namespace or namespace alias.
+ */
+ CXCursor_NamespaceRef = 46,
+ /**
+ * A reference to a member of a struct, union, or class that occurs in
+ * some non-expression context, e.g., a designated initializer.
+ */
+ CXCursor_MemberRef = 47,
+ /**
+ * A reference to a labeled statement.
+ *
+ * This cursor kind is used to describe the jump to "start_over" in the
+ * goto statement in the following example:
+ *
+ * \code
+ * start_over:
+ * ++counter;
+ *
+ * goto start_over;
+ * \endcode
+ *
+ * A label reference cursor refers to a label statement.
+ */
+ CXCursor_LabelRef = 48,
+
+ /**
+ * A reference to a set of overloaded functions or function templates
+ * that has not yet been resolved to a specific function or function template.
+ *
+ * An overloaded declaration reference cursor occurs in C++ templates where
+ * a dependent name refers to a function. For example:
+ *
+ * \code
+ * template<typename T> void swap(T&, T&);
+ *
+ * struct X { ... };
+ * void swap(X&, X&);
+ *
+ * template<typename T>
+ * void reverse(T* first, T* last) {
+ * while (first < last - 1) {
+ * swap(*first, *--last);
+ * ++first;
+ * }
+ * }
+ *
+ * struct Y { };
+ * void swap(Y&, Y&);
+ * \endcode
+ *
+ * Here, the identifier "swap" is associated with an overloaded declaration
+ * reference. In the template definition, "swap" refers to either of the two
+ * "swap" functions declared above, so both results will be available. At
+ * instantiation time, "swap" may also refer to other functions found via
+ * argument-dependent lookup (e.g., the "swap" function at the end of the
+ * example).
+ *
+ * The functions \c clang_getNumOverloadedDecls() and
+ * \c clang_getOverloadedDecl() can be used to retrieve the definitions
+ * referenced by this cursor.
+ */
+ CXCursor_OverloadedDeclRef = 49,
+
+ /**
+ * A reference to a variable that occurs in some non-expression
+ * context, e.g., a C++ lambda capture list.
+ */
+ CXCursor_VariableRef = 50,
+
+ CXCursor_LastRef = CXCursor_VariableRef,
+
+ /* Error conditions */
+ CXCursor_FirstInvalid = 70,
+ CXCursor_InvalidFile = 70,
+ CXCursor_NoDeclFound = 71,
+ CXCursor_NotImplemented = 72,
+ CXCursor_InvalidCode = 73,
+ CXCursor_LastInvalid = CXCursor_InvalidCode,
+
+ /* Expressions */
+ CXCursor_FirstExpr = 100,
+
+ /**
+ * An expression whose specific kind is not exposed via this
+ * interface.
+ *
+ * Unexposed expressions have the same operations as any other kind
+ * of expression; one can extract their location information,
+ * spelling, children, etc. However, the specific kind of the
+ * expression is not reported.
+ */
+ CXCursor_UnexposedExpr = 100,
+
+ /**
+ * An expression that refers to some value declaration, such
+ * as a function, variable, or enumerator.
+ */
+ CXCursor_DeclRefExpr = 101,
+
+ /**
+ * An expression that refers to a member of a struct, union,
+ * class, Objective-C class, etc.
+ */
+ CXCursor_MemberRefExpr = 102,
+
+ /** An expression that calls a function. */
+ CXCursor_CallExpr = 103,
+
+ /** An expression that sends a message to an Objective-C
+ object or class. */
+ CXCursor_ObjCMessageExpr = 104,
+
+ /** An expression that represents a block literal. */
+ CXCursor_BlockExpr = 105,
+
+ /** An integer literal.
+ */
+ CXCursor_IntegerLiteral = 106,
+
+ /** A floating point number literal.
+ */
+ CXCursor_FloatingLiteral = 107,
+
+ /** An imaginary number literal.
+ */
+ CXCursor_ImaginaryLiteral = 108,
+
+ /** A string literal.
+ */
+ CXCursor_StringLiteral = 109,
+
+ /** A character literal.
+ */
+ CXCursor_CharacterLiteral = 110,
+
+ /** A parenthesized expression, e.g. "(1)".
+ *
+ * This AST node is only formed if full location information is requested.
+ */
+ CXCursor_ParenExpr = 111,
+
+ /** This represents the unary-expression's (except sizeof and
+ * alignof).
+ */
+ CXCursor_UnaryOperator = 112,
+
+ /** [C99 6.5.2.1] Array Subscripting.
+ */
+ CXCursor_ArraySubscriptExpr = 113,
+
+ /** A builtin binary operation expression such as "x + y" or
+ * "x <= y".
+ */
+ CXCursor_BinaryOperator = 114,
+
+ /** Compound assignment such as "+=".
+ */
+ CXCursor_CompoundAssignOperator = 115,
+
+ /** The ?: ternary operator.
+ */
+ CXCursor_ConditionalOperator = 116,
+
+ /** An explicit cast in C (C99 6.5.4) or a C-style cast in C++
+ * (C++ [expr.cast]), which uses the syntax (Type)expr.
+ *
+ * For example: (int)f.
+ */
+ CXCursor_CStyleCastExpr = 117,
+
+ /** [C99 6.5.2.5]
+ */
+ CXCursor_CompoundLiteralExpr = 118,
+
+ /** Describes an C or C++ initializer list.
+ */
+ CXCursor_InitListExpr = 119,
+
+ /** The GNU address of label extension, representing &&label.
+ */
+ CXCursor_AddrLabelExpr = 120,
+
+ /** This is the GNU Statement Expression extension: ({int X=4; X;})
+ */
+ CXCursor_StmtExpr = 121,
+
+ /** Represents a C11 generic selection.
+ */
+ CXCursor_GenericSelectionExpr = 122,
+
+ /** Implements the GNU __null extension, which is a name for a null
+ * pointer constant that has integral type (e.g., int or long) and is the same
+ * size and alignment as a pointer.
+ *
+ * The __null extension is typically only used by system headers, which define
+ * NULL as __null in C++ rather than using 0 (which is an integer that may not
+ * match the size of a pointer).
+ */
+ CXCursor_GNUNullExpr = 123,
+
+ /** C++'s static_cast<> expression.
+ */
+ CXCursor_CXXStaticCastExpr = 124,
+
+ /** C++'s dynamic_cast<> expression.
+ */
+ CXCursor_CXXDynamicCastExpr = 125,
+
+ /** C++'s reinterpret_cast<> expression.
+ */
+ CXCursor_CXXReinterpretCastExpr = 126,
+
+ /** C++'s const_cast<> expression.
+ */
+ CXCursor_CXXConstCastExpr = 127,
+
+ /** Represents an explicit C++ type conversion that uses "functional"
+ * notion (C++ [expr.type.conv]).
+ *
+ * Example:
+ * \code
+ * x = int(0.5);
+ * \endcode
+ */
+ CXCursor_CXXFunctionalCastExpr = 128,
+
+ /** A C++ typeid expression (C++ [expr.typeid]).
+ */
+ CXCursor_CXXTypeidExpr = 129,
+
+ /** [C++ 2.13.5] C++ Boolean Literal.
+ */
+ CXCursor_CXXBoolLiteralExpr = 130,
+
+ /** [C++0x 2.14.7] C++ Pointer Literal.
+ */
+ CXCursor_CXXNullPtrLiteralExpr = 131,
+
+ /** Represents the "this" expression in C++
+ */
+ CXCursor_CXXThisExpr = 132,
+
+ /** [C++ 15] C++ Throw Expression.
+ *
+ * This handles 'throw' and 'throw' assignment-expression. When
+ * assignment-expression isn't present, Op will be null.
+ */
+ CXCursor_CXXThrowExpr = 133,
+
+ /** A new expression for memory allocation and constructor calls, e.g:
+ * "new CXXNewExpr(foo)".
+ */
+ CXCursor_CXXNewExpr = 134,
+
+ /** A delete expression for memory deallocation and destructor calls,
+ * e.g. "delete[] pArray".
+ */
+ CXCursor_CXXDeleteExpr = 135,
+
+ /** A unary expression. (noexcept, sizeof, or other traits)
+ */
+ CXCursor_UnaryExpr = 136,
+
+ /** An Objective-C string literal i.e. @"foo".
+ */
+ CXCursor_ObjCStringLiteral = 137,
+
+ /** An Objective-C \@encode expression.
+ */
+ CXCursor_ObjCEncodeExpr = 138,
+
+ /** An Objective-C \@selector expression.
+ */
+ CXCursor_ObjCSelectorExpr = 139,
+
+ /** An Objective-C \@protocol expression.
+ */
+ CXCursor_ObjCProtocolExpr = 140,
+
+ /** An Objective-C "bridged" cast expression, which casts between
+ * Objective-C pointers and C pointers, transferring ownership in the process.
+ *
+ * \code
+ * NSString *str = (__bridge_transfer NSString *)CFCreateString();
+ * \endcode
+ */
+ CXCursor_ObjCBridgedCastExpr = 141,
+
+ /** Represents a C++0x pack expansion that produces a sequence of
+ * expressions.
+ *
+ * A pack expansion expression contains a pattern (which itself is an
+ * expression) followed by an ellipsis. For example:
+ *
+ * \code
+ * template<typename F, typename ...Types>
+ * void forward(F f, Types &&...args) {
+ * f(static_cast<Types&&>(args)...);
+ * }
+ * \endcode
+ */
+ CXCursor_PackExpansionExpr = 142,
+
+ /** Represents an expression that computes the length of a parameter
+ * pack.
+ *
+ * \code
+ * template<typename ...Types>
+ * struct count {
+ * static const unsigned value = sizeof...(Types);
+ * };
+ * \endcode
+ */
+ CXCursor_SizeOfPackExpr = 143,
+
+ /* Represents a C++ lambda expression that produces a local function
+ * object.
+ *
+ * \code
+ * void abssort(float *x, unsigned N) {
+ * std::sort(x, x + N,
+ * [](float a, float b) {
+ * return std::abs(a) < std::abs(b);
+ * });
+ * }
+ * \endcode
+ */
+ CXCursor_LambdaExpr = 144,
+
+ /** Objective-c Boolean Literal.
+ */
+ CXCursor_ObjCBoolLiteralExpr = 145,
+
+ /** Represents the "self" expression in an Objective-C method.
+ */
+ CXCursor_ObjCSelfExpr = 146,
+
+ /** OpenMP 4.0 [2.4, Array Section].
+ */
+ CXCursor_OMPArraySectionExpr = 147,
+
+ /** Represents an @available(...) check.
+ */
+ CXCursor_ObjCAvailabilityCheckExpr = 148,
+
+ /**
+ * Fixed point literal
+ */
+ CXCursor_FixedPointLiteral = 149,
+
+ CXCursor_LastExpr = CXCursor_FixedPointLiteral,
+
+ /* Statements */
+ CXCursor_FirstStmt = 200,
+ /**
+ * A statement whose specific kind is not exposed via this
+ * interface.
+ *
+ * Unexposed statements have the same operations as any other kind of
+ * statement; one can extract their location information, spelling,
+ * children, etc. However, the specific kind of the statement is not
+ * reported.
+ */
+ CXCursor_UnexposedStmt = 200,
+
+ /** A labelled statement in a function.
+ *
+ * This cursor kind is used to describe the "start_over:" label statement in
+ * the following example:
+ *
+ * \code
+ * start_over:
+ * ++counter;
+ * \endcode
+ *
+ */
+ CXCursor_LabelStmt = 201,
+
+ /** A group of statements like { stmt stmt }.
+ *
+ * This cursor kind is used to describe compound statements, e.g. function
+ * bodies.
+ */
+ CXCursor_CompoundStmt = 202,
+
+ /** A case statement.
+ */
+ CXCursor_CaseStmt = 203,
+
+ /** A default statement.
+ */
+ CXCursor_DefaultStmt = 204,
+
+ /** An if statement
+ */
+ CXCursor_IfStmt = 205,
+
+ /** A switch statement.
+ */
+ CXCursor_SwitchStmt = 206,
+
+ /** A while statement.
+ */
+ CXCursor_WhileStmt = 207,
+
+ /** A do statement.
+ */
+ CXCursor_DoStmt = 208,
+
+ /** A for statement.
+ */
+ CXCursor_ForStmt = 209,
+
+ /** A goto statement.
+ */
+ CXCursor_GotoStmt = 210,
+
+ /** An indirect goto statement.
+ */
+ CXCursor_IndirectGotoStmt = 211,
+
+ /** A continue statement.
+ */
+ CXCursor_ContinueStmt = 212,
+
+ /** A break statement.
+ */
+ CXCursor_BreakStmt = 213,
+
+ /** A return statement.
+ */
+ CXCursor_ReturnStmt = 214,
+
+ /** A GCC inline assembly statement extension.
+ */
+ CXCursor_GCCAsmStmt = 215,
+ CXCursor_AsmStmt = CXCursor_GCCAsmStmt,
+
+ /** Objective-C's overall \@try-\@catch-\@finally statement.
+ */
+ CXCursor_ObjCAtTryStmt = 216,
+
+ /** Objective-C's \@catch statement.
+ */
+ CXCursor_ObjCAtCatchStmt = 217,
+
+ /** Objective-C's \@finally statement.
+ */
+ CXCursor_ObjCAtFinallyStmt = 218,
+
+ /** Objective-C's \@throw statement.
+ */
+ CXCursor_ObjCAtThrowStmt = 219,
+
+ /** Objective-C's \@synchronized statement.
+ */
+ CXCursor_ObjCAtSynchronizedStmt = 220,
+
+ /** Objective-C's autorelease pool statement.
+ */
+ CXCursor_ObjCAutoreleasePoolStmt = 221,
+
+ /** Objective-C's collection statement.
+ */
+ CXCursor_ObjCForCollectionStmt = 222,
+
+ /** C++'s catch statement.
+ */
+ CXCursor_CXXCatchStmt = 223,
+
+ /** C++'s try statement.
+ */
+ CXCursor_CXXTryStmt = 224,
+
+ /** C++'s for (* : *) statement.
+ */
+ CXCursor_CXXForRangeStmt = 225,
+
+ /** Windows Structured Exception Handling's try statement.
+ */
+ CXCursor_SEHTryStmt = 226,
+
+ /** Windows Structured Exception Handling's except statement.
+ */
+ CXCursor_SEHExceptStmt = 227,
+
+ /** Windows Structured Exception Handling's finally statement.
+ */
+ CXCursor_SEHFinallyStmt = 228,
+
+ /** A MS inline assembly statement extension.
+ */
+ CXCursor_MSAsmStmt = 229,
+
+ /** The null statement ";": C99 6.8.3p3.
+ *
+ * This cursor kind is used to describe the null statement.
+ */
+ CXCursor_NullStmt = 230,
+
+ /** Adaptor class for mixing declarations with statements and
+ * expressions.
+ */
+ CXCursor_DeclStmt = 231,
+
+ /** OpenMP parallel directive.
+ */
+ CXCursor_OMPParallelDirective = 232,
+
+ /** OpenMP SIMD directive.
+ */
+ CXCursor_OMPSimdDirective = 233,
+
+ /** OpenMP for directive.
+ */
+ CXCursor_OMPForDirective = 234,
+
+ /** OpenMP sections directive.
+ */
+ CXCursor_OMPSectionsDirective = 235,
+
+ /** OpenMP section directive.
+ */
+ CXCursor_OMPSectionDirective = 236,
+
+ /** OpenMP single directive.
+ */
+ CXCursor_OMPSingleDirective = 237,
+
+ /** OpenMP parallel for directive.
+ */
+ CXCursor_OMPParallelForDirective = 238,
+
+ /** OpenMP parallel sections directive.
+ */
+ CXCursor_OMPParallelSectionsDirective = 239,
+
+ /** OpenMP task directive.
+ */
+ CXCursor_OMPTaskDirective = 240,
+
+ /** OpenMP master directive.
+ */
+ CXCursor_OMPMasterDirective = 241,
+
+ /** OpenMP critical directive.
+ */
+ CXCursor_OMPCriticalDirective = 242,
+
+ /** OpenMP taskyield directive.
+ */
+ CXCursor_OMPTaskyieldDirective = 243,
+
+ /** OpenMP barrier directive.
+ */
+ CXCursor_OMPBarrierDirective = 244,
+
+ /** OpenMP taskwait directive.
+ */
+ CXCursor_OMPTaskwaitDirective = 245,
+
+ /** OpenMP flush directive.
+ */
+ CXCursor_OMPFlushDirective = 246,
+
+ /** Windows Structured Exception Handling's leave statement.
+ */
+ CXCursor_SEHLeaveStmt = 247,
+
+ /** OpenMP ordered directive.
+ */
+ CXCursor_OMPOrderedDirective = 248,
+
+ /** OpenMP atomic directive.
+ */
+ CXCursor_OMPAtomicDirective = 249,
+
+ /** OpenMP for SIMD directive.
+ */
+ CXCursor_OMPForSimdDirective = 250,
+
+ /** OpenMP parallel for SIMD directive.
+ */
+ CXCursor_OMPParallelForSimdDirective = 251,
+
+ /** OpenMP target directive.
+ */
+ CXCursor_OMPTargetDirective = 252,
+
+ /** OpenMP teams directive.
+ */
+ CXCursor_OMPTeamsDirective = 253,
+
+ /** OpenMP taskgroup directive.
+ */
+ CXCursor_OMPTaskgroupDirective = 254,
+
+ /** OpenMP cancellation point directive.
+ */
+ CXCursor_OMPCancellationPointDirective = 255,
+
+ /** OpenMP cancel directive.
+ */
+ CXCursor_OMPCancelDirective = 256,
+
+ /** OpenMP target data directive.
+ */
+ CXCursor_OMPTargetDataDirective = 257,
+
+ /** OpenMP taskloop directive.
+ */
+ CXCursor_OMPTaskLoopDirective = 258,
+
+ /** OpenMP taskloop simd directive.
+ */
+ CXCursor_OMPTaskLoopSimdDirective = 259,
+
+ /** OpenMP distribute directive.
+ */
+ CXCursor_OMPDistributeDirective = 260,
+
+ /** OpenMP target enter data directive.
+ */
+ CXCursor_OMPTargetEnterDataDirective = 261,
+
+ /** OpenMP target exit data directive.
+ */
+ CXCursor_OMPTargetExitDataDirective = 262,
+
+ /** OpenMP target parallel directive.
+ */
+ CXCursor_OMPTargetParallelDirective = 263,
+
+ /** OpenMP target parallel for directive.
+ */
+ CXCursor_OMPTargetParallelForDirective = 264,
+
+ /** OpenMP target update directive.
+ */
+ CXCursor_OMPTargetUpdateDirective = 265,
+
+ /** OpenMP distribute parallel for directive.
+ */
+ CXCursor_OMPDistributeParallelForDirective = 266,
+
+ /** OpenMP distribute parallel for simd directive.
+ */
+ CXCursor_OMPDistributeParallelForSimdDirective = 267,
+
+ /** OpenMP distribute simd directive.
+ */
+ CXCursor_OMPDistributeSimdDirective = 268,
+
+ /** OpenMP target parallel for simd directive.
+ */
+ CXCursor_OMPTargetParallelForSimdDirective = 269,
+
+ /** OpenMP target simd directive.
+ */
+ CXCursor_OMPTargetSimdDirective = 270,
+
+ /** OpenMP teams distribute directive.
+ */
+ CXCursor_OMPTeamsDistributeDirective = 271,
+
+ /** OpenMP teams distribute simd directive.
+ */
+ CXCursor_OMPTeamsDistributeSimdDirective = 272,
+
+ /** OpenMP teams distribute parallel for simd directive.
+ */
+ CXCursor_OMPTeamsDistributeParallelForSimdDirective = 273,
+
+ /** OpenMP teams distribute parallel for directive.
+ */
+ CXCursor_OMPTeamsDistributeParallelForDirective = 274,
+
+ /** OpenMP target teams directive.
+ */
+ CXCursor_OMPTargetTeamsDirective = 275,
+
+ /** OpenMP target teams distribute directive.
+ */
+ CXCursor_OMPTargetTeamsDistributeDirective = 276,
+
+ /** OpenMP target teams distribute parallel for directive.
+ */
+ CXCursor_OMPTargetTeamsDistributeParallelForDirective = 277,
+
+ /** OpenMP target teams distribute parallel for simd directive.
+ */
+ CXCursor_OMPTargetTeamsDistributeParallelForSimdDirective = 278,
+
+ /** OpenMP target teams distribute simd directive.
+ */
+ CXCursor_OMPTargetTeamsDistributeSimdDirective = 279,
+
+ /** C++2a std::bit_cast expression.
+ */
+ CXCursor_BuiltinBitCastExpr = 280,
+
+ /** OpenMP master taskloop directive.
+ */
+ CXCursor_OMPMasterTaskLoopDirective = 281,
+
+ /** OpenMP parallel master taskloop directive.
+ */
+ CXCursor_OMPParallelMasterTaskLoopDirective = 282,
+
+ /** OpenMP master taskloop simd directive.
+ */
+ CXCursor_OMPMasterTaskLoopSimdDirective = 283,
+
+ /** OpenMP parallel master taskloop simd directive.
+ */
+ CXCursor_OMPParallelMasterTaskLoopSimdDirective = 284,
+
+ /** OpenMP parallel master directive.
+ */
+ CXCursor_OMPParallelMasterDirective = 285,
+
+ CXCursor_LastStmt = CXCursor_OMPParallelMasterDirective,
+
+ /**
+ * Cursor that represents the translation unit itself.
+ *
+ * The translation unit cursor exists primarily to act as the root
+ * cursor for traversing the contents of a translation unit.
+ */
+ CXCursor_TranslationUnit = 300,
+
+ /* Attributes */
+ CXCursor_FirstAttr = 400,
+ /**
+ * An attribute whose specific kind is not exposed via this
+ * interface.
+ */
+ CXCursor_UnexposedAttr = 400,
+
+ CXCursor_IBActionAttr = 401,
+ CXCursor_IBOutletAttr = 402,
+ CXCursor_IBOutletCollectionAttr = 403,
+ CXCursor_CXXFinalAttr = 404,
+ CXCursor_CXXOverrideAttr = 405,
+ CXCursor_AnnotateAttr = 406,
+ CXCursor_AsmLabelAttr = 407,
+ CXCursor_PackedAttr = 408,
+ CXCursor_PureAttr = 409,
+ CXCursor_ConstAttr = 410,
+ CXCursor_NoDuplicateAttr = 411,
+ CXCursor_CUDAConstantAttr = 412,
+ CXCursor_CUDADeviceAttr = 413,
+ CXCursor_CUDAGlobalAttr = 414,
+ CXCursor_CUDAHostAttr = 415,
+ CXCursor_CUDASharedAttr = 416,
+ CXCursor_VisibilityAttr = 417,
+ CXCursor_DLLExport = 418,
+ CXCursor_DLLImport = 419,
+ CXCursor_NSReturnsRetained = 420,
+ CXCursor_NSReturnsNotRetained = 421,
+ CXCursor_NSReturnsAutoreleased = 422,
+ CXCursor_NSConsumesSelf = 423,
+ CXCursor_NSConsumed = 424,
+ CXCursor_ObjCException = 425,
+ CXCursor_ObjCNSObject = 426,
+ CXCursor_ObjCIndependentClass = 427,
+ CXCursor_ObjCPreciseLifetime = 428,
+ CXCursor_ObjCReturnsInnerPointer = 429,
+ CXCursor_ObjCRequiresSuper = 430,
+ CXCursor_ObjCRootClass = 431,
+ CXCursor_ObjCSubclassingRestricted = 432,
+ CXCursor_ObjCExplicitProtocolImpl = 433,
+ CXCursor_ObjCDesignatedInitializer = 434,
+ CXCursor_ObjCRuntimeVisible = 435,
+ CXCursor_ObjCBoxable = 436,
+ CXCursor_FlagEnum = 437,
+ CXCursor_ConvergentAttr = 438,
+ CXCursor_WarnUnusedAttr = 439,
+ CXCursor_WarnUnusedResultAttr = 440,
+ CXCursor_AlignedAttr = 441,
+ CXCursor_LastAttr = CXCursor_AlignedAttr,
+
+ /* Preprocessing */
+ CXCursor_PreprocessingDirective = 500,
+ CXCursor_MacroDefinition = 501,
+ CXCursor_MacroExpansion = 502,
+ CXCursor_MacroInstantiation = CXCursor_MacroExpansion,
+ CXCursor_InclusionDirective = 503,
+ CXCursor_FirstPreprocessing = CXCursor_PreprocessingDirective,
+ CXCursor_LastPreprocessing = CXCursor_InclusionDirective,
+
+ /* Extra Declarations */
+ /**
+ * A module import declaration.
+ */
+ CXCursor_ModuleImportDecl = 600,
+ CXCursor_TypeAliasTemplateDecl = 601,
+ /**
+ * A static_assert or _Static_assert node
+ */
+ CXCursor_StaticAssert = 602,
+ /**
+ * a friend declaration.
+ */
+ CXCursor_FriendDecl = 603,
+ CXCursor_FirstExtraDecl = CXCursor_ModuleImportDecl,
+ CXCursor_LastExtraDecl = CXCursor_FriendDecl,
+
+ /**
+ * A code completion overload candidate.
+ */
+ CXCursor_OverloadCandidate = 700
+};
+
+/**
+ * A cursor representing some element in the abstract syntax tree for
+ * a translation unit.
+ *
+ * The cursor abstraction unifies the different kinds of entities in a
+ * program--declaration, statements, expressions, references to declarations,
+ * etc.--under a single "cursor" abstraction with a common set of operations.
+ * Common operation for a cursor include: getting the physical location in
+ * a source file where the cursor points, getting the name associated with a
+ * cursor, and retrieving cursors for any child nodes of a particular cursor.
+ *
+ * Cursors can be produced in two specific ways.
+ * clang_getTranslationUnitCursor() produces a cursor for a translation unit,
+ * from which one can use clang_visitChildren() to explore the rest of the
+ * translation unit. clang_getCursor() maps from a physical source location
+ * to the entity that resides at that location, allowing one to map from the
+ * source code into the AST.
+ */
+typedef struct {
+ enum CXCursorKind kind;
+ int xdata;
+ const void *data[3];
+} CXCursor;
+
+/**
+ * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations
+ *
+ * @{
+ */
+
+/**
+ * Retrieve the NULL cursor, which represents no entity.
+ */
+CINDEX_LINKAGE CXCursor clang_getNullCursor(void);
+
+/**
+ * Retrieve the cursor that represents the given translation unit.
+ *
+ * The translation unit cursor can be used to start traversing the
+ * various declarations within the given translation unit.
+ */
+CINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit);
+
+/**
+ * Determine whether two cursors are equivalent.
+ */
+CINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor);
+
+/**
+ * Returns non-zero if \p cursor is null.
+ */
+CINDEX_LINKAGE int clang_Cursor_isNull(CXCursor cursor);
+
+/**
+ * Compute a hash value for the given cursor.
+ */
+CINDEX_LINKAGE unsigned clang_hashCursor(CXCursor);
+
+/**
+ * Retrieve the kind of the given cursor.
+ */
+CINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor);
+
+/**
+ * Determine whether the given cursor kind represents a declaration.
+ */
+CINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind);
+
+/**
+ * Determine whether the given declaration is invalid.
+ *
+ * A declaration is invalid if it could not be parsed successfully.
+ *
+ * \returns non-zero if the cursor represents a declaration and it is
+ * invalid, otherwise NULL.
+ */
+CINDEX_LINKAGE unsigned clang_isInvalidDeclaration(CXCursor);
+
+/**
+ * Determine whether the given cursor kind represents a simple
+ * reference.
+ *
+ * Note that other kinds of cursors (such as expressions) can also refer to
+ * other cursors. Use clang_getCursorReferenced() to determine whether a
+ * particular cursor refers to another entity.
+ */
+CINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind);
+
+/**
+ * Determine whether the given cursor kind represents an expression.
+ */
+CINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind);
+
+/**
+ * Determine whether the given cursor kind represents a statement.
+ */
+CINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind);
+
+/**
+ * Determine whether the given cursor kind represents an attribute.
+ */
+CINDEX_LINKAGE unsigned clang_isAttribute(enum CXCursorKind);
+
+/**
+ * Determine whether the given cursor has any attributes.
+ */
+CINDEX_LINKAGE unsigned clang_Cursor_hasAttrs(CXCursor C);
+
+/**
+ * Determine whether the given cursor kind represents an invalid
+ * cursor.
+ */
+CINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind);
+
+/**
+ * Determine whether the given cursor kind represents a translation
+ * unit.
+ */
+CINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind);
+
+/***
+ * Determine whether the given cursor represents a preprocessing
+ * element, such as a preprocessor directive or macro instantiation.
+ */
+CINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind);
+
+/***
+ * Determine whether the given cursor represents a currently
+ * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt).
+ */
+CINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind);
+
+/**
+ * Describe the linkage of the entity referred to by a cursor.
+ */
+enum CXLinkageKind {
+ /** This value indicates that no linkage information is available
+ * for a provided CXCursor. */
+ CXLinkage_Invalid,
+ /**
+ * This is the linkage for variables, parameters, and so on that
+ * have automatic storage. This covers normal (non-extern) local variables.
+ */
+ CXLinkage_NoLinkage,
+ /** This is the linkage for static variables and static functions. */
+ CXLinkage_Internal,
+ /** This is the linkage for entities with external linkage that live
+ * in C++ anonymous namespaces.*/
+ CXLinkage_UniqueExternal,
+ /** This is the linkage for entities with true, external linkage. */
+ CXLinkage_External
+};
+
+/**
+ * Determine the linkage of the entity referred to by a given cursor.
+ */
+CINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor);
+
+enum CXVisibilityKind {
+ /** This value indicates that no visibility information is available
+ * for a provided CXCursor. */
+ CXVisibility_Invalid,
+
+ /** Symbol not seen by the linker. */
+ CXVisibility_Hidden,
+ /** Symbol seen by the linker but resolves to a symbol inside this object. */
+ CXVisibility_Protected,
+ /** Symbol seen by the linker and acts like a normal symbol. */
+ CXVisibility_Default
+};
+
+/**
+ * Describe the visibility of the entity referred to by a cursor.
+ *
+ * This returns the default visibility if not explicitly specified by
+ * a visibility attribute. The default visibility may be changed by
+ * commandline arguments.
+ *
+ * \param cursor The cursor to query.
+ *
+ * \returns The visibility of the cursor.
+ */
+CINDEX_LINKAGE enum CXVisibilityKind clang_getCursorVisibility(CXCursor cursor);
+
+/**
+ * Determine the availability of the entity that this cursor refers to,
+ * taking the current target platform into account.
+ *
+ * \param cursor The cursor to query.
+ *
+ * \returns The availability of the cursor.
+ */
+CINDEX_LINKAGE enum CXAvailabilityKind
+clang_getCursorAvailability(CXCursor cursor);
+
+/**
+ * Describes the availability of a given entity on a particular platform, e.g.,
+ * a particular class might only be available on Mac OS 10.7 or newer.
+ */
+typedef struct CXPlatformAvailability {
+ /**
+ * A string that describes the platform for which this structure
+ * provides availability information.
+ *
+ * Possible values are "ios" or "macos".
+ */
+ CXString Platform;
+ /**
+ * The version number in which this entity was introduced.
+ */
+ CXVersion Introduced;
+ /**
+ * The version number in which this entity was deprecated (but is
+ * still available).
+ */
+ CXVersion Deprecated;
+ /**
+ * The version number in which this entity was obsoleted, and therefore
+ * is no longer available.
+ */
+ CXVersion Obsoleted;
+ /**
+ * Whether the entity is unconditionally unavailable on this platform.
+ */
+ int Unavailable;
+ /**
+ * An optional message to provide to a user of this API, e.g., to
+ * suggest replacement APIs.
+ */
+ CXString Message;
+} CXPlatformAvailability;
+
+/**
+ * Determine the availability of the entity that this cursor refers to
+ * on any platforms for which availability information is known.
+ *
+ * \param cursor The cursor to query.
+ *
+ * \param always_deprecated If non-NULL, will be set to indicate whether the
+ * entity is deprecated on all platforms.
+ *
+ * \param deprecated_message If non-NULL, will be set to the message text
+ * provided along with the unconditional deprecation of this entity. The client
+ * is responsible for deallocating this string.
+ *
+ * \param always_unavailable If non-NULL, will be set to indicate whether the
+ * entity is unavailable on all platforms.
+ *
+ * \param unavailable_message If non-NULL, will be set to the message text
+ * provided along with the unconditional unavailability of this entity. The
+ * client is responsible for deallocating this string.
+ *
+ * \param availability If non-NULL, an array of CXPlatformAvailability instances
+ * that will be populated with platform availability information, up to either
+ * the number of platforms for which availability information is available (as
+ * returned by this function) or \c availability_size, whichever is smaller.
+ *
+ * \param availability_size The number of elements available in the
+ * \c availability array.
+ *
+ * \returns The number of platforms (N) for which availability information is
+ * available (which is unrelated to \c availability_size).
+ *
+ * Note that the client is responsible for calling
+ * \c clang_disposeCXPlatformAvailability to free each of the
+ * platform-availability structures returned. There are
+ * \c min(N, availability_size) such structures.
+ */
+CINDEX_LINKAGE int
+clang_getCursorPlatformAvailability(CXCursor cursor,
+ int *always_deprecated,
+ CXString *deprecated_message,
+ int *always_unavailable,
+ CXString *unavailable_message,
+ CXPlatformAvailability *availability,
+ int availability_size);
+
+/**
+ * Free the memory associated with a \c CXPlatformAvailability structure.
+ */
+CINDEX_LINKAGE void
+clang_disposeCXPlatformAvailability(CXPlatformAvailability *availability);
+
+/**
+ * Describe the "language" of the entity referred to by a cursor.
+ */
+enum CXLanguageKind {
+ CXLanguage_Invalid = 0,
+ CXLanguage_C,
+ CXLanguage_ObjC,
+ CXLanguage_CPlusPlus
+};
+
+/**
+ * Determine the "language" of the entity referred to by a given cursor.
+ */
+CINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor);
+
+/**
+ * Describe the "thread-local storage (TLS) kind" of the declaration
+ * referred to by a cursor.
+ */
+enum CXTLSKind {
+ CXTLS_None = 0,
+ CXTLS_Dynamic,
+ CXTLS_Static
+};
+
+/**
+ * Determine the "thread-local storage (TLS) kind" of the declaration
+ * referred to by a cursor.
+ */
+CINDEX_LINKAGE enum CXTLSKind clang_getCursorTLSKind(CXCursor cursor);
+
+/**
+ * Returns the translation unit that a cursor originated from.
+ */
+CINDEX_LINKAGE CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor);
+
+/**
+ * A fast container representing a set of CXCursors.
+ */
+typedef struct CXCursorSetImpl *CXCursorSet;
+
+/**
+ * Creates an empty CXCursorSet.
+ */
+CINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(void);
+
+/**
+ * Disposes a CXCursorSet and releases its associated memory.
+ */
+CINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset);
+
+/**
+ * Queries a CXCursorSet to see if it contains a specific CXCursor.
+ *
+ * \returns non-zero if the set contains the specified cursor.
+*/
+CINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset,
+ CXCursor cursor);
+
+/**
+ * Inserts a CXCursor into a CXCursorSet.
+ *
+ * \returns zero if the CXCursor was already in the set, and non-zero otherwise.
+*/
+CINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset,
+ CXCursor cursor);
+
+/**
+ * Determine the semantic parent of the given cursor.
+ *
+ * The semantic parent of a cursor is the cursor that semantically contains
+ * the given \p cursor. For many declarations, the lexical and semantic parents
+ * are equivalent (the lexical parent is returned by
+ * \c clang_getCursorLexicalParent()). They diverge when declarations or
+ * definitions are provided out-of-line. For example:
+ *
+ * \code
+ * class C {
+ * void f();
+ * };
+ *
+ * void C::f() { }
+ * \endcode
+ *
+ * In the out-of-line definition of \c C::f, the semantic parent is
+ * the class \c C, of which this function is a member. The lexical parent is
+ * the place where the declaration actually occurs in the source code; in this
+ * case, the definition occurs in the translation unit. In general, the
+ * lexical parent for a given entity can change without affecting the semantics
+ * of the program, and the lexical parent of different declarations of the
+ * same entity may be different. Changing the semantic parent of a declaration,
+ * on the other hand, can have a major impact on semantics, and redeclarations
+ * of a particular entity should all have the same semantic context.
+ *
+ * In the example above, both declarations of \c C::f have \c C as their
+ * semantic context, while the lexical context of the first \c C::f is \c C
+ * and the lexical context of the second \c C::f is the translation unit.
+ *
+ * For global declarations, the semantic parent is the translation unit.
+ */
+CINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor);
+
+/**
+ * Determine the lexical parent of the given cursor.
+ *
+ * The lexical parent of a cursor is the cursor in which the given \p cursor
+ * was actually written. For many declarations, the lexical and semantic parents
+ * are equivalent (the semantic parent is returned by
+ * \c clang_getCursorSemanticParent()). They diverge when declarations or
+ * definitions are provided out-of-line. For example:
+ *
+ * \code
+ * class C {
+ * void f();
+ * };
+ *
+ * void C::f() { }
+ * \endcode
+ *
+ * In the out-of-line definition of \c C::f, the semantic parent is
+ * the class \c C, of which this function is a member. The lexical parent is
+ * the place where the declaration actually occurs in the source code; in this
+ * case, the definition occurs in the translation unit. In general, the
+ * lexical parent for a given entity can change without affecting the semantics
+ * of the program, and the lexical parent of different declarations of the
+ * same entity may be different. Changing the semantic parent of a declaration,
+ * on the other hand, can have a major impact on semantics, and redeclarations
+ * of a particular entity should all have the same semantic context.
+ *
+ * In the example above, both declarations of \c C::f have \c C as their
+ * semantic context, while the lexical context of the first \c C::f is \c C
+ * and the lexical context of the second \c C::f is the translation unit.
+ *
+ * For declarations written in the global scope, the lexical parent is
+ * the translation unit.
+ */
+CINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor);
+
+/**
+ * Determine the set of methods that are overridden by the given
+ * method.
+ *
+ * In both Objective-C and C++, a method (aka virtual member function,
+ * in C++) can override a virtual method in a base class. For
+ * Objective-C, a method is said to override any method in the class's
+ * base class, its protocols, or its categories' protocols, that has the same
+ * selector and is of the same kind (class or instance).
+ * If no such method exists, the search continues to the class's superclass,
+ * its protocols, and its categories, and so on. A method from an Objective-C
+ * implementation is considered to override the same methods as its
+ * corresponding method in the interface.
+ *
+ * For C++, a virtual member function overrides any virtual member
+ * function with the same signature that occurs in its base
+ * classes. With multiple inheritance, a virtual member function can
+ * override several virtual member functions coming from different
+ * base classes.
+ *
+ * In all cases, this function determines the immediate overridden
+ * method, rather than all of the overridden methods. For example, if
+ * a method is originally declared in a class A, then overridden in B
+ * (which in inherits from A) and also in C (which inherited from B),
+ * then the only overridden method returned from this function when
+ * invoked on C's method will be B's method. The client may then
+ * invoke this function again, given the previously-found overridden
+ * methods, to map out the complete method-override set.
+ *
+ * \param cursor A cursor representing an Objective-C or C++
+ * method. This routine will compute the set of methods that this
+ * method overrides.
+ *
+ * \param overridden A pointer whose pointee will be replaced with a
+ * pointer to an array of cursors, representing the set of overridden
+ * methods. If there are no overridden methods, the pointee will be
+ * set to NULL. The pointee must be freed via a call to
+ * \c clang_disposeOverriddenCursors().
+ *
+ * \param num_overridden A pointer to the number of overridden
+ * functions, will be set to the number of overridden functions in the
+ * array pointed to by \p overridden.
+ */
+CINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor,
+ CXCursor **overridden,
+ unsigned *num_overridden);
+
+/**
+ * Free the set of overridden cursors returned by \c
+ * clang_getOverriddenCursors().
+ */
+CINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden);
+
+/**
+ * Retrieve the file that is included by the given inclusion directive
+ * cursor.
+ */
+CINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor);
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code
+ *
+ * Cursors represent a location within the Abstract Syntax Tree (AST). These
+ * routines help map between cursors and the physical locations where the
+ * described entities occur in the source code. The mapping is provided in
+ * both directions, so one can map from source code to the AST and back.
+ *
+ * @{
+ */
+
+/**
+ * Map a source location to the cursor that describes the entity at that
+ * location in the source code.
+ *
+ * clang_getCursor() maps an arbitrary source location within a translation
+ * unit down to the most specific cursor that describes the entity at that
+ * location. For example, given an expression \c x + y, invoking
+ * clang_getCursor() with a source location pointing to "x" will return the
+ * cursor for "x"; similarly for "y". If the cursor points anywhere between
+ * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor()
+ * will return a cursor referring to the "+" expression.
+ *
+ * \returns a cursor representing the entity at the given source location, or
+ * a NULL cursor if no such entity can be found.
+ */
+CINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation);
+
+/**
+ * Retrieve the physical location of the source constructor referenced
+ * by the given cursor.
+ *
+ * The location of a declaration is typically the location of the name of that
+ * declaration, where the name of that declaration would occur if it is
+ * unnamed, or some keyword that introduces that particular declaration.
+ * The location of a reference is where that reference occurs within the
+ * source code.
+ */
+CINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor);
+
+/**
+ * Retrieve the physical extent of the source construct referenced by
+ * the given cursor.
+ *
+ * The extent of a cursor starts with the file/line/column pointing at the
+ * first character within the source construct that the cursor refers to and
+ * ends with the last character within that source construct. For a
+ * declaration, the extent covers the declaration itself. For a reference,
+ * the extent covers the location of the reference (e.g., where the referenced
+ * entity was actually used).
+ */
+CINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor);
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup CINDEX_TYPES Type information for CXCursors
+ *
+ * @{
+ */
+
+/**
+ * Describes the kind of type
+ */
+enum CXTypeKind {
+ /**
+ * Represents an invalid type (e.g., where no type is available).
+ */
+ CXType_Invalid = 0,
+
+ /**
+ * A type whose specific kind is not exposed via this
+ * interface.
+ */
+ CXType_Unexposed = 1,
+
+ /* Builtin types */
+ CXType_Void = 2,
+ CXType_Bool = 3,
+ CXType_Char_U = 4,
+ CXType_UChar = 5,
+ CXType_Char16 = 6,
+ CXType_Char32 = 7,
+ CXType_UShort = 8,
+ CXType_UInt = 9,
+ CXType_ULong = 10,
+ CXType_ULongLong = 11,
+ CXType_UInt128 = 12,
+ CXType_Char_S = 13,
+ CXType_SChar = 14,
+ CXType_WChar = 15,
+ CXType_Short = 16,
+ CXType_Int = 17,
+ CXType_Long = 18,
+ CXType_LongLong = 19,
+ CXType_Int128 = 20,
+ CXType_Float = 21,
+ CXType_Double = 22,
+ CXType_LongDouble = 23,
+ CXType_NullPtr = 24,
+ CXType_Overload = 25,
+ CXType_Dependent = 26,
+ CXType_ObjCId = 27,
+ CXType_ObjCClass = 28,
+ CXType_ObjCSel = 29,
+ CXType_Float128 = 30,
+ CXType_Half = 31,
+ CXType_Float16 = 32,
+ CXType_ShortAccum = 33,
+ CXType_Accum = 34,
+ CXType_LongAccum = 35,
+ CXType_UShortAccum = 36,
+ CXType_UAccum = 37,
+ CXType_ULongAccum = 38,
+ CXType_FirstBuiltin = CXType_Void,
+ CXType_LastBuiltin = CXType_ULongAccum,
+
+ CXType_Complex = 100,
+ CXType_Pointer = 101,
+ CXType_BlockPointer = 102,
+ CXType_LValueReference = 103,
+ CXType_RValueReference = 104,
+ CXType_Record = 105,
+ CXType_Enum = 106,
+ CXType_Typedef = 107,
+ CXType_ObjCInterface = 108,
+ CXType_ObjCObjectPointer = 109,
+ CXType_FunctionNoProto = 110,
+ CXType_FunctionProto = 111,
+ CXType_ConstantArray = 112,
+ CXType_Vector = 113,
+ CXType_IncompleteArray = 114,
+ CXType_VariableArray = 115,
+ CXType_DependentSizedArray = 116,
+ CXType_MemberPointer = 117,
+ CXType_Auto = 118,
+
+ /**
+ * Represents a type that was referred to using an elaborated type keyword.
+ *
+ * E.g., struct S, or via a qualified name, e.g., N::M::type, or both.
+ */
+ CXType_Elaborated = 119,
+
+ /* OpenCL PipeType. */
+ CXType_Pipe = 120,
+
+ /* OpenCL builtin types. */
+ CXType_OCLImage1dRO = 121,
+ CXType_OCLImage1dArrayRO = 122,
+ CXType_OCLImage1dBufferRO = 123,
+ CXType_OCLImage2dRO = 124,
+ CXType_OCLImage2dArrayRO = 125,
+ CXType_OCLImage2dDepthRO = 126,
+ CXType_OCLImage2dArrayDepthRO = 127,
+ CXType_OCLImage2dMSAARO = 128,
+ CXType_OCLImage2dArrayMSAARO = 129,
+ CXType_OCLImage2dMSAADepthRO = 130,
+ CXType_OCLImage2dArrayMSAADepthRO = 131,
+ CXType_OCLImage3dRO = 132,
+ CXType_OCLImage1dWO = 133,
+ CXType_OCLImage1dArrayWO = 134,
+ CXType_OCLImage1dBufferWO = 135,
+ CXType_OCLImage2dWO = 136,
+ CXType_OCLImage2dArrayWO = 137,
+ CXType_OCLImage2dDepthWO = 138,
+ CXType_OCLImage2dArrayDepthWO = 139,
+ CXType_OCLImage2dMSAAWO = 140,
+ CXType_OCLImage2dArrayMSAAWO = 141,
+ CXType_OCLImage2dMSAADepthWO = 142,
+ CXType_OCLImage2dArrayMSAADepthWO = 143,
+ CXType_OCLImage3dWO = 144,
+ CXType_OCLImage1dRW = 145,
+ CXType_OCLImage1dArrayRW = 146,
+ CXType_OCLImage1dBufferRW = 147,
+ CXType_OCLImage2dRW = 148,
+ CXType_OCLImage2dArrayRW = 149,
+ CXType_OCLImage2dDepthRW = 150,
+ CXType_OCLImage2dArrayDepthRW = 151,
+ CXType_OCLImage2dMSAARW = 152,
+ CXType_OCLImage2dArrayMSAARW = 153,
+ CXType_OCLImage2dMSAADepthRW = 154,
+ CXType_OCLImage2dArrayMSAADepthRW = 155,
+ CXType_OCLImage3dRW = 156,
+ CXType_OCLSampler = 157,
+ CXType_OCLEvent = 158,
+ CXType_OCLQueue = 159,
+ CXType_OCLReserveID = 160,
+
+ CXType_ObjCObject = 161,
+ CXType_ObjCTypeParam = 162,
+ CXType_Attributed = 163,
+
+ CXType_OCLIntelSubgroupAVCMcePayload = 164,
+ CXType_OCLIntelSubgroupAVCImePayload = 165,
+ CXType_OCLIntelSubgroupAVCRefPayload = 166,
+ CXType_OCLIntelSubgroupAVCSicPayload = 167,
+ CXType_OCLIntelSubgroupAVCMceResult = 168,
+ CXType_OCLIntelSubgroupAVCImeResult = 169,
+ CXType_OCLIntelSubgroupAVCRefResult = 170,
+ CXType_OCLIntelSubgroupAVCSicResult = 171,
+ CXType_OCLIntelSubgroupAVCImeResultSingleRefStreamout = 172,
+ CXType_OCLIntelSubgroupAVCImeResultDualRefStreamout = 173,
+ CXType_OCLIntelSubgroupAVCImeSingleRefStreamin = 174,
+
+ CXType_OCLIntelSubgroupAVCImeDualRefStreamin = 175,
+
+ CXType_ExtVector = 176
+};
+
+/**
+ * Describes the calling convention of a function type
+ */
+enum CXCallingConv {
+ CXCallingConv_Default = 0,
+ CXCallingConv_C = 1,
+ CXCallingConv_X86StdCall = 2,
+ CXCallingConv_X86FastCall = 3,
+ CXCallingConv_X86ThisCall = 4,
+ CXCallingConv_X86Pascal = 5,
+ CXCallingConv_AAPCS = 6,
+ CXCallingConv_AAPCS_VFP = 7,
+ CXCallingConv_X86RegCall = 8,
+ CXCallingConv_IntelOclBicc = 9,
+ CXCallingConv_Win64 = 10,
+ /* Alias for compatibility with older versions of API. */
+ CXCallingConv_X86_64Win64 = CXCallingConv_Win64,
+ CXCallingConv_X86_64SysV = 11,
+ CXCallingConv_X86VectorCall = 12,
+ CXCallingConv_Swift = 13,
+ CXCallingConv_PreserveMost = 14,
+ CXCallingConv_PreserveAll = 15,
+ CXCallingConv_AArch64VectorCall = 16,
+
+ CXCallingConv_Invalid = 100,
+ CXCallingConv_Unexposed = 200
+};
+
+/**
+ * The type of an element in the abstract syntax tree.
+ *
+ */
+typedef struct {
+ enum CXTypeKind kind;
+ void *data[2];
+} CXType;
+
+/**
+ * Retrieve the type of a CXCursor (if any).
+ */
+CINDEX_LINKAGE CXType clang_getCursorType(CXCursor C);
+
+/**
+ * Pretty-print the underlying type using the rules of the
+ * language of the translation unit from which it came.
+ *
+ * If the type is invalid, an empty string is returned.
+ */
+CINDEX_LINKAGE CXString clang_getTypeSpelling(CXType CT);
+
+/**
+ * Retrieve the underlying type of a typedef declaration.
+ *
+ * If the cursor does not reference a typedef declaration, an invalid type is
+ * returned.
+ */
+CINDEX_LINKAGE CXType clang_getTypedefDeclUnderlyingType(CXCursor C);
+
+/**
+ * Retrieve the integer type of an enum declaration.
+ *
+ * If the cursor does not reference an enum declaration, an invalid type is
+ * returned.
+ */
+CINDEX_LINKAGE CXType clang_getEnumDeclIntegerType(CXCursor C);
+
+/**
+ * Retrieve the integer value of an enum constant declaration as a signed
+ * long long.
+ *
+ * If the cursor does not reference an enum constant declaration, LLONG_MIN is returned.
+ * Since this is also potentially a valid constant value, the kind of the cursor
+ * must be verified before calling this function.
+ */
+CINDEX_LINKAGE long long clang_getEnumConstantDeclValue(CXCursor C);
+
+/**
+ * Retrieve the integer value of an enum constant declaration as an unsigned
+ * long long.
+ *
+ * If the cursor does not reference an enum constant declaration, ULLONG_MAX is returned.
+ * Since this is also potentially a valid constant value, the kind of the cursor
+ * must be verified before calling this function.
+ */
+CINDEX_LINKAGE unsigned long long clang_getEnumConstantDeclUnsignedValue(CXCursor C);
+
+/**
+ * Retrieve the bit width of a bit field declaration as an integer.
+ *
+ * If a cursor that is not a bit field declaration is passed in, -1 is returned.
+ */
+CINDEX_LINKAGE int clang_getFieldDeclBitWidth(CXCursor C);
+
+/**
+ * Retrieve the number of non-variadic arguments associated with a given
+ * cursor.
+ *
+ * The number of arguments can be determined for calls as well as for
+ * declarations of functions or methods. For other cursors -1 is returned.
+ */
+CINDEX_LINKAGE int clang_Cursor_getNumArguments(CXCursor C);
+
+/**
+ * Retrieve the argument cursor of a function or method.
+ *
+ * The argument cursor can be determined for calls as well as for declarations
+ * of functions or methods. For other cursors and for invalid indices, an
+ * invalid cursor is returned.
+ */
+CINDEX_LINKAGE CXCursor clang_Cursor_getArgument(CXCursor C, unsigned i);
+
+/**
+ * Describes the kind of a template argument.
+ *
+ * See the definition of llvm::clang::TemplateArgument::ArgKind for full
+ * element descriptions.
+ */
+enum CXTemplateArgumentKind {
+ CXTemplateArgumentKind_Null,
+ CXTemplateArgumentKind_Type,
+ CXTemplateArgumentKind_Declaration,
+ CXTemplateArgumentKind_NullPtr,
+ CXTemplateArgumentKind_Integral,
+ CXTemplateArgumentKind_Template,
+ CXTemplateArgumentKind_TemplateExpansion,
+ CXTemplateArgumentKind_Expression,
+ CXTemplateArgumentKind_Pack,
+ /* Indicates an error case, preventing the kind from being deduced. */
+ CXTemplateArgumentKind_Invalid
+};
+
+/**
+ *Returns the number of template args of a function decl representing a
+ * template specialization.
+ *
+ * If the argument cursor cannot be converted into a template function
+ * declaration, -1 is returned.
+ *
+ * For example, for the following declaration and specialization:
+ * template <typename T, int kInt, bool kBool>
+ * void foo() { ... }
+ *
+ * template <>
+ * void foo<float, -7, true>();
+ *
+ * The value 3 would be returned from this call.
+ */
+CINDEX_LINKAGE int clang_Cursor_getNumTemplateArguments(CXCursor C);
+
+/**
+ * Retrieve the kind of the I'th template argument of the CXCursor C.
+ *
+ * If the argument CXCursor does not represent a FunctionDecl, an invalid
+ * template argument kind is returned.
+ *
+ * For example, for the following declaration and specialization:
+ * template <typename T, int kInt, bool kBool>
+ * void foo() { ... }
+ *
+ * template <>
+ * void foo<float, -7, true>();
+ *
+ * For I = 0, 1, and 2, Type, Integral, and Integral will be returned,
+ * respectively.
+ */
+CINDEX_LINKAGE enum CXTemplateArgumentKind clang_Cursor_getTemplateArgumentKind(
+ CXCursor C, unsigned I);
+
+/**
+ * Retrieve a CXType representing the type of a TemplateArgument of a
+ * function decl representing a template specialization.
+ *
+ * If the argument CXCursor does not represent a FunctionDecl whose I'th
+ * template argument has a kind of CXTemplateArgKind_Integral, an invalid type
+ * is returned.
+ *
+ * For example, for the following declaration and specialization:
+ * template <typename T, int kInt, bool kBool>
+ * void foo() { ... }
+ *
+ * template <>
+ * void foo<float, -7, true>();
+ *
+ * If called with I = 0, "float", will be returned.
+ * Invalid types will be returned for I == 1 or 2.
+ */
+CINDEX_LINKAGE CXType clang_Cursor_getTemplateArgumentType(CXCursor C,
+ unsigned I);
+
+/**
+ * Retrieve the value of an Integral TemplateArgument (of a function
+ * decl representing a template specialization) as a signed long long.
+ *
+ * It is undefined to call this function on a CXCursor that does not represent a
+ * FunctionDecl or whose I'th template argument is not an integral value.
+ *
+ * For example, for the following declaration and specialization:
+ * template <typename T, int kInt, bool kBool>
+ * void foo() { ... }
+ *
+ * template <>
+ * void foo<float, -7, true>();
+ *
+ * If called with I = 1 or 2, -7 or true will be returned, respectively.
+ * For I == 0, this function's behavior is undefined.
+ */
+CINDEX_LINKAGE long long clang_Cursor_getTemplateArgumentValue(CXCursor C,
+ unsigned I);
+
+/**
+ * Retrieve the value of an Integral TemplateArgument (of a function
+ * decl representing a template specialization) as an unsigned long long.
+ *
+ * It is undefined to call this function on a CXCursor that does not represent a
+ * FunctionDecl or whose I'th template argument is not an integral value.
+ *
+ * For example, for the following declaration and specialization:
+ * template <typename T, int kInt, bool kBool>
+ * void foo() { ... }
+ *
+ * template <>
+ * void foo<float, 2147483649, true>();
+ *
+ * If called with I = 1 or 2, 2147483649 or true will be returned, respectively.
+ * For I == 0, this function's behavior is undefined.
+ */
+CINDEX_LINKAGE unsigned long long clang_Cursor_getTemplateArgumentUnsignedValue(
+ CXCursor C, unsigned I);
+
+/**
+ * Determine whether two CXTypes represent the same type.
+ *
+ * \returns non-zero if the CXTypes represent the same type and
+ * zero otherwise.
+ */
+CINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B);
+
+/**
+ * Return the canonical type for a CXType.
+ *
+ * Clang's type system explicitly models typedefs and all the ways
+ * a specific type can be represented. The canonical type is the underlying
+ * type with all the "sugar" removed. For example, if 'T' is a typedef
+ * for 'int', the canonical type for 'T' would be 'int'.
+ */
+CINDEX_LINKAGE CXType clang_getCanonicalType(CXType T);
+
+/**
+ * Determine whether a CXType has the "const" qualifier set,
+ * without looking through typedefs that may have added "const" at a
+ * different level.
+ */
+CINDEX_LINKAGE unsigned clang_isConstQualifiedType(CXType T);
+
+/**
+ * Determine whether a CXCursor that is a macro, is
+ * function like.
+ */
+CINDEX_LINKAGE unsigned clang_Cursor_isMacroFunctionLike(CXCursor C);
+
+/**
+ * Determine whether a CXCursor that is a macro, is a
+ * builtin one.
+ */
+CINDEX_LINKAGE unsigned clang_Cursor_isMacroBuiltin(CXCursor C);
+
+/**
+ * Determine whether a CXCursor that is a function declaration, is an
+ * inline declaration.
+ */
+CINDEX_LINKAGE unsigned clang_Cursor_isFunctionInlined(CXCursor C);
+
+/**
+ * Determine whether a CXType has the "volatile" qualifier set,
+ * without looking through typedefs that may have added "volatile" at
+ * a different level.
+ */
+CINDEX_LINKAGE unsigned clang_isVolatileQualifiedType(CXType T);
+
+/**
+ * Determine whether a CXType has the "restrict" qualifier set,
+ * without looking through typedefs that may have added "restrict" at a
+ * different level.
+ */
+CINDEX_LINKAGE unsigned clang_isRestrictQualifiedType(CXType T);
+
+/**
+ * Returns the address space of the given type.
+ */
+CINDEX_LINKAGE unsigned clang_getAddressSpace(CXType T);
+
+/**
+ * Returns the typedef name of the given type.
+ */
+CINDEX_LINKAGE CXString clang_getTypedefName(CXType CT);
+
+/**
+ * For pointer types, returns the type of the pointee.
+ */
+CINDEX_LINKAGE CXType clang_getPointeeType(CXType T);
+
+/**
+ * Return the cursor for the declaration of the given type.
+ */
+CINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T);
+
+/**
+ * Returns the Objective-C type encoding for the specified declaration.
+ */
+CINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C);
+
+/**
+ * Returns the Objective-C type encoding for the specified CXType.
+ */
+CINDEX_LINKAGE CXString clang_Type_getObjCEncoding(CXType type);
+
+/**
+ * Retrieve the spelling of a given CXTypeKind.
+ */
+CINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K);
+
+/**
+ * Retrieve the calling convention associated with a function type.
+ *
+ * If a non-function type is passed in, CXCallingConv_Invalid is returned.
+ */
+CINDEX_LINKAGE enum CXCallingConv clang_getFunctionTypeCallingConv(CXType T);
+
+/**
+ * Retrieve the return type associated with a function type.
+ *
+ * If a non-function type is passed in, an invalid type is returned.
+ */
+CINDEX_LINKAGE CXType clang_getResultType(CXType T);
+
+/**
+ * Retrieve the exception specification type associated with a function type.
+ * This is a value of type CXCursor_ExceptionSpecificationKind.
+ *
+ * If a non-function type is passed in, an error code of -1 is returned.
+ */
+CINDEX_LINKAGE int clang_getExceptionSpecificationType(CXType T);
+
+/**
+ * Retrieve the number of non-variadic parameters associated with a
+ * function type.
+ *
+ * If a non-function type is passed in, -1 is returned.
+ */
+CINDEX_LINKAGE int clang_getNumArgTypes(CXType T);
+
+/**
+ * Retrieve the type of a parameter of a function type.
+ *
+ * If a non-function type is passed in or the function does not have enough
+ * parameters, an invalid type is returned.
+ */
+CINDEX_LINKAGE CXType clang_getArgType(CXType T, unsigned i);
+
+/**
+ * Retrieves the base type of the ObjCObjectType.
+ *
+ * If the type is not an ObjC object, an invalid type is returned.
+ */
+CINDEX_LINKAGE CXType clang_Type_getObjCObjectBaseType(CXType T);
+
+/**
+ * Retrieve the number of protocol references associated with an ObjC object/id.
+ *
+ * If the type is not an ObjC object, 0 is returned.
+ */
+CINDEX_LINKAGE unsigned clang_Type_getNumObjCProtocolRefs(CXType T);
+
+/**
+ * Retrieve the decl for a protocol reference for an ObjC object/id.
+ *
+ * If the type is not an ObjC object or there are not enough protocol
+ * references, an invalid cursor is returned.
+ */
+CINDEX_LINKAGE CXCursor clang_Type_getObjCProtocolDecl(CXType T, unsigned i);
+
+/**
+ * Retreive the number of type arguments associated with an ObjC object.
+ *
+ * If the type is not an ObjC object, 0 is returned.
+ */
+CINDEX_LINKAGE unsigned clang_Type_getNumObjCTypeArgs(CXType T);
+
+/**
+ * Retrieve a type argument associated with an ObjC object.
+ *
+ * If the type is not an ObjC or the index is not valid,
+ * an invalid type is returned.
+ */
+CINDEX_LINKAGE CXType clang_Type_getObjCTypeArg(CXType T, unsigned i);
+
+/**
+ * Return 1 if the CXType is a variadic function type, and 0 otherwise.
+ */
+CINDEX_LINKAGE unsigned clang_isFunctionTypeVariadic(CXType T);
+
+/**
+ * Retrieve the return type associated with a given cursor.
+ *
+ * This only returns a valid type if the cursor refers to a function or method.
+ */
+CINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C);
+
+/**
+ * Retrieve the exception specification type associated with a given cursor.
+ * This is a value of type CXCursor_ExceptionSpecificationKind.
+ *
+ * This only returns a valid result if the cursor refers to a function or method.
+ */
+CINDEX_LINKAGE int clang_getCursorExceptionSpecificationType(CXCursor C);
+
+/**
+ * Return 1 if the CXType is a POD (plain old data) type, and 0
+ * otherwise.
+ */
+CINDEX_LINKAGE unsigned clang_isPODType(CXType T);
+
+/**
+ * Return the element type of an array, complex, or vector type.
+ *
+ * If a type is passed in that is not an array, complex, or vector type,
+ * an invalid type is returned.
+ */
+CINDEX_LINKAGE CXType clang_getElementType(CXType T);
+
+/**
+ * Return the number of elements of an array or vector type.
+ *
+ * If a type is passed in that is not an array or vector type,
+ * -1 is returned.
+ */
+CINDEX_LINKAGE long long clang_getNumElements(CXType T);
+
+/**
+ * Return the element type of an array type.
+ *
+ * If a non-array type is passed in, an invalid type is returned.
+ */
+CINDEX_LINKAGE CXType clang_getArrayElementType(CXType T);
+
+/**
+ * Return the array size of a constant array.
+ *
+ * If a non-array type is passed in, -1 is returned.
+ */
+CINDEX_LINKAGE long long clang_getArraySize(CXType T);
+
+/**
+ * Retrieve the type named by the qualified-id.
+ *
+ * If a non-elaborated type is passed in, an invalid type is returned.
+ */
+CINDEX_LINKAGE CXType clang_Type_getNamedType(CXType T);
+
+/**
+ * Determine if a typedef is 'transparent' tag.
+ *
+ * A typedef is considered 'transparent' if it shares a name and spelling
+ * location with its underlying tag type, as is the case with the NS_ENUM macro.
+ *
+ * \returns non-zero if transparent and zero otherwise.
+ */
+CINDEX_LINKAGE unsigned clang_Type_isTransparentTagTypedef(CXType T);
+
+enum CXTypeNullabilityKind {
+ /**
+ * Values of this type can never be null.
+ */
+ CXTypeNullability_NonNull = 0,
+ /**
+ * Values of this type can be null.
+ */
+ CXTypeNullability_Nullable = 1,
+ /**
+ * Whether values of this type can be null is (explicitly)
+ * unspecified. This captures a (fairly rare) case where we
+ * can't conclude anything about the nullability of the type even
+ * though it has been considered.
+ */
+ CXTypeNullability_Unspecified = 2,
+ /**
+ * Nullability is not applicable to this type.
+ */
+ CXTypeNullability_Invalid = 3
+};
+
+/**
+ * Retrieve the nullability kind of a pointer type.
+ */
+CINDEX_LINKAGE enum CXTypeNullabilityKind clang_Type_getNullability(CXType T);
+
+/**
+ * List the possible error codes for \c clang_Type_getSizeOf,
+ * \c clang_Type_getAlignOf, \c clang_Type_getOffsetOf and
+ * \c clang_Cursor_getOffsetOf.
+ *
+ * A value of this enumeration type can be returned if the target type is not
+ * a valid argument to sizeof, alignof or offsetof.
+ */
+enum CXTypeLayoutError {
+ /**
+ * Type is of kind CXType_Invalid.
+ */
+ CXTypeLayoutError_Invalid = -1,
+ /**
+ * The type is an incomplete Type.
+ */
+ CXTypeLayoutError_Incomplete = -2,
+ /**
+ * The type is a dependent Type.
+ */
+ CXTypeLayoutError_Dependent = -3,
+ /**
+ * The type is not a constant size type.
+ */
+ CXTypeLayoutError_NotConstantSize = -4,
+ /**
+ * The Field name is not valid for this record.
+ */
+ CXTypeLayoutError_InvalidFieldName = -5,
+ /**
+ * The type is undeduced.
+ */
+ CXTypeLayoutError_Undeduced = -6
+};
+
+/**
+ * Return the alignment of a type in bytes as per C++[expr.alignof]
+ * standard.
+ *
+ * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
+ * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
+ * is returned.
+ * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
+ * returned.
+ * If the type declaration is not a constant size type,
+ * CXTypeLayoutError_NotConstantSize is returned.
+ */
+CINDEX_LINKAGE long long clang_Type_getAlignOf(CXType T);
+
+/**
+ * Return the class type of an member pointer type.
+ *
+ * If a non-member-pointer type is passed in, an invalid type is returned.
+ */
+CINDEX_LINKAGE CXType clang_Type_getClassType(CXType T);
+
+/**
+ * Return the size of a type in bytes as per C++[expr.sizeof] standard.
+ *
+ * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
+ * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
+ * is returned.
+ * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
+ * returned.
+ */
+CINDEX_LINKAGE long long clang_Type_getSizeOf(CXType T);
+
+/**
+ * Return the offset of a field named S in a record of type T in bits
+ * as it would be returned by __offsetof__ as per C++11[18.2p4]
+ *
+ * If the cursor is not a record field declaration, CXTypeLayoutError_Invalid
+ * is returned.
+ * If the field's type declaration is an incomplete type,
+ * CXTypeLayoutError_Incomplete is returned.
+ * If the field's type declaration is a dependent type,
+ * CXTypeLayoutError_Dependent is returned.
+ * If the field's name S is not found,
+ * CXTypeLayoutError_InvalidFieldName is returned.
+ */
+CINDEX_LINKAGE long long clang_Type_getOffsetOf(CXType T, const char *S);
+
+/**
+ * Return the type that was modified by this attributed type.
+ *
+ * If the type is not an attributed type, an invalid type is returned.
+ */
+CINDEX_LINKAGE CXType clang_Type_getModifiedType(CXType T);
+
+/**
+ * Return the offset of the field represented by the Cursor.
+ *
+ * If the cursor is not a field declaration, -1 is returned.
+ * If the cursor semantic parent is not a record field declaration,
+ * CXTypeLayoutError_Invalid is returned.
+ * If the field's type declaration is an incomplete type,
+ * CXTypeLayoutError_Incomplete is returned.
+ * If the field's type declaration is a dependent type,
+ * CXTypeLayoutError_Dependent is returned.
+ * If the field's name S is not found,
+ * CXTypeLayoutError_InvalidFieldName is returned.
+ */
+CINDEX_LINKAGE long long clang_Cursor_getOffsetOfField(CXCursor C);
+
+/**
+ * Determine whether the given cursor represents an anonymous
+ * tag or namespace
+ */
+CINDEX_LINKAGE unsigned clang_Cursor_isAnonymous(CXCursor C);
+
+/**
+ * Determine whether the given cursor represents an anonymous record
+ * declaration.
+ */
+CINDEX_LINKAGE unsigned clang_Cursor_isAnonymousRecordDecl(CXCursor C);
+
+/**
+ * Determine whether the given cursor represents an inline namespace
+ * declaration.
+ */
+CINDEX_LINKAGE unsigned clang_Cursor_isInlineNamespace(CXCursor C);
+
+enum CXRefQualifierKind {
+ /** No ref-qualifier was provided. */
+ CXRefQualifier_None = 0,
+ /** An lvalue ref-qualifier was provided (\c &). */
+ CXRefQualifier_LValue,
+ /** An rvalue ref-qualifier was provided (\c &&). */
+ CXRefQualifier_RValue
+};
+
+/**
+ * Returns the number of template arguments for given template
+ * specialization, or -1 if type \c T is not a template specialization.
+ */
+CINDEX_LINKAGE int clang_Type_getNumTemplateArguments(CXType T);
+
+/**
+ * Returns the type template argument of a template class specialization
+ * at given index.
+ *
+ * This function only returns template type arguments and does not handle
+ * template template arguments or variadic packs.
+ */
+CINDEX_LINKAGE CXType clang_Type_getTemplateArgumentAsType(CXType T, unsigned i);
+
+/**
+ * Retrieve the ref-qualifier kind of a function or method.
+ *
+ * The ref-qualifier is returned for C++ functions or methods. For other types
+ * or non-C++ declarations, CXRefQualifier_None is returned.
+ */
+CINDEX_LINKAGE enum CXRefQualifierKind clang_Type_getCXXRefQualifier(CXType T);
+
+/**
+ * Returns non-zero if the cursor specifies a Record member that is a
+ * bitfield.
+ */
+CINDEX_LINKAGE unsigned clang_Cursor_isBitField(CXCursor C);
+
+/**
+ * Returns 1 if the base class specified by the cursor with kind
+ * CX_CXXBaseSpecifier is virtual.
+ */
+CINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor);
+
+/**
+ * Represents the C++ access control level to a base class for a
+ * cursor with kind CX_CXXBaseSpecifier.
+ */
+enum CX_CXXAccessSpecifier {
+ CX_CXXInvalidAccessSpecifier,
+ CX_CXXPublic,
+ CX_CXXProtected,
+ CX_CXXPrivate
+};
+
+/**
+ * Returns the access control level for the referenced object.
+ *
+ * If the cursor refers to a C++ declaration, its access control level within its
+ * parent scope is returned. Otherwise, if the cursor refers to a base specifier or
+ * access specifier, the specifier itself is returned.
+ */
+CINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor);
+
+/**
+ * Represents the storage classes as declared in the source. CX_SC_Invalid
+ * was added for the case that the passed cursor in not a declaration.
+ */
+enum CX_StorageClass {
+ CX_SC_Invalid,
+ CX_SC_None,
+ CX_SC_Extern,
+ CX_SC_Static,
+ CX_SC_PrivateExtern,
+ CX_SC_OpenCLWorkGroupLocal,
+ CX_SC_Auto,
+ CX_SC_Register
+};
+
+/**
+ * Returns the storage class for a function or variable declaration.
+ *
+ * If the passed in Cursor is not a function or variable declaration,
+ * CX_SC_Invalid is returned else the storage class.
+ */
+CINDEX_LINKAGE enum CX_StorageClass clang_Cursor_getStorageClass(CXCursor);
+
+/**
+ * Determine the number of overloaded declarations referenced by a
+ * \c CXCursor_OverloadedDeclRef cursor.
+ *
+ * \param cursor The cursor whose overloaded declarations are being queried.
+ *
+ * \returns The number of overloaded declarations referenced by \c cursor. If it
+ * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0.
+ */
+CINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor);
+
+/**
+ * Retrieve a cursor for one of the overloaded declarations referenced
+ * by a \c CXCursor_OverloadedDeclRef cursor.
+ *
+ * \param cursor The cursor whose overloaded declarations are being queried.
+ *
+ * \param index The zero-based index into the set of overloaded declarations in
+ * the cursor.
+ *
+ * \returns A cursor representing the declaration referenced by the given
+ * \c cursor at the specified \c index. If the cursor does not have an
+ * associated set of overloaded declarations, or if the index is out of bounds,
+ * returns \c clang_getNullCursor();
+ */
+CINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor,
+ unsigned index);
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup CINDEX_ATTRIBUTES Information for attributes
+ *
+ * @{
+ */
+
+/**
+ * For cursors representing an iboutletcollection attribute,
+ * this function returns the collection element type.
+ *
+ */
+CINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor);
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors
+ *
+ * These routines provide the ability to traverse the abstract syntax tree
+ * using cursors.
+ *
+ * @{
+ */
+
+/**
+ * Describes how the traversal of the children of a particular
+ * cursor should proceed after visiting a particular child cursor.
+ *
+ * A value of this enumeration type should be returned by each
+ * \c CXCursorVisitor to indicate how clang_visitChildren() proceed.
+ */
+enum CXChildVisitResult {
+ /**
+ * Terminates the cursor traversal.
+ */
+ CXChildVisit_Break,
+ /**
+ * Continues the cursor traversal with the next sibling of
+ * the cursor just visited, without visiting its children.
+ */
+ CXChildVisit_Continue,
+ /**
+ * Recursively traverse the children of this cursor, using
+ * the same visitor and client data.
+ */
+ CXChildVisit_Recurse
+};
+
+/**
+ * Visitor invoked for each cursor found by a traversal.
+ *
+ * This visitor function will be invoked for each cursor found by
+ * clang_visitCursorChildren(). Its first argument is the cursor being
+ * visited, its second argument is the parent visitor for that cursor,
+ * and its third argument is the client data provided to
+ * clang_visitCursorChildren().
+ *
+ * The visitor should return one of the \c CXChildVisitResult values
+ * to direct clang_visitCursorChildren().
+ */
+typedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor,
+ CXCursor parent,
+ CXClientData client_data);
+
+/**
+ * Visit the children of a particular cursor.
+ *
+ * This function visits all the direct children of the given cursor,
+ * invoking the given \p visitor function with the cursors of each
+ * visited child. The traversal may be recursive, if the visitor returns
+ * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if
+ * the visitor returns \c CXChildVisit_Break.
+ *
+ * \param parent the cursor whose child may be visited. All kinds of
+ * cursors can be visited, including invalid cursors (which, by
+ * definition, have no children).
+ *
+ * \param visitor the visitor function that will be invoked for each
+ * child of \p parent.
+ *
+ * \param client_data pointer data supplied by the client, which will
+ * be passed to the visitor each time it is invoked.
+ *
+ * \returns a non-zero value if the traversal was terminated
+ * prematurely by the visitor returning \c CXChildVisit_Break.
+ */
+CINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent,
+ CXCursorVisitor visitor,
+ CXClientData client_data);
+#ifdef __has_feature
+# if __has_feature(blocks)
+/**
+ * Visitor invoked for each cursor found by a traversal.
+ *
+ * This visitor block will be invoked for each cursor found by
+ * clang_visitChildrenWithBlock(). Its first argument is the cursor being
+ * visited, its second argument is the parent visitor for that cursor.
+ *
+ * The visitor should return one of the \c CXChildVisitResult values
+ * to direct clang_visitChildrenWithBlock().
+ */
+typedef enum CXChildVisitResult
+ (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
+
+/**
+ * Visits the children of a cursor using the specified block. Behaves
+ * identically to clang_visitChildren() in all other respects.
+ */
+CINDEX_LINKAGE unsigned clang_visitChildrenWithBlock(CXCursor parent,
+ CXCursorVisitorBlock block);
+# endif
+#endif
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST
+ *
+ * These routines provide the ability to determine references within and
+ * across translation units, by providing the names of the entities referenced
+ * by cursors, follow reference cursors to the declarations they reference,
+ * and associate declarations with their definitions.
+ *
+ * @{
+ */
+
+/**
+ * Retrieve a Unified Symbol Resolution (USR) for the entity referenced
+ * by the given cursor.
+ *
+ * A Unified Symbol Resolution (USR) is a string that identifies a particular
+ * entity (function, class, variable, etc.) within a program. USRs can be
+ * compared across translation units to determine, e.g., when references in
+ * one translation refer to an entity defined in another translation unit.
+ */
+CINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor);
+
+/**
+ * Construct a USR for a specified Objective-C class.
+ */
+CINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name);
+
+/**
+ * Construct a USR for a specified Objective-C category.
+ */
+CINDEX_LINKAGE CXString
+ clang_constructUSR_ObjCCategory(const char *class_name,
+ const char *category_name);
+
+/**
+ * Construct a USR for a specified Objective-C protocol.
+ */
+CINDEX_LINKAGE CXString
+ clang_constructUSR_ObjCProtocol(const char *protocol_name);
+
+/**
+ * Construct a USR for a specified Objective-C instance variable and
+ * the USR for its containing class.
+ */
+CINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name,
+ CXString classUSR);
+
+/**
+ * Construct a USR for a specified Objective-C method and
+ * the USR for its containing class.
+ */
+CINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name,
+ unsigned isInstanceMethod,
+ CXString classUSR);
+
+/**
+ * Construct a USR for a specified Objective-C property and the USR
+ * for its containing class.
+ */
+CINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property,
+ CXString classUSR);
+
+/**
+ * Retrieve a name for the entity referenced by this cursor.
+ */
+CINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor);
+
+/**
+ * Retrieve a range for a piece that forms the cursors spelling name.
+ * Most of the times there is only one range for the complete spelling but for
+ * Objective-C methods and Objective-C message expressions, there are multiple
+ * pieces for each selector identifier.
+ *
+ * \param pieceIndex the index of the spelling name piece. If this is greater
+ * than the actual number of pieces, it will return a NULL (invalid) range.
+ *
+ * \param options Reserved.
+ */
+CINDEX_LINKAGE CXSourceRange clang_Cursor_getSpellingNameRange(CXCursor,
+ unsigned pieceIndex,
+ unsigned options);
+
+/**
+ * Opaque pointer representing a policy that controls pretty printing
+ * for \c clang_getCursorPrettyPrinted.
+ */
+typedef void *CXPrintingPolicy;
+
+/**
+ * Properties for the printing policy.
+ *
+ * See \c clang::PrintingPolicy for more information.
+ */
+enum CXPrintingPolicyProperty {
+ CXPrintingPolicy_Indentation,
+ CXPrintingPolicy_SuppressSpecifiers,
+ CXPrintingPolicy_SuppressTagKeyword,
+ CXPrintingPolicy_IncludeTagDefinition,
+ CXPrintingPolicy_SuppressScope,
+ CXPrintingPolicy_SuppressUnwrittenScope,
+ CXPrintingPolicy_SuppressInitializers,
+ CXPrintingPolicy_ConstantArraySizeAsWritten,
+ CXPrintingPolicy_AnonymousTagLocations,
+ CXPrintingPolicy_SuppressStrongLifetime,
+ CXPrintingPolicy_SuppressLifetimeQualifiers,
+ CXPrintingPolicy_SuppressTemplateArgsInCXXConstructors,
+ CXPrintingPolicy_Bool,
+ CXPrintingPolicy_Restrict,
+ CXPrintingPolicy_Alignof,
+ CXPrintingPolicy_UnderscoreAlignof,
+ CXPrintingPolicy_UseVoidForZeroParams,
+ CXPrintingPolicy_TerseOutput,
+ CXPrintingPolicy_PolishForDeclaration,
+ CXPrintingPolicy_Half,
+ CXPrintingPolicy_MSWChar,
+ CXPrintingPolicy_IncludeNewlines,
+ CXPrintingPolicy_MSVCFormatting,
+ CXPrintingPolicy_ConstantsAsWritten,
+ CXPrintingPolicy_SuppressImplicitBase,
+ CXPrintingPolicy_FullyQualifiedName,
+
+ CXPrintingPolicy_LastProperty = CXPrintingPolicy_FullyQualifiedName
+};
+
+/**
+ * Get a property value for the given printing policy.
+ */
+CINDEX_LINKAGE unsigned
+clang_PrintingPolicy_getProperty(CXPrintingPolicy Policy,
+ enum CXPrintingPolicyProperty Property);
+
+/**
+ * Set a property value for the given printing policy.
+ */
+CINDEX_LINKAGE void clang_PrintingPolicy_setProperty(CXPrintingPolicy Policy,
+ enum CXPrintingPolicyProperty Property,
+ unsigned Value);
+
+/**
+ * Retrieve the default policy for the cursor.
+ *
+ * The policy should be released after use with \c
+ * clang_PrintingPolicy_dispose.
+ */
+CINDEX_LINKAGE CXPrintingPolicy clang_getCursorPrintingPolicy(CXCursor);
+
+/**
+ * Release a printing policy.
+ */
+CINDEX_LINKAGE void clang_PrintingPolicy_dispose(CXPrintingPolicy Policy);
+
+/**
+ * Pretty print declarations.
+ *
+ * \param Cursor The cursor representing a declaration.
+ *
+ * \param Policy The policy to control the entities being printed. If
+ * NULL, a default policy is used.
+ *
+ * \returns The pretty printed declaration or the empty string for
+ * other cursors.
+ */
+CINDEX_LINKAGE CXString clang_getCursorPrettyPrinted(CXCursor Cursor,
+ CXPrintingPolicy Policy);
+
+/**
+ * Retrieve the display name for the entity referenced by this cursor.
+ *
+ * The display name contains extra information that helps identify the cursor,
+ * such as the parameters of a function or template or the arguments of a
+ * class template specialization.
+ */
+CINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor);
+
+/** For a cursor that is a reference, retrieve a cursor representing the
+ * entity that it references.
+ *
+ * Reference cursors refer to other entities in the AST. For example, an
+ * Objective-C superclass reference cursor refers to an Objective-C class.
+ * This function produces the cursor for the Objective-C class from the
+ * cursor for the superclass reference. If the input cursor is a declaration or
+ * definition, it returns that declaration or definition unchanged.
+ * Otherwise, returns the NULL cursor.
+ */
+CINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor);
+
+/**
+ * For a cursor that is either a reference to or a declaration
+ * of some entity, retrieve a cursor that describes the definition of
+ * that entity.
+ *
+ * Some entities can be declared multiple times within a translation
+ * unit, but only one of those declarations can also be a
+ * definition. For example, given:
+ *
+ * \code
+ * int f(int, int);
+ * int g(int x, int y) { return f(x, y); }
+ * int f(int a, int b) { return a + b; }
+ * int f(int, int);
+ * \endcode
+ *
+ * there are three declarations of the function "f", but only the
+ * second one is a definition. The clang_getCursorDefinition()
+ * function will take any cursor pointing to a declaration of "f"
+ * (the first or fourth lines of the example) or a cursor referenced
+ * that uses "f" (the call to "f' inside "g") and will return a
+ * declaration cursor pointing to the definition (the second "f"
+ * declaration).
+ *
+ * If given a cursor for which there is no corresponding definition,
+ * e.g., because there is no definition of that entity within this
+ * translation unit, returns a NULL cursor.
+ */
+CINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor);
+
+/**
+ * Determine whether the declaration pointed to by this cursor
+ * is also a definition of that entity.
+ */
+CINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor);
+
+/**
+ * Retrieve the canonical cursor corresponding to the given cursor.
+ *
+ * In the C family of languages, many kinds of entities can be declared several
+ * times within a single translation unit. For example, a structure type can
+ * be forward-declared (possibly multiple times) and later defined:
+ *
+ * \code
+ * struct X;
+ * struct X;
+ * struct X {
+ * int member;
+ * };
+ * \endcode
+ *
+ * The declarations and the definition of \c X are represented by three
+ * different cursors, all of which are declarations of the same underlying
+ * entity. One of these cursor is considered the "canonical" cursor, which
+ * is effectively the representative for the underlying entity. One can
+ * determine if two cursors are declarations of the same underlying entity by
+ * comparing their canonical cursors.
+ *
+ * \returns The canonical cursor for the entity referred to by the given cursor.
+ */
+CINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor);
+
+/**
+ * If the cursor points to a selector identifier in an Objective-C
+ * method or message expression, this returns the selector index.
+ *
+ * After getting a cursor with #clang_getCursor, this can be called to
+ * determine if the location points to a selector identifier.
+ *
+ * \returns The selector index if the cursor is an Objective-C method or message
+ * expression and the cursor is pointing to a selector identifier, or -1
+ * otherwise.
+ */
+CINDEX_LINKAGE int clang_Cursor_getObjCSelectorIndex(CXCursor);
+
+/**
+ * Given a cursor pointing to a C++ method call or an Objective-C
+ * message, returns non-zero if the method/message is "dynamic", meaning:
+ *
+ * For a C++ method: the call is virtual.
+ * For an Objective-C message: the receiver is an object instance, not 'super'
+ * or a specific class.
+ *
+ * If the method/message is "static" or the cursor does not point to a
+ * method/message, it will return zero.
+ */
+CINDEX_LINKAGE int clang_Cursor_isDynamicCall(CXCursor C);
+
+/**
+ * Given a cursor pointing to an Objective-C message or property
+ * reference, or C++ method call, returns the CXType of the receiver.
+ */
+CINDEX_LINKAGE CXType clang_Cursor_getReceiverType(CXCursor C);
+
+/**
+ * Property attributes for a \c CXCursor_ObjCPropertyDecl.
+ */
+typedef enum {
+ CXObjCPropertyAttr_noattr = 0x00,
+ CXObjCPropertyAttr_readonly = 0x01,
+ CXObjCPropertyAttr_getter = 0x02,
+ CXObjCPropertyAttr_assign = 0x04,
+ CXObjCPropertyAttr_readwrite = 0x08,
+ CXObjCPropertyAttr_retain = 0x10,
+ CXObjCPropertyAttr_copy = 0x20,
+ CXObjCPropertyAttr_nonatomic = 0x40,
+ CXObjCPropertyAttr_setter = 0x80,
+ CXObjCPropertyAttr_atomic = 0x100,
+ CXObjCPropertyAttr_weak = 0x200,
+ CXObjCPropertyAttr_strong = 0x400,
+ CXObjCPropertyAttr_unsafe_unretained = 0x800,
+ CXObjCPropertyAttr_class = 0x1000
+} CXObjCPropertyAttrKind;
+
+/**
+ * Given a cursor that represents a property declaration, return the
+ * associated property attributes. The bits are formed from
+ * \c CXObjCPropertyAttrKind.
+ *
+ * \param reserved Reserved for future use, pass 0.
+ */
+CINDEX_LINKAGE unsigned clang_Cursor_getObjCPropertyAttributes(CXCursor C,
+ unsigned reserved);
+
+/**
+ * Given a cursor that represents a property declaration, return the
+ * name of the method that implements the getter.
+ */
+CINDEX_LINKAGE CXString clang_Cursor_getObjCPropertyGetterName(CXCursor C);
+
+/**
+ * Given a cursor that represents a property declaration, return the
+ * name of the method that implements the setter, if any.
+ */
+CINDEX_LINKAGE CXString clang_Cursor_getObjCPropertySetterName(CXCursor C);
+
+/**
+ * 'Qualifiers' written next to the return and parameter types in
+ * Objective-C method declarations.
+ */
+typedef enum {
+ CXObjCDeclQualifier_None = 0x0,
+ CXObjCDeclQualifier_In = 0x1,
+ CXObjCDeclQualifier_Inout = 0x2,
+ CXObjCDeclQualifier_Out = 0x4,
+ CXObjCDeclQualifier_Bycopy = 0x8,
+ CXObjCDeclQualifier_Byref = 0x10,
+ CXObjCDeclQualifier_Oneway = 0x20
+} CXObjCDeclQualifierKind;
+
+/**
+ * Given a cursor that represents an Objective-C method or parameter
+ * declaration, return the associated Objective-C qualifiers for the return
+ * type or the parameter respectively. The bits are formed from
+ * CXObjCDeclQualifierKind.
+ */
+CINDEX_LINKAGE unsigned clang_Cursor_getObjCDeclQualifiers(CXCursor C);
+
+/**
+ * Given a cursor that represents an Objective-C method or property
+ * declaration, return non-zero if the declaration was affected by "\@optional".
+ * Returns zero if the cursor is not such a declaration or it is "\@required".
+ */
+CINDEX_LINKAGE unsigned clang_Cursor_isObjCOptional(CXCursor C);
+
+/**
+ * Returns non-zero if the given cursor is a variadic function or method.
+ */
+CINDEX_LINKAGE unsigned clang_Cursor_isVariadic(CXCursor C);
+
+/**
+ * Returns non-zero if the given cursor points to a symbol marked with
+ * external_source_symbol attribute.
+ *
+ * \param language If non-NULL, and the attribute is present, will be set to
+ * the 'language' string from the attribute.
+ *
+ * \param definedIn If non-NULL, and the attribute is present, will be set to
+ * the 'definedIn' string from the attribute.
+ *
+ * \param isGenerated If non-NULL, and the attribute is present, will be set to
+ * non-zero if the 'generated_declaration' is set in the attribute.
+ */
+CINDEX_LINKAGE unsigned clang_Cursor_isExternalSymbol(CXCursor C,
+ CXString *language, CXString *definedIn,
+ unsigned *isGenerated);
+
+/**
+ * Given a cursor that represents a declaration, return the associated
+ * comment's source range. The range may include multiple consecutive comments
+ * with whitespace in between.
+ */
+CINDEX_LINKAGE CXSourceRange clang_Cursor_getCommentRange(CXCursor C);
+
+/**
+ * Given a cursor that represents a declaration, return the associated
+ * comment text, including comment markers.
+ */
+CINDEX_LINKAGE CXString clang_Cursor_getRawCommentText(CXCursor C);
+
+/**
+ * Given a cursor that represents a documentable entity (e.g.,
+ * declaration), return the associated \paragraph; otherwise return the
+ * first paragraph.
+ */
+CINDEX_LINKAGE CXString clang_Cursor_getBriefCommentText(CXCursor C);
+
+/**
+ * @}
+ */
+
+/** \defgroup CINDEX_MANGLE Name Mangling API Functions
+ *
+ * @{
+ */
+
+/**
+ * Retrieve the CXString representing the mangled name of the cursor.
+ */
+CINDEX_LINKAGE CXString clang_Cursor_getMangling(CXCursor);
+
+/**
+ * Retrieve the CXStrings representing the mangled symbols of the C++
+ * constructor or destructor at the cursor.
+ */
+CINDEX_LINKAGE CXStringSet *clang_Cursor_getCXXManglings(CXCursor);
+
+/**
+ * Retrieve the CXStrings representing the mangled symbols of the ObjC
+ * class interface or implementation at the cursor.
+ */
+CINDEX_LINKAGE CXStringSet *clang_Cursor_getObjCManglings(CXCursor);
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup CINDEX_MODULE Module introspection
+ *
+ * The functions in this group provide access to information about modules.
+ *
+ * @{
+ */
+
+typedef void *CXModule;
+
+/**
+ * Given a CXCursor_ModuleImportDecl cursor, return the associated module.
+ */
+CINDEX_LINKAGE CXModule clang_Cursor_getModule(CXCursor C);
+
+/**
+ * Given a CXFile header file, return the module that contains it, if one
+ * exists.
+ */
+CINDEX_LINKAGE CXModule clang_getModuleForFile(CXTranslationUnit, CXFile);
+
+/**
+ * \param Module a module object.
+ *
+ * \returns the module file where the provided module object came from.
+ */
+CINDEX_LINKAGE CXFile clang_Module_getASTFile(CXModule Module);
+
+/**
+ * \param Module a module object.
+ *
+ * \returns the parent of a sub-module or NULL if the given module is top-level,
+ * e.g. for 'std.vector' it will return the 'std' module.
+ */
+CINDEX_LINKAGE CXModule clang_Module_getParent(CXModule Module);
+
+/**
+ * \param Module a module object.
+ *
+ * \returns the name of the module, e.g. for the 'std.vector' sub-module it
+ * will return "vector".
+ */
+CINDEX_LINKAGE CXString clang_Module_getName(CXModule Module);
+
+/**
+ * \param Module a module object.
+ *
+ * \returns the full name of the module, e.g. "std.vector".
+ */
+CINDEX_LINKAGE CXString clang_Module_getFullName(CXModule Module);
+
+/**
+ * \param Module a module object.
+ *
+ * \returns non-zero if the module is a system one.
+ */
+CINDEX_LINKAGE int clang_Module_isSystem(CXModule Module);
+
+/**
+ * \param Module a module object.
+ *
+ * \returns the number of top level headers associated with this module.
+ */
+CINDEX_LINKAGE unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit,
+ CXModule Module);
+
+/**
+ * \param Module a module object.
+ *
+ * \param Index top level header index (zero-based).
+ *
+ * \returns the specified top level header associated with the module.
+ */
+CINDEX_LINKAGE
+CXFile clang_Module_getTopLevelHeader(CXTranslationUnit,
+ CXModule Module, unsigned Index);
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup CINDEX_CPP C++ AST introspection
+ *
+ * The routines in this group provide access information in the ASTs specific
+ * to C++ language features.
+ *
+ * @{
+ */
+
+/**
+ * Determine if a C++ constructor is a converting constructor.
+ */
+CINDEX_LINKAGE unsigned clang_CXXConstructor_isConvertingConstructor(CXCursor C);
+
+/**
+ * Determine if a C++ constructor is a copy constructor.
+ */
+CINDEX_LINKAGE unsigned clang_CXXConstructor_isCopyConstructor(CXCursor C);
+
+/**
+ * Determine if a C++ constructor is the default constructor.
+ */
+CINDEX_LINKAGE unsigned clang_CXXConstructor_isDefaultConstructor(CXCursor C);
+
+/**
+ * Determine if a C++ constructor is a move constructor.
+ */
+CINDEX_LINKAGE unsigned clang_CXXConstructor_isMoveConstructor(CXCursor C);
+
+/**
+ * Determine if a C++ field is declared 'mutable'.
+ */
+CINDEX_LINKAGE unsigned clang_CXXField_isMutable(CXCursor C);
+
+/**
+ * Determine if a C++ method is declared '= default'.
+ */
+CINDEX_LINKAGE unsigned clang_CXXMethod_isDefaulted(CXCursor C);
+
+/**
+ * Determine if a C++ member function or member function template is
+ * pure virtual.
+ */
+CINDEX_LINKAGE unsigned clang_CXXMethod_isPureVirtual(CXCursor C);
+
+/**
+ * Determine if a C++ member function or member function template is
+ * declared 'static'.
+ */
+CINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C);
+
+/**
+ * Determine if a C++ member function or member function template is
+ * explicitly declared 'virtual' or if it overrides a virtual method from
+ * one of the base classes.
+ */
+CINDEX_LINKAGE unsigned clang_CXXMethod_isVirtual(CXCursor C);
+
+/**
+ * Determine if a C++ record is abstract, i.e. whether a class or struct
+ * has a pure virtual member function.
+ */
+CINDEX_LINKAGE unsigned clang_CXXRecord_isAbstract(CXCursor C);
+
+/**
+ * Determine if an enum declaration refers to a scoped enum.
+ */
+CINDEX_LINKAGE unsigned clang_EnumDecl_isScoped(CXCursor C);
+
+/**
+ * Determine if a C++ member function or member function template is
+ * declared 'const'.
+ */
+CINDEX_LINKAGE unsigned clang_CXXMethod_isConst(CXCursor C);
+
+/**
+ * Given a cursor that represents a template, determine
+ * the cursor kind of the specializations would be generated by instantiating
+ * the template.
+ *
+ * This routine can be used to determine what flavor of function template,
+ * class template, or class template partial specialization is stored in the
+ * cursor. For example, it can describe whether a class template cursor is
+ * declared with "struct", "class" or "union".
+ *
+ * \param C The cursor to query. This cursor should represent a template
+ * declaration.
+ *
+ * \returns The cursor kind of the specializations that would be generated
+ * by instantiating the template \p C. If \p C is not a template, returns
+ * \c CXCursor_NoDeclFound.
+ */
+CINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C);
+
+/**
+ * Given a cursor that may represent a specialization or instantiation
+ * of a template, retrieve the cursor that represents the template that it
+ * specializes or from which it was instantiated.
+ *
+ * This routine determines the template involved both for explicit
+ * specializations of templates and for implicit instantiations of the template,
+ * both of which are referred to as "specializations". For a class template
+ * specialization (e.g., \c std::vector<bool>), this routine will return
+ * either the primary template (\c std::vector) or, if the specialization was
+ * instantiated from a class template partial specialization, the class template
+ * partial specialization. For a class template partial specialization and a
+ * function template specialization (including instantiations), this
+ * this routine will return the specialized template.
+ *
+ * For members of a class template (e.g., member functions, member classes, or
+ * static data members), returns the specialized or instantiated member.
+ * Although not strictly "templates" in the C++ language, members of class
+ * templates have the same notions of specializations and instantiations that
+ * templates do, so this routine treats them similarly.
+ *
+ * \param C A cursor that may be a specialization of a template or a member
+ * of a template.
+ *
+ * \returns If the given cursor is a specialization or instantiation of a
+ * template or a member thereof, the template or member that it specializes or
+ * from which it was instantiated. Otherwise, returns a NULL cursor.
+ */
+CINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C);
+
+/**
+ * Given a cursor that references something else, return the source range
+ * covering that reference.
+ *
+ * \param C A cursor pointing to a member reference, a declaration reference, or
+ * an operator call.
+ * \param NameFlags A bitset with three independent flags:
+ * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and
+ * CXNameRange_WantSinglePiece.
+ * \param PieceIndex For contiguous names or when passing the flag
+ * CXNameRange_WantSinglePiece, only one piece with index 0 is
+ * available. When the CXNameRange_WantSinglePiece flag is not passed for a
+ * non-contiguous names, this index can be used to retrieve the individual
+ * pieces of the name. See also CXNameRange_WantSinglePiece.
+ *
+ * \returns The piece of the name pointed to by the given cursor. If there is no
+ * name, or if the PieceIndex is out-of-range, a null-cursor will be returned.
+ */
+CINDEX_LINKAGE CXSourceRange clang_getCursorReferenceNameRange(CXCursor C,
+ unsigned NameFlags,
+ unsigned PieceIndex);
+
+enum CXNameRefFlags {
+ /**
+ * Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the
+ * range.
+ */
+ CXNameRange_WantQualifier = 0x1,
+
+ /**
+ * Include the explicit template arguments, e.g. \<int> in x.f<int>,
+ * in the range.
+ */
+ CXNameRange_WantTemplateArgs = 0x2,
+
+ /**
+ * If the name is non-contiguous, return the full spanning range.
+ *
+ * Non-contiguous names occur in Objective-C when a selector with two or more
+ * parameters is used, or in C++ when using an operator:
+ * \code
+ * [object doSomething:here withValue:there]; // Objective-C
+ * return some_vector[1]; // C++
+ * \endcode
+ */
+ CXNameRange_WantSinglePiece = 0x4
+};
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup CINDEX_LEX Token extraction and manipulation
+ *
+ * The routines in this group provide access to the tokens within a
+ * translation unit, along with a semantic mapping of those tokens to
+ * their corresponding cursors.
+ *
+ * @{
+ */
+
+/**
+ * Describes a kind of token.
+ */
+typedef enum CXTokenKind {
+ /**
+ * A token that contains some kind of punctuation.
+ */
+ CXToken_Punctuation,
+
+ /**
+ * A language keyword.
+ */
+ CXToken_Keyword,
+
+ /**
+ * An identifier (that is not a keyword).
+ */
+ CXToken_Identifier,
+
+ /**
+ * A numeric, string, or character literal.
+ */
+ CXToken_Literal,
+
+ /**
+ * A comment.
+ */
+ CXToken_Comment
+} CXTokenKind;
+
+/**
+ * Describes a single preprocessing token.
+ */
+typedef struct {
+ unsigned int_data[4];
+ void *ptr_data;
+} CXToken;
+
+/**
+ * Get the raw lexical token starting with the given location.
+ *
+ * \param TU the translation unit whose text is being tokenized.
+ *
+ * \param Location the source location with which the token starts.
+ *
+ * \returns The token starting with the given location or NULL if no such token
+ * exist. The returned pointer must be freed with clang_disposeTokens before the
+ * translation unit is destroyed.
+ */
+CINDEX_LINKAGE CXToken *clang_getToken(CXTranslationUnit TU,
+ CXSourceLocation Location);
+
+/**
+ * Determine the kind of the given token.
+ */
+CINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken);
+
+/**
+ * Determine the spelling of the given token.
+ *
+ * The spelling of a token is the textual representation of that token, e.g.,
+ * the text of an identifier or keyword.
+ */
+CINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken);
+
+/**
+ * Retrieve the source location of the given token.
+ */
+CINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit,
+ CXToken);
+
+/**
+ * Retrieve a source range that covers the given token.
+ */
+CINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken);
+
+/**
+ * Tokenize the source code described by the given range into raw
+ * lexical tokens.
+ *
+ * \param TU the translation unit whose text is being tokenized.
+ *
+ * \param Range the source range in which text should be tokenized. All of the
+ * tokens produced by tokenization will fall within this source range,
+ *
+ * \param Tokens this pointer will be set to point to the array of tokens
+ * that occur within the given source range. The returned pointer must be
+ * freed with clang_disposeTokens() before the translation unit is destroyed.
+ *
+ * \param NumTokens will be set to the number of tokens in the \c *Tokens
+ * array.
+ *
+ */
+CINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
+ CXToken **Tokens, unsigned *NumTokens);
+
+/**
+ * Annotate the given set of tokens by providing cursors for each token
+ * that can be mapped to a specific entity within the abstract syntax tree.
+ *
+ * This token-annotation routine is equivalent to invoking
+ * clang_getCursor() for the source locations of each of the
+ * tokens. The cursors provided are filtered, so that only those
+ * cursors that have a direct correspondence to the token are
+ * accepted. For example, given a function call \c f(x),
+ * clang_getCursor() would provide the following cursors:
+ *
+ * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'.
+ * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'.
+ * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'.
+ *
+ * Only the first and last of these cursors will occur within the
+ * annotate, since the tokens "f" and "x' directly refer to a function
+ * and a variable, respectively, but the parentheses are just a small
+ * part of the full syntax of the function call expression, which is
+ * not provided as an annotation.
+ *
+ * \param TU the translation unit that owns the given tokens.
+ *
+ * \param Tokens the set of tokens to annotate.
+ *
+ * \param NumTokens the number of tokens in \p Tokens.
+ *
+ * \param Cursors an array of \p NumTokens cursors, whose contents will be
+ * replaced with the cursors corresponding to each token.
+ */
+CINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU,
+ CXToken *Tokens, unsigned NumTokens,
+ CXCursor *Cursors);
+
+/**
+ * Free the given set of tokens.
+ */
+CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU,
+ CXToken *Tokens, unsigned NumTokens);
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup CINDEX_DEBUG Debugging facilities
+ *
+ * These routines are used for testing and debugging, only, and should not
+ * be relied upon.
+ *
+ * @{
+ */
+
+/* for debug/testing */
+CINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind);
+CINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor,
+ const char **startBuf,
+ const char **endBuf,
+ unsigned *startLine,
+ unsigned *startColumn,
+ unsigned *endLine,
+ unsigned *endColumn);
+CINDEX_LINKAGE void clang_enableStackTraces(void);
+CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data,
+ unsigned stack_size);
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup CINDEX_CODE_COMPLET Code completion
+ *
+ * Code completion involves taking an (incomplete) source file, along with
+ * knowledge of where the user is actively editing that file, and suggesting
+ * syntactically- and semantically-valid constructs that the user might want to
+ * use at that particular point in the source code. These data structures and
+ * routines provide support for code completion.
+ *
+ * @{
+ */
+
+/**
+ * A semantic string that describes a code-completion result.
+ *
+ * A semantic string that describes the formatting of a code-completion
+ * result as a single "template" of text that should be inserted into the
+ * source buffer when a particular code-completion result is selected.
+ * Each semantic string is made up of some number of "chunks", each of which
+ * contains some text along with a description of what that text means, e.g.,
+ * the name of the entity being referenced, whether the text chunk is part of
+ * the template, or whether it is a "placeholder" that the user should replace
+ * with actual code,of a specific kind. See \c CXCompletionChunkKind for a
+ * description of the different kinds of chunks.
+ */
+typedef void *CXCompletionString;
+
+/**
+ * A single result of code completion.
+ */
+typedef struct {
+ /**
+ * The kind of entity that this completion refers to.
+ *
+ * The cursor kind will be a macro, keyword, or a declaration (one of the
+ * *Decl cursor kinds), describing the entity that the completion is
+ * referring to.
+ *
+ * \todo In the future, we would like to provide a full cursor, to allow
+ * the client to extract additional information from declaration.
+ */
+ enum CXCursorKind CursorKind;
+
+ /**
+ * The code-completion string that describes how to insert this
+ * code-completion result into the editing buffer.
+ */
+ CXCompletionString CompletionString;
+} CXCompletionResult;
+
+/**
+ * Describes a single piece of text within a code-completion string.
+ *
+ * Each "chunk" within a code-completion string (\c CXCompletionString) is
+ * either a piece of text with a specific "kind" that describes how that text
+ * should be interpreted by the client or is another completion string.
+ */
+enum CXCompletionChunkKind {
+ /**
+ * A code-completion string that describes "optional" text that
+ * could be a part of the template (but is not required).
+ *
+ * The Optional chunk is the only kind of chunk that has a code-completion
+ * string for its representation, which is accessible via
+ * \c clang_getCompletionChunkCompletionString(). The code-completion string
+ * describes an additional part of the template that is completely optional.
+ * For example, optional chunks can be used to describe the placeholders for
+ * arguments that match up with defaulted function parameters, e.g. given:
+ *
+ * \code
+ * void f(int x, float y = 3.14, double z = 2.71828);
+ * \endcode
+ *
+ * The code-completion string for this function would contain:
+ * - a TypedText chunk for "f".
+ * - a LeftParen chunk for "(".
+ * - a Placeholder chunk for "int x"
+ * - an Optional chunk containing the remaining defaulted arguments, e.g.,
+ * - a Comma chunk for ","
+ * - a Placeholder chunk for "float y"
+ * - an Optional chunk containing the last defaulted argument:
+ * - a Comma chunk for ","
+ * - a Placeholder chunk for "double z"
+ * - a RightParen chunk for ")"
+ *
+ * There are many ways to handle Optional chunks. Two simple approaches are:
+ * - Completely ignore optional chunks, in which case the template for the
+ * function "f" would only include the first parameter ("int x").
+ * - Fully expand all optional chunks, in which case the template for the
+ * function "f" would have all of the parameters.
+ */
+ CXCompletionChunk_Optional,
+ /**
+ * Text that a user would be expected to type to get this
+ * code-completion result.
+ *
+ * There will be exactly one "typed text" chunk in a semantic string, which
+ * will typically provide the spelling of a keyword or the name of a
+ * declaration that could be used at the current code point. Clients are
+ * expected to filter the code-completion results based on the text in this
+ * chunk.
+ */
+ CXCompletionChunk_TypedText,
+ /**
+ * Text that should be inserted as part of a code-completion result.
+ *
+ * A "text" chunk represents text that is part of the template to be
+ * inserted into user code should this particular code-completion result
+ * be selected.
+ */
+ CXCompletionChunk_Text,
+ /**
+ * Placeholder text that should be replaced by the user.
+ *
+ * A "placeholder" chunk marks a place where the user should insert text
+ * into the code-completion template. For example, placeholders might mark
+ * the function parameters for a function declaration, to indicate that the
+ * user should provide arguments for each of those parameters. The actual
+ * text in a placeholder is a suggestion for the text to display before
+ * the user replaces the placeholder with real code.
+ */
+ CXCompletionChunk_Placeholder,
+ /**
+ * Informative text that should be displayed but never inserted as
+ * part of the template.
+ *
+ * An "informative" chunk contains annotations that can be displayed to
+ * help the user decide whether a particular code-completion result is the
+ * right option, but which is not part of the actual template to be inserted
+ * by code completion.
+ */
+ CXCompletionChunk_Informative,
+ /**
+ * Text that describes the current parameter when code-completion is
+ * referring to function call, message send, or template specialization.
+ *
+ * A "current parameter" chunk occurs when code-completion is providing
+ * information about a parameter corresponding to the argument at the
+ * code-completion point. For example, given a function
+ *
+ * \code
+ * int add(int x, int y);
+ * \endcode
+ *
+ * and the source code \c add(, where the code-completion point is after the
+ * "(", the code-completion string will contain a "current parameter" chunk
+ * for "int x", indicating that the current argument will initialize that
+ * parameter. After typing further, to \c add(17, (where the code-completion
+ * point is after the ","), the code-completion string will contain a
+ * "current parameter" chunk to "int y".
+ */
+ CXCompletionChunk_CurrentParameter,
+ /**
+ * A left parenthesis ('('), used to initiate a function call or
+ * signal the beginning of a function parameter list.
+ */
+ CXCompletionChunk_LeftParen,
+ /**
+ * A right parenthesis (')'), used to finish a function call or
+ * signal the end of a function parameter list.
+ */
+ CXCompletionChunk_RightParen,
+ /**
+ * A left bracket ('[').
+ */
+ CXCompletionChunk_LeftBracket,
+ /**
+ * A right bracket (']').
+ */
+ CXCompletionChunk_RightBracket,
+ /**
+ * A left brace ('{').
+ */
+ CXCompletionChunk_LeftBrace,
+ /**
+ * A right brace ('}').
+ */
+ CXCompletionChunk_RightBrace,
+ /**
+ * A left angle bracket ('<').
+ */
+ CXCompletionChunk_LeftAngle,
+ /**
+ * A right angle bracket ('>').
+ */
+ CXCompletionChunk_RightAngle,
+ /**
+ * A comma separator (',').
+ */
+ CXCompletionChunk_Comma,
+ /**
+ * Text that specifies the result type of a given result.
+ *
+ * This special kind of informative chunk is not meant to be inserted into
+ * the text buffer. Rather, it is meant to illustrate the type that an
+ * expression using the given completion string would have.
+ */
+ CXCompletionChunk_ResultType,
+ /**
+ * A colon (':').
+ */
+ CXCompletionChunk_Colon,
+ /**
+ * A semicolon (';').
+ */
+ CXCompletionChunk_SemiColon,
+ /**
+ * An '=' sign.
+ */
+ CXCompletionChunk_Equal,
+ /**
+ * Horizontal space (' ').
+ */
+ CXCompletionChunk_HorizontalSpace,
+ /**
+ * Vertical space ('\\n'), after which it is generally a good idea to
+ * perform indentation.
+ */
+ CXCompletionChunk_VerticalSpace
+};
+
+/**
+ * Determine the kind of a particular chunk within a completion string.
+ *
+ * \param completion_string the completion string to query.
+ *
+ * \param chunk_number the 0-based index of the chunk in the completion string.
+ *
+ * \returns the kind of the chunk at the index \c chunk_number.
+ */
+CINDEX_LINKAGE enum CXCompletionChunkKind
+clang_getCompletionChunkKind(CXCompletionString completion_string,
+ unsigned chunk_number);
+
+/**
+ * Retrieve the text associated with a particular chunk within a
+ * completion string.
+ *
+ * \param completion_string the completion string to query.
+ *
+ * \param chunk_number the 0-based index of the chunk in the completion string.
+ *
+ * \returns the text associated with the chunk at index \c chunk_number.
+ */
+CINDEX_LINKAGE CXString
+clang_getCompletionChunkText(CXCompletionString completion_string,
+ unsigned chunk_number);
+
+/**
+ * Retrieve the completion string associated with a particular chunk
+ * within a completion string.
+ *
+ * \param completion_string the completion string to query.
+ *
+ * \param chunk_number the 0-based index of the chunk in the completion string.
+ *
+ * \returns the completion string associated with the chunk at index
+ * \c chunk_number.
+ */
+CINDEX_LINKAGE CXCompletionString
+clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
+ unsigned chunk_number);
+
+/**
+ * Retrieve the number of chunks in the given code-completion string.
+ */
+CINDEX_LINKAGE unsigned
+clang_getNumCompletionChunks(CXCompletionString completion_string);
+
+/**
+ * Determine the priority of this code completion.
+ *
+ * The priority of a code completion indicates how likely it is that this
+ * particular completion is the completion that the user will select. The
+ * priority is selected by various internal heuristics.
+ *
+ * \param completion_string The completion string to query.
+ *
+ * \returns The priority of this completion string. Smaller values indicate
+ * higher-priority (more likely) completions.
+ */
+CINDEX_LINKAGE unsigned
+clang_getCompletionPriority(CXCompletionString completion_string);
+
+/**
+ * Determine the availability of the entity that this code-completion
+ * string refers to.
+ *
+ * \param completion_string The completion string to query.
+ *
+ * \returns The availability of the completion string.
+ */
+CINDEX_LINKAGE enum CXAvailabilityKind
+clang_getCompletionAvailability(CXCompletionString completion_string);
+
+/**
+ * Retrieve the number of annotations associated with the given
+ * completion string.
+ *
+ * \param completion_string the completion string to query.
+ *
+ * \returns the number of annotations associated with the given completion
+ * string.
+ */
+CINDEX_LINKAGE unsigned
+clang_getCompletionNumAnnotations(CXCompletionString completion_string);
+
+/**
+ * Retrieve the annotation associated with the given completion string.
+ *
+ * \param completion_string the completion string to query.
+ *
+ * \param annotation_number the 0-based index of the annotation of the
+ * completion string.
+ *
+ * \returns annotation string associated with the completion at index
+ * \c annotation_number, or a NULL string if that annotation is not available.
+ */
+CINDEX_LINKAGE CXString
+clang_getCompletionAnnotation(CXCompletionString completion_string,
+ unsigned annotation_number);
+
+/**
+ * Retrieve the parent context of the given completion string.
+ *
+ * The parent context of a completion string is the semantic parent of
+ * the declaration (if any) that the code completion represents. For example,
+ * a code completion for an Objective-C method would have the method's class
+ * or protocol as its context.
+ *
+ * \param completion_string The code completion string whose parent is
+ * being queried.
+ *
+ * \param kind DEPRECATED: always set to CXCursor_NotImplemented if non-NULL.
+ *
+ * \returns The name of the completion parent, e.g., "NSObject" if
+ * the completion string represents a method in the NSObject class.
+ */
+CINDEX_LINKAGE CXString
+clang_getCompletionParent(CXCompletionString completion_string,
+ enum CXCursorKind *kind);
+
+/**
+ * Retrieve the brief documentation comment attached to the declaration
+ * that corresponds to the given completion string.
+ */
+CINDEX_LINKAGE CXString
+clang_getCompletionBriefComment(CXCompletionString completion_string);
+
+/**
+ * Retrieve a completion string for an arbitrary declaration or macro
+ * definition cursor.
+ *
+ * \param cursor The cursor to query.
+ *
+ * \returns A non-context-sensitive completion string for declaration and macro
+ * definition cursors, or NULL for other kinds of cursors.
+ */
+CINDEX_LINKAGE CXCompletionString
+clang_getCursorCompletionString(CXCursor cursor);
+
+/**
+ * Contains the results of code-completion.
+ *
+ * This data structure contains the results of code completion, as
+ * produced by \c clang_codeCompleteAt(). Its contents must be freed by
+ * \c clang_disposeCodeCompleteResults.
+ */
+typedef struct {
+ /**
+ * The code-completion results.
+ */
+ CXCompletionResult *Results;
+
+ /**
+ * The number of code-completion results stored in the
+ * \c Results array.
+ */
+ unsigned NumResults;
+} CXCodeCompleteResults;
+
+/**
+ * Retrieve the number of fix-its for the given completion index.
+ *
+ * Calling this makes sense only if CXCodeComplete_IncludeCompletionsWithFixIts
+ * option was set.
+ *
+ * \param results The structure keeping all completion results
+ *
+ * \param completion_index The index of the completion
+ *
+ * \return The number of fix-its which must be applied before the completion at
+ * completion_index can be applied
+ */
+CINDEX_LINKAGE unsigned
+clang_getCompletionNumFixIts(CXCodeCompleteResults *results,
+ unsigned completion_index);
+
+/**
+ * Fix-its that *must* be applied before inserting the text for the
+ * corresponding completion.
+ *
+ * By default, clang_codeCompleteAt() only returns completions with empty
+ * fix-its. Extra completions with non-empty fix-its should be explicitly
+ * requested by setting CXCodeComplete_IncludeCompletionsWithFixIts.
+ *
+ * For the clients to be able to compute position of the cursor after applying
+ * fix-its, the following conditions are guaranteed to hold for
+ * replacement_range of the stored fix-its:
+ * - Ranges in the fix-its are guaranteed to never contain the completion
+ * point (or identifier under completion point, if any) inside them, except
+ * at the start or at the end of the range.
+ * - If a fix-it range starts or ends with completion point (or starts or
+ * ends after the identifier under completion point), it will contain at
+ * least one character. It allows to unambiguously recompute completion
+ * point after applying the fix-it.
+ *
+ * The intuition is that provided fix-its change code around the identifier we
+ * complete, but are not allowed to touch the identifier itself or the
+ * completion point. One example of completions with corrections are the ones
+ * replacing '.' with '->' and vice versa:
+ *
+ * std::unique_ptr<std::vector<int>> vec_ptr;
+ * In 'vec_ptr.^', one of the completions is 'push_back', it requires
+ * replacing '.' with '->'.
+ * In 'vec_ptr->^', one of the completions is 'release', it requires
+ * replacing '->' with '.'.
+ *
+ * \param results The structure keeping all completion results
+ *
+ * \param completion_index The index of the completion
+ *
+ * \param fixit_index The index of the fix-it for the completion at
+ * completion_index
+ *
+ * \param replacement_range The fix-it range that must be replaced before the
+ * completion at completion_index can be applied
+ *
+ * \returns The fix-it string that must replace the code at replacement_range
+ * before the completion at completion_index can be applied
+ */
+CINDEX_LINKAGE CXString clang_getCompletionFixIt(
+ CXCodeCompleteResults *results, unsigned completion_index,
+ unsigned fixit_index, CXSourceRange *replacement_range);
+
+/**
+ * Flags that can be passed to \c clang_codeCompleteAt() to
+ * modify its behavior.
+ *
+ * The enumerators in this enumeration can be bitwise-OR'd together to
+ * provide multiple options to \c clang_codeCompleteAt().
+ */
+enum CXCodeComplete_Flags {
+ /**
+ * Whether to include macros within the set of code
+ * completions returned.
+ */
+ CXCodeComplete_IncludeMacros = 0x01,
+
+ /**
+ * Whether to include code patterns for language constructs
+ * within the set of code completions, e.g., for loops.
+ */
+ CXCodeComplete_IncludeCodePatterns = 0x02,
+
+ /**
+ * Whether to include brief documentation within the set of code
+ * completions returned.
+ */
+ CXCodeComplete_IncludeBriefComments = 0x04,
+
+ /**
+ * Whether to speed up completion by omitting top- or namespace-level entities
+ * defined in the preamble. There's no guarantee any particular entity is
+ * omitted. This may be useful if the headers are indexed externally.
+ */
+ CXCodeComplete_SkipPreamble = 0x08,
+
+ /**
+ * Whether to include completions with small
+ * fix-its, e.g. change '.' to '->' on member access, etc.
+ */
+ CXCodeComplete_IncludeCompletionsWithFixIts = 0x10
+};
+
+/**
+ * Bits that represent the context under which completion is occurring.
+ *
+ * The enumerators in this enumeration may be bitwise-OR'd together if multiple
+ * contexts are occurring simultaneously.
+ */
+enum CXCompletionContext {
+ /**
+ * The context for completions is unexposed, as only Clang results
+ * should be included. (This is equivalent to having no context bits set.)
+ */
+ CXCompletionContext_Unexposed = 0,
+
+ /**
+ * Completions for any possible type should be included in the results.
+ */
+ CXCompletionContext_AnyType = 1 << 0,
+
+ /**
+ * Completions for any possible value (variables, function calls, etc.)
+ * should be included in the results.
+ */
+ CXCompletionContext_AnyValue = 1 << 1,
+ /**
+ * Completions for values that resolve to an Objective-C object should
+ * be included in the results.
+ */
+ CXCompletionContext_ObjCObjectValue = 1 << 2,
+ /**
+ * Completions for values that resolve to an Objective-C selector
+ * should be included in the results.
+ */
+ CXCompletionContext_ObjCSelectorValue = 1 << 3,
+ /**
+ * Completions for values that resolve to a C++ class type should be
+ * included in the results.
+ */
+ CXCompletionContext_CXXClassTypeValue = 1 << 4,
+
+ /**
+ * Completions for fields of the member being accessed using the dot
+ * operator should be included in the results.
+ */
+ CXCompletionContext_DotMemberAccess = 1 << 5,
+ /**
+ * Completions for fields of the member being accessed using the arrow
+ * operator should be included in the results.
+ */
+ CXCompletionContext_ArrowMemberAccess = 1 << 6,
+ /**
+ * Completions for properties of the Objective-C object being accessed
+ * using the dot operator should be included in the results.
+ */
+ CXCompletionContext_ObjCPropertyAccess = 1 << 7,
+
+ /**
+ * Completions for enum tags should be included in the results.
+ */
+ CXCompletionContext_EnumTag = 1 << 8,
+ /**
+ * Completions for union tags should be included in the results.
+ */
+ CXCompletionContext_UnionTag = 1 << 9,
+ /**
+ * Completions for struct tags should be included in the results.
+ */
+ CXCompletionContext_StructTag = 1 << 10,
+
+ /**
+ * Completions for C++ class names should be included in the results.
+ */
+ CXCompletionContext_ClassTag = 1 << 11,
+ /**
+ * Completions for C++ namespaces and namespace aliases should be
+ * included in the results.
+ */
+ CXCompletionContext_Namespace = 1 << 12,
+ /**
+ * Completions for C++ nested name specifiers should be included in
+ * the results.
+ */
+ CXCompletionContext_NestedNameSpecifier = 1 << 13,
+
+ /**
+ * Completions for Objective-C interfaces (classes) should be included
+ * in the results.
+ */
+ CXCompletionContext_ObjCInterface = 1 << 14,
+ /**
+ * Completions for Objective-C protocols should be included in
+ * the results.
+ */
+ CXCompletionContext_ObjCProtocol = 1 << 15,
+ /**
+ * Completions for Objective-C categories should be included in
+ * the results.
+ */
+ CXCompletionContext_ObjCCategory = 1 << 16,
+ /**
+ * Completions for Objective-C instance messages should be included
+ * in the results.
+ */
+ CXCompletionContext_ObjCInstanceMessage = 1 << 17,
+ /**
+ * Completions for Objective-C class messages should be included in
+ * the results.
+ */
+ CXCompletionContext_ObjCClassMessage = 1 << 18,
+ /**
+ * Completions for Objective-C selector names should be included in
+ * the results.
+ */
+ CXCompletionContext_ObjCSelectorName = 1 << 19,
+
+ /**
+ * Completions for preprocessor macro names should be included in
+ * the results.
+ */
+ CXCompletionContext_MacroName = 1 << 20,
+
+ /**
+ * Natural language completions should be included in the results.
+ */
+ CXCompletionContext_NaturalLanguage = 1 << 21,
+
+ /**
+ * #include file completions should be included in the results.
+ */
+ CXCompletionContext_IncludedFile = 1 << 22,
+
+ /**
+ * The current context is unknown, so set all contexts.
+ */
+ CXCompletionContext_Unknown = ((1 << 23) - 1)
+};
+
+/**
+ * Returns a default set of code-completion options that can be
+ * passed to\c clang_codeCompleteAt().
+ */
+CINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void);
+
+/**
+ * Perform code completion at a given location in a translation unit.
+ *
+ * This function performs code completion at a particular file, line, and
+ * column within source code, providing results that suggest potential
+ * code snippets based on the context of the completion. The basic model
+ * for code completion is that Clang will parse a complete source file,
+ * performing syntax checking up to the location where code-completion has
+ * been requested. At that point, a special code-completion token is passed
+ * to the parser, which recognizes this token and determines, based on the
+ * current location in the C/Objective-C/C++ grammar and the state of
+ * semantic analysis, what completions to provide. These completions are
+ * returned via a new \c CXCodeCompleteResults structure.
+ *
+ * Code completion itself is meant to be triggered by the client when the
+ * user types punctuation characters or whitespace, at which point the
+ * code-completion location will coincide with the cursor. For example, if \c p
+ * is a pointer, code-completion might be triggered after the "-" and then
+ * after the ">" in \c p->. When the code-completion location is after the ">",
+ * the completion results will provide, e.g., the members of the struct that
+ * "p" points to. The client is responsible for placing the cursor at the
+ * beginning of the token currently being typed, then filtering the results
+ * based on the contents of the token. For example, when code-completing for
+ * the expression \c p->get, the client should provide the location just after
+ * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the
+ * client can filter the results based on the current token text ("get"), only
+ * showing those results that start with "get". The intent of this interface
+ * is to separate the relatively high-latency acquisition of code-completion
+ * results from the filtering of results on a per-character basis, which must
+ * have a lower latency.
+ *
+ * \param TU The translation unit in which code-completion should
+ * occur. The source files for this translation unit need not be
+ * completely up-to-date (and the contents of those source files may
+ * be overridden via \p unsaved_files). Cursors referring into the
+ * translation unit may be invalidated by this invocation.
+ *
+ * \param complete_filename The name of the source file where code
+ * completion should be performed. This filename may be any file
+ * included in the translation unit.
+ *
+ * \param complete_line The line at which code-completion should occur.
+ *
+ * \param complete_column The column at which code-completion should occur.
+ * Note that the column should point just after the syntactic construct that
+ * initiated code completion, and not in the middle of a lexical token.
+ *
+ * \param unsaved_files the Files that have not yet been saved to disk
+ * but may be required for parsing or code completion, including the
+ * contents of those files. The contents and name of these files (as
+ * specified by CXUnsavedFile) are copied when necessary, so the
+ * client only needs to guarantee their validity until the call to
+ * this function returns.
+ *
+ * \param num_unsaved_files The number of unsaved file entries in \p
+ * unsaved_files.
+ *
+ * \param options Extra options that control the behavior of code
+ * completion, expressed as a bitwise OR of the enumerators of the
+ * CXCodeComplete_Flags enumeration. The
+ * \c clang_defaultCodeCompleteOptions() function returns a default set
+ * of code-completion options.
+ *
+ * \returns If successful, a new \c CXCodeCompleteResults structure
+ * containing code-completion results, which should eventually be
+ * freed with \c clang_disposeCodeCompleteResults(). If code
+ * completion fails, returns NULL.
+ */
+CINDEX_LINKAGE
+CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
+ const char *complete_filename,
+ unsigned complete_line,
+ unsigned complete_column,
+ struct CXUnsavedFile *unsaved_files,
+ unsigned num_unsaved_files,
+ unsigned options);
+
+/**
+ * Sort the code-completion results in case-insensitive alphabetical
+ * order.
+ *
+ * \param Results The set of results to sort.
+ * \param NumResults The number of results in \p Results.
+ */
+CINDEX_LINKAGE
+void clang_sortCodeCompletionResults(CXCompletionResult *Results,
+ unsigned NumResults);
+
+/**
+ * Free the given set of code-completion results.
+ */
+CINDEX_LINKAGE
+void clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results);
+
+/**
+ * Determine the number of diagnostics produced prior to the
+ * location where code completion was performed.
+ */
+CINDEX_LINKAGE
+unsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results);
+
+/**
+ * Retrieve a diagnostic associated with the given code completion.
+ *
+ * \param Results the code completion results to query.
+ * \param Index the zero-based diagnostic number to retrieve.
+ *
+ * \returns the requested diagnostic. This diagnostic must be freed
+ * via a call to \c clang_disposeDiagnostic().
+ */
+CINDEX_LINKAGE
+CXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results,
+ unsigned Index);
+
+/**
+ * Determines what completions are appropriate for the context
+ * the given code completion.
+ *
+ * \param Results the code completion results to query
+ *
+ * \returns the kinds of completions that are appropriate for use
+ * along with the given code completion results.
+ */
+CINDEX_LINKAGE
+unsigned long long clang_codeCompleteGetContexts(
+ CXCodeCompleteResults *Results);
+
+/**
+ * Returns the cursor kind for the container for the current code
+ * completion context. The container is only guaranteed to be set for
+ * contexts where a container exists (i.e. member accesses or Objective-C
+ * message sends); if there is not a container, this function will return
+ * CXCursor_InvalidCode.
+ *
+ * \param Results the code completion results to query
+ *
+ * \param IsIncomplete on return, this value will be false if Clang has complete
+ * information about the container. If Clang does not have complete
+ * information, this value will be true.
+ *
+ * \returns the container kind, or CXCursor_InvalidCode if there is not a
+ * container
+ */
+CINDEX_LINKAGE
+enum CXCursorKind clang_codeCompleteGetContainerKind(
+ CXCodeCompleteResults *Results,
+ unsigned *IsIncomplete);
+
+/**
+ * Returns the USR for the container for the current code completion
+ * context. If there is not a container for the current context, this
+ * function will return the empty string.
+ *
+ * \param Results the code completion results to query
+ *
+ * \returns the USR for the container
+ */
+CINDEX_LINKAGE
+CXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *Results);
+
+/**
+ * Returns the currently-entered selector for an Objective-C message
+ * send, formatted like "initWithFoo:bar:". Only guaranteed to return a
+ * non-empty string for CXCompletionContext_ObjCInstanceMessage and
+ * CXCompletionContext_ObjCClassMessage.
+ *
+ * \param Results the code completion results to query
+ *
+ * \returns the selector (or partial selector) that has been entered thus far
+ * for an Objective-C message send.
+ */
+CINDEX_LINKAGE
+CXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *Results);
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup CINDEX_MISC Miscellaneous utility functions
+ *
+ * @{
+ */
+
+/**
+ * Return a version string, suitable for showing to a user, but not
+ * intended to be parsed (the format is not guaranteed to be stable).
+ */
+CINDEX_LINKAGE CXString clang_getClangVersion(void);
+
+/**
+ * Enable/disable crash recovery.
+ *
+ * \param isEnabled Flag to indicate if crash recovery is enabled. A non-zero
+ * value enables crash recovery, while 0 disables it.
+ */
+CINDEX_LINKAGE void clang_toggleCrashRecovery(unsigned isEnabled);
+
+ /**
+ * Visitor invoked for each file in a translation unit
+ * (used with clang_getInclusions()).
+ *
+ * This visitor function will be invoked by clang_getInclusions() for each
+ * file included (either at the top-level or by \#include directives) within
+ * a translation unit. The first argument is the file being included, and
+ * the second and third arguments provide the inclusion stack. The
+ * array is sorted in order of immediate inclusion. For example,
+ * the first element refers to the location that included 'included_file'.
+ */
+typedef void (*CXInclusionVisitor)(CXFile included_file,
+ CXSourceLocation* inclusion_stack,
+ unsigned include_len,
+ CXClientData client_data);
+
+/**
+ * Visit the set of preprocessor inclusions in a translation unit.
+ * The visitor function is called with the provided data for every included
+ * file. This does not include headers included by the PCH file (unless one
+ * is inspecting the inclusions in the PCH file itself).
+ */
+CINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu,
+ CXInclusionVisitor visitor,
+ CXClientData client_data);
+
+typedef enum {
+ CXEval_Int = 1 ,
+ CXEval_Float = 2,
+ CXEval_ObjCStrLiteral = 3,
+ CXEval_StrLiteral = 4,
+ CXEval_CFStr = 5,
+ CXEval_Other = 6,
+
+ CXEval_UnExposed = 0
+
+} CXEvalResultKind ;
+
+/**
+ * Evaluation result of a cursor
+ */
+typedef void * CXEvalResult;
+
+/**
+ * If cursor is a statement declaration tries to evaluate the
+ * statement and if its variable, tries to evaluate its initializer,
+ * into its corresponding type.
+ */
+CINDEX_LINKAGE CXEvalResult clang_Cursor_Evaluate(CXCursor C);
+
+/**
+ * Returns the kind of the evaluated result.
+ */
+CINDEX_LINKAGE CXEvalResultKind clang_EvalResult_getKind(CXEvalResult E);
+
+/**
+ * Returns the evaluation result as integer if the
+ * kind is Int.
+ */
+CINDEX_LINKAGE int clang_EvalResult_getAsInt(CXEvalResult E);
+
+/**
+ * Returns the evaluation result as a long long integer if the
+ * kind is Int. This prevents overflows that may happen if the result is
+ * returned with clang_EvalResult_getAsInt.
+ */
+CINDEX_LINKAGE long long clang_EvalResult_getAsLongLong(CXEvalResult E);
+
+/**
+ * Returns a non-zero value if the kind is Int and the evaluation
+ * result resulted in an unsigned integer.
+ */
+CINDEX_LINKAGE unsigned clang_EvalResult_isUnsignedInt(CXEvalResult E);
+
+/**
+ * Returns the evaluation result as an unsigned integer if
+ * the kind is Int and clang_EvalResult_isUnsignedInt is non-zero.
+ */
+CINDEX_LINKAGE unsigned long long clang_EvalResult_getAsUnsigned(CXEvalResult E);
+
+/**
+ * Returns the evaluation result as double if the
+ * kind is double.
+ */
+CINDEX_LINKAGE double clang_EvalResult_getAsDouble(CXEvalResult E);
+
+/**
+ * Returns the evaluation result as a constant string if the
+ * kind is other than Int or float. User must not free this pointer,
+ * instead call clang_EvalResult_dispose on the CXEvalResult returned
+ * by clang_Cursor_Evaluate.
+ */
+CINDEX_LINKAGE const char* clang_EvalResult_getAsStr(CXEvalResult E);
+
+/**
+ * Disposes the created Eval memory.
+ */
+CINDEX_LINKAGE void clang_EvalResult_dispose(CXEvalResult E);
+/**
+ * @}
+ */
+
+/** \defgroup CINDEX_REMAPPING Remapping functions
+ *
+ * @{
+ */
+
+/**
+ * A remapping of original source files and their translated files.
+ */
+typedef void *CXRemapping;
+
+/**
+ * Retrieve a remapping.
+ *
+ * \param path the path that contains metadata about remappings.
+ *
+ * \returns the requested remapping. This remapping must be freed
+ * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
+ */
+CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path);
+
+/**
+ * Retrieve a remapping.
+ *
+ * \param filePaths pointer to an array of file paths containing remapping info.
+ *
+ * \param numFiles number of file paths.
+ *
+ * \returns the requested remapping. This remapping must be freed
+ * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
+ */
+CINDEX_LINKAGE
+CXRemapping clang_getRemappingsFromFileList(const char **filePaths,
+ unsigned numFiles);
+
+/**
+ * Determine the number of remappings.
+ */
+CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping);
+
+/**
+ * Get the original and the associated filename from the remapping.
+ *
+ * \param original If non-NULL, will be set to the original filename.
+ *
+ * \param transformed If non-NULL, will be set to the filename that the original
+ * is associated with.
+ */
+CINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index,
+ CXString *original, CXString *transformed);
+
+/**
+ * Dispose the remapping.
+ */
+CINDEX_LINKAGE void clang_remap_dispose(CXRemapping);
+
+/**
+ * @}
+ */
+
+/** \defgroup CINDEX_HIGH Higher level API functions
+ *
+ * @{
+ */
+
+enum CXVisitorResult {
+ CXVisit_Break,
+ CXVisit_Continue
+};
+
+typedef struct CXCursorAndRangeVisitor {
+ void *context;
+ enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange);
+} CXCursorAndRangeVisitor;
+
+typedef enum {
+ /**
+ * Function returned successfully.
+ */
+ CXResult_Success = 0,
+ /**
+ * One of the parameters was invalid for the function.
+ */
+ CXResult_Invalid = 1,
+ /**
+ * The function was terminated by a callback (e.g. it returned
+ * CXVisit_Break)
+ */
+ CXResult_VisitBreak = 2
+
+} CXResult;
+
+/**
+ * Find references of a declaration in a specific file.
+ *
+ * \param cursor pointing to a declaration or a reference of one.
+ *
+ * \param file to search for references.
+ *
+ * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
+ * each reference found.
+ * The CXSourceRange will point inside the file; if the reference is inside
+ * a macro (and not a macro argument) the CXSourceRange will be invalid.
+ *
+ * \returns one of the CXResult enumerators.
+ */
+CINDEX_LINKAGE CXResult clang_findReferencesInFile(CXCursor cursor, CXFile file,
+ CXCursorAndRangeVisitor visitor);
+
+/**
+ * Find #import/#include directives in a specific file.
+ *
+ * \param TU translation unit containing the file to query.
+ *
+ * \param file to search for #import/#include directives.
+ *
+ * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
+ * each directive found.
+ *
+ * \returns one of the CXResult enumerators.
+ */
+CINDEX_LINKAGE CXResult clang_findIncludesInFile(CXTranslationUnit TU,
+ CXFile file,
+ CXCursorAndRangeVisitor visitor);
+
+#ifdef __has_feature
+# if __has_feature(blocks)
+
+typedef enum CXVisitorResult
+ (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange);
+
+CINDEX_LINKAGE
+CXResult clang_findReferencesInFileWithBlock(CXCursor, CXFile,
+ CXCursorAndRangeVisitorBlock);
+
+CINDEX_LINKAGE
+CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit, CXFile,
+ CXCursorAndRangeVisitorBlock);
+
+# endif
+#endif
+
+/**
+ * The client's data object that is associated with a CXFile.
+ */
+typedef void *CXIdxClientFile;
+
+/**
+ * The client's data object that is associated with a semantic entity.
+ */
+typedef void *CXIdxClientEntity;
+
+/**
+ * The client's data object that is associated with a semantic container
+ * of entities.
+ */
+typedef void *CXIdxClientContainer;
+
+/**
+ * The client's data object that is associated with an AST file (PCH
+ * or module).
+ */
+typedef void *CXIdxClientASTFile;
+
+/**
+ * Source location passed to index callbacks.
+ */
+typedef struct {
+ void *ptr_data[2];
+ unsigned int_data;
+} CXIdxLoc;
+
+/**
+ * Data for ppIncludedFile callback.
+ */
+typedef struct {
+ /**
+ * Location of '#' in the \#include/\#import directive.
+ */
+ CXIdxLoc hashLoc;
+ /**
+ * Filename as written in the \#include/\#import directive.
+ */
+ const char *filename;
+ /**
+ * The actual file that the \#include/\#import directive resolved to.
+ */
+ CXFile file;
+ int isImport;
+ int isAngled;
+ /**
+ * Non-zero if the directive was automatically turned into a module
+ * import.
+ */
+ int isModuleImport;
+} CXIdxIncludedFileInfo;
+
+/**
+ * Data for IndexerCallbacks#importedASTFile.
+ */
+typedef struct {
+ /**
+ * Top level AST file containing the imported PCH, module or submodule.
+ */
+ CXFile file;
+ /**
+ * The imported module or NULL if the AST file is a PCH.
+ */
+ CXModule module;
+ /**
+ * Location where the file is imported. Applicable only for modules.
+ */
+ CXIdxLoc loc;
+ /**
+ * Non-zero if an inclusion directive was automatically turned into
+ * a module import. Applicable only for modules.
+ */
+ int isImplicit;
+
+} CXIdxImportedASTFileInfo;
+
+typedef enum {
+ CXIdxEntity_Unexposed = 0,
+ CXIdxEntity_Typedef = 1,
+ CXIdxEntity_Function = 2,
+ CXIdxEntity_Variable = 3,
+ CXIdxEntity_Field = 4,
+ CXIdxEntity_EnumConstant = 5,
+
+ CXIdxEntity_ObjCClass = 6,
+ CXIdxEntity_ObjCProtocol = 7,
+ CXIdxEntity_ObjCCategory = 8,
+
+ CXIdxEntity_ObjCInstanceMethod = 9,
+ CXIdxEntity_ObjCClassMethod = 10,
+ CXIdxEntity_ObjCProperty = 11,
+ CXIdxEntity_ObjCIvar = 12,
+
+ CXIdxEntity_Enum = 13,
+ CXIdxEntity_Struct = 14,
+ CXIdxEntity_Union = 15,
+
+ CXIdxEntity_CXXClass = 16,
+ CXIdxEntity_CXXNamespace = 17,
+ CXIdxEntity_CXXNamespaceAlias = 18,
+ CXIdxEntity_CXXStaticVariable = 19,
+ CXIdxEntity_CXXStaticMethod = 20,
+ CXIdxEntity_CXXInstanceMethod = 21,
+ CXIdxEntity_CXXConstructor = 22,
+ CXIdxEntity_CXXDestructor = 23,
+ CXIdxEntity_CXXConversionFunction = 24,
+ CXIdxEntity_CXXTypeAlias = 25,
+ CXIdxEntity_CXXInterface = 26
+
+} CXIdxEntityKind;
+
+typedef enum {
+ CXIdxEntityLang_None = 0,
+ CXIdxEntityLang_C = 1,
+ CXIdxEntityLang_ObjC = 2,
+ CXIdxEntityLang_CXX = 3,
+ CXIdxEntityLang_Swift = 4
+} CXIdxEntityLanguage;
+
+/**
+ * Extra C++ template information for an entity. This can apply to:
+ * CXIdxEntity_Function
+ * CXIdxEntity_CXXClass
+ * CXIdxEntity_CXXStaticMethod
+ * CXIdxEntity_CXXInstanceMethod
+ * CXIdxEntity_CXXConstructor
+ * CXIdxEntity_CXXConversionFunction
+ * CXIdxEntity_CXXTypeAlias
+ */
+typedef enum {
+ CXIdxEntity_NonTemplate = 0,
+ CXIdxEntity_Template = 1,
+ CXIdxEntity_TemplatePartialSpecialization = 2,
+ CXIdxEntity_TemplateSpecialization = 3
+} CXIdxEntityCXXTemplateKind;
+
+typedef enum {
+ CXIdxAttr_Unexposed = 0,
+ CXIdxAttr_IBAction = 1,
+ CXIdxAttr_IBOutlet = 2,
+ CXIdxAttr_IBOutletCollection = 3
+} CXIdxAttrKind;
+
+typedef struct {
+ CXIdxAttrKind kind;
+ CXCursor cursor;
+ CXIdxLoc loc;
+} CXIdxAttrInfo;
+
+typedef struct {
+ CXIdxEntityKind kind;
+ CXIdxEntityCXXTemplateKind templateKind;
+ CXIdxEntityLanguage lang;
+ const char *name;
+ const char *USR;
+ CXCursor cursor;
+ const CXIdxAttrInfo *const *attributes;
+ unsigned numAttributes;
+} CXIdxEntityInfo;
+
+typedef struct {
+ CXCursor cursor;
+} CXIdxContainerInfo;
+
+typedef struct {
+ const CXIdxAttrInfo *attrInfo;
+ const CXIdxEntityInfo *objcClass;
+ CXCursor classCursor;
+ CXIdxLoc classLoc;
+} CXIdxIBOutletCollectionAttrInfo;
+
+typedef enum {
+ CXIdxDeclFlag_Skipped = 0x1
+} CXIdxDeclInfoFlags;
+
+typedef struct {
+ const CXIdxEntityInfo *entityInfo;
+ CXCursor cursor;
+ CXIdxLoc loc;
+ const CXIdxContainerInfo *semanticContainer;
+ /**
+ * Generally same as #semanticContainer but can be different in
+ * cases like out-of-line C++ member functions.
+ */
+ const CXIdxContainerInfo *lexicalContainer;
+ int isRedeclaration;
+ int isDefinition;
+ int isContainer;
+ const CXIdxContainerInfo *declAsContainer;
+ /**
+ * Whether the declaration exists in code or was created implicitly
+ * by the compiler, e.g. implicit Objective-C methods for properties.
+ */
+ int isImplicit;
+ const CXIdxAttrInfo *const *attributes;
+ unsigned numAttributes;
+
+ unsigned flags;
+
+} CXIdxDeclInfo;
+
+typedef enum {
+ CXIdxObjCContainer_ForwardRef = 0,
+ CXIdxObjCContainer_Interface = 1,
+ CXIdxObjCContainer_Implementation = 2
+} CXIdxObjCContainerKind;
+
+typedef struct {
+ const CXIdxDeclInfo *declInfo;
+ CXIdxObjCContainerKind kind;
+} CXIdxObjCContainerDeclInfo;
+
+typedef struct {
+ const CXIdxEntityInfo *base;
+ CXCursor cursor;
+ CXIdxLoc loc;
+} CXIdxBaseClassInfo;
+
+typedef struct {
+ const CXIdxEntityInfo *protocol;
+ CXCursor cursor;
+ CXIdxLoc loc;
+} CXIdxObjCProtocolRefInfo;
+
+typedef struct {
+ const CXIdxObjCProtocolRefInfo *const *protocols;
+ unsigned numProtocols;
+} CXIdxObjCProtocolRefListInfo;
+
+typedef struct {
+ const CXIdxObjCContainerDeclInfo *containerInfo;
+ const CXIdxBaseClassInfo *superInfo;
+ const CXIdxObjCProtocolRefListInfo *protocols;
+} CXIdxObjCInterfaceDeclInfo;
+
+typedef struct {
+ const CXIdxObjCContainerDeclInfo *containerInfo;
+ const CXIdxEntityInfo *objcClass;
+ CXCursor classCursor;
+ CXIdxLoc classLoc;
+ const CXIdxObjCProtocolRefListInfo *protocols;
+} CXIdxObjCCategoryDeclInfo;
+
+typedef struct {
+ const CXIdxDeclInfo *declInfo;
+ const CXIdxEntityInfo *getter;
+ const CXIdxEntityInfo *setter;
+} CXIdxObjCPropertyDeclInfo;
+
+typedef struct {
+ const CXIdxDeclInfo *declInfo;
+ const CXIdxBaseClassInfo *const *bases;
+ unsigned numBases;
+} CXIdxCXXClassDeclInfo;
+
+/**
+ * Data for IndexerCallbacks#indexEntityReference.
+ *
+ * This may be deprecated in a future version as this duplicates
+ * the \c CXSymbolRole_Implicit bit in \c CXSymbolRole.
+ */
+typedef enum {
+ /**
+ * The entity is referenced directly in user's code.
+ */
+ CXIdxEntityRef_Direct = 1,
+ /**
+ * An implicit reference, e.g. a reference of an Objective-C method
+ * via the dot syntax.
+ */
+ CXIdxEntityRef_Implicit = 2
+} CXIdxEntityRefKind;
+
+/**
+ * Roles that are attributed to symbol occurrences.
+ *
+ * Internal: this currently mirrors low 9 bits of clang::index::SymbolRole with
+ * higher bits zeroed. These high bits may be exposed in the future.
+ */
+typedef enum {
+ CXSymbolRole_None = 0,
+ CXSymbolRole_Declaration = 1 << 0,
+ CXSymbolRole_Definition = 1 << 1,
+ CXSymbolRole_Reference = 1 << 2,
+ CXSymbolRole_Read = 1 << 3,
+ CXSymbolRole_Write = 1 << 4,
+ CXSymbolRole_Call = 1 << 5,
+ CXSymbolRole_Dynamic = 1 << 6,
+ CXSymbolRole_AddressOf = 1 << 7,
+ CXSymbolRole_Implicit = 1 << 8
+} CXSymbolRole;
+
+/**
+ * Data for IndexerCallbacks#indexEntityReference.
+ */
+typedef struct {
+ CXIdxEntityRefKind kind;
+ /**
+ * Reference cursor.
+ */
+ CXCursor cursor;
+ CXIdxLoc loc;
+ /**
+ * The entity that gets referenced.
+ */
+ const CXIdxEntityInfo *referencedEntity;
+ /**
+ * Immediate "parent" of the reference. For example:
+ *
+ * \code
+ * Foo *var;
+ * \endcode
+ *
+ * The parent of reference of type 'Foo' is the variable 'var'.
+ * For references inside statement bodies of functions/methods,
+ * the parentEntity will be the function/method.
+ */
+ const CXIdxEntityInfo *parentEntity;
+ /**
+ * Lexical container context of the reference.
+ */
+ const CXIdxContainerInfo *container;
+ /**
+ * Sets of symbol roles of the reference.
+ */
+ CXSymbolRole role;
+} CXIdxEntityRefInfo;
+
+/**
+ * A group of callbacks used by #clang_indexSourceFile and
+ * #clang_indexTranslationUnit.
+ */
+typedef struct {
+ /**
+ * Called periodically to check whether indexing should be aborted.
+ * Should return 0 to continue, and non-zero to abort.
+ */
+ int (*abortQuery)(CXClientData client_data, void *reserved);
+
+ /**
+ * Called at the end of indexing; passes the complete diagnostic set.
+ */
+ void (*diagnostic)(CXClientData client_data,
+ CXDiagnosticSet, void *reserved);
+
+ CXIdxClientFile (*enteredMainFile)(CXClientData client_data,
+ CXFile mainFile, void *reserved);
+
+ /**
+ * Called when a file gets \#included/\#imported.
+ */
+ CXIdxClientFile (*ppIncludedFile)(CXClientData client_data,
+ const CXIdxIncludedFileInfo *);
+
+ /**
+ * Called when a AST file (PCH or module) gets imported.
+ *
+ * AST files will not get indexed (there will not be callbacks to index all
+ * the entities in an AST file). The recommended action is that, if the AST
+ * file is not already indexed, to initiate a new indexing job specific to
+ * the AST file.
+ */
+ CXIdxClientASTFile (*importedASTFile)(CXClientData client_data,
+ const CXIdxImportedASTFileInfo *);
+
+ /**
+ * Called at the beginning of indexing a translation unit.
+ */
+ CXIdxClientContainer (*startedTranslationUnit)(CXClientData client_data,
+ void *reserved);
+
+ void (*indexDeclaration)(CXClientData client_data,
+ const CXIdxDeclInfo *);
+
+ /**
+ * Called to index a reference of an entity.
+ */
+ void (*indexEntityReference)(CXClientData client_data,
+ const CXIdxEntityRefInfo *);
+
+} IndexerCallbacks;
+
+CINDEX_LINKAGE int clang_index_isEntityObjCContainerKind(CXIdxEntityKind);
+CINDEX_LINKAGE const CXIdxObjCContainerDeclInfo *
+clang_index_getObjCContainerDeclInfo(const CXIdxDeclInfo *);
+
+CINDEX_LINKAGE const CXIdxObjCInterfaceDeclInfo *
+clang_index_getObjCInterfaceDeclInfo(const CXIdxDeclInfo *);
+
+CINDEX_LINKAGE
+const CXIdxObjCCategoryDeclInfo *
+clang_index_getObjCCategoryDeclInfo(const CXIdxDeclInfo *);
+
+CINDEX_LINKAGE const CXIdxObjCProtocolRefListInfo *
+clang_index_getObjCProtocolRefListInfo(const CXIdxDeclInfo *);
+
+CINDEX_LINKAGE const CXIdxObjCPropertyDeclInfo *
+clang_index_getObjCPropertyDeclInfo(const CXIdxDeclInfo *);
+
+CINDEX_LINKAGE const CXIdxIBOutletCollectionAttrInfo *
+clang_index_getIBOutletCollectionAttrInfo(const CXIdxAttrInfo *);
+
+CINDEX_LINKAGE const CXIdxCXXClassDeclInfo *
+clang_index_getCXXClassDeclInfo(const CXIdxDeclInfo *);
+
+/**
+ * For retrieving a custom CXIdxClientContainer attached to a
+ * container.
+ */
+CINDEX_LINKAGE CXIdxClientContainer
+clang_index_getClientContainer(const CXIdxContainerInfo *);
+
+/**
+ * For setting a custom CXIdxClientContainer attached to a
+ * container.
+ */
+CINDEX_LINKAGE void
+clang_index_setClientContainer(const CXIdxContainerInfo *,CXIdxClientContainer);
+
+/**
+ * For retrieving a custom CXIdxClientEntity attached to an entity.
+ */
+CINDEX_LINKAGE CXIdxClientEntity
+clang_index_getClientEntity(const CXIdxEntityInfo *);
+
+/**
+ * For setting a custom CXIdxClientEntity attached to an entity.
+ */
+CINDEX_LINKAGE void
+clang_index_setClientEntity(const CXIdxEntityInfo *, CXIdxClientEntity);
+
+/**
+ * An indexing action/session, to be applied to one or multiple
+ * translation units.
+ */
+typedef void *CXIndexAction;
+
+/**
+ * An indexing action/session, to be applied to one or multiple
+ * translation units.
+ *
+ * \param CIdx The index object with which the index action will be associated.
+ */
+CINDEX_LINKAGE CXIndexAction clang_IndexAction_create(CXIndex CIdx);
+
+/**
+ * Destroy the given index action.
+ *
+ * The index action must not be destroyed until all of the translation units
+ * created within that index action have been destroyed.
+ */
+CINDEX_LINKAGE void clang_IndexAction_dispose(CXIndexAction);
+
+typedef enum {
+ /**
+ * Used to indicate that no special indexing options are needed.
+ */
+ CXIndexOpt_None = 0x0,
+
+ /**
+ * Used to indicate that IndexerCallbacks#indexEntityReference should
+ * be invoked for only one reference of an entity per source file that does
+ * not also include a declaration/definition of the entity.
+ */
+ CXIndexOpt_SuppressRedundantRefs = 0x1,
+
+ /**
+ * Function-local symbols should be indexed. If this is not set
+ * function-local symbols will be ignored.
+ */
+ CXIndexOpt_IndexFunctionLocalSymbols = 0x2,
+
+ /**
+ * Implicit function/class template instantiations should be indexed.
+ * If this is not set, implicit instantiations will be ignored.
+ */
+ CXIndexOpt_IndexImplicitTemplateInstantiations = 0x4,
+
+ /**
+ * Suppress all compiler warnings when parsing for indexing.
+ */
+ CXIndexOpt_SuppressWarnings = 0x8,
+
+ /**
+ * Skip a function/method body that was already parsed during an
+ * indexing session associated with a \c CXIndexAction object.
+ * Bodies in system headers are always skipped.
+ */
+ CXIndexOpt_SkipParsedBodiesInSession = 0x10
+
+} CXIndexOptFlags;
+
+/**
+ * Index the given source file and the translation unit corresponding
+ * to that file via callbacks implemented through #IndexerCallbacks.
+ *
+ * \param client_data pointer data supplied by the client, which will
+ * be passed to the invoked callbacks.
+ *
+ * \param index_callbacks Pointer to indexing callbacks that the client
+ * implements.
+ *
+ * \param index_callbacks_size Size of #IndexerCallbacks structure that gets
+ * passed in index_callbacks.
+ *
+ * \param index_options A bitmask of options that affects how indexing is
+ * performed. This should be a bitwise OR of the CXIndexOpt_XXX flags.
+ *
+ * \param[out] out_TU pointer to store a \c CXTranslationUnit that can be
+ * reused after indexing is finished. Set to \c NULL if you do not require it.
+ *
+ * \returns 0 on success or if there were errors from which the compiler could
+ * recover. If there is a failure from which there is no recovery, returns
+ * a non-zero \c CXErrorCode.
+ *
+ * The rest of the parameters are the same as #clang_parseTranslationUnit.
+ */
+CINDEX_LINKAGE int clang_indexSourceFile(CXIndexAction,
+ CXClientData client_data,
+ IndexerCallbacks *index_callbacks,
+ unsigned index_callbacks_size,
+ unsigned index_options,
+ const char *source_filename,
+ const char * const *command_line_args,
+ int num_command_line_args,
+ struct CXUnsavedFile *unsaved_files,
+ unsigned num_unsaved_files,
+ CXTranslationUnit *out_TU,
+ unsigned TU_options);
+
+/**
+ * Same as clang_indexSourceFile but requires a full command line
+ * for \c command_line_args including argv[0]. This is useful if the standard
+ * library paths are relative to the binary.
+ */
+CINDEX_LINKAGE int clang_indexSourceFileFullArgv(
+ CXIndexAction, CXClientData client_data, IndexerCallbacks *index_callbacks,
+ unsigned index_callbacks_size, unsigned index_options,
+ const char *source_filename, const char *const *command_line_args,
+ int num_command_line_args, struct CXUnsavedFile *unsaved_files,
+ unsigned num_unsaved_files, CXTranslationUnit *out_TU, unsigned TU_options);
+
+/**
+ * Index the given translation unit via callbacks implemented through
+ * #IndexerCallbacks.
+ *
+ * The order of callback invocations is not guaranteed to be the same as
+ * when indexing a source file. The high level order will be:
+ *
+ * -Preprocessor callbacks invocations
+ * -Declaration/reference callbacks invocations
+ * -Diagnostic callback invocations
+ *
+ * The parameters are the same as #clang_indexSourceFile.
+ *
+ * \returns If there is a failure from which there is no recovery, returns
+ * non-zero, otherwise returns 0.
+ */
+CINDEX_LINKAGE int clang_indexTranslationUnit(CXIndexAction,
+ CXClientData client_data,
+ IndexerCallbacks *index_callbacks,
+ unsigned index_callbacks_size,
+ unsigned index_options,
+ CXTranslationUnit);
+
+/**
+ * Retrieve the CXIdxFile, file, line, column, and offset represented by
+ * the given CXIdxLoc.
+ *
+ * If the location refers into a macro expansion, retrieves the
+ * location of the macro expansion and if it refers into a macro argument
+ * retrieves the location of the argument.
+ */
+CINDEX_LINKAGE void clang_indexLoc_getFileLocation(CXIdxLoc loc,
+ CXIdxClientFile *indexFile,
+ CXFile *file,
+ unsigned *line,
+ unsigned *column,
+ unsigned *offset);
+
+/**
+ * Retrieve the CXSourceLocation represented by the given CXIdxLoc.
+ */
+CINDEX_LINKAGE
+CXSourceLocation clang_indexLoc_getCXSourceLocation(CXIdxLoc loc);
+
+/**
+ * Visitor invoked for each field found by a traversal.
+ *
+ * This visitor function will be invoked for each field found by
+ * \c clang_Type_visitFields. Its first argument is the cursor being
+ * visited, its second argument is the client data provided to
+ * \c clang_Type_visitFields.
+ *
+ * The visitor should return one of the \c CXVisitorResult values
+ * to direct \c clang_Type_visitFields.
+ */
+typedef enum CXVisitorResult (*CXFieldVisitor)(CXCursor C,
+ CXClientData client_data);
+
+/**
+ * Visit the fields of a particular type.
+ *
+ * This function visits all the direct fields of the given cursor,
+ * invoking the given \p visitor function with the cursors of each
+ * visited field. The traversal may be ended prematurely, if
+ * the visitor returns \c CXFieldVisit_Break.
+ *
+ * \param T the record type whose field may be visited.
+ *
+ * \param visitor the visitor function that will be invoked for each
+ * field of \p T.
+ *
+ * \param client_data pointer data supplied by the client, which will
+ * be passed to the visitor each time it is invoked.
+ *
+ * \returns a non-zero value if the traversal was terminated
+ * prematurely by the visitor returning \c CXFieldVisit_Break.
+ */
+CINDEX_LINKAGE unsigned clang_Type_visitFields(CXType T,
+ CXFieldVisitor visitor,
+ CXClientData client_data);
+
+/**
+ * @}
+ */
+
+/**
+ * @}
+ */
+
+LLVM_CLANG_C_EXTERN_C_END
+
+#endif
diff --git a/third_party/libclang/include/clang-c/Platform.h b/third_party/libclang/include/clang-c/Platform.h
new file mode 100644
index 0000000..3bb66bb
--- /dev/null
+++ b/third_party/libclang/include/clang-c/Platform.h
@@ -0,0 +1,44 @@
+/*===-- clang-c/Platform.h - C Index platform decls -------------*- C -*-===*\
+|* *|
+|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
+|* Exceptions. *|
+|* See https://llvm.org/LICENSE.txt for license information. *|
+|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
+|* *|
+|*===----------------------------------------------------------------------===*|
+|* *|
+|* This header provides platform specific macros (dllimport, deprecated, ...) *|
+|* *|
+\*===----------------------------------------------------------------------===*/
+
+#ifndef LLVM_CLANG_C_PLATFORM_H
+#define LLVM_CLANG_C_PLATFORM_H
+
+#include "clang-c/ExternC.h"
+
+LLVM_CLANG_C_EXTERN_C_BEGIN
+
+/* MSVC DLL import/export. */
+#ifdef _MSC_VER
+ #ifdef _CINDEX_LIB_
+ #define CINDEX_LINKAGE __declspec(dllexport)
+ #else
+ #define CINDEX_LINKAGE __declspec(dllimport)
+ #endif
+#else
+ #define CINDEX_LINKAGE
+#endif
+
+#ifdef __GNUC__
+ #define CINDEX_DEPRECATED __attribute__((deprecated))
+#else
+ #ifdef _MSC_VER
+ #define CINDEX_DEPRECATED __declspec(deprecated)
+ #else
+ #define CINDEX_DEPRECATED
+ #endif
+#endif
+
+LLVM_CLANG_C_EXTERN_C_END
+
+#endif
diff --git a/third_party/sqlite/sqlite3.h b/third_party/sqlite/sqlite3.h
new file mode 100644
index 0000000..f34a7b5
--- /dev/null
+++ b/third_party/sqlite/sqlite3.h
@@ -0,0 +1,12168 @@
+/*
+** 2001-09-15
+**
+** The author disclaims copyright to this source code. In place of
+** a legal notice, here is a blessing:
+**
+** May you do good and not evil.
+** May you find forgiveness for yourself and forgive others.
+** May you share freely, never taking more than you give.
+**
+*************************************************************************
+** This header file defines the interface that the SQLite library
+** presents to client programs. If a C-function, structure, datatype,
+** or constant definition does not appear in this file, then it is
+** not a published API of SQLite, is subject to change without
+** notice, and should not be referenced by programs that use SQLite.
+**
+** Some of the definitions that are in this file are marked as
+** "experimental". Experimental interfaces are normally new
+** features recently added to SQLite. We do not anticipate changes
+** to experimental interfaces but reserve the right to make minor changes
+** if experience from use "in the wild" suggest such changes are prudent.
+**
+** The official C-language API documentation for SQLite is derived
+** from comments in this file. This file is the authoritative source
+** on how SQLite interfaces are supposed to operate.
+**
+** The name of this file under configuration management is "sqlite.h.in".
+** The makefile makes some minor changes to this file (such as inserting
+** the version number) and changes its name to "sqlite3.h" as
+** part of the build process.
+*/
+#ifndef SQLITE3_H
+#define SQLITE3_H
+#include <stdarg.h> /* Needed for the definition of va_list */
+
+/*
+** Make sure we can call this stuff from C++.
+*/
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+/*
+** Provide the ability to override linkage features of the interface.
+*/
+#ifndef SQLITE_EXTERN
+# define SQLITE_EXTERN extern
+#endif
+#ifndef SQLITE_API
+# define SQLITE_API
+#endif
+#ifndef SQLITE_CDECL
+# define SQLITE_CDECL
+#endif
+#ifndef SQLITE_APICALL
+# define SQLITE_APICALL
+#endif
+#ifndef SQLITE_STDCALL
+# define SQLITE_STDCALL SQLITE_APICALL
+#endif
+#ifndef SQLITE_CALLBACK
+# define SQLITE_CALLBACK
+#endif
+#ifndef SQLITE_SYSAPI
+# define SQLITE_SYSAPI
+#endif
+
+/*
+** These no-op macros are used in front of interfaces to mark those
+** interfaces as either deprecated or experimental. New applications
+** should not use deprecated interfaces - they are supported for backwards
+** compatibility only. Application writers should be aware that
+** experimental interfaces are subject to change in point releases.
+**
+** These macros used to resolve to various kinds of compiler magic that
+** would generate warning messages when they were used. But that
+** compiler magic ended up generating such a flurry of bug reports
+** that we have taken it all out and gone back to using simple
+** noop macros.
+*/
+#define SQLITE_DEPRECATED
+#define SQLITE_EXPERIMENTAL
+
+/*
+** Ensure these symbols were not defined by some previous header file.
+*/
+#ifdef SQLITE_VERSION
+# undef SQLITE_VERSION
+#endif
+#ifdef SQLITE_VERSION_NUMBER
+# undef SQLITE_VERSION_NUMBER
+#endif
+
+/*
+** CAPI3REF: Compile-Time Library Version Numbers
+**
+** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header
+** evaluates to a string literal that is the SQLite version in the
+** format "X.Y.Z" where X is the major version number (always 3 for
+** SQLite3) and Y is the minor version number and Z is the release number.)^
+** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer
+** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same
+** numbers used in [SQLITE_VERSION].)^
+** The SQLITE_VERSION_NUMBER for any given release of SQLite will also
+** be larger than the release from which it is derived. Either Y will
+** be held constant and Z will be incremented or else Y will be incremented
+** and Z will be reset to zero.
+**
+** Since [version 3.6.18] ([dateof:3.6.18]),
+** SQLite source code has been stored in the
+** <a href="http://www.fossil-scm.org/">Fossil configuration management
+** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to
+** a string which identifies a particular check-in of SQLite
+** within its configuration management system. ^The SQLITE_SOURCE_ID
+** string contains the date and time of the check-in (UTC) and a SHA1
+** or SHA3-256 hash of the entire source tree. If the source code has
+** been edited in any way since it was last checked in, then the last
+** four hexadecimal digits of the hash may be modified.
+**
+** See also: [sqlite3_libversion()],
+** [sqlite3_libversion_number()], [sqlite3_sourceid()],
+** [sqlite_version()] and [sqlite_source_id()].
+*/
+#define SQLITE_VERSION "3.32.3"
+#define SQLITE_VERSION_NUMBER 3032003
+#define SQLITE_SOURCE_ID "2020-06-18 14:00:33 7ebdfa80be8e8e73324b8d66b3460222eb74c7e9dfd655b48d6ca7e1933cc8fd"
+
+/*
+** CAPI3REF: Run-Time Library Version Numbers
+** KEYWORDS: sqlite3_version sqlite3_sourceid
+**
+** These interfaces provide the same information as the [SQLITE_VERSION],
+** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros
+** but are associated with the library instead of the header file. ^(Cautious
+** programmers might include assert() statements in their application to
+** verify that values returned by these interfaces match the macros in
+** the header, and thus ensure that the application is
+** compiled with matching library and header files.
+**
+** <blockquote><pre>
+** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
+** assert( strncmp(sqlite3_sourceid(),SQLITE_SOURCE_ID,80)==0 );
+** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 );
+** </pre></blockquote>)^
+**
+** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION]
+** macro. ^The sqlite3_libversion() function returns a pointer to the
+** to the sqlite3_version[] string constant. The sqlite3_libversion()
+** function is provided for use in DLLs since DLL users usually do not have
+** direct access to string constants within the DLL. ^The
+** sqlite3_libversion_number() function returns an integer equal to
+** [SQLITE_VERSION_NUMBER]. ^(The sqlite3_sourceid() function returns
+** a pointer to a string constant whose value is the same as the
+** [SQLITE_SOURCE_ID] C preprocessor macro. Except if SQLite is built
+** using an edited copy of [the amalgamation], then the last four characters
+** of the hash might be different from [SQLITE_SOURCE_ID].)^
+**
+** See also: [sqlite_version()] and [sqlite_source_id()].
+*/
+SQLITE_API SQLITE_EXTERN const char sqlite3_version[];
+SQLITE_API const char *sqlite3_libversion(void);
+SQLITE_API const char *sqlite3_sourceid(void);
+SQLITE_API int sqlite3_libversion_number(void);
+
+/*
+** CAPI3REF: Run-Time Library Compilation Options Diagnostics
+**
+** ^The sqlite3_compileoption_used() function returns 0 or 1
+** indicating whether the specified option was defined at
+** compile time. ^The SQLITE_ prefix may be omitted from the
+** option name passed to sqlite3_compileoption_used().
+**
+** ^The sqlite3_compileoption_get() function allows iterating
+** over the list of options that were defined at compile time by
+** returning the N-th compile time option string. ^If N is out of range,
+** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_
+** prefix is omitted from any strings returned by
+** sqlite3_compileoption_get().
+**
+** ^Support for the diagnostic functions sqlite3_compileoption_used()
+** and sqlite3_compileoption_get() may be omitted by specifying the
+** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time.
+**
+** See also: SQL functions [sqlite_compileoption_used()] and
+** [sqlite_compileoption_get()] and the [compile_options pragma].
+*/
+#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
+SQLITE_API int sqlite3_compileoption_used(const char *zOptName);
+SQLITE_API const char *sqlite3_compileoption_get(int N);
+#else
+# define sqlite3_compileoption_used(X) 0
+# define sqlite3_compileoption_get(X) ((void*)0)
+#endif
+
+/*
+** CAPI3REF: Test To See If The Library Is Threadsafe
+**
+** ^The sqlite3_threadsafe() function returns zero if and only if
+** SQLite was compiled with mutexing code omitted due to the
+** [SQLITE_THREADSAFE] compile-time option being set to 0.
+**
+** SQLite can be compiled with or without mutexes. When
+** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes
+** are enabled and SQLite is threadsafe. When the
+** [SQLITE_THREADSAFE] macro is 0,
+** the mutexes are omitted. Without the mutexes, it is not safe
+** to use SQLite concurrently from more than one thread.
+**
+** Enabling mutexes incurs a measurable performance penalty.
+** So if speed is of utmost importance, it makes sense to disable
+** the mutexes. But for maximum safety, mutexes should be enabled.
+** ^The default behavior is for mutexes to be enabled.
+**
+** This interface can be used by an application to make sure that the
+** version of SQLite that it is linking against was compiled with
+** the desired setting of the [SQLITE_THREADSAFE] macro.
+**
+** This interface only reports on the compile-time mutex setting
+** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with
+** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but
+** can be fully or partially disabled using a call to [sqlite3_config()]
+** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD],
+** or [SQLITE_CONFIG_SERIALIZED]. ^(The return value of the
+** sqlite3_threadsafe() function shows only the compile-time setting of
+** thread safety, not any run-time changes to that setting made by
+** sqlite3_config(). In other words, the return value from sqlite3_threadsafe()
+** is unchanged by calls to sqlite3_config().)^
+**
+** See the [threading mode] documentation for additional information.
+*/
+SQLITE_API int sqlite3_threadsafe(void);
+
+/*
+** CAPI3REF: Database Connection Handle
+** KEYWORDS: {database connection} {database connections}
+**
+** Each open SQLite database is represented by a pointer to an instance of
+** the opaque structure named "sqlite3". It is useful to think of an sqlite3
+** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and
+** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
+** and [sqlite3_close_v2()] are its destructors. There are many other
+** interfaces (such as
+** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
+** [sqlite3_busy_timeout()] to name but three) that are methods on an
+** sqlite3 object.
+*/
+typedef struct sqlite3 sqlite3;
+
+/*
+** CAPI3REF: 64-Bit Integer Types
+** KEYWORDS: sqlite_int64 sqlite_uint64
+**
+** Because there is no cross-platform way to specify 64-bit integer types
+** SQLite includes typedefs for 64-bit signed and unsigned integers.
+**
+** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.
+** The sqlite_int64 and sqlite_uint64 types are supported for backwards
+** compatibility only.
+**
+** ^The sqlite3_int64 and sqlite_int64 types can store integer values
+** between -9223372036854775808 and +9223372036854775807 inclusive. ^The
+** sqlite3_uint64 and sqlite_uint64 types can store integer values
+** between 0 and +18446744073709551615 inclusive.
+*/
+#ifdef SQLITE_INT64_TYPE
+ typedef SQLITE_INT64_TYPE sqlite_int64;
+# ifdef SQLITE_UINT64_TYPE
+ typedef SQLITE_UINT64_TYPE sqlite_uint64;
+# else
+ typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
+# endif
+#elif defined(_MSC_VER) || defined(__BORLANDC__)
+ typedef __int64 sqlite_int64;
+ typedef unsigned __int64 sqlite_uint64;
+#else
+ typedef long long int sqlite_int64;
+ typedef unsigned long long int sqlite_uint64;
+#endif
+typedef sqlite_int64 sqlite3_int64;
+typedef sqlite_uint64 sqlite3_uint64;
+
+/*
+** If compiling for a processor that lacks floating point support,
+** substitute integer for floating-point.
+*/
+#ifdef SQLITE_OMIT_FLOATING_POINT
+# define double sqlite3_int64
+#endif
+
+/*
+** CAPI3REF: Closing A Database Connection
+** DESTRUCTOR: sqlite3
+**
+** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors
+** for the [sqlite3] object.
+** ^Calls to sqlite3_close() and sqlite3_close_v2() return [SQLITE_OK] if
+** the [sqlite3] object is successfully destroyed and all associated
+** resources are deallocated.
+**
+** Ideally, applications should [sqlite3_finalize | finalize] all
+** [prepared statements], [sqlite3_blob_close | close] all [BLOB handles], and
+** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated
+** with the [sqlite3] object prior to attempting to close the object.
+** ^If the database connection is associated with unfinalized prepared
+** statements, BLOB handlers, and/or unfinished sqlite3_backup objects then
+** sqlite3_close() will leave the database connection open and return
+** [SQLITE_BUSY]. ^If sqlite3_close_v2() is called with unfinalized prepared
+** statements, unclosed BLOB handlers, and/or unfinished sqlite3_backups,
+** it returns [SQLITE_OK] regardless, but instead of deallocating the database
+** connection immediately, it marks the database connection as an unusable
+** "zombie" and makes arrangements to automatically deallocate the database
+** connection after all prepared statements are finalized, all BLOB handles
+** are closed, and all backups have finished. The sqlite3_close_v2() interface
+** is intended for use with host languages that are garbage collected, and
+** where the order in which destructors are called is arbitrary.
+**
+** ^If an [sqlite3] object is destroyed while a transaction is open,
+** the transaction is automatically rolled back.
+**
+** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)]
+** must be either a NULL
+** pointer or an [sqlite3] object pointer obtained
+** from [sqlite3_open()], [sqlite3_open16()], or
+** [sqlite3_open_v2()], and not previously closed.
+** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer
+** argument is a harmless no-op.
+*/
+SQLITE_API int sqlite3_close(sqlite3*);
+SQLITE_API int sqlite3_close_v2(sqlite3*);
+
+/*
+** The type for a callback function.
+** This is legacy and deprecated. It is included for historical
+** compatibility and is not documented.
+*/
+typedef int (*sqlite3_callback)(void*,int,char**, char**);
+
+/*
+** CAPI3REF: One-Step Query Execution Interface
+** METHOD: sqlite3
+**
+** The sqlite3_exec() interface is a convenience wrapper around
+** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()],
+** that allows an application to run multiple statements of SQL
+** without having to use a lot of C code.
+**
+** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded,
+** semicolon-separate SQL statements passed into its 2nd argument,
+** in the context of the [database connection] passed in as its 1st
+** argument. ^If the callback function of the 3rd argument to
+** sqlite3_exec() is not NULL, then it is invoked for each result row
+** coming out of the evaluated SQL statements. ^The 4th argument to
+** sqlite3_exec() is relayed through to the 1st argument of each
+** callback invocation. ^If the callback pointer to sqlite3_exec()
+** is NULL, then no callback is ever invoked and result rows are
+** ignored.
+**
+** ^If an error occurs while evaluating the SQL statements passed into
+** sqlite3_exec(), then execution of the current statement stops and
+** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec()
+** is not NULL then any error message is written into memory obtained
+** from [sqlite3_malloc()] and passed back through the 5th parameter.
+** To avoid memory leaks, the application should invoke [sqlite3_free()]
+** on error message strings returned through the 5th parameter of
+** sqlite3_exec() after the error message string is no longer needed.
+** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors
+** occur, then sqlite3_exec() sets the pointer in its 5th parameter to
+** NULL before returning.
+**
+** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec()
+** routine returns SQLITE_ABORT without invoking the callback again and
+** without running any subsequent SQL statements.
+**
+** ^The 2nd argument to the sqlite3_exec() callback function is the
+** number of columns in the result. ^The 3rd argument to the sqlite3_exec()
+** callback is an array of pointers to strings obtained as if from
+** [sqlite3_column_text()], one for each column. ^If an element of a
+** result row is NULL then the corresponding string pointer for the
+** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the
+** sqlite3_exec() callback is an array of pointers to strings where each
+** entry represents the name of corresponding result column as obtained
+** from [sqlite3_column_name()].
+**
+** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer
+** to an empty string, or a pointer that contains only whitespace and/or
+** SQL comments, then no SQL statements are evaluated and the database
+** is not changed.
+**
+** Restrictions:
+**
+** <ul>
+** <li> The application must ensure that the 1st parameter to sqlite3_exec()
+** is a valid and open [database connection].
+** <li> The application must not close the [database connection] specified by
+** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.
+** <li> The application must not modify the SQL statement text passed into
+** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.
+** </ul>
+*/
+SQLITE_API int sqlite3_exec(
+ sqlite3*, /* An open database */
+ const char *sql, /* SQL to be evaluated */
+ int (*callback)(void*,int,char**,char**), /* Callback function */
+ void *, /* 1st argument to callback */
+ char **errmsg /* Error msg written here */
+);
+
+/*
+** CAPI3REF: Result Codes
+** KEYWORDS: {result code definitions}
+**
+** Many SQLite functions return an integer result code from the set shown
+** here in order to indicate success or failure.
+**
+** New error codes may be added in future versions of SQLite.
+**
+** See also: [extended result code definitions]
+*/
+#define SQLITE_OK 0 /* Successful result */
+/* beginning-of-error-codes */
+#define SQLITE_ERROR 1 /* Generic error */
+#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */
+#define SQLITE_PERM 3 /* Access permission denied */
+#define SQLITE_ABORT 4 /* Callback routine requested an abort */
+#define SQLITE_BUSY 5 /* The database file is locked */
+#define SQLITE_LOCKED 6 /* A table in the database is locked */
+#define SQLITE_NOMEM 7 /* A malloc() failed */
+#define SQLITE_READONLY 8 /* Attempt to write a readonly database */
+#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
+#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
+#define SQLITE_CORRUPT 11 /* The database disk image is malformed */
+#define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */
+#define SQLITE_FULL 13 /* Insertion failed because database is full */
+#define SQLITE_CANTOPEN 14 /* Unable to open the database file */
+#define SQLITE_PROTOCOL 15 /* Database lock protocol error */
+#define SQLITE_EMPTY 16 /* Internal use only */
+#define SQLITE_SCHEMA 17 /* The database schema changed */
+#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */
+#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */
+#define SQLITE_MISMATCH 20 /* Data type mismatch */
+#define SQLITE_MISUSE 21 /* Library used incorrectly */
+#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
+#define SQLITE_AUTH 23 /* Authorization denied */
+#define SQLITE_FORMAT 24 /* Not used */
+#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
+#define SQLITE_NOTADB 26 /* File opened that is not a database file */
+#define SQLITE_NOTICE 27 /* Notifications from sqlite3_log() */
+#define SQLITE_WARNING 28 /* Warnings from sqlite3_log() */
+#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
+#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
+/* end-of-error-codes */
+
+/*
+** CAPI3REF: Extended Result Codes
+** KEYWORDS: {extended result code definitions}
+**
+** In its default configuration, SQLite API routines return one of 30 integer
+** [result codes]. However, experience has shown that many of
+** these result codes are too coarse-grained. They do not provide as
+** much information about problems as programmers might like. In an effort to
+** address this, newer versions of SQLite (version 3.3.8 [dateof:3.3.8]
+** and later) include
+** support for additional result codes that provide more detailed information
+** about errors. These [extended result codes] are enabled or disabled
+** on a per database connection basis using the
+** [sqlite3_extended_result_codes()] API. Or, the extended code for
+** the most recent error can be obtained using
+** [sqlite3_extended_errcode()].
+*/
+#define SQLITE_ERROR_MISSING_COLLSEQ (SQLITE_ERROR | (1<<8))
+#define SQLITE_ERROR_RETRY (SQLITE_ERROR | (2<<8))
+#define SQLITE_ERROR_SNAPSHOT (SQLITE_ERROR | (3<<8))
+#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8))
+#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8))
+#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8))
+#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8))
+#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8))
+#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8))
+#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8))
+#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8))
+#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8))
+#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8))
+#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8))
+#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8))
+#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8))
+#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8))
+#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8))
+#define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8))
+#define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8))
+#define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8))
+#define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8))
+#define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8))
+#define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8))
+#define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8))
+#define SQLITE_IOERR_DELETE_NOENT (SQLITE_IOERR | (23<<8))
+#define SQLITE_IOERR_MMAP (SQLITE_IOERR | (24<<8))
+#define SQLITE_IOERR_GETTEMPPATH (SQLITE_IOERR | (25<<8))
+#define SQLITE_IOERR_CONVPATH (SQLITE_IOERR | (26<<8))
+#define SQLITE_IOERR_VNODE (SQLITE_IOERR | (27<<8))
+#define SQLITE_IOERR_AUTH (SQLITE_IOERR | (28<<8))
+#define SQLITE_IOERR_BEGIN_ATOMIC (SQLITE_IOERR | (29<<8))
+#define SQLITE_IOERR_COMMIT_ATOMIC (SQLITE_IOERR | (30<<8))
+#define SQLITE_IOERR_ROLLBACK_ATOMIC (SQLITE_IOERR | (31<<8))
+#define SQLITE_IOERR_DATA (SQLITE_IOERR | (32<<8))
+#define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8))
+#define SQLITE_LOCKED_VTAB (SQLITE_LOCKED | (2<<8))
+#define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8))
+#define SQLITE_BUSY_SNAPSHOT (SQLITE_BUSY | (2<<8))
+#define SQLITE_BUSY_TIMEOUT (SQLITE_BUSY | (3<<8))
+#define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8))
+#define SQLITE_CANTOPEN_ISDIR (SQLITE_CANTOPEN | (2<<8))
+#define SQLITE_CANTOPEN_FULLPATH (SQLITE_CANTOPEN | (3<<8))
+#define SQLITE_CANTOPEN_CONVPATH (SQLITE_CANTOPEN | (4<<8))
+#define SQLITE_CANTOPEN_DIRTYWAL (SQLITE_CANTOPEN | (5<<8)) /* Not Used */
+#define SQLITE_CANTOPEN_SYMLINK (SQLITE_CANTOPEN | (6<<8))
+#define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8))
+#define SQLITE_CORRUPT_SEQUENCE (SQLITE_CORRUPT | (2<<8))
+#define SQLITE_CORRUPT_INDEX (SQLITE_CORRUPT | (3<<8))
+#define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8))
+#define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8))
+#define SQLITE_READONLY_ROLLBACK (SQLITE_READONLY | (3<<8))
+#define SQLITE_READONLY_DBMOVED (SQLITE_READONLY | (4<<8))
+#define SQLITE_READONLY_CANTINIT (SQLITE_READONLY | (5<<8))
+#define SQLITE_READONLY_DIRECTORY (SQLITE_READONLY | (6<<8))
+#define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT | (2<<8))
+#define SQLITE_CONSTRAINT_CHECK (SQLITE_CONSTRAINT | (1<<8))
+#define SQLITE_CONSTRAINT_COMMITHOOK (SQLITE_CONSTRAINT | (2<<8))
+#define SQLITE_CONSTRAINT_FOREIGNKEY (SQLITE_CONSTRAINT | (3<<8))
+#define SQLITE_CONSTRAINT_FUNCTION (SQLITE_CONSTRAINT | (4<<8))
+#define SQLITE_CONSTRAINT_NOTNULL (SQLITE_CONSTRAINT | (5<<8))
+#define SQLITE_CONSTRAINT_PRIMARYKEY (SQLITE_CONSTRAINT | (6<<8))
+#define SQLITE_CONSTRAINT_TRIGGER (SQLITE_CONSTRAINT | (7<<8))
+#define SQLITE_CONSTRAINT_UNIQUE (SQLITE_CONSTRAINT | (8<<8))
+#define SQLITE_CONSTRAINT_VTAB (SQLITE_CONSTRAINT | (9<<8))
+#define SQLITE_CONSTRAINT_ROWID (SQLITE_CONSTRAINT |(10<<8))
+#define SQLITE_CONSTRAINT_PINNED (SQLITE_CONSTRAINT |(11<<8))
+#define SQLITE_NOTICE_RECOVER_WAL (SQLITE_NOTICE | (1<<8))
+#define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE | (2<<8))
+#define SQLITE_WARNING_AUTOINDEX (SQLITE_WARNING | (1<<8))
+#define SQLITE_AUTH_USER (SQLITE_AUTH | (1<<8))
+#define SQLITE_OK_LOAD_PERMANENTLY (SQLITE_OK | (1<<8))
+#define SQLITE_OK_SYMLINK (SQLITE_OK | (2<<8))
+
+/*
+** CAPI3REF: Flags For File Open Operations
+**
+** These bit values are intended for use in the
+** 3rd parameter to the [sqlite3_open_v2()] interface and
+** in the 4th parameter to the [sqlite3_vfs.xOpen] method.
+*/
+#define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */
+#define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */
+#define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */
+#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */
+#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */
+#define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */
+#define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */
+#define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */
+#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */
+#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */
+#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */
+#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */
+#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */
+#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */
+#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */
+#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */
+#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */
+#define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */
+#define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */
+#define SQLITE_OPEN_WAL 0x00080000 /* VFS only */
+#define SQLITE_OPEN_NOFOLLOW 0x01000000 /* Ok for sqlite3_open_v2() */
+
+/* Reserved: 0x00F00000 */
+
+/*
+** CAPI3REF: Device Characteristics
+**
+** The xDeviceCharacteristics method of the [sqlite3_io_methods]
+** object returns an integer which is a vector of these
+** bit values expressing I/O characteristics of the mass storage
+** device that holds the file that the [sqlite3_io_methods]
+** refers to.
+**
+** The SQLITE_IOCAP_ATOMIC property means that all writes of
+** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
+** mean that writes of blocks that are nnn bytes in size and
+** are aligned to an address which is an integer multiple of
+** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
+** that when data is appended to a file, the data is appended
+** first then the size of the file is extended, never the other
+** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
+** information is written to disk in the same order as calls
+** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that
+** after reboot following a crash or power loss, the only bytes in a
+** file that were written at the application level might have changed
+** and that adjacent bytes, even bytes within the same sector are
+** guaranteed to be unchanged. The SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN
+** flag indicates that a file cannot be deleted when open. The
+** SQLITE_IOCAP_IMMUTABLE flag indicates that the file is on
+** read-only media and cannot be changed even by processes with
+** elevated privileges.
+**
+** The SQLITE_IOCAP_BATCH_ATOMIC property means that the underlying
+** filesystem supports doing multiple write operations atomically when those
+** write operations are bracketed by [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] and
+** [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE].
+*/
+#define SQLITE_IOCAP_ATOMIC 0x00000001
+#define SQLITE_IOCAP_ATOMIC512 0x00000002
+#define SQLITE_IOCAP_ATOMIC1K 0x00000004
+#define SQLITE_IOCAP_ATOMIC2K 0x00000008
+#define SQLITE_IOCAP_ATOMIC4K 0x00000010
+#define SQLITE_IOCAP_ATOMIC8K 0x00000020
+#define SQLITE_IOCAP_ATOMIC16K 0x00000040
+#define SQLITE_IOCAP_ATOMIC32K 0x00000080
+#define SQLITE_IOCAP_ATOMIC64K 0x00000100
+#define SQLITE_IOCAP_SAFE_APPEND 0x00000200
+#define SQLITE_IOCAP_SEQUENTIAL 0x00000400
+#define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800
+#define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000
+#define SQLITE_IOCAP_IMMUTABLE 0x00002000
+#define SQLITE_IOCAP_BATCH_ATOMIC 0x00004000
+
+/*
+** CAPI3REF: File Locking Levels
+**
+** SQLite uses one of these integer values as the second
+** argument to calls it makes to the xLock() and xUnlock() methods
+** of an [sqlite3_io_methods] object.
+*/
+#define SQLITE_LOCK_NONE 0
+#define SQLITE_LOCK_SHARED 1
+#define SQLITE_LOCK_RESERVED 2
+#define SQLITE_LOCK_PENDING 3
+#define SQLITE_LOCK_EXCLUSIVE 4
+
+/*
+** CAPI3REF: Synchronization Type Flags
+**
+** When SQLite invokes the xSync() method of an
+** [sqlite3_io_methods] object it uses a combination of
+** these integer values as the second argument.
+**
+** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
+** sync operation only needs to flush data to mass storage. Inode
+** information need not be flushed. If the lower four bits of the flag
+** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics.
+** If the lower four bits equal SQLITE_SYNC_FULL, that means
+** to use Mac OS X style fullsync instead of fsync().
+**
+** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags
+** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL
+** settings. The [synchronous pragma] determines when calls to the
+** xSync VFS method occur and applies uniformly across all platforms.
+** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how
+** energetic or rigorous or forceful the sync operations are and
+** only make a difference on Mac OSX for the default SQLite code.
+** (Third-party VFS implementations might also make the distinction
+** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the
+** operating systems natively supported by SQLite, only Mac OSX
+** cares about the difference.)
+*/
+#define SQLITE_SYNC_NORMAL 0x00002
+#define SQLITE_SYNC_FULL 0x00003
+#define SQLITE_SYNC_DATAONLY 0x00010
+
+/*
+** CAPI3REF: OS Interface Open File Handle
+**
+** An [sqlite3_file] object represents an open file in the
+** [sqlite3_vfs | OS interface layer]. Individual OS interface
+** implementations will
+** want to subclass this object by appending additional fields
+** for their own use. The pMethods entry is a pointer to an
+** [sqlite3_io_methods] object that defines methods for performing
+** I/O operations on the open file.
+*/
+typedef struct sqlite3_file sqlite3_file;
+struct sqlite3_file {
+ const struct sqlite3_io_methods *pMethods; /* Methods for an open file */
+};
+
+/*
+** CAPI3REF: OS Interface File Virtual Methods Object
+**
+** Every file opened by the [sqlite3_vfs.xOpen] method populates an
+** [sqlite3_file] object (or, more commonly, a subclass of the
+** [sqlite3_file] object) with a pointer to an instance of this object.
+** This object defines the methods used to perform various operations
+** against the open file represented by the [sqlite3_file] object.
+**
+** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element
+** to a non-NULL pointer, then the sqlite3_io_methods.xClose method
+** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The
+** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen]
+** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element
+** to NULL.
+**
+** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
+** [SQLITE_SYNC_FULL]. The first choice is the normal fsync().
+** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY]
+** flag may be ORed in to indicate that only the data of the file
+** and not its inode needs to be synced.
+**
+** The integer values to xLock() and xUnlock() are one of
+** <ul>
+** <li> [SQLITE_LOCK_NONE],
+** <li> [SQLITE_LOCK_SHARED],
+** <li> [SQLITE_LOCK_RESERVED],
+** <li> [SQLITE_LOCK_PENDING], or
+** <li> [SQLITE_LOCK_EXCLUSIVE].
+** </ul>
+** xLock() increases the lock. xUnlock() decreases the lock.
+** The xCheckReservedLock() method checks whether any database connection,
+** either in this process or in some other process, is holding a RESERVED,
+** PENDING, or EXCLUSIVE lock on the file. It returns true
+** if such a lock exists and false otherwise.
+**
+** The xFileControl() method is a generic interface that allows custom
+** VFS implementations to directly control an open file using the
+** [sqlite3_file_control()] interface. The second "op" argument is an
+** integer opcode. The third argument is a generic pointer intended to
+** point to a structure that may contain arguments or space in which to
+** write return values. Potential uses for xFileControl() might be
+** functions to enable blocking locks with timeouts, to change the
+** locking strategy (for example to use dot-file locks), to inquire
+** about the status of a lock, or to break stale locks. The SQLite
+** core reserves all opcodes less than 100 for its own use.
+** A [file control opcodes | list of opcodes] less than 100 is available.
+** Applications that define a custom xFileControl method should use opcodes
+** greater than 100 to avoid conflicts. VFS implementations should
+** return [SQLITE_NOTFOUND] for file control opcodes that they do not
+** recognize.
+**
+** The xSectorSize() method returns the sector size of the
+** device that underlies the file. The sector size is the
+** minimum write that can be performed without disturbing
+** other bytes in the file. The xDeviceCharacteristics()
+** method returns a bit vector describing behaviors of the
+** underlying device:
+**
+** <ul>
+** <li> [SQLITE_IOCAP_ATOMIC]
+** <li> [SQLITE_IOCAP_ATOMIC512]
+** <li> [SQLITE_IOCAP_ATOMIC1K]
+** <li> [SQLITE_IOCAP_ATOMIC2K]
+** <li> [SQLITE_IOCAP_ATOMIC4K]
+** <li> [SQLITE_IOCAP_ATOMIC8K]
+** <li> [SQLITE_IOCAP_ATOMIC16K]
+** <li> [SQLITE_IOCAP_ATOMIC32K]
+** <li> [SQLITE_IOCAP_ATOMIC64K]
+** <li> [SQLITE_IOCAP_SAFE_APPEND]
+** <li> [SQLITE_IOCAP_SEQUENTIAL]
+** <li> [SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN]
+** <li> [SQLITE_IOCAP_POWERSAFE_OVERWRITE]
+** <li> [SQLITE_IOCAP_IMMUTABLE]
+** <li> [SQLITE_IOCAP_BATCH_ATOMIC]
+** </ul>
+**
+** The SQLITE_IOCAP_ATOMIC property means that all writes of
+** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
+** mean that writes of blocks that are nnn bytes in size and
+** are aligned to an address which is an integer multiple of
+** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
+** that when data is appended to a file, the data is appended
+** first then the size of the file is extended, never the other
+** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
+** information is written to disk in the same order as calls
+** to xWrite().
+**
+** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill
+** in the unread portions of the buffer with zeros. A VFS that
+** fails to zero-fill short reads might seem to work. However,
+** failure to zero-fill short reads will eventually lead to
+** database corruption.
+*/
+typedef struct sqlite3_io_methods sqlite3_io_methods;
+struct sqlite3_io_methods {
+ int iVersion;
+ int (*xClose)(sqlite3_file*);
+ int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
+ int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
+ int (*xTruncate)(sqlite3_file*, sqlite3_int64 size);
+ int (*xSync)(sqlite3_file*, int flags);
+ int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
+ int (*xLock)(sqlite3_file*, int);
+ int (*xUnlock)(sqlite3_file*, int);
+ int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
+ int (*xFileControl)(sqlite3_file*, int op, void *pArg);
+ int (*xSectorSize)(sqlite3_file*);
+ int (*xDeviceCharacteristics)(sqlite3_file*);
+ /* Methods above are valid for version 1 */
+ int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**);
+ int (*xShmLock)(sqlite3_file*, int offset, int n, int flags);
+ void (*xShmBarrier)(sqlite3_file*);
+ int (*xShmUnmap)(sqlite3_file*, int deleteFlag);
+ /* Methods above are valid for version 2 */
+ int (*xFetch)(sqlite3_file*, sqlite3_int64 iOfst, int iAmt, void **pp);
+ int (*xUnfetch)(sqlite3_file*, sqlite3_int64 iOfst, void *p);
+ /* Methods above are valid for version 3 */
+ /* Additional methods may be added in future releases */
+};
+
+/*
+** CAPI3REF: Standard File Control Opcodes
+** KEYWORDS: {file control opcodes} {file control opcode}
+**
+** These integer constants are opcodes for the xFileControl method
+** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
+** interface.
+**
+** <ul>
+** <li>[[SQLITE_FCNTL_LOCKSTATE]]
+** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This
+** opcode causes the xFileControl method to write the current state of
+** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
+** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
+** into an integer that the pArg argument points to. This capability
+** is used during testing and is only available when the SQLITE_TEST
+** compile-time option is used.
+**
+** <li>[[SQLITE_FCNTL_SIZE_HINT]]
+** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS
+** layer a hint of how large the database file will grow to be during the
+** current transaction. This hint is not guaranteed to be accurate but it
+** is often close. The underlying VFS might choose to preallocate database
+** file space based on this hint in order to help writes to the database
+** file run faster.
+**
+** <li>[[SQLITE_FCNTL_SIZE_LIMIT]]
+** The [SQLITE_FCNTL_SIZE_LIMIT] opcode is used by in-memory VFS that
+** implements [sqlite3_deserialize()] to set an upper bound on the size
+** of the in-memory database. The argument is a pointer to a [sqlite3_int64].
+** If the integer pointed to is negative, then it is filled in with the
+** current limit. Otherwise the limit is set to the larger of the value
+** of the integer pointed to and the current database size. The integer
+** pointed to is set to the new limit.
+**
+** <li>[[SQLITE_FCNTL_CHUNK_SIZE]]
+** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS
+** extends and truncates the database file in chunks of a size specified
+** by the user. The fourth argument to [sqlite3_file_control()] should
+** point to an integer (type int) containing the new chunk-size to use
+** for the nominated database. Allocating database file space in large
+** chunks (say 1MB at a time), may reduce file-system fragmentation and
+** improve performance on some systems.
+**
+** <li>[[SQLITE_FCNTL_FILE_POINTER]]
+** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer
+** to the [sqlite3_file] object associated with a particular database
+** connection. See also [SQLITE_FCNTL_JOURNAL_POINTER].
+**
+** <li>[[SQLITE_FCNTL_JOURNAL_POINTER]]
+** The [SQLITE_FCNTL_JOURNAL_POINTER] opcode is used to obtain a pointer
+** to the [sqlite3_file] object associated with the journal file (either
+** the [rollback journal] or the [write-ahead log]) for a particular database
+** connection. See also [SQLITE_FCNTL_FILE_POINTER].
+**
+** <li>[[SQLITE_FCNTL_SYNC_OMITTED]]
+** No longer in use.
+**
+** <li>[[SQLITE_FCNTL_SYNC]]
+** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and
+** sent to the VFS immediately before the xSync method is invoked on a
+** database file descriptor. Or, if the xSync method is not invoked
+** because the user has configured SQLite with
+** [PRAGMA synchronous | PRAGMA synchronous=OFF] it is invoked in place
+** of the xSync method. In most cases, the pointer argument passed with
+** this file-control is NULL. However, if the database file is being synced
+** as part of a multi-database commit, the argument points to a nul-terminated
+** string containing the transactions master-journal file name. VFSes that
+** do not need this signal should silently ignore this opcode. Applications
+** should not call [sqlite3_file_control()] with this opcode as doing so may
+** disrupt the operation of the specialized VFSes that do require it.
+**
+** <li>[[SQLITE_FCNTL_COMMIT_PHASETWO]]
+** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite
+** and sent to the VFS after a transaction has been committed immediately
+** but before the database is unlocked. VFSes that do not need this signal
+** should silently ignore this opcode. Applications should not call
+** [sqlite3_file_control()] with this opcode as doing so may disrupt the
+** operation of the specialized VFSes that do require it.
+**
+** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]]
+** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic
+** retry counts and intervals for certain disk I/O operations for the
+** windows [VFS] in order to provide robustness in the presence of
+** anti-virus programs. By default, the windows VFS will retry file read,
+** file write, and file delete operations up to 10 times, with a delay
+** of 25 milliseconds before the first retry and with the delay increasing
+** by an additional 25 milliseconds with each subsequent retry. This
+** opcode allows these two values (10 retries and 25 milliseconds of delay)
+** to be adjusted. The values are changed for all database connections
+** within the same process. The argument is a pointer to an array of two
+** integers where the first integer is the new retry count and the second
+** integer is the delay. If either integer is negative, then the setting
+** is not changed but instead the prior value of that setting is written
+** into the array entry, allowing the current retry settings to be
+** interrogated. The zDbName parameter is ignored.
+**
+** <li>[[SQLITE_FCNTL_PERSIST_WAL]]
+** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the
+** persistent [WAL | Write Ahead Log] setting. By default, the auxiliary
+** write ahead log ([WAL file]) and shared memory
+** files used for transaction control
+** are automatically deleted when the latest connection to the database
+** closes. Setting persistent WAL mode causes those files to persist after
+** close. Persisting the files is useful when other processes that do not
+** have write permission on the directory containing the database file want
+** to read the database file, as the WAL and shared memory files must exist
+** in order for the database to be readable. The fourth parameter to
+** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
+** That integer is 0 to disable persistent WAL mode or 1 to enable persistent
+** WAL mode. If the integer is -1, then it is overwritten with the current
+** WAL persistence setting.
+**
+** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]]
+** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the
+** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting
+** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the
+** xDeviceCharacteristics methods. The fourth parameter to
+** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
+** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage
+** mode. If the integer is -1, then it is overwritten with the current
+** zero-damage mode setting.
+**
+** <li>[[SQLITE_FCNTL_OVERWRITE]]
+** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening
+** a write transaction to indicate that, unless it is rolled back for some
+** reason, the entire database file will be overwritten by the current
+** transaction. This is used by VACUUM operations.
+**
+** <li>[[SQLITE_FCNTL_VFSNAME]]
+** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of
+** all [VFSes] in the VFS stack. The names are of all VFS shims and the
+** final bottom-level VFS are written into memory obtained from
+** [sqlite3_malloc()] and the result is stored in the char* variable
+** that the fourth parameter of [sqlite3_file_control()] points to.
+** The caller is responsible for freeing the memory when done. As with
+** all file-control actions, there is no guarantee that this will actually
+** do anything. Callers should initialize the char* variable to a NULL
+** pointer in case this file-control is not implemented. This file-control
+** is intended for diagnostic use only.
+**
+** <li>[[SQLITE_FCNTL_VFS_POINTER]]
+** ^The [SQLITE_FCNTL_VFS_POINTER] opcode finds a pointer to the top-level
+** [VFSes] currently in use. ^(The argument X in
+** sqlite3_file_control(db,SQLITE_FCNTL_VFS_POINTER,X) must be
+** of type "[sqlite3_vfs] **". This opcodes will set *X
+** to a pointer to the top-level VFS.)^
+** ^When there are multiple VFS shims in the stack, this opcode finds the
+** upper-most shim only.
+**
+** <li>[[SQLITE_FCNTL_PRAGMA]]
+** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA]
+** file control is sent to the open [sqlite3_file] object corresponding
+** to the database file to which the pragma statement refers. ^The argument
+** to the [SQLITE_FCNTL_PRAGMA] file control is an array of
+** pointers to strings (char**) in which the second element of the array
+** is the name of the pragma and the third element is the argument to the
+** pragma or NULL if the pragma has no argument. ^The handler for an
+** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element
+** of the char** argument point to a string obtained from [sqlite3_mprintf()]
+** or the equivalent and that string will become the result of the pragma or
+** the error message if the pragma fails. ^If the
+** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal
+** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA]
+** file control returns [SQLITE_OK], then the parser assumes that the
+** VFS has handled the PRAGMA itself and the parser generates a no-op
+** prepared statement if result string is NULL, or that returns a copy
+** of the result string if the string is non-NULL.
+** ^If the [SQLITE_FCNTL_PRAGMA] file control returns
+** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means
+** that the VFS encountered an error while handling the [PRAGMA] and the
+** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA]
+** file control occurs at the beginning of pragma statement analysis and so
+** it is able to override built-in [PRAGMA] statements.
+**
+** <li>[[SQLITE_FCNTL_BUSYHANDLER]]
+** ^The [SQLITE_FCNTL_BUSYHANDLER]
+** file-control may be invoked by SQLite on the database file handle
+** shortly after it is opened in order to provide a custom VFS with access
+** to the connection's busy-handler callback. The argument is of type (void**)
+** - an array of two (void *) values. The first (void *) actually points
+** to a function of type (int (*)(void *)). In order to invoke the connection's
+** busy-handler, this function should be invoked with the second (void *) in
+** the array as the only argument. If it returns non-zero, then the operation
+** should be retried. If it returns zero, the custom VFS should abandon the
+** current operation.
+**
+** <li>[[SQLITE_FCNTL_TEMPFILENAME]]
+** ^Applications can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control
+** to have SQLite generate a
+** temporary filename using the same algorithm that is followed to generate
+** temporary filenames for TEMP tables and other internal uses. The
+** argument should be a char** which will be filled with the filename
+** written into memory obtained from [sqlite3_malloc()]. The caller should
+** invoke [sqlite3_free()] on the result to avoid a memory leak.
+**
+** <li>[[SQLITE_FCNTL_MMAP_SIZE]]
+** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the
+** maximum number of bytes that will be used for memory-mapped I/O.
+** The argument is a pointer to a value of type sqlite3_int64 that
+** is an advisory maximum number of bytes in the file to memory map. The
+** pointer is overwritten with the old value. The limit is not changed if
+** the value originally pointed to is negative, and so the current limit
+** can be queried by passing in a pointer to a negative number. This
+** file-control is used internally to implement [PRAGMA mmap_size].
+**
+** <li>[[SQLITE_FCNTL_TRACE]]
+** The [SQLITE_FCNTL_TRACE] file control provides advisory information
+** to the VFS about what the higher layers of the SQLite stack are doing.
+** This file control is used by some VFS activity tracing [shims].
+** The argument is a zero-terminated string. Higher layers in the
+** SQLite stack may generate instances of this file control if
+** the [SQLITE_USE_FCNTL_TRACE] compile-time option is enabled.
+**
+** <li>[[SQLITE_FCNTL_HAS_MOVED]]
+** The [SQLITE_FCNTL_HAS_MOVED] file control interprets its argument as a
+** pointer to an integer and it writes a boolean into that integer depending
+** on whether or not the file has been renamed, moved, or deleted since it
+** was first opened.
+**
+** <li>[[SQLITE_FCNTL_WIN32_GET_HANDLE]]
+** The [SQLITE_FCNTL_WIN32_GET_HANDLE] opcode can be used to obtain the
+** underlying native file handle associated with a file handle. This file
+** control interprets its argument as a pointer to a native file handle and
+** writes the resulting value there.
+**
+** <li>[[SQLITE_FCNTL_WIN32_SET_HANDLE]]
+** The [SQLITE_FCNTL_WIN32_SET_HANDLE] opcode is used for debugging. This
+** opcode causes the xFileControl method to swap the file handle with the one
+** pointed to by the pArg argument. This capability is used during testing
+** and only needs to be supported when SQLITE_TEST is defined.
+**
+** <li>[[SQLITE_FCNTL_WAL_BLOCK]]
+** The [SQLITE_FCNTL_WAL_BLOCK] is a signal to the VFS layer that it might
+** be advantageous to block on the next WAL lock if the lock is not immediately
+** available. The WAL subsystem issues this signal during rare
+** circumstances in order to fix a problem with priority inversion.
+** Applications should <em>not</em> use this file-control.
+**
+** <li>[[SQLITE_FCNTL_ZIPVFS]]
+** The [SQLITE_FCNTL_ZIPVFS] opcode is implemented by zipvfs only. All other
+** VFS should return SQLITE_NOTFOUND for this opcode.
+**
+** <li>[[SQLITE_FCNTL_RBU]]
+** The [SQLITE_FCNTL_RBU] opcode is implemented by the special VFS used by
+** the RBU extension only. All other VFS should return SQLITE_NOTFOUND for
+** this opcode.
+**
+** <li>[[SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]]
+** If the [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] opcode returns SQLITE_OK, then
+** the file descriptor is placed in "batch write mode", which
+** means all subsequent write operations will be deferred and done
+** atomically at the next [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]. Systems
+** that do not support batch atomic writes will return SQLITE_NOTFOUND.
+** ^Following a successful SQLITE_FCNTL_BEGIN_ATOMIC_WRITE and prior to
+** the closing [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] or
+** [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE], SQLite will make
+** no VFS interface calls on the same [sqlite3_file] file descriptor
+** except for calls to the xWrite method and the xFileControl method
+** with [SQLITE_FCNTL_SIZE_HINT].
+**
+** <li>[[SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]]
+** The [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] opcode causes all write
+** operations since the previous successful call to
+** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be performed atomically.
+** This file control returns [SQLITE_OK] if and only if the writes were
+** all performed successfully and have been committed to persistent storage.
+** ^Regardless of whether or not it is successful, this file control takes
+** the file descriptor out of batch write mode so that all subsequent
+** write operations are independent.
+** ^SQLite will never invoke SQLITE_FCNTL_COMMIT_ATOMIC_WRITE without
+** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE].
+**
+** <li>[[SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE]]
+** The [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE] opcode causes all write
+** operations since the previous successful call to
+** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be rolled back.
+** ^This file control takes the file descriptor out of batch write mode
+** so that all subsequent write operations are independent.
+** ^SQLite will never invoke SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE without
+** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE].
+**
+** <li>[[SQLITE_FCNTL_LOCK_TIMEOUT]]
+** The [SQLITE_FCNTL_LOCK_TIMEOUT] opcode is used to configure a VFS
+** to block for up to M milliseconds before failing when attempting to
+** obtain a file lock using the xLock or xShmLock methods of the VFS.
+** The parameter is a pointer to a 32-bit signed integer that contains
+** the value that M is to be set to. Before returning, the 32-bit signed
+** integer is overwritten with the previous value of M.
+**
+** <li>[[SQLITE_FCNTL_DATA_VERSION]]
+** The [SQLITE_FCNTL_DATA_VERSION] opcode is used to detect changes to
+** a database file. The argument is a pointer to a 32-bit unsigned integer.
+** The "data version" for the pager is written into the pointer. The
+** "data version" changes whenever any change occurs to the corresponding
+** database file, either through SQL statements on the same database
+** connection or through transactions committed by separate database
+** connections possibly in other processes. The [sqlite3_total_changes()]
+** interface can be used to find if any database on the connection has changed,
+** but that interface responds to changes on TEMP as well as MAIN and does
+** not provide a mechanism to detect changes to MAIN only. Also, the
+** [sqlite3_total_changes()] interface responds to internal changes only and
+** omits changes made by other database connections. The
+** [PRAGMA data_version] command provides a mechanism to detect changes to
+** a single attached database that occur due to other database connections,
+** but omits changes implemented by the database connection on which it is
+** called. This file control is the only mechanism to detect changes that
+** happen either internally or externally and that are associated with
+** a particular attached database.
+**
+** <li>[[SQLITE_FCNTL_CKPT_START]]
+** The [SQLITE_FCNTL_CKPT_START] opcode is invoked from within a checkpoint
+** in wal mode before the client starts to copy pages from the wal
+** file to the database file.
+**
+** <li>[[SQLITE_FCNTL_CKPT_DONE]]
+** The [SQLITE_FCNTL_CKPT_DONE] opcode is invoked from within a checkpoint
+** in wal mode after the client has finished copying pages from the wal
+** file to the database file, but before the *-shm file is updated to
+** record the fact that the pages have been checkpointed.
+** </ul>
+*/
+#define SQLITE_FCNTL_LOCKSTATE 1
+#define SQLITE_FCNTL_GET_LOCKPROXYFILE 2
+#define SQLITE_FCNTL_SET_LOCKPROXYFILE 3
+#define SQLITE_FCNTL_LAST_ERRNO 4
+#define SQLITE_FCNTL_SIZE_HINT 5
+#define SQLITE_FCNTL_CHUNK_SIZE 6
+#define SQLITE_FCNTL_FILE_POINTER 7
+#define SQLITE_FCNTL_SYNC_OMITTED 8
+#define SQLITE_FCNTL_WIN32_AV_RETRY 9
+#define SQLITE_FCNTL_PERSIST_WAL 10
+#define SQLITE_FCNTL_OVERWRITE 11
+#define SQLITE_FCNTL_VFSNAME 12
+#define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13
+#define SQLITE_FCNTL_PRAGMA 14
+#define SQLITE_FCNTL_BUSYHANDLER 15
+#define SQLITE_FCNTL_TEMPFILENAME 16
+#define SQLITE_FCNTL_MMAP_SIZE 18
+#define SQLITE_FCNTL_TRACE 19
+#define SQLITE_FCNTL_HAS_MOVED 20
+#define SQLITE_FCNTL_SYNC 21
+#define SQLITE_FCNTL_COMMIT_PHASETWO 22
+#define SQLITE_FCNTL_WIN32_SET_HANDLE 23
+#define SQLITE_FCNTL_WAL_BLOCK 24
+#define SQLITE_FCNTL_ZIPVFS 25
+#define SQLITE_FCNTL_RBU 26
+#define SQLITE_FCNTL_VFS_POINTER 27
+#define SQLITE_FCNTL_JOURNAL_POINTER 28
+#define SQLITE_FCNTL_WIN32_GET_HANDLE 29
+#define SQLITE_FCNTL_PDB 30
+#define SQLITE_FCNTL_BEGIN_ATOMIC_WRITE 31
+#define SQLITE_FCNTL_COMMIT_ATOMIC_WRITE 32
+#define SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE 33
+#define SQLITE_FCNTL_LOCK_TIMEOUT 34
+#define SQLITE_FCNTL_DATA_VERSION 35
+#define SQLITE_FCNTL_SIZE_LIMIT 36
+#define SQLITE_FCNTL_CKPT_DONE 37
+#define SQLITE_FCNTL_RESERVE_BYTES 38
+#define SQLITE_FCNTL_CKPT_START 39
+
+/* deprecated names */
+#define SQLITE_GET_LOCKPROXYFILE SQLITE_FCNTL_GET_LOCKPROXYFILE
+#define SQLITE_SET_LOCKPROXYFILE SQLITE_FCNTL_SET_LOCKPROXYFILE
+#define SQLITE_LAST_ERRNO SQLITE_FCNTL_LAST_ERRNO
+
+
+/*
+** CAPI3REF: Mutex Handle
+**
+** The mutex module within SQLite defines [sqlite3_mutex] to be an
+** abstract type for a mutex object. The SQLite core never looks
+** at the internal representation of an [sqlite3_mutex]. It only
+** deals with pointers to the [sqlite3_mutex] object.
+**
+** Mutexes are created using [sqlite3_mutex_alloc()].
+*/
+typedef struct sqlite3_mutex sqlite3_mutex;
+
+/*
+** CAPI3REF: Loadable Extension Thunk
+**
+** A pointer to the opaque sqlite3_api_routines structure is passed as
+** the third parameter to entry points of [loadable extensions]. This
+** structure must be typedefed in order to work around compiler warnings
+** on some platforms.
+*/
+typedef struct sqlite3_api_routines sqlite3_api_routines;
+
+/*
+** CAPI3REF: OS Interface Object
+**
+** An instance of the sqlite3_vfs object defines the interface between
+** the SQLite core and the underlying operating system. The "vfs"
+** in the name of the object stands for "virtual file system". See
+** the [VFS | VFS documentation] for further information.
+**
+** The VFS interface is sometimes extended by adding new methods onto
+** the end. Each time such an extension occurs, the iVersion field
+** is incremented. The iVersion value started out as 1 in
+** SQLite [version 3.5.0] on [dateof:3.5.0], then increased to 2
+** with SQLite [version 3.7.0] on [dateof:3.7.0], and then increased
+** to 3 with SQLite [version 3.7.6] on [dateof:3.7.6]. Additional fields
+** may be appended to the sqlite3_vfs object and the iVersion value
+** may increase again in future versions of SQLite.
+** Note that due to an oversight, the structure
+** of the sqlite3_vfs object changed in the transition from
+** SQLite [version 3.5.9] to [version 3.6.0] on [dateof:3.6.0]
+** and yet the iVersion field was not increased.
+**
+** The szOsFile field is the size of the subclassed [sqlite3_file]
+** structure used by this VFS. mxPathname is the maximum length of
+** a pathname in this VFS.
+**
+** Registered sqlite3_vfs objects are kept on a linked list formed by
+** the pNext pointer. The [sqlite3_vfs_register()]
+** and [sqlite3_vfs_unregister()] interfaces manage this list
+** in a thread-safe way. The [sqlite3_vfs_find()] interface
+** searches the list. Neither the application code nor the VFS
+** implementation should use the pNext pointer.
+**
+** The pNext field is the only field in the sqlite3_vfs
+** structure that SQLite will ever modify. SQLite will only access
+** or modify this field while holding a particular static mutex.
+** The application should never modify anything within the sqlite3_vfs
+** object once the object has been registered.
+**
+** The zName field holds the name of the VFS module. The name must
+** be unique across all VFS modules.
+**
+** [[sqlite3_vfs.xOpen]]
+** ^SQLite guarantees that the zFilename parameter to xOpen
+** is either a NULL pointer or string obtained
+** from xFullPathname() with an optional suffix added.
+** ^If a suffix is added to the zFilename parameter, it will
+** consist of a single "-" character followed by no more than
+** 11 alphanumeric and/or "-" characters.
+** ^SQLite further guarantees that
+** the string will be valid and unchanged until xClose() is
+** called. Because of the previous sentence,
+** the [sqlite3_file] can safely store a pointer to the
+** filename if it needs to remember the filename for some reason.
+** If the zFilename parameter to xOpen is a NULL pointer then xOpen
+** must invent its own temporary name for the file. ^Whenever the
+** xFilename parameter is NULL it will also be the case that the
+** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
+**
+** The flags argument to xOpen() includes all bits set in
+** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()]
+** or [sqlite3_open16()] is used, then flags includes at least
+** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE].
+** If xOpen() opens a file read-only then it sets *pOutFlags to
+** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set.
+**
+** ^(SQLite will also add one of the following flags to the xOpen()
+** call, depending on the object being opened:
+**
+** <ul>
+** <li> [SQLITE_OPEN_MAIN_DB]
+** <li> [SQLITE_OPEN_MAIN_JOURNAL]
+** <li> [SQLITE_OPEN_TEMP_DB]
+** <li> [SQLITE_OPEN_TEMP_JOURNAL]
+** <li> [SQLITE_OPEN_TRANSIENT_DB]
+** <li> [SQLITE_OPEN_SUBJOURNAL]
+** <li> [SQLITE_OPEN_MASTER_JOURNAL]
+** <li> [SQLITE_OPEN_WAL]
+** </ul>)^
+**
+** The file I/O implementation can use the object type flags to
+** change the way it deals with files. For example, an application
+** that does not care about crash recovery or rollback might make
+** the open of a journal file a no-op. Writes to this journal would
+** also be no-ops, and any attempt to read the journal would return
+** SQLITE_IOERR. Or the implementation might recognize that a database
+** file will be doing page-aligned sector reads and writes in a random
+** order and set up its I/O subsystem accordingly.
+**
+** SQLite might also add one of the following flags to the xOpen method:
+**
+** <ul>
+** <li> [SQLITE_OPEN_DELETEONCLOSE]
+** <li> [SQLITE_OPEN_EXCLUSIVE]
+** </ul>
+**
+** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
+** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE]
+** will be set for TEMP databases and their journals, transient
+** databases, and subjournals.
+**
+** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction
+** with the [SQLITE_OPEN_CREATE] flag, which are both directly
+** analogous to the O_EXCL and O_CREAT flags of the POSIX open()
+** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the
+** SQLITE_OPEN_CREATE, is used to indicate that file should always
+** be created, and that it is an error if it already exists.
+** It is <i>not</i> used to indicate the file should be opened
+** for exclusive access.
+**
+** ^At least szOsFile bytes of memory are allocated by SQLite
+** to hold the [sqlite3_file] structure passed as the third
+** argument to xOpen. The xOpen method does not have to
+** allocate the structure; it should just fill it in. Note that
+** the xOpen method must set the sqlite3_file.pMethods to either
+** a valid [sqlite3_io_methods] object or to NULL. xOpen must do
+** this even if the open fails. SQLite expects that the sqlite3_file.pMethods
+** element will be valid after xOpen returns regardless of the success
+** or failure of the xOpen call.
+**
+** [[sqlite3_vfs.xAccess]]
+** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
+** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
+** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
+** to test whether a file is at least readable. The SQLITE_ACCESS_READ
+** flag is never actually used and is not implemented in the built-in
+** VFSes of SQLite. The file is named by the second argument and can be a
+** directory. The xAccess method returns [SQLITE_OK] on success or some
+** non-zero error code if there is an I/O error or if the name of
+** the file given in the second argument is illegal. If SQLITE_OK
+** is returned, then non-zero or zero is written into *pResOut to indicate
+** whether or not the file is accessible.
+**
+** ^SQLite will always allocate at least mxPathname+1 bytes for the
+** output buffer xFullPathname. The exact size of the output buffer
+** is also passed as a parameter to both methods. If the output buffer
+** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
+** handled as a fatal error by SQLite, vfs implementations should endeavor
+** to prevent this by setting mxPathname to a sufficiently large value.
+**
+** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64()
+** interfaces are not strictly a part of the filesystem, but they are
+** included in the VFS structure for completeness.
+** The xRandomness() function attempts to return nBytes bytes
+** of good-quality randomness into zOut. The return value is
+** the actual number of bytes of randomness obtained.
+** The xSleep() method causes the calling thread to sleep for at
+** least the number of microseconds given. ^The xCurrentTime()
+** method returns a Julian Day Number for the current date and time as
+** a floating point value.
+** ^The xCurrentTimeInt64() method returns, as an integer, the Julian
+** Day Number multiplied by 86400000 (the number of milliseconds in
+** a 24-hour day).
+** ^SQLite will use the xCurrentTimeInt64() method to get the current
+** date and time if that method is available (if iVersion is 2 or
+** greater and the function pointer is not NULL) and will fall back
+** to xCurrentTime() if xCurrentTimeInt64() is unavailable.
+**
+** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces
+** are not used by the SQLite core. These optional interfaces are provided
+** by some VFSes to facilitate testing of the VFS code. By overriding
+** system calls with functions under its control, a test program can
+** simulate faults and error conditions that would otherwise be difficult
+** or impossible to induce. The set of system calls that can be overridden
+** varies from one VFS to another, and from one version of the same VFS to the
+** next. Applications that use these interfaces must be prepared for any
+** or all of these interfaces to be NULL or for their behavior to change
+** from one release to the next. Applications must not attempt to access
+** any of these methods if the iVersion of the VFS is less than 3.
+*/
+typedef struct sqlite3_vfs sqlite3_vfs;
+typedef void (*sqlite3_syscall_ptr)(void);
+struct sqlite3_vfs {
+ int iVersion; /* Structure version number (currently 3) */
+ int szOsFile; /* Size of subclassed sqlite3_file */
+ int mxPathname; /* Maximum file pathname length */
+ sqlite3_vfs *pNext; /* Next registered VFS */
+ const char *zName; /* Name of this virtual file system */
+ void *pAppData; /* Pointer to application-specific data */
+ int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
+ int flags, int *pOutFlags);
+ int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
+ int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut);
+ int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
+ void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
+ void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
+ void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void);
+ void (*xDlClose)(sqlite3_vfs*, void*);
+ int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
+ int (*xSleep)(sqlite3_vfs*, int microseconds);
+ int (*xCurrentTime)(sqlite3_vfs*, double*);
+ int (*xGetLastError)(sqlite3_vfs*, int, char *);
+ /*
+ ** The methods above are in version 1 of the sqlite_vfs object
+ ** definition. Those that follow are added in version 2 or later
+ */
+ int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*);
+ /*
+ ** The methods above are in versions 1 and 2 of the sqlite_vfs object.
+ ** Those below are for version 3 and greater.
+ */
+ int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr);
+ sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName);
+ const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName);
+ /*
+ ** The methods above are in versions 1 through 3 of the sqlite_vfs object.
+ ** New fields may be appended in future versions. The iVersion
+ ** value will increment whenever this happens.
+ */
+};
+
+/*
+** CAPI3REF: Flags for the xAccess VFS method
+**
+** These integer constants can be used as the third parameter to
+** the xAccess method of an [sqlite3_vfs] object. They determine
+** what kind of permissions the xAccess method is looking for.
+** With SQLITE_ACCESS_EXISTS, the xAccess method
+** simply checks whether the file exists.
+** With SQLITE_ACCESS_READWRITE, the xAccess method
+** checks whether the named directory is both readable and writable
+** (in other words, if files can be added, removed, and renamed within
+** the directory).
+** The SQLITE_ACCESS_READWRITE constant is currently used only by the
+** [temp_store_directory pragma], though this could change in a future
+** release of SQLite.
+** With SQLITE_ACCESS_READ, the xAccess method
+** checks whether the file is readable. The SQLITE_ACCESS_READ constant is
+** currently unused, though it might be used in a future release of
+** SQLite.
+*/
+#define SQLITE_ACCESS_EXISTS 0
+#define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */
+#define SQLITE_ACCESS_READ 2 /* Unused */
+
+/*
+** CAPI3REF: Flags for the xShmLock VFS method
+**
+** These integer constants define the various locking operations
+** allowed by the xShmLock method of [sqlite3_io_methods]. The
+** following are the only legal combinations of flags to the
+** xShmLock method:
+**
+** <ul>
+** <li> SQLITE_SHM_LOCK | SQLITE_SHM_SHARED
+** <li> SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE
+** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED
+** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE
+** </ul>
+**
+** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as
+** was given on the corresponding lock.
+**
+** The xShmLock method can transition between unlocked and SHARED or
+** between unlocked and EXCLUSIVE. It cannot transition between SHARED
+** and EXCLUSIVE.
+*/
+#define SQLITE_SHM_UNLOCK 1
+#define SQLITE_SHM_LOCK 2
+#define SQLITE_SHM_SHARED 4
+#define SQLITE_SHM_EXCLUSIVE 8
+
+/*
+** CAPI3REF: Maximum xShmLock index
+**
+** The xShmLock method on [sqlite3_io_methods] may use values
+** between 0 and this upper bound as its "offset" argument.
+** The SQLite core will never attempt to acquire or release a
+** lock outside of this range
+*/
+#define SQLITE_SHM_NLOCK 8
+
+
+/*
+** CAPI3REF: Initialize The SQLite Library
+**
+** ^The sqlite3_initialize() routine initializes the
+** SQLite library. ^The sqlite3_shutdown() routine
+** deallocates any resources that were allocated by sqlite3_initialize().
+** These routines are designed to aid in process initialization and
+** shutdown on embedded systems. Workstation applications using
+** SQLite normally do not need to invoke either of these routines.
+**
+** A call to sqlite3_initialize() is an "effective" call if it is
+** the first time sqlite3_initialize() is invoked during the lifetime of
+** the process, or if it is the first time sqlite3_initialize() is invoked
+** following a call to sqlite3_shutdown(). ^(Only an effective call
+** of sqlite3_initialize() does any initialization. All other calls
+** are harmless no-ops.)^
+**
+** A call to sqlite3_shutdown() is an "effective" call if it is the first
+** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only
+** an effective call to sqlite3_shutdown() does any deinitialization.
+** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^
+**
+** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown()
+** is not. The sqlite3_shutdown() interface must only be called from a
+** single thread. All open [database connections] must be closed and all
+** other SQLite resources must be deallocated prior to invoking
+** sqlite3_shutdown().
+**
+** Among other things, ^sqlite3_initialize() will invoke
+** sqlite3_os_init(). Similarly, ^sqlite3_shutdown()
+** will invoke sqlite3_os_end().
+**
+** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success.
+** ^If for some reason, sqlite3_initialize() is unable to initialize
+** the library (perhaps it is unable to allocate a needed resource such
+** as a mutex) it returns an [error code] other than [SQLITE_OK].
+**
+** ^The sqlite3_initialize() routine is called internally by many other
+** SQLite interfaces so that an application usually does not need to
+** invoke sqlite3_initialize() directly. For example, [sqlite3_open()]
+** calls sqlite3_initialize() so the SQLite library will be automatically
+** initialized when [sqlite3_open()] is called if it has not be initialized
+** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
+** compile-time option, then the automatic calls to sqlite3_initialize()
+** are omitted and the application must call sqlite3_initialize() directly
+** prior to using any other SQLite interface. For maximum portability,
+** it is recommended that applications always invoke sqlite3_initialize()
+** directly prior to using any other SQLite interface. Future releases
+** of SQLite may require this. In other words, the behavior exhibited
+** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the
+** default behavior in some future release of SQLite.
+**
+** The sqlite3_os_init() routine does operating-system specific
+** initialization of the SQLite library. The sqlite3_os_end()
+** routine undoes the effect of sqlite3_os_init(). Typical tasks
+** performed by these routines include allocation or deallocation
+** of static resources, initialization of global variables,
+** setting up a default [sqlite3_vfs] module, or setting up
+** a default configuration using [sqlite3_config()].
+**
+** The application should never invoke either sqlite3_os_init()
+** or sqlite3_os_end() directly. The application should only invoke
+** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init()
+** interface is called automatically by sqlite3_initialize() and
+** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate
+** implementations for sqlite3_os_init() and sqlite3_os_end()
+** are built into SQLite when it is compiled for Unix, Windows, or OS/2.
+** When [custom builds | built for other platforms]
+** (using the [SQLITE_OS_OTHER=1] compile-time
+** option) the application must supply a suitable implementation for
+** sqlite3_os_init() and sqlite3_os_end(). An application-supplied
+** implementation of sqlite3_os_init() or sqlite3_os_end()
+** must return [SQLITE_OK] on success and some other [error code] upon
+** failure.
+*/
+SQLITE_API int sqlite3_initialize(void);
+SQLITE_API int sqlite3_shutdown(void);
+SQLITE_API int sqlite3_os_init(void);
+SQLITE_API int sqlite3_os_end(void);
+
+/*
+** CAPI3REF: Configuring The SQLite Library
+**
+** The sqlite3_config() interface is used to make global configuration
+** changes to SQLite in order to tune SQLite to the specific needs of
+** the application. The default configuration is recommended for most
+** applications and so this routine is usually not necessary. It is
+** provided to support rare applications with unusual needs.
+**
+** <b>The sqlite3_config() interface is not threadsafe. The application
+** must ensure that no other SQLite interfaces are invoked by other
+** threads while sqlite3_config() is running.</b>
+**
+** The sqlite3_config() interface
+** may only be invoked prior to library initialization using
+** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
+** ^If sqlite3_config() is called after [sqlite3_initialize()] and before
+** [sqlite3_shutdown()] then it will return SQLITE_MISUSE.
+** Note, however, that ^sqlite3_config() can be called as part of the
+** implementation of an application-defined [sqlite3_os_init()].
+**
+** The first argument to sqlite3_config() is an integer
+** [configuration option] that determines
+** what property of SQLite is to be configured. Subsequent arguments
+** vary depending on the [configuration option]
+** in the first argument.
+**
+** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
+** ^If the option is unknown or SQLite is unable to set the option
+** then this routine returns a non-zero [error code].
+*/
+SQLITE_API int sqlite3_config(int, ...);
+
+/*
+** CAPI3REF: Configure database connections
+** METHOD: sqlite3
+**
+** The sqlite3_db_config() interface is used to make configuration
+** changes to a [database connection]. The interface is similar to
+** [sqlite3_config()] except that the changes apply to a single
+** [database connection] (specified in the first argument).
+**
+** The second argument to sqlite3_db_config(D,V,...) is the
+** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code
+** that indicates what aspect of the [database connection] is being configured.
+** Subsequent arguments vary depending on the configuration verb.
+**
+** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if
+** the call is considered successful.
+*/
+SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...);
+
+/*
+** CAPI3REF: Memory Allocation Routines
+**
+** An instance of this object defines the interface between SQLite
+** and low-level memory allocation routines.
+**
+** This object is used in only one place in the SQLite interface.
+** A pointer to an instance of this object is the argument to
+** [sqlite3_config()] when the configuration option is
+** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC].
+** By creating an instance of this object
+** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC])
+** during configuration, an application can specify an alternative
+** memory allocation subsystem for SQLite to use for all of its
+** dynamic memory needs.
+**
+** Note that SQLite comes with several [built-in memory allocators]
+** that are perfectly adequate for the overwhelming majority of applications
+** and that this object is only useful to a tiny minority of applications
+** with specialized memory allocation requirements. This object is
+** also used during testing of SQLite in order to specify an alternative
+** memory allocator that simulates memory out-of-memory conditions in
+** order to verify that SQLite recovers gracefully from such
+** conditions.
+**
+** The xMalloc, xRealloc, and xFree methods must work like the
+** malloc(), realloc() and free() functions from the standard C library.
+** ^SQLite guarantees that the second argument to
+** xRealloc is always a value returned by a prior call to xRoundup.
+**
+** xSize should return the allocated size of a memory allocation
+** previously obtained from xMalloc or xRealloc. The allocated size
+** is always at least as big as the requested size but may be larger.
+**
+** The xRoundup method returns what would be the allocated size of
+** a memory allocation given a particular requested size. Most memory
+** allocators round up memory allocations at least to the next multiple
+** of 8. Some allocators round up to a larger multiple or to a power of 2.
+** Every memory allocation request coming in through [sqlite3_malloc()]
+** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0,
+** that causes the corresponding memory allocation to fail.
+**
+** The xInit method initializes the memory allocator. For example,
+** it might allocate any required mutexes or initialize internal data
+** structures. The xShutdown method is invoked (indirectly) by
+** [sqlite3_shutdown()] and should deallocate any resources acquired
+** by xInit. The pAppData pointer is used as the only parameter to
+** xInit and xShutdown.
+**
+** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes
+** the xInit method, so the xInit method need not be threadsafe. The
+** xShutdown method is only called from [sqlite3_shutdown()] so it does
+** not need to be threadsafe either. For all other methods, SQLite
+** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the
+** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which
+** it is by default) and so the methods are automatically serialized.
+** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other
+** methods must be threadsafe or else make their own arrangements for
+** serialization.
+**
+** SQLite will never invoke xInit() more than once without an intervening
+** call to xShutdown().
+*/
+typedef struct sqlite3_mem_methods sqlite3_mem_methods;
+struct sqlite3_mem_methods {
+ void *(*xMalloc)(int); /* Memory allocation function */
+ void (*xFree)(void*); /* Free a prior allocation */
+ void *(*xRealloc)(void*,int); /* Resize an allocation */
+ int (*xSize)(void*); /* Return the size of an allocation */
+ int (*xRoundup)(int); /* Round up request size to allocation size */
+ int (*xInit)(void*); /* Initialize the memory allocator */
+ void (*xShutdown)(void*); /* Deinitialize the memory allocator */
+ void *pAppData; /* Argument to xInit() and xShutdown() */
+};
+
+/*
+** CAPI3REF: Configuration Options
+** KEYWORDS: {configuration option}
+**
+** These constants are the available integer configuration options that
+** can be passed as the first argument to the [sqlite3_config()] interface.
+**
+** New configuration options may be added in future releases of SQLite.
+** Existing configuration options might be discontinued. Applications
+** should check the return code from [sqlite3_config()] to make sure that
+** the call worked. The [sqlite3_config()] interface will return a
+** non-zero [error code] if a discontinued or unsupported configuration option
+** is invoked.
+**
+** <dl>
+** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt>
+** <dd>There are no arguments to this option. ^This option sets the
+** [threading mode] to Single-thread. In other words, it disables
+** all mutexing and puts SQLite into a mode where it can only be used
+** by a single thread. ^If SQLite is compiled with
+** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
+** it is not possible to change the [threading mode] from its default
+** value of Single-thread and so [sqlite3_config()] will return
+** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD
+** configuration option.</dd>
+**
+** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt>
+** <dd>There are no arguments to this option. ^This option sets the
+** [threading mode] to Multi-thread. In other words, it disables
+** mutexing on [database connection] and [prepared statement] objects.
+** The application is responsible for serializing access to
+** [database connections] and [prepared statements]. But other mutexes
+** are enabled so that SQLite will be safe to use in a multi-threaded
+** environment as long as no two threads attempt to use the same
+** [database connection] at the same time. ^If SQLite is compiled with
+** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
+** it is not possible to set the Multi-thread [threading mode] and
+** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
+** SQLITE_CONFIG_MULTITHREAD configuration option.</dd>
+**
+** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt>
+** <dd>There are no arguments to this option. ^This option sets the
+** [threading mode] to Serialized. In other words, this option enables
+** all mutexes including the recursive
+** mutexes on [database connection] and [prepared statement] objects.
+** In this mode (which is the default when SQLite is compiled with
+** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
+** to [database connections] and [prepared statements] so that the
+** application is free to use the same [database connection] or the
+** same [prepared statement] in different threads at the same time.
+** ^If SQLite is compiled with
+** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
+** it is not possible to set the Serialized [threading mode] and
+** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
+** SQLITE_CONFIG_SERIALIZED configuration option.</dd>
+**
+** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt>
+** <dd> ^(The SQLITE_CONFIG_MALLOC option takes a single argument which is
+** a pointer to an instance of the [sqlite3_mem_methods] structure.
+** The argument specifies
+** alternative low-level memory allocation routines to be used in place of
+** the memory allocation routines built into SQLite.)^ ^SQLite makes
+** its own private copy of the content of the [sqlite3_mem_methods] structure
+** before the [sqlite3_config()] call returns.</dd>
+**
+** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt>
+** <dd> ^(The SQLITE_CONFIG_GETMALLOC option takes a single argument which
+** is a pointer to an instance of the [sqlite3_mem_methods] structure.
+** The [sqlite3_mem_methods]
+** structure is filled with the currently defined memory allocation routines.)^
+** This option can be used to overload the default memory allocation
+** routines with a wrapper that simulations memory allocation failure or
+** tracks memory usage, for example. </dd>
+**
+** [[SQLITE_CONFIG_SMALL_MALLOC]] <dt>SQLITE_CONFIG_SMALL_MALLOC</dt>
+** <dd> ^The SQLITE_CONFIG_SMALL_MALLOC option takes single argument of
+** type int, interpreted as a boolean, which if true provides a hint to
+** SQLite that it should avoid large memory allocations if possible.
+** SQLite will run faster if it is free to make large memory allocations,
+** but some application might prefer to run slower in exchange for
+** guarantees about memory fragmentation that are possible if large
+** allocations are avoided. This hint is normally off.
+** </dd>
+**
+** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt>
+** <dd> ^The SQLITE_CONFIG_MEMSTATUS option takes single argument of type int,
+** interpreted as a boolean, which enables or disables the collection of
+** memory allocation statistics. ^(When memory allocation statistics are
+** disabled, the following SQLite interfaces become non-operational:
+** <ul>
+** <li> [sqlite3_hard_heap_limit64()]
+** <li> [sqlite3_memory_used()]
+** <li> [sqlite3_memory_highwater()]
+** <li> [sqlite3_soft_heap_limit64()]
+** <li> [sqlite3_status64()]
+** </ul>)^
+** ^Memory allocation statistics are enabled by default unless SQLite is
+** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory
+** allocation statistics are disabled by default.
+** </dd>
+**
+** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt>
+** <dd> The SQLITE_CONFIG_SCRATCH option is no longer used.
+** </dd>
+**
+** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt>
+** <dd> ^The SQLITE_CONFIG_PAGECACHE option specifies a memory pool
+** that SQLite can use for the database page cache with the default page
+** cache implementation.
+** This configuration option is a no-op if an application-defined page
+** cache implementation is loaded using the [SQLITE_CONFIG_PCACHE2].
+** ^There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to
+** 8-byte aligned memory (pMem), the size of each page cache line (sz),
+** and the number of cache lines (N).
+** The sz argument should be the size of the largest database page
+** (a power of two between 512 and 65536) plus some extra bytes for each
+** page header. ^The number of extra bytes needed by the page header
+** can be determined using [SQLITE_CONFIG_PCACHE_HDRSZ].
+** ^It is harmless, apart from the wasted memory,
+** for the sz parameter to be larger than necessary. The pMem
+** argument must be either a NULL pointer or a pointer to an 8-byte
+** aligned block of memory of at least sz*N bytes, otherwise
+** subsequent behavior is undefined.
+** ^When pMem is not NULL, SQLite will strive to use the memory provided
+** to satisfy page cache needs, falling back to [sqlite3_malloc()] if
+** a page cache line is larger than sz bytes or if all of the pMem buffer
+** is exhausted.
+** ^If pMem is NULL and N is non-zero, then each database connection
+** does an initial bulk allocation for page cache memory
+** from [sqlite3_malloc()] sufficient for N cache lines if N is positive or
+** of -1024*N bytes if N is negative, . ^If additional
+** page cache memory is needed beyond what is provided by the initial
+** allocation, then SQLite goes to [sqlite3_malloc()] separately for each
+** additional cache line. </dd>
+**
+** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt>
+** <dd> ^The SQLITE_CONFIG_HEAP option specifies a static memory buffer
+** that SQLite will use for all of its dynamic memory allocation needs
+** beyond those provided for by [SQLITE_CONFIG_PAGECACHE].
+** ^The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled
+** with either [SQLITE_ENABLE_MEMSYS3] or [SQLITE_ENABLE_MEMSYS5] and returns
+** [SQLITE_ERROR] if invoked otherwise.
+** ^There are three arguments to SQLITE_CONFIG_HEAP:
+** An 8-byte aligned pointer to the memory,
+** the number of bytes in the memory buffer, and the minimum allocation size.
+** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts
+** to using its default memory allocator (the system malloc() implementation),
+** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the
+** memory pointer is not NULL then the alternative memory
+** allocator is engaged to handle all of SQLites memory allocation needs.
+** The first pointer (the memory pointer) must be aligned to an 8-byte
+** boundary or subsequent behavior of SQLite will be undefined.
+** The minimum allocation size is capped at 2**12. Reasonable values
+** for the minimum allocation size are 2**5 through 2**8.</dd>
+**
+** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt>
+** <dd> ^(The SQLITE_CONFIG_MUTEX option takes a single argument which is a
+** pointer to an instance of the [sqlite3_mutex_methods] structure.
+** The argument specifies alternative low-level mutex routines to be used
+** in place the mutex routines built into SQLite.)^ ^SQLite makes a copy of
+** the content of the [sqlite3_mutex_methods] structure before the call to
+** [sqlite3_config()] returns. ^If SQLite is compiled with
+** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
+** the entire mutexing subsystem is omitted from the build and hence calls to
+** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will
+** return [SQLITE_ERROR].</dd>
+**
+** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt>
+** <dd> ^(The SQLITE_CONFIG_GETMUTEX option takes a single argument which
+** is a pointer to an instance of the [sqlite3_mutex_methods] structure. The
+** [sqlite3_mutex_methods]
+** structure is filled with the currently defined mutex routines.)^
+** This option can be used to overload the default mutex allocation
+** routines with a wrapper used to track mutex usage for performance
+** profiling or testing, for example. ^If SQLite is compiled with
+** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
+** the entire mutexing subsystem is omitted from the build and hence calls to
+** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will
+** return [SQLITE_ERROR].</dd>
+**
+** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt>
+** <dd> ^(The SQLITE_CONFIG_LOOKASIDE option takes two arguments that determine
+** the default size of lookaside memory on each [database connection].
+** The first argument is the
+** size of each lookaside buffer slot and the second is the number of
+** slots allocated to each database connection.)^ ^(SQLITE_CONFIG_LOOKASIDE
+** sets the <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE]
+** option to [sqlite3_db_config()] can be used to change the lookaside
+** configuration on individual connections.)^ </dd>
+**
+** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt>
+** <dd> ^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is
+** a pointer to an [sqlite3_pcache_methods2] object. This object specifies
+** the interface to a custom page cache implementation.)^
+** ^SQLite makes a copy of the [sqlite3_pcache_methods2] object.</dd>
+**
+** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt>
+** <dd> ^(The SQLITE_CONFIG_GETPCACHE2 option takes a single argument which
+** is a pointer to an [sqlite3_pcache_methods2] object. SQLite copies of
+** the current page cache implementation into that object.)^ </dd>
+**
+** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt>
+** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite
+** global [error log].
+** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a
+** function with a call signature of void(*)(void*,int,const char*),
+** and a pointer to void. ^If the function pointer is not NULL, it is
+** invoked by [sqlite3_log()] to process each logging event. ^If the
+** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op.
+** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is
+** passed through as the first parameter to the application-defined logger
+** function whenever that function is invoked. ^The second parameter to
+** the logger function is a copy of the first parameter to the corresponding
+** [sqlite3_log()] call and is intended to be a [result code] or an
+** [extended result code]. ^The third parameter passed to the logger is
+** log message after formatting via [sqlite3_snprintf()].
+** The SQLite logging interface is not reentrant; the logger function
+** supplied by the application must not invoke any SQLite interface.
+** In a multi-threaded application, the application-defined logger
+** function must be threadsafe. </dd>
+**
+** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI
+** <dd>^(The SQLITE_CONFIG_URI option takes a single argument of type int.
+** If non-zero, then URI handling is globally enabled. If the parameter is zero,
+** then URI handling is globally disabled.)^ ^If URI handling is globally
+** enabled, all filenames passed to [sqlite3_open()], [sqlite3_open_v2()],
+** [sqlite3_open16()] or
+** specified as part of [ATTACH] commands are interpreted as URIs, regardless
+** of whether or not the [SQLITE_OPEN_URI] flag is set when the database
+** connection is opened. ^If it is globally disabled, filenames are
+** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the
+** database connection is opened. ^(By default, URI handling is globally
+** disabled. The default value may be changed by compiling with the
+** [SQLITE_USE_URI] symbol defined.)^
+**
+** [[SQLITE_CONFIG_COVERING_INDEX_SCAN]] <dt>SQLITE_CONFIG_COVERING_INDEX_SCAN
+** <dd>^The SQLITE_CONFIG_COVERING_INDEX_SCAN option takes a single integer
+** argument which is interpreted as a boolean in order to enable or disable
+** the use of covering indices for full table scans in the query optimizer.
+** ^The default setting is determined
+** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on"
+** if that compile-time option is omitted.
+** The ability to disable the use of covering indices for full table scans
+** is because some incorrectly coded legacy applications might malfunction
+** when the optimization is enabled. Providing the ability to
+** disable the optimization allows the older, buggy application code to work
+** without change even with newer versions of SQLite.
+**
+** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]]
+** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE
+** <dd> These options are obsolete and should not be used by new code.
+** They are retained for backwards compatibility but are now no-ops.
+** </dd>
+**
+** [[SQLITE_CONFIG_SQLLOG]]
+** <dt>SQLITE_CONFIG_SQLLOG
+** <dd>This option is only available if sqlite is compiled with the
+** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should
+** be a pointer to a function of type void(*)(void*,sqlite3*,const char*, int).
+** The second should be of type (void*). The callback is invoked by the library
+** in three separate circumstances, identified by the value passed as the
+** fourth parameter. If the fourth parameter is 0, then the database connection
+** passed as the second argument has just been opened. The third argument
+** points to a buffer containing the name of the main database file. If the
+** fourth parameter is 1, then the SQL statement that the third parameter
+** points to has just been executed. Or, if the fourth parameter is 2, then
+** the connection being passed as the second parameter is being closed. The
+** third parameter is passed NULL In this case. An example of using this
+** configuration option can be seen in the "test_sqllog.c" source file in
+** the canonical SQLite source tree.</dd>
+**
+** [[SQLITE_CONFIG_MMAP_SIZE]]
+** <dt>SQLITE_CONFIG_MMAP_SIZE
+** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values
+** that are the default mmap size limit (the default setting for
+** [PRAGMA mmap_size]) and the maximum allowed mmap size limit.
+** ^The default setting can be overridden by each database connection using
+** either the [PRAGMA mmap_size] command, or by using the
+** [SQLITE_FCNTL_MMAP_SIZE] file control. ^(The maximum allowed mmap size
+** will be silently truncated if necessary so that it does not exceed the
+** compile-time maximum mmap size set by the
+** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^
+** ^If either argument to this option is negative, then that argument is
+** changed to its compile-time default.
+**
+** [[SQLITE_CONFIG_WIN32_HEAPSIZE]]
+** <dt>SQLITE_CONFIG_WIN32_HEAPSIZE
+** <dd>^The SQLITE_CONFIG_WIN32_HEAPSIZE option is only available if SQLite is
+** compiled for Windows with the [SQLITE_WIN32_MALLOC] pre-processor macro
+** defined. ^SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value
+** that specifies the maximum size of the created heap.
+**
+** [[SQLITE_CONFIG_PCACHE_HDRSZ]]
+** <dt>SQLITE_CONFIG_PCACHE_HDRSZ
+** <dd>^The SQLITE_CONFIG_PCACHE_HDRSZ option takes a single parameter which
+** is a pointer to an integer and writes into that integer the number of extra
+** bytes per page required for each page in [SQLITE_CONFIG_PAGECACHE].
+** The amount of extra space required can change depending on the compiler,
+** target platform, and SQLite version.
+**
+** [[SQLITE_CONFIG_PMASZ]]
+** <dt>SQLITE_CONFIG_PMASZ
+** <dd>^The SQLITE_CONFIG_PMASZ option takes a single parameter which
+** is an unsigned integer and sets the "Minimum PMA Size" for the multithreaded
+** sorter to that integer. The default minimum PMA Size is set by the
+** [SQLITE_SORTER_PMASZ] compile-time option. New threads are launched
+** to help with sort operations when multithreaded sorting
+** is enabled (using the [PRAGMA threads] command) and the amount of content
+** to be sorted exceeds the page size times the minimum of the
+** [PRAGMA cache_size] setting and this value.
+**
+** [[SQLITE_CONFIG_STMTJRNL_SPILL]]
+** <dt>SQLITE_CONFIG_STMTJRNL_SPILL
+** <dd>^The SQLITE_CONFIG_STMTJRNL_SPILL option takes a single parameter which
+** becomes the [statement journal] spill-to-disk threshold.
+** [Statement journals] are held in memory until their size (in bytes)
+** exceeds this threshold, at which point they are written to disk.
+** Or if the threshold is -1, statement journals are always held
+** exclusively in memory.
+** Since many statement journals never become large, setting the spill
+** threshold to a value such as 64KiB can greatly reduce the amount of
+** I/O required to support statement rollback.
+** The default value for this setting is controlled by the
+** [SQLITE_STMTJRNL_SPILL] compile-time option.
+**
+** [[SQLITE_CONFIG_SORTERREF_SIZE]]
+** <dt>SQLITE_CONFIG_SORTERREF_SIZE
+** <dd>The SQLITE_CONFIG_SORTERREF_SIZE option accepts a single parameter
+** of type (int) - the new value of the sorter-reference size threshold.
+** Usually, when SQLite uses an external sort to order records according
+** to an ORDER BY clause, all fields required by the caller are present in the
+** sorted records. However, if SQLite determines based on the declared type
+** of a table column that its values are likely to be very large - larger
+** than the configured sorter-reference size threshold - then a reference
+** is stored in each sorted record and the required column values loaded
+** from the database as records are returned in sorted order. The default
+** value for this option is to never use this optimization. Specifying a
+** negative value for this option restores the default behaviour.
+** This option is only available if SQLite is compiled with the
+** [SQLITE_ENABLE_SORTER_REFERENCES] compile-time option.
+**
+** [[SQLITE_CONFIG_MEMDB_MAXSIZE]]
+** <dt>SQLITE_CONFIG_MEMDB_MAXSIZE
+** <dd>The SQLITE_CONFIG_MEMDB_MAXSIZE option accepts a single parameter
+** [sqlite3_int64] parameter which is the default maximum size for an in-memory
+** database created using [sqlite3_deserialize()]. This default maximum
+** size can be adjusted up or down for individual databases using the
+** [SQLITE_FCNTL_SIZE_LIMIT] [sqlite3_file_control|file-control]. If this
+** configuration setting is never used, then the default maximum is determined
+** by the [SQLITE_MEMDB_DEFAULT_MAXSIZE] compile-time option. If that
+** compile-time option is not set, then the default maximum is 1073741824.
+** </dl>
+*/
+#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
+#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */
+#define SQLITE_CONFIG_SERIALIZED 3 /* nil */
+#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */
+#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */
+#define SQLITE_CONFIG_SCRATCH 6 /* No longer used */
+#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */
+#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */
+#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */
+#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */
+#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */
+/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */
+#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */
+#define SQLITE_CONFIG_PCACHE 14 /* no-op */
+#define SQLITE_CONFIG_GETPCACHE 15 /* no-op */
+#define SQLITE_CONFIG_LOG 16 /* xFunc, void* */
+#define SQLITE_CONFIG_URI 17 /* int */
+#define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */
+#define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */
+#define SQLITE_CONFIG_COVERING_INDEX_SCAN 20 /* int */
+#define SQLITE_CONFIG_SQLLOG 21 /* xSqllog, void* */
+#define SQLITE_CONFIG_MMAP_SIZE 22 /* sqlite3_int64, sqlite3_int64 */
+#define SQLITE_CONFIG_WIN32_HEAPSIZE 23 /* int nByte */
+#define SQLITE_CONFIG_PCACHE_HDRSZ 24 /* int *psz */
+#define SQLITE_CONFIG_PMASZ 25 /* unsigned int szPma */
+#define SQLITE_CONFIG_STMTJRNL_SPILL 26 /* int nByte */
+#define SQLITE_CONFIG_SMALL_MALLOC 27 /* boolean */
+#define SQLITE_CONFIG_SORTERREF_SIZE 28 /* int nByte */
+#define SQLITE_CONFIG_MEMDB_MAXSIZE 29 /* sqlite3_int64 */
+
+/*
+** CAPI3REF: Database Connection Configuration Options
+**
+** These constants are the available integer configuration options that
+** can be passed as the second argument to the [sqlite3_db_config()] interface.
+**
+** New configuration options may be added in future releases of SQLite.
+** Existing configuration options might be discontinued. Applications
+** should check the return code from [sqlite3_db_config()] to make sure that
+** the call worked. ^The [sqlite3_db_config()] interface will return a
+** non-zero [error code] if a discontinued or unsupported configuration option
+** is invoked.
+**
+** <dl>
+** [[SQLITE_DBCONFIG_LOOKASIDE]]
+** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt>
+** <dd> ^This option takes three additional arguments that determine the
+** [lookaside memory allocator] configuration for the [database connection].
+** ^The first argument (the third parameter to [sqlite3_db_config()] is a
+** pointer to a memory buffer to use for lookaside memory.
+** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb
+** may be NULL in which case SQLite will allocate the
+** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the
+** size of each lookaside buffer slot. ^The third argument is the number of
+** slots. The size of the buffer in the first argument must be greater than
+** or equal to the product of the second and third arguments. The buffer
+** must be aligned to an 8-byte boundary. ^If the second argument to
+** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally
+** rounded down to the next smaller multiple of 8. ^(The lookaside memory
+** configuration for a database connection can only be changed when that
+** connection is not currently using lookaside memory, or in other words
+** when the "current value" returned by
+** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero.
+** Any attempt to change the lookaside memory configuration when lookaside
+** memory is in use leaves the configuration unchanged and returns
+** [SQLITE_BUSY].)^</dd>
+**
+** [[SQLITE_DBCONFIG_ENABLE_FKEY]]
+** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt>
+** <dd> ^This option is used to enable or disable the enforcement of
+** [foreign key constraints]. There should be two additional arguments.
+** The first argument is an integer which is 0 to disable FK enforcement,
+** positive to enable FK enforcement or negative to leave FK enforcement
+** unchanged. The second parameter is a pointer to an integer into which
+** is written 0 or 1 to indicate whether FK enforcement is off or on
+** following this call. The second parameter may be a NULL pointer, in
+** which case the FK enforcement setting is not reported back. </dd>
+**
+** [[SQLITE_DBCONFIG_ENABLE_TRIGGER]]
+** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt>
+** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers].
+** There should be two additional arguments.
+** The first argument is an integer which is 0 to disable triggers,
+** positive to enable triggers or negative to leave the setting unchanged.
+** The second parameter is a pointer to an integer into which
+** is written 0 or 1 to indicate whether triggers are disabled or enabled
+** following this call. The second parameter may be a NULL pointer, in
+** which case the trigger setting is not reported back. </dd>
+**
+** [[SQLITE_DBCONFIG_ENABLE_VIEW]]
+** <dt>SQLITE_DBCONFIG_ENABLE_VIEW</dt>
+** <dd> ^This option is used to enable or disable [CREATE VIEW | views].
+** There should be two additional arguments.
+** The first argument is an integer which is 0 to disable views,
+** positive to enable views or negative to leave the setting unchanged.
+** The second parameter is a pointer to an integer into which
+** is written 0 or 1 to indicate whether views are disabled or enabled
+** following this call. The second parameter may be a NULL pointer, in
+** which case the view setting is not reported back. </dd>
+**
+** [[SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER]]
+** <dt>SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER</dt>
+** <dd> ^This option is used to enable or disable the
+** [fts3_tokenizer()] function which is part of the
+** [FTS3] full-text search engine extension.
+** There should be two additional arguments.
+** The first argument is an integer which is 0 to disable fts3_tokenizer() or
+** positive to enable fts3_tokenizer() or negative to leave the setting
+** unchanged.
+** The second parameter is a pointer to an integer into which
+** is written 0 or 1 to indicate whether fts3_tokenizer is disabled or enabled
+** following this call. The second parameter may be a NULL pointer, in
+** which case the new setting is not reported back. </dd>
+**
+** [[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION]]
+** <dt>SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION</dt>
+** <dd> ^This option is used to enable or disable the [sqlite3_load_extension()]
+** interface independently of the [load_extension()] SQL function.
+** The [sqlite3_enable_load_extension()] API enables or disables both the
+** C-API [sqlite3_load_extension()] and the SQL function [load_extension()].
+** There should be two additional arguments.
+** When the first argument to this interface is 1, then only the C-API is
+** enabled and the SQL function remains disabled. If the first argument to
+** this interface is 0, then both the C-API and the SQL function are disabled.
+** If the first argument is -1, then no changes are made to state of either the
+** C-API or the SQL function.
+** The second parameter is a pointer to an integer into which
+** is written 0 or 1 to indicate whether [sqlite3_load_extension()] interface
+** is disabled or enabled following this call. The second parameter may
+** be a NULL pointer, in which case the new setting is not reported back.
+** </dd>
+**
+** [[SQLITE_DBCONFIG_MAINDBNAME]] <dt>SQLITE_DBCONFIG_MAINDBNAME</dt>
+** <dd> ^This option is used to change the name of the "main" database
+** schema. ^The sole argument is a pointer to a constant UTF8 string
+** which will become the new schema name in place of "main". ^SQLite
+** does not make a copy of the new main schema name string, so the application
+** must ensure that the argument passed into this DBCONFIG option is unchanged
+** until after the database connection closes.
+** </dd>
+**
+** [[SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE]]
+** <dt>SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE</dt>
+** <dd> Usually, when a database in wal mode is closed or detached from a
+** database handle, SQLite checks if this will mean that there are now no
+** connections at all to the database. If so, it performs a checkpoint
+** operation before closing the connection. This option may be used to
+** override this behaviour. The first parameter passed to this operation
+** is an integer - positive to disable checkpoints-on-close, or zero (the
+** default) to enable them, and negative to leave the setting unchanged.
+** The second parameter is a pointer to an integer
+** into which is written 0 or 1 to indicate whether checkpoints-on-close
+** have been disabled - 0 if they are not disabled, 1 if they are.
+** </dd>
+**
+** [[SQLITE_DBCONFIG_ENABLE_QPSG]] <dt>SQLITE_DBCONFIG_ENABLE_QPSG</dt>
+** <dd>^(The SQLITE_DBCONFIG_ENABLE_QPSG option activates or deactivates
+** the [query planner stability guarantee] (QPSG). When the QPSG is active,
+** a single SQL query statement will always use the same algorithm regardless
+** of values of [bound parameters].)^ The QPSG disables some query optimizations
+** that look at the values of bound parameters, which can make some queries
+** slower. But the QPSG has the advantage of more predictable behavior. With
+** the QPSG active, SQLite will always use the same query plan in the field as
+** was used during testing in the lab.
+** The first argument to this setting is an integer which is 0 to disable
+** the QPSG, positive to enable QPSG, or negative to leave the setting
+** unchanged. The second parameter is a pointer to an integer into which
+** is written 0 or 1 to indicate whether the QPSG is disabled or enabled
+** following this call.
+** </dd>
+**
+** [[SQLITE_DBCONFIG_TRIGGER_EQP]] <dt>SQLITE_DBCONFIG_TRIGGER_EQP</dt>
+** <dd> By default, the output of EXPLAIN QUERY PLAN commands does not
+** include output for any operations performed by trigger programs. This
+** option is used to set or clear (the default) a flag that governs this
+** behavior. The first parameter passed to this operation is an integer -
+** positive to enable output for trigger programs, or zero to disable it,
+** or negative to leave the setting unchanged.
+** The second parameter is a pointer to an integer into which is written
+** 0 or 1 to indicate whether output-for-triggers has been disabled - 0 if
+** it is not disabled, 1 if it is.
+** </dd>
+**
+** [[SQLITE_DBCONFIG_RESET_DATABASE]] <dt>SQLITE_DBCONFIG_RESET_DATABASE</dt>
+** <dd> Set the SQLITE_DBCONFIG_RESET_DATABASE flag and then run
+** [VACUUM] in order to reset a database back to an empty database
+** with no schema and no content. The following process works even for
+** a badly corrupted database file:
+** <ol>
+** <li> If the database connection is newly opened, make sure it has read the
+** database schema by preparing then discarding some query against the
+** database, or calling sqlite3_table_column_metadata(), ignoring any
+** errors. This step is only necessary if the application desires to keep
+** the database in WAL mode after the reset if it was in WAL mode before
+** the reset.
+** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 1, 0);
+** <li> [sqlite3_exec](db, "[VACUUM]", 0, 0, 0);
+** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 0, 0);
+** </ol>
+** Because resetting a database is destructive and irreversible, the
+** process requires the use of this obscure API and multiple steps to help
+** ensure that it does not happen by accident.
+**
+** [[SQLITE_DBCONFIG_DEFENSIVE]] <dt>SQLITE_DBCONFIG_DEFENSIVE</dt>
+** <dd>The SQLITE_DBCONFIG_DEFENSIVE option activates or deactivates the
+** "defensive" flag for a database connection. When the defensive
+** flag is enabled, language features that allow ordinary SQL to
+** deliberately corrupt the database file are disabled. The disabled
+** features include but are not limited to the following:
+** <ul>
+** <li> The [PRAGMA writable_schema=ON] statement.
+** <li> The [PRAGMA journal_mode=OFF] statement.
+** <li> Writes to the [sqlite_dbpage] virtual table.
+** <li> Direct writes to [shadow tables].
+** </ul>
+** </dd>
+**
+** [[SQLITE_DBCONFIG_WRITABLE_SCHEMA]] <dt>SQLITE_DBCONFIG_WRITABLE_SCHEMA</dt>
+** <dd>The SQLITE_DBCONFIG_WRITABLE_SCHEMA option activates or deactivates the
+** "writable_schema" flag. This has the same effect and is logically equivalent
+** to setting [PRAGMA writable_schema=ON] or [PRAGMA writable_schema=OFF].
+** The first argument to this setting is an integer which is 0 to disable
+** the writable_schema, positive to enable writable_schema, or negative to
+** leave the setting unchanged. The second parameter is a pointer to an
+** integer into which is written 0 or 1 to indicate whether the writable_schema
+** is enabled or disabled following this call.
+** </dd>
+**
+** [[SQLITE_DBCONFIG_LEGACY_ALTER_TABLE]]
+** <dt>SQLITE_DBCONFIG_LEGACY_ALTER_TABLE</dt>
+** <dd>The SQLITE_DBCONFIG_LEGACY_ALTER_TABLE option activates or deactivates
+** the legacy behavior of the [ALTER TABLE RENAME] command such it
+** behaves as it did prior to [version 3.24.0] (2018-06-04). See the
+** "Compatibility Notice" on the [ALTER TABLE RENAME documentation] for
+** additional information. This feature can also be turned on and off
+** using the [PRAGMA legacy_alter_table] statement.
+** </dd>
+**
+** [[SQLITE_DBCONFIG_DQS_DML]]
+** <dt>SQLITE_DBCONFIG_DQS_DML</td>
+** <dd>The SQLITE_DBCONFIG_DQS_DML option activates or deactivates
+** the legacy [double-quoted string literal] misfeature for DML statements
+** only, that is DELETE, INSERT, SELECT, and UPDATE statements. The
+** default value of this setting is determined by the [-DSQLITE_DQS]
+** compile-time option.
+** </dd>
+**
+** [[SQLITE_DBCONFIG_DQS_DDL]]
+** <dt>SQLITE_DBCONFIG_DQS_DDL</td>
+** <dd>The SQLITE_DBCONFIG_DQS option activates or deactivates
+** the legacy [double-quoted string literal] misfeature for DDL statements,
+** such as CREATE TABLE and CREATE INDEX. The
+** default value of this setting is determined by the [-DSQLITE_DQS]
+** compile-time option.
+** </dd>
+**
+** [[SQLITE_DBCONFIG_TRUSTED_SCHEMA]]
+** <dt>SQLITE_DBCONFIG_TRUSTED_SCHEMA</td>
+** <dd>The SQLITE_DBCONFIG_TRUSTED_SCHEMA option tells SQLite to
+** assume that database schemas (the contents of the [sqlite_master] tables)
+** are untainted by malicious content.
+** When the SQLITE_DBCONFIG_TRUSTED_SCHEMA option is disabled, SQLite
+** takes additional defensive steps to protect the application from harm
+** including:
+** <ul>
+** <li> Prohibit the use of SQL functions inside triggers, views,
+** CHECK constraints, DEFAULT clauses, expression indexes,
+** partial indexes, or generated columns
+** unless those functions are tagged with [SQLITE_INNOCUOUS].
+** <li> Prohibit the use of virtual tables inside of triggers or views
+** unless those virtual tables are tagged with [SQLITE_VTAB_INNOCUOUS].
+** </ul>
+** This setting defaults to "on" for legacy compatibility, however
+** all applications are advised to turn it off if possible. This setting
+** can also be controlled using the [PRAGMA trusted_schema] statement.
+** </dd>
+**
+** [[SQLITE_DBCONFIG_LEGACY_FILE_FORMAT]]
+** <dt>SQLITE_DBCONFIG_LEGACY_FILE_FORMAT</td>
+** <dd>The SQLITE_DBCONFIG_LEGACY_FILE_FORMAT option activates or deactivates
+** the legacy file format flag. When activated, this flag causes all newly
+** created database file to have a schema format version number (the 4-byte
+** integer found at offset 44 into the database header) of 1. This in turn
+** means that the resulting database file will be readable and writable by
+** any SQLite version back to 3.0.0 ([dateof:3.0.0]). Without this setting,
+** newly created databases are generally not understandable by SQLite versions
+** prior to 3.3.0 ([dateof:3.3.0]). As these words are written, there
+** is now scarcely any need to generated database files that are compatible
+** all the way back to version 3.0.0, and so this setting is of little
+** practical use, but is provided so that SQLite can continue to claim the
+** ability to generate new database files that are compatible with version
+** 3.0.0.
+** <p>Note that when the SQLITE_DBCONFIG_LEGACY_FILE_FORMAT setting is on,
+** the [VACUUM] command will fail with an obscure error when attempting to
+** process a table with generated columns and a descending index. This is
+** not considered a bug since SQLite versions 3.3.0 and earlier do not support
+** either generated columns or decending indexes.
+** </dd>
+** </dl>
+*/
+#define SQLITE_DBCONFIG_MAINDBNAME 1000 /* const char* */
+#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */
+#define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */
+#define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */
+#define SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER 1004 /* int int* */
+#define SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION 1005 /* int int* */
+#define SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE 1006 /* int int* */
+#define SQLITE_DBCONFIG_ENABLE_QPSG 1007 /* int int* */
+#define SQLITE_DBCONFIG_TRIGGER_EQP 1008 /* int int* */
+#define SQLITE_DBCONFIG_RESET_DATABASE 1009 /* int int* */
+#define SQLITE_DBCONFIG_DEFENSIVE 1010 /* int int* */
+#define SQLITE_DBCONFIG_WRITABLE_SCHEMA 1011 /* int int* */
+#define SQLITE_DBCONFIG_LEGACY_ALTER_TABLE 1012 /* int int* */
+#define SQLITE_DBCONFIG_DQS_DML 1013 /* int int* */
+#define SQLITE_DBCONFIG_DQS_DDL 1014 /* int int* */
+#define SQLITE_DBCONFIG_ENABLE_VIEW 1015 /* int int* */
+#define SQLITE_DBCONFIG_LEGACY_FILE_FORMAT 1016 /* int int* */
+#define SQLITE_DBCONFIG_TRUSTED_SCHEMA 1017 /* int int* */
+#define SQLITE_DBCONFIG_MAX 1017 /* Largest DBCONFIG */
+
+/*
+** CAPI3REF: Enable Or Disable Extended Result Codes
+** METHOD: sqlite3
+**
+** ^The sqlite3_extended_result_codes() routine enables or disables the
+** [extended result codes] feature of SQLite. ^The extended result
+** codes are disabled by default for historical compatibility.
+*/
+SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff);
+
+/*
+** CAPI3REF: Last Insert Rowid
+** METHOD: sqlite3
+**
+** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables)
+** has a unique 64-bit signed
+** integer key called the [ROWID | "rowid"]. ^The rowid is always available
+** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
+** names are not also used by explicitly declared columns. ^If
+** the table has a column of type [INTEGER PRIMARY KEY] then that column
+** is another alias for the rowid.
+**
+** ^The sqlite3_last_insert_rowid(D) interface usually returns the [rowid] of
+** the most recent successful [INSERT] into a rowid table or [virtual table]
+** on database connection D. ^Inserts into [WITHOUT ROWID] tables are not
+** recorded. ^If no successful [INSERT]s into rowid tables have ever occurred
+** on the database connection D, then sqlite3_last_insert_rowid(D) returns
+** zero.
+**
+** As well as being set automatically as rows are inserted into database
+** tables, the value returned by this function may be set explicitly by
+** [sqlite3_set_last_insert_rowid()]
+**
+** Some virtual table implementations may INSERT rows into rowid tables as
+** part of committing a transaction (e.g. to flush data accumulated in memory
+** to disk). In this case subsequent calls to this function return the rowid
+** associated with these internal INSERT operations, which leads to
+** unintuitive results. Virtual table implementations that do write to rowid
+** tables in this way can avoid this problem by restoring the original
+** rowid value using [sqlite3_set_last_insert_rowid()] before returning
+** control to the user.
+**
+** ^(If an [INSERT] occurs within a trigger then this routine will
+** return the [rowid] of the inserted row as long as the trigger is
+** running. Once the trigger program ends, the value returned
+** by this routine reverts to what it was before the trigger was fired.)^
+**
+** ^An [INSERT] that fails due to a constraint violation is not a
+** successful [INSERT] and does not change the value returned by this
+** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
+** and INSERT OR ABORT make no changes to the return value of this
+** routine when their insertion fails. ^(When INSERT OR REPLACE
+** encounters a constraint violation, it does not fail. The
+** INSERT continues to completion after deleting rows that caused
+** the constraint problem so INSERT OR REPLACE will always change
+** the return value of this interface.)^
+**
+** ^For the purposes of this routine, an [INSERT] is considered to
+** be successful even if it is subsequently rolled back.
+**
+** This function is accessible to SQL statements via the
+** [last_insert_rowid() SQL function].
+**
+** If a separate thread performs a new [INSERT] on the same
+** database connection while the [sqlite3_last_insert_rowid()]
+** function is running and thus changes the last insert [rowid],
+** then the value returned by [sqlite3_last_insert_rowid()] is
+** unpredictable and might not equal either the old or the new
+** last insert [rowid].
+*/
+SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
+
+/*
+** CAPI3REF: Set the Last Insert Rowid value.
+** METHOD: sqlite3
+**
+** The sqlite3_set_last_insert_rowid(D, R) method allows the application to
+** set the value returned by calling sqlite3_last_insert_rowid(D) to R
+** without inserting a row into the database.
+*/
+SQLITE_API void sqlite3_set_last_insert_rowid(sqlite3*,sqlite3_int64);
+
+/*
+** CAPI3REF: Count The Number Of Rows Modified
+** METHOD: sqlite3
+**
+** ^This function returns the number of rows modified, inserted or
+** deleted by the most recently completed INSERT, UPDATE or DELETE
+** statement on the database connection specified by the only parameter.
+** ^Executing any other type of SQL statement does not modify the value
+** returned by this function.
+**
+** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are
+** considered - auxiliary changes caused by [CREATE TRIGGER | triggers],
+** [foreign key actions] or [REPLACE] constraint resolution are not counted.
+**
+** Changes to a view that are intercepted by
+** [INSTEAD OF trigger | INSTEAD OF triggers] are not counted. ^The value
+** returned by sqlite3_changes() immediately after an INSERT, UPDATE or
+** DELETE statement run on a view is always zero. Only changes made to real
+** tables are counted.
+**
+** Things are more complicated if the sqlite3_changes() function is
+** executed while a trigger program is running. This may happen if the
+** program uses the [changes() SQL function], or if some other callback
+** function invokes sqlite3_changes() directly. Essentially:
+**
+** <ul>
+** <li> ^(Before entering a trigger program the value returned by
+** sqlite3_changes() function is saved. After the trigger program
+** has finished, the original value is restored.)^
+**
+** <li> ^(Within a trigger program each INSERT, UPDATE and DELETE
+** statement sets the value returned by sqlite3_changes()
+** upon completion as normal. Of course, this value will not include
+** any changes performed by sub-triggers, as the sqlite3_changes()
+** value will be saved and restored after each sub-trigger has run.)^
+** </ul>
+**
+** ^This means that if the changes() SQL function (or similar) is used
+** by the first INSERT, UPDATE or DELETE statement within a trigger, it
+** returns the value as set when the calling statement began executing.
+** ^If it is used by the second or subsequent such statement within a trigger
+** program, the value returned reflects the number of rows modified by the
+** previous INSERT, UPDATE or DELETE statement within the same trigger.
+**
+** If a separate thread makes changes on the same database connection
+** while [sqlite3_changes()] is running then the value returned
+** is unpredictable and not meaningful.
+**
+** See also:
+** <ul>
+** <li> the [sqlite3_total_changes()] interface
+** <li> the [count_changes pragma]
+** <li> the [changes() SQL function]
+** <li> the [data_version pragma]
+** </ul>
+*/
+SQLITE_API int sqlite3_changes(sqlite3*);
+
+/*
+** CAPI3REF: Total Number Of Rows Modified
+** METHOD: sqlite3
+**
+** ^This function returns the total number of rows inserted, modified or
+** deleted by all [INSERT], [UPDATE] or [DELETE] statements completed
+** since the database connection was opened, including those executed as
+** part of trigger programs. ^Executing any other type of SQL statement
+** does not affect the value returned by sqlite3_total_changes().
+**
+** ^Changes made as part of [foreign key actions] are included in the
+** count, but those made as part of REPLACE constraint resolution are
+** not. ^Changes to a view that are intercepted by INSTEAD OF triggers
+** are not counted.
+**
+** The [sqlite3_total_changes(D)] interface only reports the number
+** of rows that changed due to SQL statement run against database
+** connection D. Any changes by other database connections are ignored.
+** To detect changes against a database file from other database
+** connections use the [PRAGMA data_version] command or the
+** [SQLITE_FCNTL_DATA_VERSION] [file control].
+**
+** If a separate thread makes changes on the same database connection
+** while [sqlite3_total_changes()] is running then the value
+** returned is unpredictable and not meaningful.
+**
+** See also:
+** <ul>
+** <li> the [sqlite3_changes()] interface
+** <li> the [count_changes pragma]
+** <li> the [changes() SQL function]
+** <li> the [data_version pragma]
+** <li> the [SQLITE_FCNTL_DATA_VERSION] [file control]
+** </ul>
+*/
+SQLITE_API int sqlite3_total_changes(sqlite3*);
+
+/*
+** CAPI3REF: Interrupt A Long-Running Query
+** METHOD: sqlite3
+**
+** ^This function causes any pending database operation to abort and
+** return at its earliest opportunity. This routine is typically
+** called in response to a user action such as pressing "Cancel"
+** or Ctrl-C where the user wants a long query operation to halt
+** immediately.
+**
+** ^It is safe to call this routine from a thread different from the
+** thread that is currently running the database operation. But it
+** is not safe to call this routine with a [database connection] that
+** is closed or might close before sqlite3_interrupt() returns.
+**
+** ^If an SQL operation is very nearly finished at the time when
+** sqlite3_interrupt() is called, then it might not have an opportunity
+** to be interrupted and might continue to completion.
+**
+** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT].
+** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE
+** that is inside an explicit transaction, then the entire transaction
+** will be rolled back automatically.
+**
+** ^The sqlite3_interrupt(D) call is in effect until all currently running
+** SQL statements on [database connection] D complete. ^Any new SQL statements
+** that are started after the sqlite3_interrupt() call and before the
+** running statement count reaches zero are interrupted as if they had been
+** running prior to the sqlite3_interrupt() call. ^New SQL statements
+** that are started after the running statement count reaches zero are
+** not effected by the sqlite3_interrupt().
+** ^A call to sqlite3_interrupt(D) that occurs when there are no running
+** SQL statements is a no-op and has no effect on SQL statements
+** that are started after the sqlite3_interrupt() call returns.
+*/
+SQLITE_API void sqlite3_interrupt(sqlite3*);
+
+/*
+** CAPI3REF: Determine If An SQL Statement Is Complete
+**
+** These routines are useful during command-line input to determine if the
+** currently entered text seems to form a complete SQL statement or
+** if additional input is needed before sending the text into
+** SQLite for parsing. ^These routines return 1 if the input string
+** appears to be a complete SQL statement. ^A statement is judged to be
+** complete if it ends with a semicolon token and is not a prefix of a
+** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within
+** string literals or quoted identifier names or comments are not
+** independent tokens (they are part of the token in which they are
+** embedded) and thus do not count as a statement terminator. ^Whitespace
+** and comments that follow the final semicolon are ignored.
+**
+** ^These routines return 0 if the statement is incomplete. ^If a
+** memory allocation fails, then SQLITE_NOMEM is returned.
+**
+** ^These routines do not parse the SQL statements thus
+** will not detect syntactically incorrect SQL.
+**
+** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior
+** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked
+** automatically by sqlite3_complete16(). If that initialization fails,
+** then the return value from sqlite3_complete16() will be non-zero
+** regardless of whether or not the input SQL is complete.)^
+**
+** The input to [sqlite3_complete()] must be a zero-terminated
+** UTF-8 string.
+**
+** The input to [sqlite3_complete16()] must be a zero-terminated
+** UTF-16 string in native byte order.
+*/
+SQLITE_API int sqlite3_complete(const char *sql);
+SQLITE_API int sqlite3_complete16(const void *sql);
+
+/*
+** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors
+** KEYWORDS: {busy-handler callback} {busy handler}
+** METHOD: sqlite3
+**
+** ^The sqlite3_busy_handler(D,X,P) routine sets a callback function X
+** that might be invoked with argument P whenever
+** an attempt is made to access a database table associated with
+** [database connection] D when another thread
+** or process has the table locked.
+** The sqlite3_busy_handler() interface is used to implement
+** [sqlite3_busy_timeout()] and [PRAGMA busy_timeout].
+**
+** ^If the busy callback is NULL, then [SQLITE_BUSY]
+** is returned immediately upon encountering the lock. ^If the busy callback
+** is not NULL, then the callback might be invoked with two arguments.
+**
+** ^The first argument to the busy handler is a copy of the void* pointer which
+** is the third argument to sqlite3_busy_handler(). ^The second argument to
+** the busy handler callback is the number of times that the busy handler has
+** been invoked previously for the same locking event. ^If the
+** busy callback returns 0, then no additional attempts are made to
+** access the database and [SQLITE_BUSY] is returned
+** to the application.
+** ^If the callback returns non-zero, then another attempt
+** is made to access the database and the cycle repeats.
+**
+** The presence of a busy handler does not guarantee that it will be invoked
+** when there is lock contention. ^If SQLite determines that invoking the busy
+** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]
+** to the application instead of invoking the
+** busy handler.
+** Consider a scenario where one process is holding a read lock that
+** it is trying to promote to a reserved lock and
+** a second process is holding a reserved lock that it is trying
+** to promote to an exclusive lock. The first process cannot proceed
+** because it is blocked by the second and the second process cannot
+** proceed because it is blocked by the first. If both processes
+** invoke the busy handlers, neither will make any progress. Therefore,
+** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
+** will induce the first process to release its read lock and allow
+** the second process to proceed.
+**
+** ^The default busy callback is NULL.
+**
+** ^(There can only be a single busy handler defined for each
+** [database connection]. Setting a new busy handler clears any
+** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()]
+** or evaluating [PRAGMA busy_timeout=N] will change the
+** busy handler and thus clear any previously set busy handler.
+**
+** The busy callback should not take any actions which modify the
+** database connection that invoked the busy handler. In other words,
+** the busy handler is not reentrant. Any such actions
+** result in undefined behavior.
+**
+** A busy handler must not close the database connection
+** or [prepared statement] that invoked the busy handler.
+*/
+SQLITE_API int sqlite3_busy_handler(sqlite3*,int(*)(void*,int),void*);
+
+/*
+** CAPI3REF: Set A Busy Timeout
+** METHOD: sqlite3
+**
+** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps
+** for a specified amount of time when a table is locked. ^The handler
+** will sleep multiple times until at least "ms" milliseconds of sleeping
+** have accumulated. ^After at least "ms" milliseconds of sleeping,
+** the handler returns 0 which causes [sqlite3_step()] to return
+** [SQLITE_BUSY].
+**
+** ^Calling this routine with an argument less than or equal to zero
+** turns off all busy handlers.
+**
+** ^(There can only be a single busy handler for a particular
+** [database connection] at any given moment. If another busy handler
+** was defined (using [sqlite3_busy_handler()]) prior to calling
+** this routine, that other busy handler is cleared.)^
+**
+** See also: [PRAGMA busy_timeout]
+*/
+SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms);
+
+/*
+** CAPI3REF: Convenience Routines For Running Queries
+** METHOD: sqlite3
+**
+** This is a legacy interface that is preserved for backwards compatibility.
+** Use of this interface is not recommended.
+**
+** Definition: A <b>result table</b> is memory data structure created by the
+** [sqlite3_get_table()] interface. A result table records the
+** complete query results from one or more queries.
+**
+** The table conceptually has a number of rows and columns. But
+** these numbers are not part of the result table itself. These
+** numbers are obtained separately. Let N be the number of rows
+** and M be the number of columns.
+**
+** A result table is an array of pointers to zero-terminated UTF-8 strings.
+** There are (N+1)*M elements in the array. The first M pointers point
+** to zero-terminated strings that contain the names of the columns.
+** The remaining entries all point to query results. NULL values result
+** in NULL pointers. All other values are in their UTF-8 zero-terminated
+** string representation as returned by [sqlite3_column_text()].
+**
+** A result table might consist of one or more memory allocations.
+** It is not safe to pass a result table directly to [sqlite3_free()].
+** A result table should be deallocated using [sqlite3_free_table()].
+**
+** ^(As an example of the result table format, suppose a query result
+** is as follows:
+**
+** <blockquote><pre>
+** Name | Age
+** -----------------------
+** Alice | 43
+** Bob | 28
+** Cindy | 21
+** </pre></blockquote>
+**
+** There are two columns (M==2) and three rows (N==3). Thus the
+** result table has 8 entries. Suppose the result table is stored
+** in an array named azResult. Then azResult holds this content:
+**
+** <blockquote><pre>
+** azResult[0] = "Name";
+** azResult[1] = "Age";
+** azResult[2] = "Alice";
+** azResult[3] = "43";
+** azResult[4] = "Bob";
+** azResult[5] = "28";
+** azResult[6] = "Cindy";
+** azResult[7] = "21";
+** </pre></blockquote>)^
+**
+** ^The sqlite3_get_table() function evaluates one or more
+** semicolon-separated SQL statements in the zero-terminated UTF-8
+** string of its 2nd parameter and returns a result table to the
+** pointer given in its 3rd parameter.
+**
+** After the application has finished with the result from sqlite3_get_table(),
+** it must pass the result table pointer to sqlite3_free_table() in order to
+** release the memory that was malloced. Because of the way the
+** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
+** function must not try to call [sqlite3_free()] directly. Only
+** [sqlite3_free_table()] is able to release the memory properly and safely.
+**
+** The sqlite3_get_table() interface is implemented as a wrapper around
+** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access
+** to any internal data structures of SQLite. It uses only the public
+** interface defined here. As a consequence, errors that occur in the
+** wrapper layer outside of the internal [sqlite3_exec()] call are not
+** reflected in subsequent calls to [sqlite3_errcode()] or
+** [sqlite3_errmsg()].
+*/
+SQLITE_API int sqlite3_get_table(
+ sqlite3 *db, /* An open database */
+ const char *zSql, /* SQL to be evaluated */
+ char ***pazResult, /* Results of the query */
+ int *pnRow, /* Number of result rows written here */
+ int *pnColumn, /* Number of result columns written here */
+ char **pzErrmsg /* Error msg written here */
+);
+SQLITE_API void sqlite3_free_table(char **result);
+
+/*
+** CAPI3REF: Formatted String Printing Functions
+**
+** These routines are work-alikes of the "printf()" family of functions
+** from the standard C library.
+** These routines understand most of the common formatting options from
+** the standard library printf()
+** plus some additional non-standard formats ([%q], [%Q], [%w], and [%z]).
+** See the [built-in printf()] documentation for details.
+**
+** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
+** results into memory obtained from [sqlite3_malloc64()].
+** The strings returned by these two routines should be
+** released by [sqlite3_free()]. ^Both routines return a
+** NULL pointer if [sqlite3_malloc64()] is unable to allocate enough
+** memory to hold the resulting string.
+**
+** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from
+** the standard C library. The result is written into the
+** buffer supplied as the second parameter whose size is given by
+** the first parameter. Note that the order of the
+** first two parameters is reversed from snprintf().)^ This is an
+** historical accident that cannot be fixed without breaking
+** backwards compatibility. ^(Note also that sqlite3_snprintf()
+** returns a pointer to its buffer instead of the number of
+** characters actually written into the buffer.)^ We admit that
+** the number of characters written would be a more useful return
+** value but we cannot change the implementation of sqlite3_snprintf()
+** now without breaking compatibility.
+**
+** ^As long as the buffer size is greater than zero, sqlite3_snprintf()
+** guarantees that the buffer is always zero-terminated. ^The first
+** parameter "n" is the total size of the buffer, including space for
+** the zero terminator. So the longest string that can be completely
+** written will be n-1 characters.
+**
+** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf().
+**
+** See also: [built-in printf()], [printf() SQL function]
+*/
+SQLITE_API char *sqlite3_mprintf(const char*,...);
+SQLITE_API char *sqlite3_vmprintf(const char*, va_list);
+SQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...);
+SQLITE_API char *sqlite3_vsnprintf(int,char*,const char*, va_list);
+
+/*
+** CAPI3REF: Memory Allocation Subsystem
+**
+** The SQLite core uses these three routines for all of its own
+** internal memory allocation needs. "Core" in the previous sentence
+** does not include operating-system specific [VFS] implementation. The
+** Windows VFS uses native malloc() and free() for some operations.
+**
+** ^The sqlite3_malloc() routine returns a pointer to a block
+** of memory at least N bytes in length, where N is the parameter.
+** ^If sqlite3_malloc() is unable to obtain sufficient free
+** memory, it returns a NULL pointer. ^If the parameter N to
+** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
+** a NULL pointer.
+**
+** ^The sqlite3_malloc64(N) routine works just like
+** sqlite3_malloc(N) except that N is an unsigned 64-bit integer instead
+** of a signed 32-bit integer.
+**
+** ^Calling sqlite3_free() with a pointer previously returned
+** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
+** that it might be reused. ^The sqlite3_free() routine is
+** a no-op if is called with a NULL pointer. Passing a NULL pointer
+** to sqlite3_free() is harmless. After being freed, memory
+** should neither be read nor written. Even reading previously freed
+** memory might result in a segmentation fault or other severe error.
+** Memory corruption, a segmentation fault, or other severe error
+** might result if sqlite3_free() is called with a non-NULL pointer that
+** was not obtained from sqlite3_malloc() or sqlite3_realloc().
+**
+** ^The sqlite3_realloc(X,N) interface attempts to resize a
+** prior memory allocation X to be at least N bytes.
+** ^If the X parameter to sqlite3_realloc(X,N)
+** is a NULL pointer then its behavior is identical to calling
+** sqlite3_malloc(N).
+** ^If the N parameter to sqlite3_realloc(X,N) is zero or
+** negative then the behavior is exactly the same as calling
+** sqlite3_free(X).
+** ^sqlite3_realloc(X,N) returns a pointer to a memory allocation
+** of at least N bytes in size or NULL if insufficient memory is available.
+** ^If M is the size of the prior allocation, then min(N,M) bytes
+** of the prior allocation are copied into the beginning of buffer returned
+** by sqlite3_realloc(X,N) and the prior allocation is freed.
+** ^If sqlite3_realloc(X,N) returns NULL and N is positive, then the
+** prior allocation is not freed.
+**
+** ^The sqlite3_realloc64(X,N) interfaces works the same as
+** sqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead
+** of a 32-bit signed integer.
+**
+** ^If X is a memory allocation previously obtained from sqlite3_malloc(),
+** sqlite3_malloc64(), sqlite3_realloc(), or sqlite3_realloc64(), then
+** sqlite3_msize(X) returns the size of that memory allocation in bytes.
+** ^The value returned by sqlite3_msize(X) might be larger than the number
+** of bytes requested when X was allocated. ^If X is a NULL pointer then
+** sqlite3_msize(X) returns zero. If X points to something that is not
+** the beginning of memory allocation, or if it points to a formerly
+** valid memory allocation that has now been freed, then the behavior
+** of sqlite3_msize(X) is undefined and possibly harmful.
+**
+** ^The memory returned by sqlite3_malloc(), sqlite3_realloc(),
+** sqlite3_malloc64(), and sqlite3_realloc64()
+** is always aligned to at least an 8 byte boundary, or to a
+** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time
+** option is used.
+**
+** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
+** must be either NULL or else pointers obtained from a prior
+** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have
+** not yet been released.
+**
+** The application must not read or write any part of
+** a block of memory after it has been released using
+** [sqlite3_free()] or [sqlite3_realloc()].
+*/
+SQLITE_API void *sqlite3_malloc(int);
+SQLITE_API void *sqlite3_malloc64(sqlite3_uint64);
+SQLITE_API void *sqlite3_realloc(void*, int);
+SQLITE_API void *sqlite3_realloc64(void*, sqlite3_uint64);
+SQLITE_API void sqlite3_free(void*);
+SQLITE_API sqlite3_uint64 sqlite3_msize(void*);
+
+/*
+** CAPI3REF: Memory Allocator Statistics
+**
+** SQLite provides these two interfaces for reporting on the status
+** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
+** routines, which form the built-in memory allocation subsystem.
+**
+** ^The [sqlite3_memory_used()] routine returns the number of bytes
+** of memory currently outstanding (malloced but not freed).
+** ^The [sqlite3_memory_highwater()] routine returns the maximum
+** value of [sqlite3_memory_used()] since the high-water mark
+** was last reset. ^The values returned by [sqlite3_memory_used()] and
+** [sqlite3_memory_highwater()] include any overhead
+** added by SQLite in its implementation of [sqlite3_malloc()],
+** but not overhead added by the any underlying system library
+** routines that [sqlite3_malloc()] may call.
+**
+** ^The memory high-water mark is reset to the current value of
+** [sqlite3_memory_used()] if and only if the parameter to
+** [sqlite3_memory_highwater()] is true. ^The value returned
+** by [sqlite3_memory_highwater(1)] is the high-water mark
+** prior to the reset.
+*/
+SQLITE_API sqlite3_int64 sqlite3_memory_used(void);
+SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
+
+/*
+** CAPI3REF: Pseudo-Random Number Generator
+**
+** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
+** select random [ROWID | ROWIDs] when inserting new records into a table that
+** already uses the largest possible [ROWID]. The PRNG is also used for
+** the built-in random() and randomblob() SQL functions. This interface allows
+** applications to access the same PRNG for other purposes.
+**
+** ^A call to this routine stores N bytes of randomness into buffer P.
+** ^The P parameter can be a NULL pointer.
+**
+** ^If this routine has not been previously called or if the previous
+** call had N less than one or a NULL pointer for P, then the PRNG is
+** seeded using randomness obtained from the xRandomness method of
+** the default [sqlite3_vfs] object.
+** ^If the previous call to this routine had an N of 1 or more and a
+** non-NULL P then the pseudo-randomness is generated
+** internally and without recourse to the [sqlite3_vfs] xRandomness
+** method.
+*/
+SQLITE_API void sqlite3_randomness(int N, void *P);
+
+/*
+** CAPI3REF: Compile-Time Authorization Callbacks
+** METHOD: sqlite3
+** KEYWORDS: {authorizer callback}
+**
+** ^This routine registers an authorizer callback with a particular
+** [database connection], supplied in the first argument.
+** ^The authorizer callback is invoked as SQL statements are being compiled
+** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],
+** [sqlite3_prepare_v3()], [sqlite3_prepare16()], [sqlite3_prepare16_v2()],
+** and [sqlite3_prepare16_v3()]. ^At various
+** points during the compilation process, as logic is being created
+** to perform various actions, the authorizer callback is invoked to
+** see if those actions are allowed. ^The authorizer callback should
+** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the
+** specific action but allow the SQL statement to continue to be
+** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be
+** rejected with an error. ^If the authorizer callback returns
+** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]
+** then the [sqlite3_prepare_v2()] or equivalent call that triggered
+** the authorizer will fail with an error message.
+**
+** When the callback returns [SQLITE_OK], that means the operation
+** requested is ok. ^When the callback returns [SQLITE_DENY], the
+** [sqlite3_prepare_v2()] or equivalent call that triggered the
+** authorizer will fail with an error message explaining that
+** access is denied.
+**
+** ^The first parameter to the authorizer callback is a copy of the third
+** parameter to the sqlite3_set_authorizer() interface. ^The second parameter
+** to the callback is an integer [SQLITE_COPY | action code] that specifies
+** the particular action to be authorized. ^The third through sixth parameters
+** to the callback are either NULL pointers or zero-terminated strings
+** that contain additional details about the action to be authorized.
+** Applications must always be prepared to encounter a NULL pointer in any
+** of the third through the sixth parameters of the authorization callback.
+**
+** ^If the action code is [SQLITE_READ]
+** and the callback returns [SQLITE_IGNORE] then the
+** [prepared statement] statement is constructed to substitute
+** a NULL value in place of the table column that would have
+** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE]
+** return can be used to deny an untrusted user access to individual
+** columns of a table.
+** ^When a table is referenced by a [SELECT] but no column values are
+** extracted from that table (for example in a query like
+** "SELECT count(*) FROM tab") then the [SQLITE_READ] authorizer callback
+** is invoked once for that table with a column name that is an empty string.
+** ^If the action code is [SQLITE_DELETE] and the callback returns
+** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the
+** [truncate optimization] is disabled and all rows are deleted individually.
+**
+** An authorizer is used when [sqlite3_prepare | preparing]
+** SQL statements from an untrusted source, to ensure that the SQL statements
+** do not try to access data they are not allowed to see, or that they do not
+** try to execute malicious statements that damage the database. For
+** example, an application may allow a user to enter arbitrary
+** SQL queries for evaluation by a database. But the application does
+** not want the user to be able to make arbitrary changes to the
+** database. An authorizer could then be put in place while the
+** user-entered SQL is being [sqlite3_prepare | prepared] that
+** disallows everything except [SELECT] statements.
+**
+** Applications that need to process SQL from untrusted sources
+** might also consider lowering resource limits using [sqlite3_limit()]
+** and limiting database size using the [max_page_count] [PRAGMA]
+** in addition to using an authorizer.
+**
+** ^(Only a single authorizer can be in place on a database connection
+** at a time. Each call to sqlite3_set_authorizer overrides the
+** previous call.)^ ^Disable the authorizer by installing a NULL callback.
+** The authorizer is disabled by default.
+**
+** The authorizer callback must not do anything that will modify
+** the database connection that invoked the authorizer callback.
+** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
+** database connections for the meaning of "modify" in this paragraph.
+**
+** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the
+** statement might be re-prepared during [sqlite3_step()] due to a
+** schema change. Hence, the application should ensure that the
+** correct authorizer callback remains in place during the [sqlite3_step()].
+**
+** ^Note that the authorizer callback is invoked only during
+** [sqlite3_prepare()] or its variants. Authorization is not
+** performed during statement evaluation in [sqlite3_step()], unless
+** as stated in the previous paragraph, sqlite3_step() invokes
+** sqlite3_prepare_v2() to reprepare a statement after a schema change.
+*/
+SQLITE_API int sqlite3_set_authorizer(
+ sqlite3*,
+ int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
+ void *pUserData
+);
+
+/*
+** CAPI3REF: Authorizer Return Codes
+**
+** The [sqlite3_set_authorizer | authorizer callback function] must
+** return either [SQLITE_OK] or one of these two constants in order
+** to signal SQLite whether or not the action is permitted. See the
+** [sqlite3_set_authorizer | authorizer documentation] for additional
+** information.
+**
+** Note that SQLITE_IGNORE is also used as a [conflict resolution mode]
+** returned from the [sqlite3_vtab_on_conflict()] interface.
+*/
+#define SQLITE_DENY 1 /* Abort the SQL statement with an error */
+#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
+
+/*
+** CAPI3REF: Authorizer Action Codes
+**
+** The [sqlite3_set_authorizer()] interface registers a callback function
+** that is invoked to authorize certain SQL statement actions. The
+** second parameter to the callback is an integer code that specifies
+** what action is being authorized. These are the integer action codes that
+** the authorizer callback may be passed.
+**
+** These action code values signify what kind of operation is to be
+** authorized. The 3rd and 4th parameters to the authorization
+** callback function will be parameters or NULL depending on which of these
+** codes is used as the second parameter. ^(The 5th parameter to the
+** authorizer callback is the name of the database ("main", "temp",
+** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback
+** is the name of the inner-most trigger or view that is responsible for
+** the access attempt or NULL if this access attempt is directly from
+** top-level SQL code.
+*/
+/******************************************* 3rd ************ 4th ***********/
+#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
+#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
+#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
+#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
+#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
+#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
+#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
+#define SQLITE_CREATE_VIEW 8 /* View Name NULL */
+#define SQLITE_DELETE 9 /* Table Name NULL */
+#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
+#define SQLITE_DROP_TABLE 11 /* Table Name NULL */
+#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
+#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
+#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
+#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
+#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
+#define SQLITE_DROP_VIEW 17 /* View Name NULL */
+#define SQLITE_INSERT 18 /* Table Name NULL */
+#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
+#define SQLITE_READ 20 /* Table Name Column Name */
+#define SQLITE_SELECT 21 /* NULL NULL */
+#define SQLITE_TRANSACTION 22 /* Operation NULL */
+#define SQLITE_UPDATE 23 /* Table Name Column Name */
+#define SQLITE_ATTACH 24 /* Filename NULL */
+#define SQLITE_DETACH 25 /* Database Name NULL */
+#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
+#define SQLITE_REINDEX 27 /* Index Name NULL */
+#define SQLITE_ANALYZE 28 /* Table Name NULL */
+#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
+#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
+#define SQLITE_FUNCTION 31 /* NULL Function Name */
+#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */
+#define SQLITE_COPY 0 /* No longer used */
+#define SQLITE_RECURSIVE 33 /* NULL NULL */
+
+/*
+** CAPI3REF: Tracing And Profiling Functions
+** METHOD: sqlite3
+**
+** These routines are deprecated. Use the [sqlite3_trace_v2()] interface
+** instead of the routines described here.
+**
+** These routines register callback functions that can be used for
+** tracing and profiling the execution of SQL statements.
+**
+** ^The callback function registered by sqlite3_trace() is invoked at
+** various times when an SQL statement is being run by [sqlite3_step()].
+** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the
+** SQL statement text as the statement first begins executing.
+** ^(Additional sqlite3_trace() callbacks might occur
+** as each triggered subprogram is entered. The callbacks for triggers
+** contain a UTF-8 SQL comment that identifies the trigger.)^
+**
+** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit
+** the length of [bound parameter] expansion in the output of sqlite3_trace().
+**
+** ^The callback function registered by sqlite3_profile() is invoked
+** as each SQL statement finishes. ^The profile callback contains
+** the original statement text and an estimate of wall-clock time
+** of how long that statement took to run. ^The profile callback
+** time is in units of nanoseconds, however the current implementation
+** is only capable of millisecond resolution so the six least significant
+** digits in the time are meaningless. Future versions of SQLite
+** might provide greater resolution on the profiler callback. Invoking
+** either [sqlite3_trace()] or [sqlite3_trace_v2()] will cancel the
+** profile callback.
+*/
+SQLITE_API SQLITE_DEPRECATED void *sqlite3_trace(sqlite3*,
+ void(*xTrace)(void*,const char*), void*);
+SQLITE_API SQLITE_DEPRECATED void *sqlite3_profile(sqlite3*,
+ void(*xProfile)(void*,const char*,sqlite3_uint64), void*);
+
+/*
+** CAPI3REF: SQL Trace Event Codes
+** KEYWORDS: SQLITE_TRACE
+**
+** These constants identify classes of events that can be monitored
+** using the [sqlite3_trace_v2()] tracing logic. The M argument
+** to [sqlite3_trace_v2(D,M,X,P)] is an OR-ed combination of one or more of
+** the following constants. ^The first argument to the trace callback
+** is one of the following constants.
+**
+** New tracing constants may be added in future releases.
+**
+** ^A trace callback has four arguments: xCallback(T,C,P,X).
+** ^The T argument is one of the integer type codes above.
+** ^The C argument is a copy of the context pointer passed in as the
+** fourth argument to [sqlite3_trace_v2()].
+** The P and X arguments are pointers whose meanings depend on T.
+**
+** <dl>
+** [[SQLITE_TRACE_STMT]] <dt>SQLITE_TRACE_STMT</dt>
+** <dd>^An SQLITE_TRACE_STMT callback is invoked when a prepared statement
+** first begins running and possibly at other times during the
+** execution of the prepared statement, such as at the start of each
+** trigger subprogram. ^The P argument is a pointer to the
+** [prepared statement]. ^The X argument is a pointer to a string which
+** is the unexpanded SQL text of the prepared statement or an SQL comment
+** that indicates the invocation of a trigger. ^The callback can compute
+** the same text that would have been returned by the legacy [sqlite3_trace()]
+** interface by using the X argument when X begins with "--" and invoking
+** [sqlite3_expanded_sql(P)] otherwise.
+**
+** [[SQLITE_TRACE_PROFILE]] <dt>SQLITE_TRACE_PROFILE</dt>
+** <dd>^An SQLITE_TRACE_PROFILE callback provides approximately the same
+** information as is provided by the [sqlite3_profile()] callback.
+** ^The P argument is a pointer to the [prepared statement] and the
+** X argument points to a 64-bit integer which is the estimated of
+** the number of nanosecond that the prepared statement took to run.
+** ^The SQLITE_TRACE_PROFILE callback is invoked when the statement finishes.
+**
+** [[SQLITE_TRACE_ROW]] <dt>SQLITE_TRACE_ROW</dt>
+** <dd>^An SQLITE_TRACE_ROW callback is invoked whenever a prepared
+** statement generates a single row of result.
+** ^The P argument is a pointer to the [prepared statement] and the
+** X argument is unused.
+**
+** [[SQLITE_TRACE_CLOSE]] <dt>SQLITE_TRACE_CLOSE</dt>
+** <dd>^An SQLITE_TRACE_CLOSE callback is invoked when a database
+** connection closes.
+** ^The P argument is a pointer to the [database connection] object
+** and the X argument is unused.
+** </dl>
+*/
+#define SQLITE_TRACE_STMT 0x01
+#define SQLITE_TRACE_PROFILE 0x02
+#define SQLITE_TRACE_ROW 0x04
+#define SQLITE_TRACE_CLOSE 0x08
+
+/*
+** CAPI3REF: SQL Trace Hook
+** METHOD: sqlite3
+**
+** ^The sqlite3_trace_v2(D,M,X,P) interface registers a trace callback
+** function X against [database connection] D, using property mask M
+** and context pointer P. ^If the X callback is
+** NULL or if the M mask is zero, then tracing is disabled. The
+** M argument should be the bitwise OR-ed combination of
+** zero or more [SQLITE_TRACE] constants.
+**
+** ^Each call to either sqlite3_trace() or sqlite3_trace_v2() overrides
+** (cancels) any prior calls to sqlite3_trace() or sqlite3_trace_v2().
+**
+** ^The X callback is invoked whenever any of the events identified by
+** mask M occur. ^The integer return value from the callback is currently
+** ignored, though this may change in future releases. Callback
+** implementations should return zero to ensure future compatibility.
+**
+** ^A trace callback is invoked with four arguments: callback(T,C,P,X).
+** ^The T argument is one of the [SQLITE_TRACE]
+** constants to indicate why the callback was invoked.
+** ^The C argument is a copy of the context pointer.
+** The P and X arguments are pointers whose meanings depend on T.
+**
+** The sqlite3_trace_v2() interface is intended to replace the legacy
+** interfaces [sqlite3_trace()] and [sqlite3_profile()], both of which
+** are deprecated.
+*/
+SQLITE_API int sqlite3_trace_v2(
+ sqlite3*,
+ unsigned uMask,
+ int(*xCallback)(unsigned,void*,void*,void*),
+ void *pCtx
+);
+
+/*
+** CAPI3REF: Query Progress Callbacks
+** METHOD: sqlite3
+**
+** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback
+** function X to be invoked periodically during long running calls to
+** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for
+** database connection D. An example use for this
+** interface is to keep a GUI updated during a large query.
+**
+** ^The parameter P is passed through as the only parameter to the
+** callback function X. ^The parameter N is the approximate number of
+** [virtual machine instructions] that are evaluated between successive
+** invocations of the callback X. ^If N is less than one then the progress
+** handler is disabled.
+**
+** ^Only a single progress handler may be defined at one time per
+** [database connection]; setting a new progress handler cancels the
+** old one. ^Setting parameter X to NULL disables the progress handler.
+** ^The progress handler is also disabled by setting N to a value less
+** than 1.
+**
+** ^If the progress callback returns non-zero, the operation is
+** interrupted. This feature can be used to implement a
+** "Cancel" button on a GUI progress dialog box.
+**
+** The progress handler callback must not do anything that will modify
+** the database connection that invoked the progress handler.
+** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
+** database connections for the meaning of "modify" in this paragraph.
+**
+*/
+SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
+
+/*
+** CAPI3REF: Opening A New Database Connection
+** CONSTRUCTOR: sqlite3
+**
+** ^These routines open an SQLite database file as specified by the
+** filename argument. ^The filename argument is interpreted as UTF-8 for
+** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte
+** order for sqlite3_open16(). ^(A [database connection] handle is usually
+** returned in *ppDb, even if an error occurs. The only exception is that
+** if SQLite is unable to allocate memory to hold the [sqlite3] object,
+** a NULL will be written into *ppDb instead of a pointer to the [sqlite3]
+** object.)^ ^(If the database is opened (and/or created) successfully, then
+** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The
+** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
+** an English language description of the error following a failure of any
+** of the sqlite3_open() routines.
+**
+** ^The default encoding will be UTF-8 for databases created using
+** sqlite3_open() or sqlite3_open_v2(). ^The default encoding for databases
+** created using sqlite3_open16() will be UTF-16 in the native byte order.
+**
+** Whether or not an error occurs when it is opened, resources
+** associated with the [database connection] handle should be released by
+** passing it to [sqlite3_close()] when it is no longer required.
+**
+** The sqlite3_open_v2() interface works like sqlite3_open()
+** except that it accepts two additional parameters for additional control
+** over the new database connection. ^(The flags parameter to
+** sqlite3_open_v2() must include, at a minimum, one of the following
+** three flag combinations:)^
+**
+** <dl>
+** ^(<dt>[SQLITE_OPEN_READONLY]</dt>
+** <dd>The database is opened in read-only mode. If the database does not
+** already exist, an error is returned.</dd>)^
+**
+** ^(<dt>[SQLITE_OPEN_READWRITE]</dt>
+** <dd>The database is opened for reading and writing if possible, or reading
+** only if the file is write protected by the operating system. In either
+** case the database must already exist, otherwise an error is returned.</dd>)^
+**
+** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt>
+** <dd>The database is opened for reading and writing, and is created if
+** it does not already exist. This is the behavior that is always used for
+** sqlite3_open() and sqlite3_open16().</dd>)^
+** </dl>
+**
+** In addition to the required flags, the following optional flags are
+** also supported:
+**
+** <dl>
+** ^(<dt>[SQLITE_OPEN_URI]</dt>
+** <dd>The filename can be interpreted as a URI if this flag is set.</dd>)^
+**
+** ^(<dt>[SQLITE_OPEN_MEMORY]</dt>
+** <dd>The database will be opened as an in-memory database. The database
+** is named by the "filename" argument for the purposes of cache-sharing,
+** if shared cache mode is enabled, but the "filename" is otherwise ignored.
+** </dd>)^
+**
+** ^(<dt>[SQLITE_OPEN_NOMUTEX]</dt>
+** <dd>The new database connection will use the "multi-thread"
+** [threading mode].)^ This means that separate threads are allowed
+** to use SQLite at the same time, as long as each thread is using
+** a different [database connection].
+**
+** ^(<dt>[SQLITE_OPEN_FULLMUTEX]</dt>
+** <dd>The new database connection will use the "serialized"
+** [threading mode].)^ This means the multiple threads can safely
+** attempt to use the same database connection at the same time.
+** (Mutexes will block any actual concurrency, but in this mode
+** there is no harm in trying.)
+**
+** ^(<dt>[SQLITE_OPEN_SHAREDCACHE]</dt>
+** <dd>The database is opened [shared cache] enabled, overriding
+** the default shared cache setting provided by
+** [sqlite3_enable_shared_cache()].)^
+**
+** ^(<dt>[SQLITE_OPEN_PRIVATECACHE]</dt>
+** <dd>The database is opened [shared cache] disabled, overriding
+** the default shared cache setting provided by
+** [sqlite3_enable_shared_cache()].)^
+**
+** [[OPEN_NOFOLLOW]] ^(<dt>[SQLITE_OPEN_NOFOLLOW]</dt>
+** <dd>The database filename is not allowed to be a symbolic link</dd>
+** </dl>)^
+**
+** If the 3rd parameter to sqlite3_open_v2() is not one of the
+** required combinations shown above optionally combined with other
+** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits]
+** then the behavior is undefined.
+**
+** ^The fourth parameter to sqlite3_open_v2() is the name of the
+** [sqlite3_vfs] object that defines the operating system interface that
+** the new database connection should use. ^If the fourth parameter is
+** a NULL pointer then the default [sqlite3_vfs] object is used.
+**
+** ^If the filename is ":memory:", then a private, temporary in-memory database
+** is created for the connection. ^This in-memory database will vanish when
+** the database connection is closed. Future versions of SQLite might
+** make use of additional special filenames that begin with the ":" character.
+** It is recommended that when a database filename actually does begin with
+** a ":" character you should prefix the filename with a pathname such as
+** "./" to avoid ambiguity.
+**
+** ^If the filename is an empty string, then a private, temporary
+** on-disk database will be created. ^This private database will be
+** automatically deleted as soon as the database connection is closed.
+**
+** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3>
+**
+** ^If [URI filename] interpretation is enabled, and the filename argument
+** begins with "file:", then the filename is interpreted as a URI. ^URI
+** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is
+** set in the third argument to sqlite3_open_v2(), or if it has
+** been enabled globally using the [SQLITE_CONFIG_URI] option with the
+** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option.
+** URI filename interpretation is turned off
+** by default, but future releases of SQLite might enable URI filename
+** interpretation by default. See "[URI filenames]" for additional
+** information.
+**
+** URI filenames are parsed according to RFC 3986. ^If the URI contains an
+** authority, then it must be either an empty string or the string
+** "localhost". ^If the authority is not an empty string or "localhost", an
+** error is returned to the caller. ^The fragment component of a URI, if
+** present, is ignored.
+**
+** ^SQLite uses the path component of the URI as the name of the disk file
+** which contains the database. ^If the path begins with a '/' character,
+** then it is interpreted as an absolute path. ^If the path does not begin
+** with a '/' (meaning that the authority section is omitted from the URI)
+** then the path is interpreted as a relative path.
+** ^(On windows, the first component of an absolute path
+** is a drive specification (e.g. "C:").)^
+**
+** [[core URI query parameters]]
+** The query component of a URI may contain parameters that are interpreted
+** either by SQLite itself, or by a [VFS | custom VFS implementation].
+** SQLite and its built-in [VFSes] interpret the
+** following query parameters:
+**
+** <ul>
+** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of
+** a VFS object that provides the operating system interface that should
+** be used to access the database file on disk. ^If this option is set to
+** an empty string the default VFS object is used. ^Specifying an unknown
+** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is
+** present, then the VFS specified by the option takes precedence over
+** the value passed as the fourth parameter to sqlite3_open_v2().
+**
+** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw",
+** "rwc", or "memory". Attempting to set it to any other value is
+** an error)^.
+** ^If "ro" is specified, then the database is opened for read-only
+** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the
+** third argument to sqlite3_open_v2(). ^If the mode option is set to
+** "rw", then the database is opened for read-write (but not create)
+** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had
+** been set. ^Value "rwc" is equivalent to setting both
+** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is
+** set to "memory" then a pure [in-memory database] that never reads
+** or writes from disk is used. ^It is an error to specify a value for
+** the mode parameter that is less restrictive than that specified by
+** the flags passed in the third parameter to sqlite3_open_v2().
+**
+** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or
+** "private". ^Setting it to "shared" is equivalent to setting the
+** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to
+** sqlite3_open_v2(). ^Setting the cache parameter to "private" is
+** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit.
+** ^If sqlite3_open_v2() is used and the "cache" parameter is present in
+** a URI filename, its value overrides any behavior requested by setting
+** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag.
+**
+** <li> <b>psow</b>: ^The psow parameter indicates whether or not the
+** [powersafe overwrite] property does or does not apply to the
+** storage media on which the database file resides.
+**
+** <li> <b>nolock</b>: ^The nolock parameter is a boolean query parameter
+** which if set disables file locking in rollback journal modes. This
+** is useful for accessing a database on a filesystem that does not
+** support locking. Caution: Database corruption might result if two
+** or more processes write to the same database and any one of those
+** processes uses nolock=1.
+**
+** <li> <b>immutable</b>: ^The immutable parameter is a boolean query
+** parameter that indicates that the database file is stored on
+** read-only media. ^When immutable is set, SQLite assumes that the
+** database file cannot be changed, even by a process with higher
+** privilege, and so the database is opened read-only and all locking
+** and change detection is disabled. Caution: Setting the immutable
+** property on a database file that does in fact change can result
+** in incorrect query results and/or [SQLITE_CORRUPT] errors.
+** See also: [SQLITE_IOCAP_IMMUTABLE].
+**
+** </ul>
+**
+** ^Specifying an unknown parameter in the query component of a URI is not an
+** error. Future versions of SQLite might understand additional query
+** parameters. See "[query parameters with special meaning to SQLite]" for
+** additional information.
+**
+** [[URI filename examples]] <h3>URI filename examples</h3>
+**
+** <table border="1" align=center cellpadding=5>
+** <tr><th> URI filenames <th> Results
+** <tr><td> file:data.db <td>
+** Open the file "data.db" in the current directory.
+** <tr><td> file:/home/fred/data.db<br>
+** file:///home/fred/data.db <br>
+** file://localhost/home/fred/data.db <br> <td>
+** Open the database file "/home/fred/data.db".
+** <tr><td> file://darkstar/home/fred/data.db <td>
+** An error. "darkstar" is not a recognized authority.
+** <tr><td style="white-space:nowrap">
+** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db
+** <td> Windows only: Open the file "data.db" on fred's desktop on drive
+** C:. Note that the %20 escaping in this example is not strictly
+** necessary - space characters can be used literally
+** in URI filenames.
+** <tr><td> file:data.db?mode=ro&cache=private <td>
+** Open file "data.db" in the current directory for read-only access.
+** Regardless of whether or not shared-cache mode is enabled by
+** default, use a private cache.
+** <tr><td> file:/home/fred/data.db?vfs=unix-dotfile <td>
+** Open file "/home/fred/data.db". Use the special VFS "unix-dotfile"
+** that uses dot-files in place of posix advisory locking.
+** <tr><td> file:data.db?mode=readonly <td>
+** An error. "readonly" is not a valid option for the "mode" parameter.
+** </table>
+**
+** ^URI hexadecimal escape sequences (%HH) are supported within the path and
+** query components of a URI. A hexadecimal escape sequence consists of a
+** percent sign - "%" - followed by exactly two hexadecimal digits
+** specifying an octet value. ^Before the path or query components of a
+** URI filename are interpreted, they are encoded using UTF-8 and all
+** hexadecimal escape sequences replaced by a single byte containing the
+** corresponding octet. If this process generates an invalid UTF-8 encoding,
+** the results are undefined.
+**
+** <b>Note to Windows users:</b> The encoding used for the filename argument
+** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever
+** codepage is currently defined. Filenames containing international
+** characters must be converted to UTF-8 prior to passing them into
+** sqlite3_open() or sqlite3_open_v2().
+**
+** <b>Note to Windows Runtime users:</b> The temporary directory must be set
+** prior to calling sqlite3_open() or sqlite3_open_v2(). Otherwise, various
+** features that require the use of temporary files may fail.
+**
+** See also: [sqlite3_temp_directory]
+*/
+SQLITE_API int sqlite3_open(
+ const char *filename, /* Database filename (UTF-8) */
+ sqlite3 **ppDb /* OUT: SQLite db handle */
+);
+SQLITE_API int sqlite3_open16(
+ const void *filename, /* Database filename (UTF-16) */
+ sqlite3 **ppDb /* OUT: SQLite db handle */
+);
+SQLITE_API int sqlite3_open_v2(
+ const char *filename, /* Database filename (UTF-8) */
+ sqlite3 **ppDb, /* OUT: SQLite db handle */
+ int flags, /* Flags */
+ const char *zVfs /* Name of VFS module to use */
+);
+
+/*
+** CAPI3REF: Obtain Values For URI Parameters
+**
+** These are utility routines, useful to [VFS|custom VFS implementations],
+** that check if a database file was a URI that contained a specific query
+** parameter, and if so obtains the value of that query parameter.
+**
+** The first parameter to these interfaces (hereafter referred to
+** as F) must be one of:
+** <ul>
+** <li> A database filename pointer created by the SQLite core and
+** passed into the xOpen() method of a VFS implemention, or
+** <li> A filename obtained from [sqlite3_db_filename()], or
+** <li> A new filename constructed using [sqlite3_create_filename()].
+** </ul>
+** If the F parameter is not one of the above, then the behavior is
+** undefined and probably undesirable. Older versions of SQLite were
+** more tolerant of invalid F parameters than newer versions.
+**
+** If F is a suitable filename (as described in the previous paragraph)
+** and if P is the name of the query parameter, then
+** sqlite3_uri_parameter(F,P) returns the value of the P
+** parameter if it exists or a NULL pointer if P does not appear as a
+** query parameter on F. If P is a query parameter of F and it
+** has no explicit value, then sqlite3_uri_parameter(F,P) returns
+** a pointer to an empty string.
+**
+** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean
+** parameter and returns true (1) or false (0) according to the value
+** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the
+** value of query parameter P is one of "yes", "true", or "on" in any
+** case or if the value begins with a non-zero number. The
+** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of
+** query parameter P is one of "no", "false", or "off" in any case or
+** if the value begins with a numeric zero. If P is not a query
+** parameter on F or if the value of P does not match any of the
+** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0).
+**
+** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a
+** 64-bit signed integer and returns that integer, or D if P does not
+** exist. If the value of P is something other than an integer, then
+** zero is returned.
+**
+** The sqlite3_uri_key(F,N) returns a pointer to the name (not
+** the value) of the N-th query parameter for filename F, or a NULL
+** pointer if N is less than zero or greater than the number of query
+** parameters minus 1. The N value is zero-based so N should be 0 to obtain
+** the name of the first query parameter, 1 for the second parameter, and
+** so forth.
+**
+** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and
+** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and
+** is not a database file pathname pointer that the SQLite core passed
+** into the xOpen VFS method, then the behavior of this routine is undefined
+** and probably undesirable.
+**
+** Beginning with SQLite [version 3.31.0] ([dateof:3.31.0]) the input F
+** parameter can also be the name of a rollback journal file or WAL file
+** in addition to the main database file. Prior to version 3.31.0, these
+** routines would only work if F was the name of the main database file.
+** When the F parameter is the name of the rollback journal or WAL file,
+** it has access to all the same query parameters as were found on the
+** main database file.
+**
+** See the [URI filename] documentation for additional information.
+*/
+SQLITE_API const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam);
+SQLITE_API int sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault);
+SQLITE_API sqlite3_int64 sqlite3_uri_int64(const char*, const char*, sqlite3_int64);
+SQLITE_API const char *sqlite3_uri_key(const char *zFilename, int N);
+
+/*
+** CAPI3REF: Translate filenames
+**
+** These routines are available to [VFS|custom VFS implementations] for
+** translating filenames between the main database file, the journal file,
+** and the WAL file.
+**
+** If F is the name of an sqlite database file, journal file, or WAL file
+** passed by the SQLite core into the VFS, then sqlite3_filename_database(F)
+** returns the name of the corresponding database file.
+**
+** If F is the name of an sqlite database file, journal file, or WAL file
+** passed by the SQLite core into the VFS, or if F is a database filename
+** obtained from [sqlite3_db_filename()], then sqlite3_filename_journal(F)
+** returns the name of the corresponding rollback journal file.
+**
+** If F is the name of an sqlite database file, journal file, or WAL file
+** that was passed by the SQLite core into the VFS, or if F is a database
+** filename obtained from [sqlite3_db_filename()], then
+** sqlite3_filename_wal(F) returns the name of the corresponding
+** WAL file.
+**
+** In all of the above, if F is not the name of a database, journal or WAL
+** filename passed into the VFS from the SQLite core and F is not the
+** return value from [sqlite3_db_filename()], then the result is
+** undefined and is likely a memory access violation.
+*/
+SQLITE_API const char *sqlite3_filename_database(const char*);
+SQLITE_API const char *sqlite3_filename_journal(const char*);
+SQLITE_API const char *sqlite3_filename_wal(const char*);
+
+/*
+** CAPI3REF: Database File Corresponding To A Journal
+**
+** ^If X is the name of a rollback or WAL-mode journal file that is
+** passed into the xOpen method of [sqlite3_vfs], then
+** sqlite3_database_file_object(X) returns a pointer to the [sqlite3_file]
+** object that represents the main database file.
+**
+** This routine is intended for use in custom [VFS] implementations
+** only. It is not a general-purpose interface.
+** The argument sqlite3_file_object(X) must be a filename pointer that
+** has been passed into [sqlite3_vfs].xOpen method where the
+** flags parameter to xOpen contains one of the bits
+** [SQLITE_OPEN_MAIN_JOURNAL] or [SQLITE_OPEN_WAL]. Any other use
+** of this routine results in undefined and probably undesirable
+** behavior.
+*/
+SQLITE_API sqlite3_file *sqlite3_database_file_object(const char*);
+
+/*
+** CAPI3REF: Create and Destroy VFS Filenames
+**
+** These interfces are provided for use by [VFS shim] implementations and
+** are not useful outside of that context.
+**
+** The sqlite3_create_filename(D,J,W,N,P) allocates memory to hold a version of
+** database filename D with corresponding journal file J and WAL file W and
+** with N URI parameters key/values pairs in the array P. The result from
+** sqlite3_create_filename(D,J,W,N,P) is a pointer to a database filename that
+** is safe to pass to routines like:
+** <ul>
+** <li> [sqlite3_uri_parameter()],
+** <li> [sqlite3_uri_boolean()],
+** <li> [sqlite3_uri_int64()],
+** <li> [sqlite3_uri_key()],
+** <li> [sqlite3_filename_database()],
+** <li> [sqlite3_filename_journal()], or
+** <li> [sqlite3_filename_wal()].
+** </ul>
+** If a memory allocation error occurs, sqlite3_create_filename() might
+** return a NULL pointer. The memory obtained from sqlite3_create_filename(X)
+** must be released by a corresponding call to sqlite3_free_filename(Y).
+**
+** The P parameter in sqlite3_create_filename(D,J,W,N,P) should be an array
+** of 2*N pointers to strings. Each pair of pointers in this array corresponds
+** to a key and value for a query parameter. The P parameter may be a NULL
+** pointer if N is zero. None of the 2*N pointers in the P array may be
+** NULL pointers and key pointers should not be empty strings.
+** None of the D, J, or W parameters to sqlite3_create_filename(D,J,W,N,P) may
+** be NULL pointers, though they can be empty strings.
+**
+** The sqlite3_free_filename(Y) routine releases a memory allocation
+** previously obtained from sqlite3_create_filename(). Invoking
+** sqlite3_free_filename(Y) where Y is a NULL pointer is a harmless no-op.
+**
+** If the Y parameter to sqlite3_free_filename(Y) is anything other
+** than a NULL pointer or a pointer previously acquired from
+** sqlite3_create_filename(), then bad things such as heap
+** corruption or segfaults may occur. The value Y should be
+** used again after sqlite3_free_filename(Y) has been called. This means
+** that if the [sqlite3_vfs.xOpen()] method of a VFS has been called using Y,
+** then the corresponding [sqlite3_module.xClose() method should also be
+** invoked prior to calling sqlite3_free_filename(Y).
+*/
+SQLITE_API char *sqlite3_create_filename(
+ const char *zDatabase,
+ const char *zJournal,
+ const char *zWal,
+ int nParam,
+ const char **azParam
+);
+SQLITE_API void sqlite3_free_filename(char*);
+
+/*
+** CAPI3REF: Error Codes And Messages
+** METHOD: sqlite3
+**
+** ^If the most recent sqlite3_* API call associated with
+** [database connection] D failed, then the sqlite3_errcode(D) interface
+** returns the numeric [result code] or [extended result code] for that
+** API call.
+** ^The sqlite3_extended_errcode()
+** interface is the same except that it always returns the
+** [extended result code] even when extended result codes are
+** disabled.
+**
+** The values returned by sqlite3_errcode() and/or
+** sqlite3_extended_errcode() might change with each API call.
+** Except, there are some interfaces that are guaranteed to never
+** change the value of the error code. The error-code preserving
+** interfaces are:
+**
+** <ul>
+** <li> sqlite3_errcode()
+** <li> sqlite3_extended_errcode()
+** <li> sqlite3_errmsg()
+** <li> sqlite3_errmsg16()
+** </ul>
+**
+** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
+** text that describes the error, as either UTF-8 or UTF-16 respectively.
+** ^(Memory to hold the error message string is managed internally.
+** The application does not need to worry about freeing the result.
+** However, the error string might be overwritten or deallocated by
+** subsequent calls to other SQLite interface functions.)^
+**
+** ^The sqlite3_errstr() interface returns the English-language text
+** that describes the [result code], as UTF-8.
+** ^(Memory to hold the error message string is managed internally
+** and must not be freed by the application)^.
+**
+** When the serialized [threading mode] is in use, it might be the
+** case that a second error occurs on a separate thread in between
+** the time of the first error and the call to these interfaces.
+** When that happens, the second error will be reported since these
+** interfaces always report the most recent result. To avoid
+** this, each thread can obtain exclusive use of the [database connection] D
+** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning
+** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after
+** all calls to the interfaces listed here are completed.
+**
+** If an interface fails with SQLITE_MISUSE, that means the interface
+** was invoked incorrectly by the application. In that case, the
+** error code and message may or may not be set.
+*/
+SQLITE_API int sqlite3_errcode(sqlite3 *db);
+SQLITE_API int sqlite3_extended_errcode(sqlite3 *db);
+SQLITE_API const char *sqlite3_errmsg(sqlite3*);
+SQLITE_API const void *sqlite3_errmsg16(sqlite3*);
+SQLITE_API const char *sqlite3_errstr(int);
+
+/*
+** CAPI3REF: Prepared Statement Object
+** KEYWORDS: {prepared statement} {prepared statements}
+**
+** An instance of this object represents a single SQL statement that
+** has been compiled into binary form and is ready to be evaluated.
+**
+** Think of each SQL statement as a separate computer program. The
+** original SQL text is source code. A prepared statement object
+** is the compiled object code. All SQL must be converted into a
+** prepared statement before it can be run.
+**
+** The life-cycle of a prepared statement object usually goes like this:
+**
+** <ol>
+** <li> Create the prepared statement object using [sqlite3_prepare_v2()].
+** <li> Bind values to [parameters] using the sqlite3_bind_*()
+** interfaces.
+** <li> Run the SQL by calling [sqlite3_step()] one or more times.
+** <li> Reset the prepared statement using [sqlite3_reset()] then go back
+** to step 2. Do this zero or more times.
+** <li> Destroy the object using [sqlite3_finalize()].
+** </ol>
+*/
+typedef struct sqlite3_stmt sqlite3_stmt;
+
+/*
+** CAPI3REF: Run-time Limits
+** METHOD: sqlite3
+**
+** ^(This interface allows the size of various constructs to be limited
+** on a connection by connection basis. The first parameter is the
+** [database connection] whose limit is to be set or queried. The
+** second parameter is one of the [limit categories] that define a
+** class of constructs to be size limited. The third parameter is the
+** new limit for that construct.)^
+**
+** ^If the new limit is a negative number, the limit is unchanged.
+** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a
+** [limits | hard upper bound]
+** set at compile-time by a C preprocessor macro called
+** [limits | SQLITE_MAX_<i>NAME</i>].
+** (The "_LIMIT_" in the name is changed to "_MAX_".))^
+** ^Attempts to increase a limit above its hard upper bound are
+** silently truncated to the hard upper bound.
+**
+** ^Regardless of whether or not the limit was changed, the
+** [sqlite3_limit()] interface returns the prior value of the limit.
+** ^Hence, to find the current value of a limit without changing it,
+** simply invoke this interface with the third parameter set to -1.
+**
+** Run-time limits are intended for use in applications that manage
+** both their own internal database and also databases that are controlled
+** by untrusted external sources. An example application might be a
+** web browser that has its own databases for storing history and
+** separate databases controlled by JavaScript applications downloaded
+** off the Internet. The internal databases can be given the
+** large, default limits. Databases managed by external sources can
+** be given much smaller limits designed to prevent a denial of service
+** attack. Developers might also want to use the [sqlite3_set_authorizer()]
+** interface to further control untrusted SQL. The size of the database
+** created by an untrusted script can be contained using the
+** [max_page_count] [PRAGMA].
+**
+** New run-time limit categories may be added in future releases.
+*/
+SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal);
+
+/*
+** CAPI3REF: Run-Time Limit Categories
+** KEYWORDS: {limit category} {*limit categories}
+**
+** These constants define various performance limits
+** that can be lowered at run-time using [sqlite3_limit()].
+** The synopsis of the meanings of the various limits is shown below.
+** Additional information is available at [limits | Limits in SQLite].
+**
+** <dl>
+** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt>
+** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^
+**
+** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt>
+** <dd>The maximum length of an SQL statement, in bytes.</dd>)^
+**
+** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt>
+** <dd>The maximum number of columns in a table definition or in the
+** result set of a [SELECT] or the maximum number of columns in an index
+** or in an ORDER BY or GROUP BY clause.</dd>)^
+**
+** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt>
+** <dd>The maximum depth of the parse tree on any expression.</dd>)^
+**
+** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt>
+** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^
+**
+** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt>
+** <dd>The maximum number of instructions in a virtual machine program
+** used to implement an SQL statement. If [sqlite3_prepare_v2()] or
+** the equivalent tries to allocate space for more than this many opcodes
+** in a single prepared statement, an SQLITE_NOMEM error is returned.</dd>)^
+**
+** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt>
+** <dd>The maximum number of arguments on a function.</dd>)^
+**
+** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt>
+** <dd>The maximum number of [ATTACH | attached databases].)^</dd>
+**
+** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]]
+** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt>
+** <dd>The maximum length of the pattern argument to the [LIKE] or
+** [GLOB] operators.</dd>)^
+**
+** [[SQLITE_LIMIT_VARIABLE_NUMBER]]
+** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt>
+** <dd>The maximum index number of any [parameter] in an SQL statement.)^
+**
+** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt>
+** <dd>The maximum depth of recursion for triggers.</dd>)^
+**
+** [[SQLITE_LIMIT_WORKER_THREADS]] ^(<dt>SQLITE_LIMIT_WORKER_THREADS</dt>
+** <dd>The maximum number of auxiliary worker threads that a single
+** [prepared statement] may start.</dd>)^
+** </dl>
+*/
+#define SQLITE_LIMIT_LENGTH 0
+#define SQLITE_LIMIT_SQL_LENGTH 1
+#define SQLITE_LIMIT_COLUMN 2
+#define SQLITE_LIMIT_EXPR_DEPTH 3
+#define SQLITE_LIMIT_COMPOUND_SELECT 4
+#define SQLITE_LIMIT_VDBE_OP 5
+#define SQLITE_LIMIT_FUNCTION_ARG 6
+#define SQLITE_LIMIT_ATTACHED 7
+#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8
+#define SQLITE_LIMIT_VARIABLE_NUMBER 9
+#define SQLITE_LIMIT_TRIGGER_DEPTH 10
+#define SQLITE_LIMIT_WORKER_THREADS 11
+
+/*
+** CAPI3REF: Prepare Flags
+**
+** These constants define various flags that can be passed into
+** "prepFlags" parameter of the [sqlite3_prepare_v3()] and
+** [sqlite3_prepare16_v3()] interfaces.
+**
+** New flags may be added in future releases of SQLite.
+**
+** <dl>
+** [[SQLITE_PREPARE_PERSISTENT]] ^(<dt>SQLITE_PREPARE_PERSISTENT</dt>
+** <dd>The SQLITE_PREPARE_PERSISTENT flag is a hint to the query planner
+** that the prepared statement will be retained for a long time and
+** probably reused many times.)^ ^Without this flag, [sqlite3_prepare_v3()]
+** and [sqlite3_prepare16_v3()] assume that the prepared statement will
+** be used just once or at most a few times and then destroyed using
+** [sqlite3_finalize()] relatively soon. The current implementation acts
+** on this hint by avoiding the use of [lookaside memory] so as not to
+** deplete the limited store of lookaside memory. Future versions of
+** SQLite may act on this hint differently.
+**
+** [[SQLITE_PREPARE_NORMALIZE]] <dt>SQLITE_PREPARE_NORMALIZE</dt>
+** <dd>The SQLITE_PREPARE_NORMALIZE flag is a no-op. This flag used
+** to be required for any prepared statement that wanted to use the
+** [sqlite3_normalized_sql()] interface. However, the
+** [sqlite3_normalized_sql()] interface is now available to all
+** prepared statements, regardless of whether or not they use this
+** flag.
+**
+** [[SQLITE_PREPARE_NO_VTAB]] <dt>SQLITE_PREPARE_NO_VTAB</dt>
+** <dd>The SQLITE_PREPARE_NO_VTAB flag causes the SQL compiler
+** to return an error (error code SQLITE_ERROR) if the statement uses
+** any virtual tables.
+** </dl>
+*/
+#define SQLITE_PREPARE_PERSISTENT 0x01
+#define SQLITE_PREPARE_NORMALIZE 0x02
+#define SQLITE_PREPARE_NO_VTAB 0x04
+
+/*
+** CAPI3REF: Compiling An SQL Statement
+** KEYWORDS: {SQL statement compiler}
+** METHOD: sqlite3
+** CONSTRUCTOR: sqlite3_stmt
+**
+** To execute an SQL statement, it must first be compiled into a byte-code
+** program using one of these routines. Or, in other words, these routines
+** are constructors for the [prepared statement] object.
+**
+** The preferred routine to use is [sqlite3_prepare_v2()]. The
+** [sqlite3_prepare()] interface is legacy and should be avoided.
+** [sqlite3_prepare_v3()] has an extra "prepFlags" option that is used
+** for special purposes.
+**
+** The use of the UTF-8 interfaces is preferred, as SQLite currently
+** does all parsing using UTF-8. The UTF-16 interfaces are provided
+** as a convenience. The UTF-16 interfaces work by converting the
+** input text into UTF-8, then invoking the corresponding UTF-8 interface.
+**
+** The first argument, "db", is a [database connection] obtained from a
+** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or
+** [sqlite3_open16()]. The database connection must not have been closed.
+**
+** The second argument, "zSql", is the statement to be compiled, encoded
+** as either UTF-8 or UTF-16. The sqlite3_prepare(), sqlite3_prepare_v2(),
+** and sqlite3_prepare_v3()
+** interfaces use UTF-8, and sqlite3_prepare16(), sqlite3_prepare16_v2(),
+** and sqlite3_prepare16_v3() use UTF-16.
+**
+** ^If the nByte argument is negative, then zSql is read up to the
+** first zero terminator. ^If nByte is positive, then it is the
+** number of bytes read from zSql. ^If nByte is zero, then no prepared
+** statement is generated.
+** If the caller knows that the supplied string is nul-terminated, then
+** there is a small performance advantage to passing an nByte parameter that
+** is the number of bytes in the input string <i>including</i>
+** the nul-terminator.
+**
+** ^If pzTail is not NULL then *pzTail is made to point to the first byte
+** past the end of the first SQL statement in zSql. These routines only
+** compile the first statement in zSql, so *pzTail is left pointing to
+** what remains uncompiled.
+**
+** ^*ppStmt is left pointing to a compiled [prepared statement] that can be
+** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set
+** to NULL. ^If the input text contains no SQL (if the input is an empty
+** string or a comment) then *ppStmt is set to NULL.
+** The calling procedure is responsible for deleting the compiled
+** SQL statement using [sqlite3_finalize()] after it has finished with it.
+** ppStmt may not be NULL.
+**
+** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK];
+** otherwise an [error code] is returned.
+**
+** The sqlite3_prepare_v2(), sqlite3_prepare_v3(), sqlite3_prepare16_v2(),
+** and sqlite3_prepare16_v3() interfaces are recommended for all new programs.
+** The older interfaces (sqlite3_prepare() and sqlite3_prepare16())
+** are retained for backwards compatibility, but their use is discouraged.
+** ^In the "vX" interfaces, the prepared statement
+** that is returned (the [sqlite3_stmt] object) contains a copy of the
+** original SQL text. This causes the [sqlite3_step()] interface to
+** behave differently in three ways:
+**
+** <ol>
+** <li>
+** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
+** always used to do, [sqlite3_step()] will automatically recompile the SQL
+** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY]
+** retries will occur before sqlite3_step() gives up and returns an error.
+** </li>
+**
+** <li>
+** ^When an error occurs, [sqlite3_step()] will return one of the detailed
+** [error codes] or [extended error codes]. ^The legacy behavior was that
+** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code
+** and the application would have to make a second call to [sqlite3_reset()]
+** in order to find the underlying cause of the problem. With the "v2" prepare
+** interfaces, the underlying reason for the error is returned immediately.
+** </li>
+**
+** <li>
+** ^If the specific value bound to a [parameter | host parameter] in the
+** WHERE clause might influence the choice of query plan for a statement,
+** then the statement will be automatically recompiled, as if there had been
+** a schema change, on the first [sqlite3_step()] call following any change
+** to the [sqlite3_bind_text | bindings] of that [parameter].
+** ^The specific value of a WHERE-clause [parameter] might influence the
+** choice of query plan if the parameter is the left-hand side of a [LIKE]
+** or [GLOB] operator or if the parameter is compared to an indexed column
+** and the [SQLITE_ENABLE_STAT4] compile-time option is enabled.
+** </li>
+** </ol>
+**
+** <p>^sqlite3_prepare_v3() differs from sqlite3_prepare_v2() only in having
+** the extra prepFlags parameter, which is a bit array consisting of zero or
+** more of the [SQLITE_PREPARE_PERSISTENT|SQLITE_PREPARE_*] flags. ^The
+** sqlite3_prepare_v2() interface works exactly the same as
+** sqlite3_prepare_v3() with a zero prepFlags parameter.
+*/
+SQLITE_API int sqlite3_prepare(
+ sqlite3 *db, /* Database handle */
+ const char *zSql, /* SQL statement, UTF-8 encoded */
+ int nByte, /* Maximum length of zSql in bytes. */
+ sqlite3_stmt **ppStmt, /* OUT: Statement handle */
+ const char **pzTail /* OUT: Pointer to unused portion of zSql */
+);
+SQLITE_API int sqlite3_prepare_v2(
+ sqlite3 *db, /* Database handle */
+ const char *zSql, /* SQL statement, UTF-8 encoded */
+ int nByte, /* Maximum length of zSql in bytes. */
+ sqlite3_stmt **ppStmt, /* OUT: Statement handle */
+ const char **pzTail /* OUT: Pointer to unused portion of zSql */
+);
+SQLITE_API int sqlite3_prepare_v3(
+ sqlite3 *db, /* Database handle */
+ const char *zSql, /* SQL statement, UTF-8 encoded */
+ int nByte, /* Maximum length of zSql in bytes. */
+ unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */
+ sqlite3_stmt **ppStmt, /* OUT: Statement handle */
+ const char **pzTail /* OUT: Pointer to unused portion of zSql */
+);
+SQLITE_API int sqlite3_prepare16(
+ sqlite3 *db, /* Database handle */
+ const void *zSql, /* SQL statement, UTF-16 encoded */
+ int nByte, /* Maximum length of zSql in bytes. */
+ sqlite3_stmt **ppStmt, /* OUT: Statement handle */
+ const void **pzTail /* OUT: Pointer to unused portion of zSql */
+);
+SQLITE_API int sqlite3_prepare16_v2(
+ sqlite3 *db, /* Database handle */
+ const void *zSql, /* SQL statement, UTF-16 encoded */
+ int nByte, /* Maximum length of zSql in bytes. */
+ sqlite3_stmt **ppStmt, /* OUT: Statement handle */
+ const void **pzTail /* OUT: Pointer to unused portion of zSql */
+);
+SQLITE_API int sqlite3_prepare16_v3(
+ sqlite3 *db, /* Database handle */
+ const void *zSql, /* SQL statement, UTF-16 encoded */
+ int nByte, /* Maximum length of zSql in bytes. */
+ unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */
+ sqlite3_stmt **ppStmt, /* OUT: Statement handle */
+ const void **pzTail /* OUT: Pointer to unused portion of zSql */
+);
+
+/*
+** CAPI3REF: Retrieving Statement SQL
+** METHOD: sqlite3_stmt
+**
+** ^The sqlite3_sql(P) interface returns a pointer to a copy of the UTF-8
+** SQL text used to create [prepared statement] P if P was
+** created by [sqlite3_prepare_v2()], [sqlite3_prepare_v3()],
+** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()].
+** ^The sqlite3_expanded_sql(P) interface returns a pointer to a UTF-8
+** string containing the SQL text of prepared statement P with
+** [bound parameters] expanded.
+** ^The sqlite3_normalized_sql(P) interface returns a pointer to a UTF-8
+** string containing the normalized SQL text of prepared statement P. The
+** semantics used to normalize a SQL statement are unspecified and subject
+** to change. At a minimum, literal values will be replaced with suitable
+** placeholders.
+**
+** ^(For example, if a prepared statement is created using the SQL
+** text "SELECT $abc,:xyz" and if parameter $abc is bound to integer 2345
+** and parameter :xyz is unbound, then sqlite3_sql() will return
+** the original string, "SELECT $abc,:xyz" but sqlite3_expanded_sql()
+** will return "SELECT 2345,NULL".)^
+**
+** ^The sqlite3_expanded_sql() interface returns NULL if insufficient memory
+** is available to hold the result, or if the result would exceed the
+** the maximum string length determined by the [SQLITE_LIMIT_LENGTH].
+**
+** ^The [SQLITE_TRACE_SIZE_LIMIT] compile-time option limits the size of
+** bound parameter expansions. ^The [SQLITE_OMIT_TRACE] compile-time
+** option causes sqlite3_expanded_sql() to always return NULL.
+**
+** ^The strings returned by sqlite3_sql(P) and sqlite3_normalized_sql(P)
+** are managed by SQLite and are automatically freed when the prepared
+** statement is finalized.
+** ^The string returned by sqlite3_expanded_sql(P), on the other hand,
+** is obtained from [sqlite3_malloc()] and must be free by the application
+** by passing it to [sqlite3_free()].
+*/
+SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt);
+SQLITE_API char *sqlite3_expanded_sql(sqlite3_stmt *pStmt);
+SQLITE_API const char *sqlite3_normalized_sql(sqlite3_stmt *pStmt);
+
+/*
+** CAPI3REF: Determine If An SQL Statement Writes The Database
+** METHOD: sqlite3_stmt
+**
+** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if
+** and only if the [prepared statement] X makes no direct changes to
+** the content of the database file.
+**
+** Note that [application-defined SQL functions] or
+** [virtual tables] might change the database indirectly as a side effect.
+** ^(For example, if an application defines a function "eval()" that
+** calls [sqlite3_exec()], then the following SQL statement would
+** change the database file through side-effects:
+**
+** <blockquote><pre>
+** SELECT eval('DELETE FROM t1') FROM t2;
+** </pre></blockquote>
+**
+** But because the [SELECT] statement does not change the database file
+** directly, sqlite3_stmt_readonly() would still return true.)^
+**
+** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK],
+** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true,
+** since the statements themselves do not actually modify the database but
+** rather they control the timing of when other statements modify the
+** database. ^The [ATTACH] and [DETACH] statements also cause
+** sqlite3_stmt_readonly() to return true since, while those statements
+** change the configuration of a database connection, they do not make
+** changes to the content of the database files on disk.
+** ^The sqlite3_stmt_readonly() interface returns true for [BEGIN] since
+** [BEGIN] merely sets internal flags, but the [BEGIN|BEGIN IMMEDIATE] and
+** [BEGIN|BEGIN EXCLUSIVE] commands do touch the database and so
+** sqlite3_stmt_readonly() returns false for those commands.
+*/
+SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt);
+
+/*
+** CAPI3REF: Query The EXPLAIN Setting For A Prepared Statement
+** METHOD: sqlite3_stmt
+**
+** ^The sqlite3_stmt_isexplain(S) interface returns 1 if the
+** prepared statement S is an EXPLAIN statement, or 2 if the
+** statement S is an EXPLAIN QUERY PLAN.
+** ^The sqlite3_stmt_isexplain(S) interface returns 0 if S is
+** an ordinary statement or a NULL pointer.
+*/
+SQLITE_API int sqlite3_stmt_isexplain(sqlite3_stmt *pStmt);
+
+/*
+** CAPI3REF: Determine If A Prepared Statement Has Been Reset
+** METHOD: sqlite3_stmt
+**
+** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the
+** [prepared statement] S has been stepped at least once using
+** [sqlite3_step(S)] but has neither run to completion (returned
+** [SQLITE_DONE] from [sqlite3_step(S)]) nor
+** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S)
+** interface returns false if S is a NULL pointer. If S is not a
+** NULL pointer and is not a pointer to a valid [prepared statement]
+** object, then the behavior is undefined and probably undesirable.
+**
+** This interface can be used in combination [sqlite3_next_stmt()]
+** to locate all prepared statements associated with a database
+** connection that are in need of being reset. This can be used,
+** for example, in diagnostic routines to search for prepared
+** statements that are holding a transaction open.
+*/
+SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*);
+
+/*
+** CAPI3REF: Dynamically Typed Value Object
+** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
+**
+** SQLite uses the sqlite3_value object to represent all values
+** that can be stored in a database table. SQLite uses dynamic typing
+** for the values it stores. ^Values stored in sqlite3_value objects
+** can be integers, floating point values, strings, BLOBs, or NULL.
+**
+** An sqlite3_value object may be either "protected" or "unprotected".
+** Some interfaces require a protected sqlite3_value. Other interfaces
+** will accept either a protected or an unprotected sqlite3_value.
+** Every interface that accepts sqlite3_value arguments specifies
+** whether or not it requires a protected sqlite3_value. The
+** [sqlite3_value_dup()] interface can be used to construct a new
+** protected sqlite3_value from an unprotected sqlite3_value.
+**
+** The terms "protected" and "unprotected" refer to whether or not
+** a mutex is held. An internal mutex is held for a protected
+** sqlite3_value object but no mutex is held for an unprotected
+** sqlite3_value object. If SQLite is compiled to be single-threaded
+** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0)
+** or if SQLite is run in one of reduced mutex modes
+** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD]
+** then there is no distinction between protected and unprotected
+** sqlite3_value objects and they can be used interchangeably. However,
+** for maximum code portability it is recommended that applications
+** still make the distinction between protected and unprotected
+** sqlite3_value objects even when not strictly required.
+**
+** ^The sqlite3_value objects that are passed as parameters into the
+** implementation of [application-defined SQL functions] are protected.
+** ^The sqlite3_value object returned by
+** [sqlite3_column_value()] is unprotected.
+** Unprotected sqlite3_value objects may only be used as arguments
+** to [sqlite3_result_value()], [sqlite3_bind_value()], and
+** [sqlite3_value_dup()].
+** The [sqlite3_value_blob | sqlite3_value_type()] family of
+** interfaces require protected sqlite3_value objects.
+*/
+typedef struct sqlite3_value sqlite3_value;
+
+/*
+** CAPI3REF: SQL Function Context Object
+**
+** The context in which an SQL function executes is stored in an
+** sqlite3_context object. ^A pointer to an sqlite3_context object
+** is always first parameter to [application-defined SQL functions].
+** The application-defined SQL function implementation will pass this
+** pointer through into calls to [sqlite3_result_int | sqlite3_result()],
+** [sqlite3_aggregate_context()], [sqlite3_user_data()],
+** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()],
+** and/or [sqlite3_set_auxdata()].
+*/
+typedef struct sqlite3_context sqlite3_context;
+
+/*
+** CAPI3REF: Binding Values To Prepared Statements
+** KEYWORDS: {host parameter} {host parameters} {host parameter name}
+** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding}
+** METHOD: sqlite3_stmt
+**
+** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants,
+** literals may be replaced by a [parameter] that matches one of following
+** templates:
+**
+** <ul>
+** <li> ?
+** <li> ?NNN
+** <li> :VVV
+** <li> @VVV
+** <li> $VVV
+** </ul>
+**
+** In the templates above, NNN represents an integer literal,
+** and VVV represents an alphanumeric identifier.)^ ^The values of these
+** parameters (also called "host parameter names" or "SQL parameters")
+** can be set using the sqlite3_bind_*() routines defined here.
+**
+** ^The first argument to the sqlite3_bind_*() routines is always
+** a pointer to the [sqlite3_stmt] object returned from
+** [sqlite3_prepare_v2()] or its variants.
+**
+** ^The second argument is the index of the SQL parameter to be set.
+** ^The leftmost SQL parameter has an index of 1. ^When the same named
+** SQL parameter is used more than once, second and subsequent
+** occurrences have the same index as the first occurrence.
+** ^The index for named parameters can be looked up using the
+** [sqlite3_bind_parameter_index()] API if desired. ^The index
+** for "?NNN" parameters is the value of NNN.
+** ^The NNN value must be between 1 and the [sqlite3_limit()]
+** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 32766).
+**
+** ^The third argument is the value to bind to the parameter.
+** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16()
+** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter
+** is ignored and the end result is the same as sqlite3_bind_null().
+** ^If the third parameter to sqlite3_bind_text() is not NULL, then
+** it should be a pointer to well-formed UTF8 text.
+** ^If the third parameter to sqlite3_bind_text16() is not NULL, then
+** it should be a pointer to well-formed UTF16 text.
+** ^If the third parameter to sqlite3_bind_text64() is not NULL, then
+** it should be a pointer to a well-formed unicode string that is
+** either UTF8 if the sixth parameter is SQLITE_UTF8, or UTF16
+** otherwise.
+**
+** [[byte-order determination rules]] ^The byte-order of
+** UTF16 input text is determined by the byte-order mark (BOM, U+FEFF)
+** found in first character, which is removed, or in the absence of a BOM
+** the byte order is the native byte order of the host
+** machine for sqlite3_bind_text16() or the byte order specified in
+** the 6th parameter for sqlite3_bind_text64().)^
+** ^If UTF16 input text contains invalid unicode
+** characters, then SQLite might change those invalid characters
+** into the unicode replacement character: U+FFFD.
+**
+** ^(In those routines that have a fourth argument, its value is the
+** number of bytes in the parameter. To be clear: the value is the
+** number of <u>bytes</u> in the value, not the number of characters.)^
+** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16()
+** is negative, then the length of the string is
+** the number of bytes up to the first zero terminator.
+** If the fourth parameter to sqlite3_bind_blob() is negative, then
+** the behavior is undefined.
+** If a non-negative fourth parameter is provided to sqlite3_bind_text()
+** or sqlite3_bind_text16() or sqlite3_bind_text64() then
+** that parameter must be the byte offset
+** where the NUL terminator would occur assuming the string were NUL
+** terminated. If any NUL characters occurs at byte offsets less than
+** the value of the fourth parameter then the resulting string value will
+** contain embedded NULs. The result of expressions involving strings
+** with embedded NULs is undefined.
+**
+** ^The fifth argument to the BLOB and string binding interfaces
+** is a destructor used to dispose of the BLOB or
+** string after SQLite has finished with it. ^The destructor is called
+** to dispose of the BLOB or string even if the call to the bind API fails,
+** except the destructor is not called if the third parameter is a NULL
+** pointer or the fourth parameter is negative.
+** ^If the fifth argument is
+** the special value [SQLITE_STATIC], then SQLite assumes that the
+** information is in static, unmanaged space and does not need to be freed.
+** ^If the fifth argument has the value [SQLITE_TRANSIENT], then
+** SQLite makes its own private copy of the data immediately, before
+** the sqlite3_bind_*() routine returns.
+**
+** ^The sixth argument to sqlite3_bind_text64() must be one of
+** [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE]
+** to specify the encoding of the text in the third parameter. If
+** the sixth argument to sqlite3_bind_text64() is not one of the
+** allowed values shown above, or if the text encoding is different
+** from the encoding specified by the sixth parameter, then the behavior
+** is undefined.
+**
+** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
+** is filled with zeroes. ^A zeroblob uses a fixed amount of memory
+** (just an integer to hold its size) while it is being processed.
+** Zeroblobs are intended to serve as placeholders for BLOBs whose
+** content is later written using
+** [sqlite3_blob_open | incremental BLOB I/O] routines.
+** ^A negative value for the zeroblob results in a zero-length BLOB.
+**
+** ^The sqlite3_bind_pointer(S,I,P,T,D) routine causes the I-th parameter in
+** [prepared statement] S to have an SQL value of NULL, but to also be
+** associated with the pointer P of type T. ^D is either a NULL pointer or
+** a pointer to a destructor function for P. ^SQLite will invoke the
+** destructor D with a single argument of P when it is finished using
+** P. The T parameter should be a static string, preferably a string
+** literal. The sqlite3_bind_pointer() routine is part of the
+** [pointer passing interface] added for SQLite 3.20.0.
+**
+** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer
+** for the [prepared statement] or with a prepared statement for which
+** [sqlite3_step()] has been called more recently than [sqlite3_reset()],
+** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_()
+** routine is passed a [prepared statement] that has been finalized, the
+** result is undefined and probably harmful.
+**
+** ^Bindings are not cleared by the [sqlite3_reset()] routine.
+** ^Unbound parameters are interpreted as NULL.
+**
+** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an
+** [error code] if anything goes wrong.
+** ^[SQLITE_TOOBIG] might be returned if the size of a string or BLOB
+** exceeds limits imposed by [sqlite3_limit]([SQLITE_LIMIT_LENGTH]) or
+** [SQLITE_MAX_LENGTH].
+** ^[SQLITE_RANGE] is returned if the parameter
+** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails.
+**
+** See also: [sqlite3_bind_parameter_count()],
+** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()].
+*/
+SQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
+SQLITE_API int sqlite3_bind_blob64(sqlite3_stmt*, int, const void*, sqlite3_uint64,
+ void(*)(void*));
+SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double);
+SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int);
+SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
+SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int);
+SQLITE_API int sqlite3_bind_text(sqlite3_stmt*,int,const char*,int,void(*)(void*));
+SQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
+SQLITE_API int sqlite3_bind_text64(sqlite3_stmt*, int, const char*, sqlite3_uint64,
+ void(*)(void*), unsigned char encoding);
+SQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
+SQLITE_API int sqlite3_bind_pointer(sqlite3_stmt*, int, void*, const char*,void(*)(void*));
+SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
+SQLITE_API int sqlite3_bind_zeroblob64(sqlite3_stmt*, int, sqlite3_uint64);
+
+/*
+** CAPI3REF: Number Of SQL Parameters
+** METHOD: sqlite3_stmt
+**
+** ^This routine can be used to find the number of [SQL parameters]
+** in a [prepared statement]. SQL parameters are tokens of the
+** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
+** placeholders for values that are [sqlite3_bind_blob | bound]
+** to the parameters at a later time.
+**
+** ^(This routine actually returns the index of the largest (rightmost)
+** parameter. For all forms except ?NNN, this will correspond to the
+** number of unique parameters. If parameters of the ?NNN form are used,
+** there may be gaps in the list.)^
+**
+** See also: [sqlite3_bind_blob|sqlite3_bind()],
+** [sqlite3_bind_parameter_name()], and
+** [sqlite3_bind_parameter_index()].
+*/
+SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*);
+
+/*
+** CAPI3REF: Name Of A Host Parameter
+** METHOD: sqlite3_stmt
+**
+** ^The sqlite3_bind_parameter_name(P,N) interface returns
+** the name of the N-th [SQL parameter] in the [prepared statement] P.
+** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA"
+** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA"
+** respectively.
+** In other words, the initial ":" or "$" or "@" or "?"
+** is included as part of the name.)^
+** ^Parameters of the form "?" without a following integer have no name
+** and are referred to as "nameless" or "anonymous parameters".
+**
+** ^The first host parameter has an index of 1, not 0.
+**
+** ^If the value N is out of range or if the N-th parameter is
+** nameless, then NULL is returned. ^The returned string is
+** always in UTF-8 encoding even if the named parameter was
+** originally specified as UTF-16 in [sqlite3_prepare16()],
+** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()].
+**
+** See also: [sqlite3_bind_blob|sqlite3_bind()],
+** [sqlite3_bind_parameter_count()], and
+** [sqlite3_bind_parameter_index()].
+*/
+SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
+
+/*
+** CAPI3REF: Index Of A Parameter With A Given Name
+** METHOD: sqlite3_stmt
+**
+** ^Return the index of an SQL parameter given its name. ^The
+** index value returned is suitable for use as the second
+** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero
+** is returned if no matching parameter is found. ^The parameter
+** name must be given in UTF-8 even if the original statement
+** was prepared from UTF-16 text using [sqlite3_prepare16_v2()] or
+** [sqlite3_prepare16_v3()].
+**
+** See also: [sqlite3_bind_blob|sqlite3_bind()],
+** [sqlite3_bind_parameter_count()], and
+** [sqlite3_bind_parameter_name()].
+*/
+SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
+
+/*
+** CAPI3REF: Reset All Bindings On A Prepared Statement
+** METHOD: sqlite3_stmt
+**
+** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset
+** the [sqlite3_bind_blob | bindings] on a [prepared statement].
+** ^Use this routine to reset all host parameters to NULL.
+*/
+SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*);
+
+/*
+** CAPI3REF: Number Of Columns In A Result Set
+** METHOD: sqlite3_stmt
+**
+** ^Return the number of columns in the result set returned by the
+** [prepared statement]. ^If this routine returns 0, that means the
+** [prepared statement] returns no data (for example an [UPDATE]).
+** ^However, just because this routine returns a positive number does not
+** mean that one or more rows of data will be returned. ^A SELECT statement
+** will always have a positive sqlite3_column_count() but depending on the
+** WHERE clause constraints and the table content, it might return no rows.
+**
+** See also: [sqlite3_data_count()]
+*/
+SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt);
+
+/*
+** CAPI3REF: Column Names In A Result Set
+** METHOD: sqlite3_stmt
+**
+** ^These routines return the name assigned to a particular column
+** in the result set of a [SELECT] statement. ^The sqlite3_column_name()
+** interface returns a pointer to a zero-terminated UTF-8 string
+** and sqlite3_column_name16() returns a pointer to a zero-terminated
+** UTF-16 string. ^The first parameter is the [prepared statement]
+** that implements the [SELECT] statement. ^The second parameter is the
+** column number. ^The leftmost column is number 0.
+**
+** ^The returned string pointer is valid until either the [prepared statement]
+** is destroyed by [sqlite3_finalize()] or until the statement is automatically
+** reprepared by the first call to [sqlite3_step()] for a particular run
+** or until the next call to
+** sqlite3_column_name() or sqlite3_column_name16() on the same column.
+**
+** ^If sqlite3_malloc() fails during the processing of either routine
+** (for example during a conversion from UTF-8 to UTF-16) then a
+** NULL pointer is returned.
+**
+** ^The name of a result column is the value of the "AS" clause for
+** that column, if there is an AS clause. If there is no AS clause
+** then the name of the column is unspecified and may change from
+** one release of SQLite to the next.
+*/
+SQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N);
+SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N);
+
+/*
+** CAPI3REF: Source Of Data In A Query Result
+** METHOD: sqlite3_stmt
+**
+** ^These routines provide a means to determine the database, table, and
+** table column that is the origin of a particular result column in
+** [SELECT] statement.
+** ^The name of the database or table or column can be returned as
+** either a UTF-8 or UTF-16 string. ^The _database_ routines return
+** the database name, the _table_ routines return the table name, and
+** the origin_ routines return the column name.
+** ^The returned string is valid until the [prepared statement] is destroyed
+** using [sqlite3_finalize()] or until the statement is automatically
+** reprepared by the first call to [sqlite3_step()] for a particular run
+** or until the same information is requested
+** again in a different encoding.
+**
+** ^The names returned are the original un-aliased names of the
+** database, table, and column.
+**
+** ^The first argument to these interfaces is a [prepared statement].
+** ^These functions return information about the Nth result column returned by
+** the statement, where N is the second function argument.
+** ^The left-most column is column 0 for these routines.
+**
+** ^If the Nth column returned by the statement is an expression or
+** subquery and is not a column value, then all of these functions return
+** NULL. ^These routines might also return NULL if a memory allocation error
+** occurs. ^Otherwise, they return the name of the attached database, table,
+** or column that query result column was extracted from.
+**
+** ^As with all other SQLite APIs, those whose names end with "16" return
+** UTF-16 encoded strings and the other functions return UTF-8.
+**
+** ^These APIs are only available if the library was compiled with the
+** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol.
+**
+** If two or more threads call one or more
+** [sqlite3_column_database_name | column metadata interfaces]
+** for the same [prepared statement] and result column
+** at the same time then the results are undefined.
+*/
+SQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int);
+SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int);
+SQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int);
+SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int);
+SQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int);
+SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
+
+/*
+** CAPI3REF: Declared Datatype Of A Query Result
+** METHOD: sqlite3_stmt
+**
+** ^(The first parameter is a [prepared statement].
+** If this statement is a [SELECT] statement and the Nth column of the
+** returned result set of that [SELECT] is a table column (not an
+** expression or subquery) then the declared type of the table
+** column is returned.)^ ^If the Nth column of the result set is an
+** expression or subquery, then a NULL pointer is returned.
+** ^The returned string is always UTF-8 encoded.
+**
+** ^(For example, given the database schema:
+**
+** CREATE TABLE t1(c1 VARIANT);
+**
+** and the following statement to be compiled:
+**
+** SELECT c1 + 1, c1 FROM t1;
+**
+** this routine would return the string "VARIANT" for the second result
+** column (i==1), and a NULL pointer for the first result column (i==0).)^
+**
+** ^SQLite uses dynamic run-time typing. ^So just because a column
+** is declared to contain a particular type does not mean that the
+** data stored in that column is of the declared type. SQLite is
+** strongly typed, but the typing is dynamic not static. ^Type
+** is associated with individual values, not with the containers
+** used to hold those values.
+*/
+SQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int);
+SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
+
+/*
+** CAPI3REF: Evaluate An SQL Statement
+** METHOD: sqlite3_stmt
+**
+** After a [prepared statement] has been prepared using any of
+** [sqlite3_prepare_v2()], [sqlite3_prepare_v3()], [sqlite3_prepare16_v2()],
+** or [sqlite3_prepare16_v3()] or one of the legacy
+** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function
+** must be called one or more times to evaluate the statement.
+**
+** The details of the behavior of the sqlite3_step() interface depend
+** on whether the statement was prepared using the newer "vX" interfaces
+** [sqlite3_prepare_v3()], [sqlite3_prepare_v2()], [sqlite3_prepare16_v3()],
+** [sqlite3_prepare16_v2()] or the older legacy
+** interfaces [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the
+** new "vX" interface is recommended for new applications but the legacy
+** interface will continue to be supported.
+**
+** ^In the legacy interface, the return value will be either [SQLITE_BUSY],
+** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].
+** ^With the "v2" interface, any of the other [result codes] or
+** [extended result codes] might be returned as well.
+**
+** ^[SQLITE_BUSY] means that the database engine was unable to acquire the
+** database locks it needs to do its job. ^If the statement is a [COMMIT]
+** or occurs outside of an explicit transaction, then you can retry the
+** statement. If the statement is not a [COMMIT] and occurs within an
+** explicit transaction then you should rollback the transaction before
+** continuing.
+**
+** ^[SQLITE_DONE] means that the statement has finished executing
+** successfully. sqlite3_step() should not be called again on this virtual
+** machine without first calling [sqlite3_reset()] to reset the virtual
+** machine back to its initial state.
+**
+** ^If the SQL statement being executed returns any data, then [SQLITE_ROW]
+** is returned each time a new row of data is ready for processing by the
+** caller. The values may be accessed using the [column access functions].
+** sqlite3_step() is called again to retrieve the next row of data.
+**
+** ^[SQLITE_ERROR] means that a run-time error (such as a constraint
+** violation) has occurred. sqlite3_step() should not be called again on
+** the VM. More information may be found by calling [sqlite3_errmsg()].
+** ^With the legacy interface, a more specific error code (for example,
+** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth)
+** can be obtained by calling [sqlite3_reset()] on the
+** [prepared statement]. ^In the "v2" interface,
+** the more specific error code is returned directly by sqlite3_step().
+**
+** [SQLITE_MISUSE] means that the this routine was called inappropriately.
+** Perhaps it was called on a [prepared statement] that has
+** already been [sqlite3_finalize | finalized] or on one that had
+** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could
+** be the case that the same database connection is being used by two or
+** more threads at the same moment in time.
+**
+** For all versions of SQLite up to and including 3.6.23.1, a call to
+** [sqlite3_reset()] was required after sqlite3_step() returned anything
+** other than [SQLITE_ROW] before any subsequent invocation of
+** sqlite3_step(). Failure to reset the prepared statement using
+** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from
+** sqlite3_step(). But after [version 3.6.23.1] ([dateof:3.6.23.1],
+** sqlite3_step() began
+** calling [sqlite3_reset()] automatically in this circumstance rather
+** than returning [SQLITE_MISUSE]. This is not considered a compatibility
+** break because any application that ever receives an SQLITE_MISUSE error
+** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option
+** can be used to restore the legacy behavior.
+**
+** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step()
+** API always returns a generic error code, [SQLITE_ERROR], following any
+** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call
+** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the
+** specific [error codes] that better describes the error.
+** We admit that this is a goofy design. The problem has been fixed
+** with the "v2" interface. If you prepare all of your SQL statements
+** using [sqlite3_prepare_v3()] or [sqlite3_prepare_v2()]
+** or [sqlite3_prepare16_v2()] or [sqlite3_prepare16_v3()] instead
+** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces,
+** then the more specific [error codes] are returned directly
+** by sqlite3_step(). The use of the "vX" interfaces is recommended.
+*/
+SQLITE_API int sqlite3_step(sqlite3_stmt*);
+
+/*
+** CAPI3REF: Number of columns in a result set
+** METHOD: sqlite3_stmt
+**
+** ^The sqlite3_data_count(P) interface returns the number of columns in the
+** current row of the result set of [prepared statement] P.
+** ^If prepared statement P does not have results ready to return
+** (via calls to the [sqlite3_column_int | sqlite3_column()] family of
+** interfaces) then sqlite3_data_count(P) returns 0.
+** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer.
+** ^The sqlite3_data_count(P) routine returns 0 if the previous call to
+** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P)
+** will return non-zero if previous call to [sqlite3_step](P) returned
+** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum]
+** where it always returns zero since each step of that multi-step
+** pragma returns 0 columns of data.
+**
+** See also: [sqlite3_column_count()]
+*/
+SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt);
+
+/*
+** CAPI3REF: Fundamental Datatypes
+** KEYWORDS: SQLITE_TEXT
+**
+** ^(Every value in SQLite has one of five fundamental datatypes:
+**
+** <ul>
+** <li> 64-bit signed integer
+** <li> 64-bit IEEE floating point number
+** <li> string
+** <li> BLOB
+** <li> NULL
+** </ul>)^
+**
+** These constants are codes for each of those types.
+**
+** Note that the SQLITE_TEXT constant was also used in SQLite version 2
+** for a completely different meaning. Software that links against both
+** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not
+** SQLITE_TEXT.
+*/
+#define SQLITE_INTEGER 1
+#define SQLITE_FLOAT 2
+#define SQLITE_BLOB 4
+#define SQLITE_NULL 5
+#ifdef SQLITE_TEXT
+# undef SQLITE_TEXT
+#else
+# define SQLITE_TEXT 3
+#endif
+#define SQLITE3_TEXT 3
+
+/*
+** CAPI3REF: Result Values From A Query
+** KEYWORDS: {column access functions}
+** METHOD: sqlite3_stmt
+**
+** <b>Summary:</b>
+** <blockquote><table border=0 cellpadding=0 cellspacing=0>
+** <tr><td><b>sqlite3_column_blob</b><td>→<td>BLOB result
+** <tr><td><b>sqlite3_column_double</b><td>→<td>REAL result
+** <tr><td><b>sqlite3_column_int</b><td>→<td>32-bit INTEGER result
+** <tr><td><b>sqlite3_column_int64</b><td>→<td>64-bit INTEGER result
+** <tr><td><b>sqlite3_column_text</b><td>→<td>UTF-8 TEXT result
+** <tr><td><b>sqlite3_column_text16</b><td>→<td>UTF-16 TEXT result
+** <tr><td><b>sqlite3_column_value</b><td>→<td>The result as an
+** [sqlite3_value|unprotected sqlite3_value] object.
+** <tr><td> <td> <td>
+** <tr><td><b>sqlite3_column_bytes</b><td>→<td>Size of a BLOB
+** or a UTF-8 TEXT result in bytes
+** <tr><td><b>sqlite3_column_bytes16 </b>
+** <td>→ <td>Size of UTF-16
+** TEXT in bytes
+** <tr><td><b>sqlite3_column_type</b><td>→<td>Default
+** datatype of the result
+** </table></blockquote>
+**
+** <b>Details:</b>
+**
+** ^These routines return information about a single column of the current
+** result row of a query. ^In every case the first argument is a pointer
+** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*]
+** that was returned from [sqlite3_prepare_v2()] or one of its variants)
+** and the second argument is the index of the column for which information
+** should be returned. ^The leftmost column of the result set has the index 0.
+** ^The number of columns in the result can be determined using
+** [sqlite3_column_count()].
+**
+** If the SQL statement does not currently point to a valid row, or if the
+** column index is out of range, the result is undefined.
+** These routines may only be called when the most recent call to
+** [sqlite3_step()] has returned [SQLITE_ROW] and neither
+** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently.
+** If any of these routines are called after [sqlite3_reset()] or
+** [sqlite3_finalize()] or after [sqlite3_step()] has returned
+** something other than [SQLITE_ROW], the results are undefined.
+** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
+** are called from a different thread while any of these routines
+** are pending, then the results are undefined.
+**
+** The first six interfaces (_blob, _double, _int, _int64, _text, and _text16)
+** each return the value of a result column in a specific data format. If
+** the result column is not initially in the requested format (for example,
+** if the query returns an integer but the sqlite3_column_text() interface
+** is used to extract the value) then an automatic type conversion is performed.
+**
+** ^The sqlite3_column_type() routine returns the
+** [SQLITE_INTEGER | datatype code] for the initial data type
+** of the result column. ^The returned value is one of [SQLITE_INTEGER],
+** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL].
+** The return value of sqlite3_column_type() can be used to decide which
+** of the first six interface should be used to extract the column value.
+** The value returned by sqlite3_column_type() is only meaningful if no
+** automatic type conversions have occurred for the value in question.
+** After a type conversion, the result of calling sqlite3_column_type()
+** is undefined, though harmless. Future
+** versions of SQLite may change the behavior of sqlite3_column_type()
+** following a type conversion.
+**
+** If the result is a BLOB or a TEXT string, then the sqlite3_column_bytes()
+** or sqlite3_column_bytes16() interfaces can be used to determine the size
+** of that BLOB or string.
+**
+** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
+** routine returns the number of bytes in that BLOB or string.
+** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts
+** the string to UTF-8 and then returns the number of bytes.
+** ^If the result is a numeric value then sqlite3_column_bytes() uses
+** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
+** the number of bytes in that string.
+** ^If the result is NULL, then sqlite3_column_bytes() returns zero.
+**
+** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16()
+** routine returns the number of bytes in that BLOB or string.
+** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts
+** the string to UTF-16 and then returns the number of bytes.
+** ^If the result is a numeric value then sqlite3_column_bytes16() uses
+** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns
+** the number of bytes in that string.
+** ^If the result is NULL, then sqlite3_column_bytes16() returns zero.
+**
+** ^The values returned by [sqlite3_column_bytes()] and
+** [sqlite3_column_bytes16()] do not include the zero terminators at the end
+** of the string. ^For clarity: the values returned by
+** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of
+** bytes in the string, not the number of characters.
+**
+** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
+** even empty strings, are always zero-terminated. ^The return
+** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer.
+**
+** <b>Warning:</b> ^The object returned by [sqlite3_column_value()] is an
+** [unprotected sqlite3_value] object. In a multithreaded environment,
+** an unprotected sqlite3_value object may only be used safely with
+** [sqlite3_bind_value()] and [sqlite3_result_value()].
+** If the [unprotected sqlite3_value] object returned by
+** [sqlite3_column_value()] is used in any other way, including calls
+** to routines like [sqlite3_value_int()], [sqlite3_value_text()],
+** or [sqlite3_value_bytes()], the behavior is not threadsafe.
+** Hence, the sqlite3_column_value() interface
+** is normally only useful within the implementation of
+** [application-defined SQL functions] or [virtual tables], not within
+** top-level application code.
+**
+** The these routines may attempt to convert the datatype of the result.
+** ^For example, if the internal representation is FLOAT and a text result
+** is requested, [sqlite3_snprintf()] is used internally to perform the
+** conversion automatically. ^(The following table details the conversions
+** that are applied:
+**
+** <blockquote>
+** <table border="1">
+** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion
+**
+** <tr><td> NULL <td> INTEGER <td> Result is 0
+** <tr><td> NULL <td> FLOAT <td> Result is 0.0
+** <tr><td> NULL <td> TEXT <td> Result is a NULL pointer
+** <tr><td> NULL <td> BLOB <td> Result is a NULL pointer
+** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float
+** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer
+** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT
+** <tr><td> FLOAT <td> INTEGER <td> [CAST] to INTEGER
+** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float
+** <tr><td> FLOAT <td> BLOB <td> [CAST] to BLOB
+** <tr><td> TEXT <td> INTEGER <td> [CAST] to INTEGER
+** <tr><td> TEXT <td> FLOAT <td> [CAST] to REAL
+** <tr><td> TEXT <td> BLOB <td> No change
+** <tr><td> BLOB <td> INTEGER <td> [CAST] to INTEGER
+** <tr><td> BLOB <td> FLOAT <td> [CAST] to REAL
+** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed
+** </table>
+** </blockquote>)^
+**
+** Note that when type conversions occur, pointers returned by prior
+** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
+** sqlite3_column_text16() may be invalidated.
+** Type conversions and pointer invalidations might occur
+** in the following cases:
+**
+** <ul>
+** <li> The initial content is a BLOB and sqlite3_column_text() or
+** sqlite3_column_text16() is called. A zero-terminator might
+** need to be added to the string.</li>
+** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or
+** sqlite3_column_text16() is called. The content must be converted
+** to UTF-16.</li>
+** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or
+** sqlite3_column_text() is called. The content must be converted
+** to UTF-8.</li>
+** </ul>
+**
+** ^Conversions between UTF-16be and UTF-16le are always done in place and do
+** not invalidate a prior pointer, though of course the content of the buffer
+** that the prior pointer references will have been modified. Other kinds
+** of conversion are done in place when it is possible, but sometimes they
+** are not possible and in those cases prior pointers are invalidated.
+**
+** The safest policy is to invoke these routines
+** in one of the following ways:
+**
+** <ul>
+** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
+** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
+** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
+** </ul>
+**
+** In other words, you should call sqlite3_column_text(),
+** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result
+** into the desired format, then invoke sqlite3_column_bytes() or
+** sqlite3_column_bytes16() to find the size of the result. Do not mix calls
+** to sqlite3_column_text() or sqlite3_column_blob() with calls to
+** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16()
+** with calls to sqlite3_column_bytes().
+**
+** ^The pointers returned are valid until a type conversion occurs as
+** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
+** [sqlite3_finalize()] is called. ^The memory space used to hold strings
+** and BLOBs is freed automatically. Do not pass the pointers returned
+** from [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
+** [sqlite3_free()].
+**
+** As long as the input parameters are correct, these routines will only
+** fail if an out-of-memory error occurs during a format conversion.
+** Only the following subset of interfaces are subject to out-of-memory
+** errors:
+**
+** <ul>
+** <li> sqlite3_column_blob()
+** <li> sqlite3_column_text()
+** <li> sqlite3_column_text16()
+** <li> sqlite3_column_bytes()
+** <li> sqlite3_column_bytes16()
+** </ul>
+**
+** If an out-of-memory error occurs, then the return value from these
+** routines is the same as if the column had contained an SQL NULL value.
+** Valid SQL NULL returns can be distinguished from out-of-memory errors
+** by invoking the [sqlite3_errcode()] immediately after the suspect
+** return value is obtained and before any
+** other SQLite interface is called on the same [database connection].
+*/
+SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
+SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol);
+SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol);
+SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
+SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
+SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
+SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
+SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
+SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
+SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol);
+
+/*
+** CAPI3REF: Destroy A Prepared Statement Object
+** DESTRUCTOR: sqlite3_stmt
+**
+** ^The sqlite3_finalize() function is called to delete a [prepared statement].
+** ^If the most recent evaluation of the statement encountered no errors
+** or if the statement is never been evaluated, then sqlite3_finalize() returns
+** SQLITE_OK. ^If the most recent evaluation of statement S failed, then
+** sqlite3_finalize(S) returns the appropriate [error code] or
+** [extended error code].
+**
+** ^The sqlite3_finalize(S) routine can be called at any point during
+** the life cycle of [prepared statement] S:
+** before statement S is ever evaluated, after
+** one or more calls to [sqlite3_reset()], or after any call
+** to [sqlite3_step()] regardless of whether or not the statement has
+** completed execution.
+**
+** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op.
+**
+** The application must finalize every [prepared statement] in order to avoid
+** resource leaks. It is a grievous error for the application to try to use
+** a prepared statement after it has been finalized. Any use of a prepared
+** statement after it has been finalized can result in undefined and
+** undesirable behavior such as segfaults and heap corruption.
+*/
+SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt);
+
+/*
+** CAPI3REF: Reset A Prepared Statement Object
+** METHOD: sqlite3_stmt
+**
+** The sqlite3_reset() function is called to reset a [prepared statement]
+** object back to its initial state, ready to be re-executed.
+** ^Any SQL statement variables that had values bound to them using
+** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values.
+** Use [sqlite3_clear_bindings()] to reset the bindings.
+**
+** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S
+** back to the beginning of its program.
+**
+** ^If the most recent call to [sqlite3_step(S)] for the
+** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE],
+** or if [sqlite3_step(S)] has never before been called on S,
+** then [sqlite3_reset(S)] returns [SQLITE_OK].
+**
+** ^If the most recent call to [sqlite3_step(S)] for the
+** [prepared statement] S indicated an error, then
+** [sqlite3_reset(S)] returns an appropriate [error code].
+**
+** ^The [sqlite3_reset(S)] interface does not change the values
+** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S.
+*/
+SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
+
+/*
+** CAPI3REF: Create Or Redefine SQL Functions
+** KEYWORDS: {function creation routines}
+** METHOD: sqlite3
+**
+** ^These functions (collectively known as "function creation routines")
+** are used to add SQL functions or aggregates or to redefine the behavior
+** of existing SQL functions or aggregates. The only differences between
+** the three "sqlite3_create_function*" routines are the text encoding
+** expected for the second parameter (the name of the function being
+** created) and the presence or absence of a destructor callback for
+** the application data pointer. Function sqlite3_create_window_function()
+** is similar, but allows the user to supply the extra callback functions
+** needed by [aggregate window functions].
+**
+** ^The first parameter is the [database connection] to which the SQL
+** function is to be added. ^If an application uses more than one database
+** connection then application-defined SQL functions must be added
+** to each database connection separately.
+**
+** ^The second parameter is the name of the SQL function to be created or
+** redefined. ^The length of the name is limited to 255 bytes in a UTF-8
+** representation, exclusive of the zero-terminator. ^Note that the name
+** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes.
+** ^Any attempt to create a function with a longer name
+** will result in [SQLITE_MISUSE] being returned.
+**
+** ^The third parameter (nArg)
+** is the number of arguments that the SQL function or
+** aggregate takes. ^If this parameter is -1, then the SQL function or
+** aggregate may take any number of arguments between 0 and the limit
+** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third
+** parameter is less than -1 or greater than 127 then the behavior is
+** undefined.
+**
+** ^The fourth parameter, eTextRep, specifies what
+** [SQLITE_UTF8 | text encoding] this SQL function prefers for
+** its parameters. The application should set this parameter to
+** [SQLITE_UTF16LE] if the function implementation invokes
+** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the
+** implementation invokes [sqlite3_value_text16be()] on an input, or
+** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8]
+** otherwise. ^The same SQL function may be registered multiple times using
+** different preferred text encodings, with different implementations for
+** each encoding.
+** ^When multiple implementations of the same function are available, SQLite
+** will pick the one that involves the least amount of data conversion.
+**
+** ^The fourth parameter may optionally be ORed with [SQLITE_DETERMINISTIC]
+** to signal that the function will always return the same result given
+** the same inputs within a single SQL statement. Most SQL functions are
+** deterministic. The built-in [random()] SQL function is an example of a
+** function that is not deterministic. The SQLite query planner is able to
+** perform additional optimizations on deterministic functions, so use
+** of the [SQLITE_DETERMINISTIC] flag is recommended where possible.
+**
+** ^The fourth parameter may also optionally include the [SQLITE_DIRECTONLY]
+** flag, which if present prevents the function from being invoked from
+** within VIEWs, TRIGGERs, CHECK constraints, generated column expressions,
+** index expressions, or the WHERE clause of partial indexes.
+**
+** <span style="background-color:#ffff90;">
+** For best security, the [SQLITE_DIRECTONLY] flag is recommended for
+** all application-defined SQL functions that do not need to be
+** used inside of triggers, view, CHECK constraints, or other elements of
+** the database schema. This flags is especially recommended for SQL
+** functions that have side effects or reveal internal application state.
+** Without this flag, an attacker might be able to modify the schema of
+** a database file to include invocations of the function with parameters
+** chosen by the attacker, which the application will then execute when
+** the database file is opened and read.
+** </span>
+**
+** ^(The fifth parameter is an arbitrary pointer. The implementation of the
+** function can gain access to this pointer using [sqlite3_user_data()].)^
+**
+** ^The sixth, seventh and eighth parameters passed to the three
+** "sqlite3_create_function*" functions, xFunc, xStep and xFinal, are
+** pointers to C-language functions that implement the SQL function or
+** aggregate. ^A scalar SQL function requires an implementation of the xFunc
+** callback only; NULL pointers must be passed as the xStep and xFinal
+** parameters. ^An aggregate SQL function requires an implementation of xStep
+** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing
+** SQL function or aggregate, pass NULL pointers for all three function
+** callbacks.
+**
+** ^The sixth, seventh, eighth and ninth parameters (xStep, xFinal, xValue
+** and xInverse) passed to sqlite3_create_window_function are pointers to
+** C-language callbacks that implement the new function. xStep and xFinal
+** must both be non-NULL. xValue and xInverse may either both be NULL, in
+** which case a regular aggregate function is created, or must both be
+** non-NULL, in which case the new function may be used as either an aggregate
+** or aggregate window function. More details regarding the implementation
+** of aggregate window functions are
+** [user-defined window functions|available here].
+**
+** ^(If the final parameter to sqlite3_create_function_v2() or
+** sqlite3_create_window_function() is not NULL, then it is destructor for
+** the application data pointer. The destructor is invoked when the function
+** is deleted, either by being overloaded or when the database connection
+** closes.)^ ^The destructor is also invoked if the call to
+** sqlite3_create_function_v2() fails. ^When the destructor callback is
+** invoked, it is passed a single argument which is a copy of the application
+** data pointer which was the fifth parameter to sqlite3_create_function_v2().
+**
+** ^It is permitted to register multiple implementations of the same
+** functions with the same name but with either differing numbers of
+** arguments or differing preferred text encodings. ^SQLite will use
+** the implementation that most closely matches the way in which the
+** SQL function is used. ^A function implementation with a non-negative
+** nArg parameter is a better match than a function implementation with
+** a negative nArg. ^A function where the preferred text encoding
+** matches the database encoding is a better
+** match than a function where the encoding is different.
+** ^A function where the encoding difference is between UTF16le and UTF16be
+** is a closer match than a function where the encoding difference is
+** between UTF8 and UTF16.
+**
+** ^Built-in functions may be overloaded by new application-defined functions.
+**
+** ^An application-defined function is permitted to call other
+** SQLite interfaces. However, such calls must not
+** close the database connection nor finalize or reset the prepared
+** statement in which the function is running.
+*/
+SQLITE_API int sqlite3_create_function(
+ sqlite3 *db,
+ const char *zFunctionName,
+ int nArg,
+ int eTextRep,
+ void *pApp,
+ void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
+ void (*xStep)(sqlite3_context*,int,sqlite3_value**),
+ void (*xFinal)(sqlite3_context*)
+);
+SQLITE_API int sqlite3_create_function16(
+ sqlite3 *db,
+ const void *zFunctionName,
+ int nArg,
+ int eTextRep,
+ void *pApp,
+ void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
+ void (*xStep)(sqlite3_context*,int,sqlite3_value**),
+ void (*xFinal)(sqlite3_context*)
+);
+SQLITE_API int sqlite3_create_function_v2(
+ sqlite3 *db,
+ const char *zFunctionName,
+ int nArg,
+ int eTextRep,
+ void *pApp,
+ void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
+ void (*xStep)(sqlite3_context*,int,sqlite3_value**),
+ void (*xFinal)(sqlite3_context*),
+ void(*xDestroy)(void*)
+);
+SQLITE_API int sqlite3_create_window_function(
+ sqlite3 *db,
+ const char *zFunctionName,
+ int nArg,
+ int eTextRep,
+ void *pApp,
+ void (*xStep)(sqlite3_context*,int,sqlite3_value**),
+ void (*xFinal)(sqlite3_context*),
+ void (*xValue)(sqlite3_context*),
+ void (*xInverse)(sqlite3_context*,int,sqlite3_value**),
+ void(*xDestroy)(void*)
+);
+
+/*
+** CAPI3REF: Text Encodings
+**
+** These constant define integer codes that represent the various
+** text encodings supported by SQLite.
+*/
+#define SQLITE_UTF8 1 /* IMP: R-37514-35566 */
+#define SQLITE_UTF16LE 2 /* IMP: R-03371-37637 */
+#define SQLITE_UTF16BE 3 /* IMP: R-51971-34154 */
+#define SQLITE_UTF16 4 /* Use native byte order */
+#define SQLITE_ANY 5 /* Deprecated */
+#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
+
+/*
+** CAPI3REF: Function Flags
+**
+** These constants may be ORed together with the
+** [SQLITE_UTF8 | preferred text encoding] as the fourth argument
+** to [sqlite3_create_function()], [sqlite3_create_function16()], or
+** [sqlite3_create_function_v2()].
+**
+** <dl>
+** [[SQLITE_DETERMINISTIC]] <dt>SQLITE_DETERMINISTIC</dt><dd>
+** The SQLITE_DETERMINISTIC flag means that the new function always gives
+** the same output when the input parameters are the same.
+** The [abs|abs() function] is deterministic, for example, but
+** [randomblob|randomblob()] is not. Functions must
+** be deterministic in order to be used in certain contexts such as
+** with the WHERE clause of [partial indexes] or in [generated columns].
+** SQLite might also optimize deterministic functions by factoring them
+** out of inner loops.
+** </dd>
+**
+** [[SQLITE_DIRECTONLY]] <dt>SQLITE_DIRECTONLY</dt><dd>
+** The SQLITE_DIRECTONLY flag means that the function may only be invoked
+** from top-level SQL, and cannot be used in VIEWs or TRIGGERs nor in
+** schema structures such as [CHECK constraints], [DEFAULT clauses],
+** [expression indexes], [partial indexes], or [generated columns].
+** The SQLITE_DIRECTONLY flags is a security feature which is recommended
+** for all [application-defined SQL functions], and especially for functions
+** that have side-effects or that could potentially leak sensitive
+** information.
+** </dd>
+**
+** [[SQLITE_INNOCUOUS]] <dt>SQLITE_INNOCUOUS</dt><dd>
+** The SQLITE_INNOCUOUS flag means that the function is unlikely
+** to cause problems even if misused. An innocuous function should have
+** no side effects and should not depend on any values other than its
+** input parameters. The [abs|abs() function] is an example of an
+** innocuous function.
+** The [load_extension() SQL function] is not innocuous because of its
+** side effects.
+** <p> SQLITE_INNOCUOUS is similar to SQLITE_DETERMINISTIC, but is not
+** exactly the same. The [random|random() function] is an example of a
+** function that is innocuous but not deterministic.
+** <p>Some heightened security settings
+** ([SQLITE_DBCONFIG_TRUSTED_SCHEMA] and [PRAGMA trusted_schema=OFF])
+** disable the use of SQL functions inside views and triggers and in
+** schema structures such as [CHECK constraints], [DEFAULT clauses],
+** [expression indexes], [partial indexes], and [generated columns] unless
+** the function is tagged with SQLITE_INNOCUOUS. Most built-in functions
+** are innocuous. Developers are advised to avoid using the
+** SQLITE_INNOCUOUS flag for application-defined functions unless the
+** function has been carefully audited and found to be free of potentially
+** security-adverse side-effects and information-leaks.
+** </dd>
+**
+** [[SQLITE_SUBTYPE]] <dt>SQLITE_SUBTYPE</dt><dd>
+** The SQLITE_SUBTYPE flag indicates to SQLite that a function may call
+** [sqlite3_value_subtype()] to inspect the sub-types of its arguments.
+** Specifying this flag makes no difference for scalar or aggregate user
+** functions. However, if it is not specified for a user-defined window
+** function, then any sub-types belonging to arguments passed to the window
+** function may be discarded before the window function is called (i.e.
+** sqlite3_value_subtype() will always return 0).
+** </dd>
+** </dl>
+*/
+#define SQLITE_DETERMINISTIC 0x000000800
+#define SQLITE_DIRECTONLY 0x000080000
+#define SQLITE_SUBTYPE 0x000100000
+#define SQLITE_INNOCUOUS 0x000200000
+
+/*
+** CAPI3REF: Deprecated Functions
+** DEPRECATED
+**
+** These functions are [deprecated]. In order to maintain
+** backwards compatibility with older code, these functions continue
+** to be supported. However, new applications should avoid
+** the use of these functions. To encourage programmers to avoid
+** these functions, we will not explain what they do.
+*/
+#ifndef SQLITE_OMIT_DEPRECATED
+SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*);
+SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*);
+SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
+SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void);
+SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void);
+SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),
+ void*,sqlite3_int64);
+#endif
+
+/*
+** CAPI3REF: Obtaining SQL Values
+** METHOD: sqlite3_value
+**
+** <b>Summary:</b>
+** <blockquote><table border=0 cellpadding=0 cellspacing=0>
+** <tr><td><b>sqlite3_value_blob</b><td>→<td>BLOB value
+** <tr><td><b>sqlite3_value_double</b><td>→<td>REAL value
+** <tr><td><b>sqlite3_value_int</b><td>→<td>32-bit INTEGER value
+** <tr><td><b>sqlite3_value_int64</b><td>→<td>64-bit INTEGER value
+** <tr><td><b>sqlite3_value_pointer</b><td>→<td>Pointer value
+** <tr><td><b>sqlite3_value_text</b><td>→<td>UTF-8 TEXT value
+** <tr><td><b>sqlite3_value_text16</b><td>→<td>UTF-16 TEXT value in
+** the native byteorder
+** <tr><td><b>sqlite3_value_text16be</b><td>→<td>UTF-16be TEXT value
+** <tr><td><b>sqlite3_value_text16le</b><td>→<td>UTF-16le TEXT value
+** <tr><td> <td> <td>
+** <tr><td><b>sqlite3_value_bytes</b><td>→<td>Size of a BLOB
+** or a UTF-8 TEXT in bytes
+** <tr><td><b>sqlite3_value_bytes16 </b>
+** <td>→ <td>Size of UTF-16
+** TEXT in bytes
+** <tr><td><b>sqlite3_value_type</b><td>→<td>Default
+** datatype of the value
+** <tr><td><b>sqlite3_value_numeric_type </b>
+** <td>→ <td>Best numeric datatype of the value
+** <tr><td><b>sqlite3_value_nochange </b>
+** <td>→ <td>True if the column is unchanged in an UPDATE
+** against a virtual table.
+** <tr><td><b>sqlite3_value_frombind </b>
+** <td>→ <td>True if value originated from a [bound parameter]
+** </table></blockquote>
+**
+** <b>Details:</b>
+**
+** These routines extract type, size, and content information from
+** [protected sqlite3_value] objects. Protected sqlite3_value objects
+** are used to pass parameter information into the functions that
+** implement [application-defined SQL functions] and [virtual tables].
+**
+** These routines work only with [protected sqlite3_value] objects.
+** Any attempt to use these routines on an [unprotected sqlite3_value]
+** is not threadsafe.
+**
+** ^These routines work just like the corresponding [column access functions]
+** except that these routines take a single [protected sqlite3_value] object
+** pointer instead of a [sqlite3_stmt*] pointer and an integer column number.
+**
+** ^The sqlite3_value_text16() interface extracts a UTF-16 string
+** in the native byte-order of the host machine. ^The
+** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
+** extract UTF-16 strings as big-endian and little-endian respectively.
+**
+** ^If [sqlite3_value] object V was initialized
+** using [sqlite3_bind_pointer(S,I,P,X,D)] or [sqlite3_result_pointer(C,P,X,D)]
+** and if X and Y are strings that compare equal according to strcmp(X,Y),
+** then sqlite3_value_pointer(V,Y) will return the pointer P. ^Otherwise,
+** sqlite3_value_pointer(V,Y) returns a NULL. The sqlite3_bind_pointer()
+** routine is part of the [pointer passing interface] added for SQLite 3.20.0.
+**
+** ^(The sqlite3_value_type(V) interface returns the
+** [SQLITE_INTEGER | datatype code] for the initial datatype of the
+** [sqlite3_value] object V. The returned value is one of [SQLITE_INTEGER],
+** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL].)^
+** Other interfaces might change the datatype for an sqlite3_value object.
+** For example, if the datatype is initially SQLITE_INTEGER and
+** sqlite3_value_text(V) is called to extract a text value for that
+** integer, then subsequent calls to sqlite3_value_type(V) might return
+** SQLITE_TEXT. Whether or not a persistent internal datatype conversion
+** occurs is undefined and may change from one release of SQLite to the next.
+**
+** ^(The sqlite3_value_numeric_type() interface attempts to apply
+** numeric affinity to the value. This means that an attempt is
+** made to convert the value to an integer or floating point. If
+** such a conversion is possible without loss of information (in other
+** words, if the value is a string that looks like a number)
+** then the conversion is performed. Otherwise no conversion occurs.
+** The [SQLITE_INTEGER | datatype] after conversion is returned.)^
+**
+** ^Within the [xUpdate] method of a [virtual table], the
+** sqlite3_value_nochange(X) interface returns true if and only if
+** the column corresponding to X is unchanged by the UPDATE operation
+** that the xUpdate method call was invoked to implement and if
+** and the prior [xColumn] method call that was invoked to extracted
+** the value for that column returned without setting a result (probably
+** because it queried [sqlite3_vtab_nochange()] and found that the column
+** was unchanging). ^Within an [xUpdate] method, any value for which
+** sqlite3_value_nochange(X) is true will in all other respects appear
+** to be a NULL value. If sqlite3_value_nochange(X) is invoked anywhere other
+** than within an [xUpdate] method call for an UPDATE statement, then
+** the return value is arbitrary and meaningless.
+**
+** ^The sqlite3_value_frombind(X) interface returns non-zero if the
+** value X originated from one of the [sqlite3_bind_int|sqlite3_bind()]
+** interfaces. ^If X comes from an SQL literal value, or a table column,
+** or an expression, then sqlite3_value_frombind(X) returns zero.
+**
+** Please pay particular attention to the fact that the pointer returned
+** from [sqlite3_value_blob()], [sqlite3_value_text()], or
+** [sqlite3_value_text16()] can be invalidated by a subsequent call to
+** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
+** or [sqlite3_value_text16()].
+**
+** These routines must be called from the same thread as
+** the SQL function that supplied the [sqlite3_value*] parameters.
+**
+** As long as the input parameter is correct, these routines can only
+** fail if an out-of-memory error occurs during a format conversion.
+** Only the following subset of interfaces are subject to out-of-memory
+** errors:
+**
+** <ul>
+** <li> sqlite3_value_blob()
+** <li> sqlite3_value_text()
+** <li> sqlite3_value_text16()
+** <li> sqlite3_value_text16le()
+** <li> sqlite3_value_text16be()
+** <li> sqlite3_value_bytes()
+** <li> sqlite3_value_bytes16()
+** </ul>
+**
+** If an out-of-memory error occurs, then the return value from these
+** routines is the same as if the column had contained an SQL NULL value.
+** Valid SQL NULL returns can be distinguished from out-of-memory errors
+** by invoking the [sqlite3_errcode()] immediately after the suspect
+** return value is obtained and before any
+** other SQLite interface is called on the same [database connection].
+*/
+SQLITE_API const void *sqlite3_value_blob(sqlite3_value*);
+SQLITE_API double sqlite3_value_double(sqlite3_value*);
+SQLITE_API int sqlite3_value_int(sqlite3_value*);
+SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
+SQLITE_API void *sqlite3_value_pointer(sqlite3_value*, const char*);
+SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*);
+SQLITE_API const void *sqlite3_value_text16(sqlite3_value*);
+SQLITE_API const void *sqlite3_value_text16le(sqlite3_value*);
+SQLITE_API const void *sqlite3_value_text16be(sqlite3_value*);
+SQLITE_API int sqlite3_value_bytes(sqlite3_value*);
+SQLITE_API int sqlite3_value_bytes16(sqlite3_value*);
+SQLITE_API int sqlite3_value_type(sqlite3_value*);
+SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*);
+SQLITE_API int sqlite3_value_nochange(sqlite3_value*);
+SQLITE_API int sqlite3_value_frombind(sqlite3_value*);
+
+/*
+** CAPI3REF: Finding The Subtype Of SQL Values
+** METHOD: sqlite3_value
+**
+** The sqlite3_value_subtype(V) function returns the subtype for
+** an [application-defined SQL function] argument V. The subtype
+** information can be used to pass a limited amount of context from
+** one SQL function to another. Use the [sqlite3_result_subtype()]
+** routine to set the subtype for the return value of an SQL function.
+*/
+SQLITE_API unsigned int sqlite3_value_subtype(sqlite3_value*);
+
+/*
+** CAPI3REF: Copy And Free SQL Values
+** METHOD: sqlite3_value
+**
+** ^The sqlite3_value_dup(V) interface makes a copy of the [sqlite3_value]
+** object D and returns a pointer to that copy. ^The [sqlite3_value] returned
+** is a [protected sqlite3_value] object even if the input is not.
+** ^The sqlite3_value_dup(V) interface returns NULL if V is NULL or if a
+** memory allocation fails.
+**
+** ^The sqlite3_value_free(V) interface frees an [sqlite3_value] object
+** previously obtained from [sqlite3_value_dup()]. ^If V is a NULL pointer
+** then sqlite3_value_free(V) is a harmless no-op.
+*/
+SQLITE_API sqlite3_value *sqlite3_value_dup(const sqlite3_value*);
+SQLITE_API void sqlite3_value_free(sqlite3_value*);
+
+/*
+** CAPI3REF: Obtain Aggregate Function Context
+** METHOD: sqlite3_context
+**
+** Implementations of aggregate SQL functions use this
+** routine to allocate memory for storing their state.
+**
+** ^The first time the sqlite3_aggregate_context(C,N) routine is called
+** for a particular aggregate function, SQLite allocates
+** N bytes of memory, zeroes out that memory, and returns a pointer
+** to the new memory. ^On second and subsequent calls to
+** sqlite3_aggregate_context() for the same aggregate function instance,
+** the same buffer is returned. Sqlite3_aggregate_context() is normally
+** called once for each invocation of the xStep callback and then one
+** last time when the xFinal callback is invoked. ^(When no rows match
+** an aggregate query, the xStep() callback of the aggregate function
+** implementation is never called and xFinal() is called exactly once.
+** In those cases, sqlite3_aggregate_context() might be called for the
+** first time from within xFinal().)^
+**
+** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer
+** when first called if N is less than or equal to zero or if a memory
+** allocate error occurs.
+**
+** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is
+** determined by the N parameter on first successful call. Changing the
+** value of N in any subsequent call to sqlite3_aggregate_context() within
+** the same aggregate function instance will not resize the memory
+** allocation.)^ Within the xFinal callback, it is customary to set
+** N=0 in calls to sqlite3_aggregate_context(C,N) so that no
+** pointless memory allocations occur.
+**
+** ^SQLite automatically frees the memory allocated by
+** sqlite3_aggregate_context() when the aggregate query concludes.
+**
+** The first parameter must be a copy of the
+** [sqlite3_context | SQL function context] that is the first parameter
+** to the xStep or xFinal callback routine that implements the aggregate
+** function.
+**
+** This routine must be called from the same thread in which
+** the aggregate SQL function is running.
+*/
+SQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
+
+/*
+** CAPI3REF: User Data For Functions
+** METHOD: sqlite3_context
+**
+** ^The sqlite3_user_data() interface returns a copy of
+** the pointer that was the pUserData parameter (the 5th parameter)
+** of the [sqlite3_create_function()]
+** and [sqlite3_create_function16()] routines that originally
+** registered the application defined function.
+**
+** This routine must be called from the same thread in which
+** the application-defined function is running.
+*/
+SQLITE_API void *sqlite3_user_data(sqlite3_context*);
+
+/*
+** CAPI3REF: Database Connection For Functions
+** METHOD: sqlite3_context
+**
+** ^The sqlite3_context_db_handle() interface returns a copy of
+** the pointer to the [database connection] (the 1st parameter)
+** of the [sqlite3_create_function()]
+** and [sqlite3_create_function16()] routines that originally
+** registered the application defined function.
+*/
+SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*);
+
+/*
+** CAPI3REF: Function Auxiliary Data
+** METHOD: sqlite3_context
+**
+** These functions may be used by (non-aggregate) SQL functions to
+** associate metadata with argument values. If the same value is passed to
+** multiple invocations of the same SQL function during query execution, under
+** some circumstances the associated metadata may be preserved. An example
+** of where this might be useful is in a regular-expression matching
+** function. The compiled version of the regular expression can be stored as
+** metadata associated with the pattern string.
+** Then as long as the pattern string remains the same,
+** the compiled regular expression can be reused on multiple
+** invocations of the same function.
+**
+** ^The sqlite3_get_auxdata(C,N) interface returns a pointer to the metadata
+** associated by the sqlite3_set_auxdata(C,N,P,X) function with the Nth argument
+** value to the application-defined function. ^N is zero for the left-most
+** function argument. ^If there is no metadata
+** associated with the function argument, the sqlite3_get_auxdata(C,N) interface
+** returns a NULL pointer.
+**
+** ^The sqlite3_set_auxdata(C,N,P,X) interface saves P as metadata for the N-th
+** argument of the application-defined function. ^Subsequent
+** calls to sqlite3_get_auxdata(C,N) return P from the most recent
+** sqlite3_set_auxdata(C,N,P,X) call if the metadata is still valid or
+** NULL if the metadata has been discarded.
+** ^After each call to sqlite3_set_auxdata(C,N,P,X) where X is not NULL,
+** SQLite will invoke the destructor function X with parameter P exactly
+** once, when the metadata is discarded.
+** SQLite is free to discard the metadata at any time, including: <ul>
+** <li> ^(when the corresponding function parameter changes)^, or
+** <li> ^(when [sqlite3_reset()] or [sqlite3_finalize()] is called for the
+** SQL statement)^, or
+** <li> ^(when sqlite3_set_auxdata() is invoked again on the same
+** parameter)^, or
+** <li> ^(during the original sqlite3_set_auxdata() call when a memory
+** allocation error occurs.)^ </ul>
+**
+** Note the last bullet in particular. The destructor X in
+** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the
+** sqlite3_set_auxdata() interface even returns. Hence sqlite3_set_auxdata()
+** should be called near the end of the function implementation and the
+** function implementation should not make any use of P after
+** sqlite3_set_auxdata() has been called.
+**
+** ^(In practice, metadata is preserved between function calls for
+** function parameters that are compile-time constants, including literal
+** values and [parameters] and expressions composed from the same.)^
+**
+** The value of the N parameter to these interfaces should be non-negative.
+** Future enhancements may make use of negative N values to define new
+** kinds of function caching behavior.
+**
+** These routines must be called from the same thread in which
+** the SQL function is running.
+*/
+SQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N);
+SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));
+
+
+/*
+** CAPI3REF: Constants Defining Special Destructor Behavior
+**
+** These are special values for the destructor that is passed in as the
+** final argument to routines like [sqlite3_result_blob()]. ^If the destructor
+** argument is SQLITE_STATIC, it means that the content pointer is constant
+** and will never change. It does not need to be destroyed. ^The
+** SQLITE_TRANSIENT value means that the content will likely change in
+** the near future and that SQLite should make its own private copy of
+** the content before returning.
+**
+** The typedef is necessary to work around problems in certain
+** C++ compilers.
+*/
+typedef void (*sqlite3_destructor_type)(void*);
+#define SQLITE_STATIC ((sqlite3_destructor_type)0)
+#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)
+
+/*
+** CAPI3REF: Setting The Result Of An SQL Function
+** METHOD: sqlite3_context
+**
+** These routines are used by the xFunc or xFinal callbacks that
+** implement SQL functions and aggregates. See
+** [sqlite3_create_function()] and [sqlite3_create_function16()]
+** for additional information.
+**
+** These functions work very much like the [parameter binding] family of
+** functions used to bind values to host parameters in prepared statements.
+** Refer to the [SQL parameter] documentation for additional information.
+**
+** ^The sqlite3_result_blob() interface sets the result from
+** an application-defined function to be the BLOB whose content is pointed
+** to by the second parameter and which is N bytes long where N is the
+** third parameter.
+**
+** ^The sqlite3_result_zeroblob(C,N) and sqlite3_result_zeroblob64(C,N)
+** interfaces set the result of the application-defined function to be
+** a BLOB containing all zero bytes and N bytes in size.
+**
+** ^The sqlite3_result_double() interface sets the result from
+** an application-defined function to be a floating point value specified
+** by its 2nd argument.
+**
+** ^The sqlite3_result_error() and sqlite3_result_error16() functions
+** cause the implemented SQL function to throw an exception.
+** ^SQLite uses the string pointed to by the
+** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
+** as the text of an error message. ^SQLite interprets the error
+** message string from sqlite3_result_error() as UTF-8. ^SQLite
+** interprets the string from sqlite3_result_error16() as UTF-16 using
+** the same [byte-order determination rules] as [sqlite3_bind_text16()].
+** ^If the third parameter to sqlite3_result_error()
+** or sqlite3_result_error16() is negative then SQLite takes as the error
+** message all text up through the first zero character.
+** ^If the third parameter to sqlite3_result_error() or
+** sqlite3_result_error16() is non-negative then SQLite takes that many
+** bytes (not characters) from the 2nd parameter as the error message.
+** ^The sqlite3_result_error() and sqlite3_result_error16()
+** routines make a private copy of the error message text before
+** they return. Hence, the calling function can deallocate or
+** modify the text after they return without harm.
+** ^The sqlite3_result_error_code() function changes the error code
+** returned by SQLite as a result of an error in a function. ^By default,
+** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error()
+** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
+**
+** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an
+** error indicating that a string or BLOB is too long to represent.
+**
+** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an
+** error indicating that a memory allocation failed.
+**
+** ^The sqlite3_result_int() interface sets the return value
+** of the application-defined function to be the 32-bit signed integer
+** value given in the 2nd argument.
+** ^The sqlite3_result_int64() interface sets the return value
+** of the application-defined function to be the 64-bit signed integer
+** value given in the 2nd argument.
+**
+** ^The sqlite3_result_null() interface sets the return value
+** of the application-defined function to be NULL.
+**
+** ^The sqlite3_result_text(), sqlite3_result_text16(),
+** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
+** set the return value of the application-defined function to be
+** a text string which is represented as UTF-8, UTF-16 native byte order,
+** UTF-16 little endian, or UTF-16 big endian, respectively.
+** ^The sqlite3_result_text64() interface sets the return value of an
+** application-defined function to be a text string in an encoding
+** specified by the fifth (and last) parameter, which must be one
+** of [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE].
+** ^SQLite takes the text result from the application from
+** the 2nd parameter of the sqlite3_result_text* interfaces.
+** ^If the 3rd parameter to the sqlite3_result_text* interfaces
+** is negative, then SQLite takes result text from the 2nd parameter
+** through the first zero character.
+** ^If the 3rd parameter to the sqlite3_result_text* interfaces
+** is non-negative, then as many bytes (not characters) of the text
+** pointed to by the 2nd parameter are taken as the application-defined
+** function result. If the 3rd parameter is non-negative, then it
+** must be the byte offset into the string where the NUL terminator would
+** appear if the string where NUL terminated. If any NUL characters occur
+** in the string at a byte offset that is less than the value of the 3rd
+** parameter, then the resulting string will contain embedded NULs and the
+** result of expressions operating on strings with embedded NULs is undefined.
+** ^If the 4th parameter to the sqlite3_result_text* interfaces
+** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
+** function as the destructor on the text or BLOB result when it has
+** finished using that result.
+** ^If the 4th parameter to the sqlite3_result_text* interfaces or to
+** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite
+** assumes that the text or BLOB result is in constant space and does not
+** copy the content of the parameter nor call a destructor on the content
+** when it has finished using that result.
+** ^If the 4th parameter to the sqlite3_result_text* interfaces
+** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
+** then SQLite makes a copy of the result into space obtained
+** from [sqlite3_malloc()] before it returns.
+**
+** ^For the sqlite3_result_text16(), sqlite3_result_text16le(), and
+** sqlite3_result_text16be() routines, and for sqlite3_result_text64()
+** when the encoding is not UTF8, if the input UTF16 begins with a
+** byte-order mark (BOM, U+FEFF) then the BOM is removed from the
+** string and the rest of the string is interpreted according to the
+** byte-order specified by the BOM. ^The byte-order specified by
+** the BOM at the beginning of the text overrides the byte-order
+** specified by the interface procedure. ^So, for example, if
+** sqlite3_result_text16le() is invoked with text that begins
+** with bytes 0xfe, 0xff (a big-endian byte-order mark) then the
+** first two bytes of input are skipped and the remaining input
+** is interpreted as UTF16BE text.
+**
+** ^For UTF16 input text to the sqlite3_result_text16(),
+** sqlite3_result_text16be(), sqlite3_result_text16le(), and
+** sqlite3_result_text64() routines, if the text contains invalid
+** UTF16 characters, the invalid characters might be converted
+** into the unicode replacement character, U+FFFD.
+**
+** ^The sqlite3_result_value() interface sets the result of
+** the application-defined function to be a copy of the
+** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The
+** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
+** so that the [sqlite3_value] specified in the parameter may change or
+** be deallocated after sqlite3_result_value() returns without harm.
+** ^A [protected sqlite3_value] object may always be used where an
+** [unprotected sqlite3_value] object is required, so either
+** kind of [sqlite3_value] object can be used with this interface.
+**
+** ^The sqlite3_result_pointer(C,P,T,D) interface sets the result to an
+** SQL NULL value, just like [sqlite3_result_null(C)], except that it
+** also associates the host-language pointer P or type T with that
+** NULL value such that the pointer can be retrieved within an
+** [application-defined SQL function] using [sqlite3_value_pointer()].
+** ^If the D parameter is not NULL, then it is a pointer to a destructor
+** for the P parameter. ^SQLite invokes D with P as its only argument
+** when SQLite is finished with P. The T parameter should be a static
+** string and preferably a string literal. The sqlite3_result_pointer()
+** routine is part of the [pointer passing interface] added for SQLite 3.20.0.
+**
+** If these routines are called from within the different thread
+** than the one containing the application-defined function that received
+** the [sqlite3_context] pointer, the results are undefined.
+*/
+SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
+SQLITE_API void sqlite3_result_blob64(sqlite3_context*,const void*,
+ sqlite3_uint64,void(*)(void*));
+SQLITE_API void sqlite3_result_double(sqlite3_context*, double);
+SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int);
+SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int);
+SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*);
+SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*);
+SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int);
+SQLITE_API void sqlite3_result_int(sqlite3_context*, int);
+SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
+SQLITE_API void sqlite3_result_null(sqlite3_context*);
+SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
+SQLITE_API void sqlite3_result_text64(sqlite3_context*, const char*,sqlite3_uint64,
+ void(*)(void*), unsigned char encoding);
+SQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
+SQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
+SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
+SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
+SQLITE_API void sqlite3_result_pointer(sqlite3_context*, void*,const char*,void(*)(void*));
+SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n);
+SQLITE_API int sqlite3_result_zeroblob64(sqlite3_context*, sqlite3_uint64 n);
+
+
+/*
+** CAPI3REF: Setting The Subtype Of An SQL Function
+** METHOD: sqlite3_context
+**
+** The sqlite3_result_subtype(C,T) function causes the subtype of
+** the result from the [application-defined SQL function] with
+** [sqlite3_context] C to be the value T. Only the lower 8 bits
+** of the subtype T are preserved in current versions of SQLite;
+** higher order bits are discarded.
+** The number of subtype bytes preserved by SQLite might increase
+** in future releases of SQLite.
+*/
+SQLITE_API void sqlite3_result_subtype(sqlite3_context*,unsigned int);
+
+/*
+** CAPI3REF: Define New Collating Sequences
+** METHOD: sqlite3
+**
+** ^These functions add, remove, or modify a [collation] associated
+** with the [database connection] specified as the first argument.
+**
+** ^The name of the collation is a UTF-8 string
+** for sqlite3_create_collation() and sqlite3_create_collation_v2()
+** and a UTF-16 string in native byte order for sqlite3_create_collation16().
+** ^Collation names that compare equal according to [sqlite3_strnicmp()] are
+** considered to be the same name.
+**
+** ^(The third argument (eTextRep) must be one of the constants:
+** <ul>
+** <li> [SQLITE_UTF8],
+** <li> [SQLITE_UTF16LE],
+** <li> [SQLITE_UTF16BE],
+** <li> [SQLITE_UTF16], or
+** <li> [SQLITE_UTF16_ALIGNED].
+** </ul>)^
+** ^The eTextRep argument determines the encoding of strings passed
+** to the collating function callback, xCompare.
+** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep
+** force strings to be UTF16 with native byte order.
+** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin
+** on an even byte address.
+**
+** ^The fourth argument, pArg, is an application data pointer that is passed
+** through as the first argument to the collating function callback.
+**
+** ^The fifth argument, xCompare, is a pointer to the collating function.
+** ^Multiple collating functions can be registered using the same name but
+** with different eTextRep parameters and SQLite will use whichever
+** function requires the least amount of data transformation.
+** ^If the xCompare argument is NULL then the collating function is
+** deleted. ^When all collating functions having the same name are deleted,
+** that collation is no longer usable.
+**
+** ^The collating function callback is invoked with a copy of the pArg
+** application data pointer and with two strings in the encoding specified
+** by the eTextRep argument. The two integer parameters to the collating
+** function callback are the length of the two strings, in bytes. The collating
+** function must return an integer that is negative, zero, or positive
+** if the first string is less than, equal to, or greater than the second,
+** respectively. A collating function must always return the same answer
+** given the same inputs. If two or more collating functions are registered
+** to the same collation name (using different eTextRep values) then all
+** must give an equivalent answer when invoked with equivalent strings.
+** The collating function must obey the following properties for all
+** strings A, B, and C:
+**
+** <ol>
+** <li> If A==B then B==A.
+** <li> If A==B and B==C then A==C.
+** <li> If A<B THEN B>A.
+** <li> If A<B and B<C then A<C.
+** </ol>
+**
+** If a collating function fails any of the above constraints and that
+** collating function is registered and used, then the behavior of SQLite
+** is undefined.
+**
+** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation()
+** with the addition that the xDestroy callback is invoked on pArg when
+** the collating function is deleted.
+** ^Collating functions are deleted when they are overridden by later
+** calls to the collation creation functions or when the
+** [database connection] is closed using [sqlite3_close()].
+**
+** ^The xDestroy callback is <u>not</u> called if the
+** sqlite3_create_collation_v2() function fails. Applications that invoke
+** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should
+** check the return code and dispose of the application data pointer
+** themselves rather than expecting SQLite to deal with it for them.
+** This is different from every other SQLite interface. The inconsistency
+** is unfortunate but cannot be changed without breaking backwards
+** compatibility.
+**
+** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()].
+*/
+SQLITE_API int sqlite3_create_collation(
+ sqlite3*,
+ const char *zName,
+ int eTextRep,
+ void *pArg,
+ int(*xCompare)(void*,int,const void*,int,const void*)
+);
+SQLITE_API int sqlite3_create_collation_v2(
+ sqlite3*,
+ const char *zName,
+ int eTextRep,
+ void *pArg,
+ int(*xCompare)(void*,int,const void*,int,const void*),
+ void(*xDestroy)(void*)
+);
+SQLITE_API int sqlite3_create_collation16(
+ sqlite3*,
+ const void *zName,
+ int eTextRep,
+ void *pArg,
+ int(*xCompare)(void*,int,const void*,int,const void*)
+);
+
+/*
+** CAPI3REF: Collation Needed Callbacks
+** METHOD: sqlite3
+**
+** ^To avoid having to register all collation sequences before a database
+** can be used, a single callback function may be registered with the
+** [database connection] to be invoked whenever an undefined collation
+** sequence is required.
+**
+** ^If the function is registered using the sqlite3_collation_needed() API,
+** then it is passed the names of undefined collation sequences as strings
+** encoded in UTF-8. ^If sqlite3_collation_needed16() is used,
+** the names are passed as UTF-16 in machine native byte order.
+** ^A call to either function replaces the existing collation-needed callback.
+**
+** ^(When the callback is invoked, the first argument passed is a copy
+** of the second argument to sqlite3_collation_needed() or
+** sqlite3_collation_needed16(). The second argument is the database
+** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE],
+** or [SQLITE_UTF16LE], indicating the most desirable form of the collation
+** sequence function required. The fourth parameter is the name of the
+** required collation sequence.)^
+**
+** The callback function should register the desired collation using
+** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
+** [sqlite3_create_collation_v2()].
+*/
+SQLITE_API int sqlite3_collation_needed(
+ sqlite3*,
+ void*,
+ void(*)(void*,sqlite3*,int eTextRep,const char*)
+);
+SQLITE_API int sqlite3_collation_needed16(
+ sqlite3*,
+ void*,
+ void(*)(void*,sqlite3*,int eTextRep,const void*)
+);
+
+#ifdef SQLITE_ENABLE_CEROD
+/*
+** Specify the activation key for a CEROD database. Unless
+** activated, none of the CEROD routines will work.
+*/
+SQLITE_API void sqlite3_activate_cerod(
+ const char *zPassPhrase /* Activation phrase */
+);
+#endif
+
+/*
+** CAPI3REF: Suspend Execution For A Short Time
+**
+** The sqlite3_sleep() function causes the current thread to suspend execution
+** for at least a number of milliseconds specified in its parameter.
+**
+** If the operating system does not support sleep requests with
+** millisecond time resolution, then the time will be rounded up to
+** the nearest second. The number of milliseconds of sleep actually
+** requested from the operating system is returned.
+**
+** ^SQLite implements this interface by calling the xSleep()
+** method of the default [sqlite3_vfs] object. If the xSleep() method
+** of the default VFS is not implemented correctly, or not implemented at
+** all, then the behavior of sqlite3_sleep() may deviate from the description
+** in the previous paragraphs.
+*/
+SQLITE_API int sqlite3_sleep(int);
+
+/*
+** CAPI3REF: Name Of The Folder Holding Temporary Files
+**
+** ^(If this global variable is made to point to a string which is
+** the name of a folder (a.k.a. directory), then all temporary files
+** created by SQLite when using a built-in [sqlite3_vfs | VFS]
+** will be placed in that directory.)^ ^If this variable
+** is a NULL pointer, then SQLite performs a search for an appropriate
+** temporary file directory.
+**
+** Applications are strongly discouraged from using this global variable.
+** It is required to set a temporary folder on Windows Runtime (WinRT).
+** But for all other platforms, it is highly recommended that applications
+** neither read nor write this variable. This global variable is a relic
+** that exists for backwards compatibility of legacy applications and should
+** be avoided in new projects.
+**
+** It is not safe to read or modify this variable in more than one
+** thread at a time. It is not safe to read or modify this variable
+** if a [database connection] is being used at the same time in a separate
+** thread.
+** It is intended that this variable be set once
+** as part of process initialization and before any SQLite interface
+** routines have been called and that this variable remain unchanged
+** thereafter.
+**
+** ^The [temp_store_directory pragma] may modify this variable and cause
+** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
+** the [temp_store_directory pragma] always assumes that any string
+** that this variable points to is held in memory obtained from
+** [sqlite3_malloc] and the pragma may attempt to free that memory
+** using [sqlite3_free].
+** Hence, if this variable is modified directly, either it should be
+** made NULL or made to point to memory obtained from [sqlite3_malloc]
+** or else the use of the [temp_store_directory pragma] should be avoided.
+** Except when requested by the [temp_store_directory pragma], SQLite
+** does not free the memory that sqlite3_temp_directory points to. If
+** the application wants that memory to be freed, it must do
+** so itself, taking care to only do so after all [database connection]
+** objects have been destroyed.
+**
+** <b>Note to Windows Runtime users:</b> The temporary directory must be set
+** prior to calling [sqlite3_open] or [sqlite3_open_v2]. Otherwise, various
+** features that require the use of temporary files may fail. Here is an
+** example of how to do this using C++ with the Windows Runtime:
+**
+** <blockquote><pre>
+** LPCWSTR zPath = Windows::Storage::ApplicationData::Current->
+** TemporaryFolder->Path->Data();
+** char zPathBuf[MAX_PATH + 1];
+** memset(zPathBuf, 0, sizeof(zPathBuf));
+** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf),
+** NULL, NULL);
+** sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf);
+** </pre></blockquote>
+*/
+SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory;
+
+/*
+** CAPI3REF: Name Of The Folder Holding Database Files
+**
+** ^(If this global variable is made to point to a string which is
+** the name of a folder (a.k.a. directory), then all database files
+** specified with a relative pathname and created or accessed by
+** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed
+** to be relative to that directory.)^ ^If this variable is a NULL
+** pointer, then SQLite assumes that all database files specified
+** with a relative pathname are relative to the current directory
+** for the process. Only the windows VFS makes use of this global
+** variable; it is ignored by the unix VFS.
+**
+** Changing the value of this variable while a database connection is
+** open can result in a corrupt database.
+**
+** It is not safe to read or modify this variable in more than one
+** thread at a time. It is not safe to read or modify this variable
+** if a [database connection] is being used at the same time in a separate
+** thread.
+** It is intended that this variable be set once
+** as part of process initialization and before any SQLite interface
+** routines have been called and that this variable remain unchanged
+** thereafter.
+**
+** ^The [data_store_directory pragma] may modify this variable and cause
+** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
+** the [data_store_directory pragma] always assumes that any string
+** that this variable points to is held in memory obtained from
+** [sqlite3_malloc] and the pragma may attempt to free that memory
+** using [sqlite3_free].
+** Hence, if this variable is modified directly, either it should be
+** made NULL or made to point to memory obtained from [sqlite3_malloc]
+** or else the use of the [data_store_directory pragma] should be avoided.
+*/
+SQLITE_API SQLITE_EXTERN char *sqlite3_data_directory;
+
+/*
+** CAPI3REF: Win32 Specific Interface
+**
+** These interfaces are available only on Windows. The
+** [sqlite3_win32_set_directory] interface is used to set the value associated
+** with the [sqlite3_temp_directory] or [sqlite3_data_directory] variable, to
+** zValue, depending on the value of the type parameter. The zValue parameter
+** should be NULL to cause the previous value to be freed via [sqlite3_free];
+** a non-NULL value will be copied into memory obtained from [sqlite3_malloc]
+** prior to being used. The [sqlite3_win32_set_directory] interface returns
+** [SQLITE_OK] to indicate success, [SQLITE_ERROR] if the type is unsupported,
+** or [SQLITE_NOMEM] if memory could not be allocated. The value of the
+** [sqlite3_data_directory] variable is intended to act as a replacement for
+** the current directory on the sub-platforms of Win32 where that concept is
+** not present, e.g. WinRT and UWP. The [sqlite3_win32_set_directory8] and
+** [sqlite3_win32_set_directory16] interfaces behave exactly the same as the
+** sqlite3_win32_set_directory interface except the string parameter must be
+** UTF-8 or UTF-16, respectively.
+*/
+SQLITE_API int sqlite3_win32_set_directory(
+ unsigned long type, /* Identifier for directory being set or reset */
+ void *zValue /* New value for directory being set or reset */
+);
+SQLITE_API int sqlite3_win32_set_directory8(unsigned long type, const char *zValue);
+SQLITE_API int sqlite3_win32_set_directory16(unsigned long type, const void *zValue);
+
+/*
+** CAPI3REF: Win32 Directory Types
+**
+** These macros are only available on Windows. They define the allowed values
+** for the type argument to the [sqlite3_win32_set_directory] interface.
+*/
+#define SQLITE_WIN32_DATA_DIRECTORY_TYPE 1
+#define SQLITE_WIN32_TEMP_DIRECTORY_TYPE 2
+
+/*
+** CAPI3REF: Test For Auto-Commit Mode
+** KEYWORDS: {autocommit mode}
+** METHOD: sqlite3
+**
+** ^The sqlite3_get_autocommit() interface returns non-zero or
+** zero if the given database connection is or is not in autocommit mode,
+** respectively. ^Autocommit mode is on by default.
+** ^Autocommit mode is disabled by a [BEGIN] statement.
+** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
+**
+** If certain kinds of errors occur on a statement within a multi-statement
+** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR],
+** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the
+** transaction might be rolled back automatically. The only way to
+** find out whether SQLite automatically rolled back the transaction after
+** an error is to use this function.
+**
+** If another thread changes the autocommit status of the database
+** connection while this routine is running, then the return value
+** is undefined.
+*/
+SQLITE_API int sqlite3_get_autocommit(sqlite3*);
+
+/*
+** CAPI3REF: Find The Database Handle Of A Prepared Statement
+** METHOD: sqlite3_stmt
+**
+** ^The sqlite3_db_handle interface returns the [database connection] handle
+** to which a [prepared statement] belongs. ^The [database connection]
+** returned by sqlite3_db_handle is the same [database connection]
+** that was the first argument
+** to the [sqlite3_prepare_v2()] call (or its variants) that was used to
+** create the statement in the first place.
+*/
+SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
+
+/*
+** CAPI3REF: Return The Filename For A Database Connection
+** METHOD: sqlite3
+**
+** ^The sqlite3_db_filename(D,N) interface returns a pointer to the filename
+** associated with database N of connection D.
+** ^If there is no attached database N on the database
+** connection D, or if database N is a temporary or in-memory database, then
+** this function will return either a NULL pointer or an empty string.
+**
+** ^The string value returned by this routine is owned and managed by
+** the database connection. ^The value will be valid until the database N
+** is [DETACH]-ed or until the database connection closes.
+**
+** ^The filename returned by this function is the output of the
+** xFullPathname method of the [VFS]. ^In other words, the filename
+** will be an absolute pathname, even if the filename used
+** to open the database originally was a URI or relative pathname.
+**
+** If the filename pointer returned by this routine is not NULL, then it
+** can be used as the filename input parameter to these routines:
+** <ul>
+** <li> [sqlite3_uri_parameter()]
+** <li> [sqlite3_uri_boolean()]
+** <li> [sqlite3_uri_int64()]
+** <li> [sqlite3_filename_database()]
+** <li> [sqlite3_filename_journal()]
+** <li> [sqlite3_filename_wal()]
+** </ul>
+*/
+SQLITE_API const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName);
+
+/*
+** CAPI3REF: Determine if a database is read-only
+** METHOD: sqlite3
+**
+** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N
+** of connection D is read-only, 0 if it is read/write, or -1 if N is not
+** the name of a database on connection D.
+*/
+SQLITE_API int sqlite3_db_readonly(sqlite3 *db, const char *zDbName);
+
+/*
+** CAPI3REF: Find the next prepared statement
+** METHOD: sqlite3
+**
+** ^This interface returns a pointer to the next [prepared statement] after
+** pStmt associated with the [database connection] pDb. ^If pStmt is NULL
+** then this interface returns a pointer to the first prepared statement
+** associated with the database connection pDb. ^If no prepared statement
+** satisfies the conditions of this routine, it returns NULL.
+**
+** The [database connection] pointer D in a call to
+** [sqlite3_next_stmt(D,S)] must refer to an open database
+** connection and in particular must not be a NULL pointer.
+*/
+SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt);
+
+/*
+** CAPI3REF: Commit And Rollback Notification Callbacks
+** METHOD: sqlite3
+**
+** ^The sqlite3_commit_hook() interface registers a callback
+** function to be invoked whenever a transaction is [COMMIT | committed].
+** ^Any callback set by a previous call to sqlite3_commit_hook()
+** for the same database connection is overridden.
+** ^The sqlite3_rollback_hook() interface registers a callback
+** function to be invoked whenever a transaction is [ROLLBACK | rolled back].
+** ^Any callback set by a previous call to sqlite3_rollback_hook()
+** for the same database connection is overridden.
+** ^The pArg argument is passed through to the callback.
+** ^If the callback on a commit hook function returns non-zero,
+** then the commit is converted into a rollback.
+**
+** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions
+** return the P argument from the previous call of the same function
+** on the same [database connection] D, or NULL for
+** the first call for each function on D.
+**
+** The commit and rollback hook callbacks are not reentrant.
+** The callback implementation must not do anything that will modify
+** the database connection that invoked the callback. Any actions
+** to modify the database connection must be deferred until after the
+** completion of the [sqlite3_step()] call that triggered the commit
+** or rollback hook in the first place.
+** Note that running any other SQL statements, including SELECT statements,
+** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify
+** the database connections for the meaning of "modify" in this paragraph.
+**
+** ^Registering a NULL function disables the callback.
+**
+** ^When the commit hook callback routine returns zero, the [COMMIT]
+** operation is allowed to continue normally. ^If the commit hook
+** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].
+** ^The rollback hook is invoked on a rollback that results from a commit
+** hook returning non-zero, just as it would be with any other rollback.
+**
+** ^For the purposes of this API, a transaction is said to have been
+** rolled back if an explicit "ROLLBACK" statement is executed, or
+** an error or constraint causes an implicit rollback to occur.
+** ^The rollback callback is not invoked if a transaction is
+** automatically rolled back because the database connection is closed.
+**
+** See also the [sqlite3_update_hook()] interface.
+*/
+SQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
+SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
+
+/*
+** CAPI3REF: Data Change Notification Callbacks
+** METHOD: sqlite3
+**
+** ^The sqlite3_update_hook() interface registers a callback function
+** with the [database connection] identified by the first argument
+** to be invoked whenever a row is updated, inserted or deleted in
+** a [rowid table].
+** ^Any callback set by a previous call to this function
+** for the same database connection is overridden.
+**
+** ^The second argument is a pointer to the function to invoke when a
+** row is updated, inserted or deleted in a rowid table.
+** ^The first argument to the callback is a copy of the third argument
+** to sqlite3_update_hook().
+** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
+** or [SQLITE_UPDATE], depending on the operation that caused the callback
+** to be invoked.
+** ^The third and fourth arguments to the callback contain pointers to the
+** database and table name containing the affected row.
+** ^The final callback parameter is the [rowid] of the row.
+** ^In the case of an update, this is the [rowid] after the update takes place.
+**
+** ^(The update hook is not invoked when internal system tables are
+** modified (i.e. sqlite_master and sqlite_sequence).)^
+** ^The update hook is not invoked when [WITHOUT ROWID] tables are modified.
+**
+** ^In the current implementation, the update hook
+** is not invoked when conflicting rows are deleted because of an
+** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook
+** invoked when rows are deleted using the [truncate optimization].
+** The exceptions defined in this paragraph might change in a future
+** release of SQLite.
+**
+** The update hook implementation must not do anything that will modify
+** the database connection that invoked the update hook. Any actions
+** to modify the database connection must be deferred until after the
+** completion of the [sqlite3_step()] call that triggered the update hook.
+** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
+** database connections for the meaning of "modify" in this paragraph.
+**
+** ^The sqlite3_update_hook(D,C,P) function
+** returns the P argument from the previous call
+** on the same [database connection] D, or NULL for
+** the first call on D.
+**
+** See also the [sqlite3_commit_hook()], [sqlite3_rollback_hook()],
+** and [sqlite3_preupdate_hook()] interfaces.
+*/
+SQLITE_API void *sqlite3_update_hook(
+ sqlite3*,
+ void(*)(void *,int ,char const *,char const *,sqlite3_int64),
+ void*
+);
+
+/*
+** CAPI3REF: Enable Or Disable Shared Pager Cache
+**
+** ^(This routine enables or disables the sharing of the database cache
+** and schema data structures between [database connection | connections]
+** to the same database. Sharing is enabled if the argument is true
+** and disabled if the argument is false.)^
+**
+** ^Cache sharing is enabled and disabled for an entire process.
+** This is a change as of SQLite [version 3.5.0] ([dateof:3.5.0]).
+** In prior versions of SQLite,
+** sharing was enabled or disabled for each thread separately.
+**
+** ^(The cache sharing mode set by this interface effects all subsequent
+** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
+** Existing database connections continue to use the sharing mode
+** that was in effect at the time they were opened.)^
+**
+** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled
+** successfully. An [error code] is returned otherwise.)^
+**
+** ^Shared cache is disabled by default. It is recommended that it stay
+** that way. In other words, do not use this routine. This interface
+** continues to be provided for historical compatibility, but its use is
+** discouraged. Any use of shared cache is discouraged. If shared cache
+** must be used, it is recommended that shared cache only be enabled for
+** individual database connections using the [sqlite3_open_v2()] interface
+** with the [SQLITE_OPEN_SHAREDCACHE] flag.
+**
+** Note: This method is disabled on MacOS X 10.7 and iOS version 5.0
+** and will always return SQLITE_MISUSE. On those systems,
+** shared cache mode should be enabled per-database connection via
+** [sqlite3_open_v2()] with [SQLITE_OPEN_SHAREDCACHE].
+**
+** This interface is threadsafe on processors where writing a
+** 32-bit integer is atomic.
+**
+** See Also: [SQLite Shared-Cache Mode]
+*/
+SQLITE_API int sqlite3_enable_shared_cache(int);
+
+/*
+** CAPI3REF: Attempt To Free Heap Memory
+**
+** ^The sqlite3_release_memory() interface attempts to free N bytes
+** of heap memory by deallocating non-essential memory allocations
+** held by the database library. Memory used to cache database
+** pages to improve performance is an example of non-essential memory.
+** ^sqlite3_release_memory() returns the number of bytes actually freed,
+** which might be more or less than the amount requested.
+** ^The sqlite3_release_memory() routine is a no-op returning zero
+** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT].
+**
+** See also: [sqlite3_db_release_memory()]
+*/
+SQLITE_API int sqlite3_release_memory(int);
+
+/*
+** CAPI3REF: Free Memory Used By A Database Connection
+** METHOD: sqlite3
+**
+** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap
+** memory as possible from database connection D. Unlike the
+** [sqlite3_release_memory()] interface, this interface is in effect even
+** when the [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is
+** omitted.
+**
+** See also: [sqlite3_release_memory()]
+*/
+SQLITE_API int sqlite3_db_release_memory(sqlite3*);
+
+/*
+** CAPI3REF: Impose A Limit On Heap Size
+**
+** These interfaces impose limits on the amount of heap memory that will be
+** by all database connections within a single process.
+**
+** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the
+** soft limit on the amount of heap memory that may be allocated by SQLite.
+** ^SQLite strives to keep heap memory utilization below the soft heap
+** limit by reducing the number of pages held in the page cache
+** as heap memory usages approaches the limit.
+** ^The soft heap limit is "soft" because even though SQLite strives to stay
+** below the limit, it will exceed the limit rather than generate
+** an [SQLITE_NOMEM] error. In other words, the soft heap limit
+** is advisory only.
+**
+** ^The sqlite3_hard_heap_limit64(N) interface sets a hard upper bound of
+** N bytes on the amount of memory that will be allocated. ^The
+** sqlite3_hard_heap_limit64(N) interface is similar to
+** sqlite3_soft_heap_limit64(N) except that memory allocations will fail
+** when the hard heap limit is reached.
+**
+** ^The return value from both sqlite3_soft_heap_limit64() and
+** sqlite3_hard_heap_limit64() is the size of
+** the heap limit prior to the call, or negative in the case of an
+** error. ^If the argument N is negative
+** then no change is made to the heap limit. Hence, the current
+** size of heap limits can be determined by invoking
+** sqlite3_soft_heap_limit64(-1) or sqlite3_hard_heap_limit(-1).
+**
+** ^Setting the heap limits to zero disables the heap limiter mechanism.
+**
+** ^The soft heap limit may not be greater than the hard heap limit.
+** ^If the hard heap limit is enabled and if sqlite3_soft_heap_limit(N)
+** is invoked with a value of N that is greater than the hard heap limit,
+** the the soft heap limit is set to the value of the hard heap limit.
+** ^The soft heap limit is automatically enabled whenever the hard heap
+** limit is enabled. ^When sqlite3_hard_heap_limit64(N) is invoked and
+** the soft heap limit is outside the range of 1..N, then the soft heap
+** limit is set to N. ^Invoking sqlite3_soft_heap_limit64(0) when the
+** hard heap limit is enabled makes the soft heap limit equal to the
+** hard heap limit.
+**
+** The memory allocation limits can also be adjusted using
+** [PRAGMA soft_heap_limit] and [PRAGMA hard_heap_limit].
+**
+** ^(The heap limits are not enforced in the current implementation
+** if one or more of following conditions are true:
+**
+** <ul>
+** <li> The limit value is set to zero.
+** <li> Memory accounting is disabled using a combination of the
+** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and
+** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option.
+** <li> An alternative page cache implementation is specified using
+** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...).
+** <li> The page cache allocates from its own memory pool supplied
+** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than
+** from the heap.
+** </ul>)^
+**
+** The circumstances under which SQLite will enforce the heap limits may
+** changes in future releases of SQLite.
+*/
+SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N);
+SQLITE_API sqlite3_int64 sqlite3_hard_heap_limit64(sqlite3_int64 N);
+
+/*
+** CAPI3REF: Deprecated Soft Heap Limit Interface
+** DEPRECATED
+**
+** This is a deprecated version of the [sqlite3_soft_heap_limit64()]
+** interface. This routine is provided for historical compatibility
+** only. All new applications should use the
+** [sqlite3_soft_heap_limit64()] interface rather than this one.
+*/
+SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N);
+
+
+/*
+** CAPI3REF: Extract Metadata About A Column Of A Table
+** METHOD: sqlite3
+**
+** ^(The sqlite3_table_column_metadata(X,D,T,C,....) routine returns
+** information about column C of table T in database D
+** on [database connection] X.)^ ^The sqlite3_table_column_metadata()
+** interface returns SQLITE_OK and fills in the non-NULL pointers in
+** the final five arguments with appropriate values if the specified
+** column exists. ^The sqlite3_table_column_metadata() interface returns
+** SQLITE_ERROR if the specified column does not exist.
+** ^If the column-name parameter to sqlite3_table_column_metadata() is a
+** NULL pointer, then this routine simply checks for the existence of the
+** table and returns SQLITE_OK if the table exists and SQLITE_ERROR if it
+** does not. If the table name parameter T in a call to
+** sqlite3_table_column_metadata(X,D,T,C,...) is NULL then the result is
+** undefined behavior.
+**
+** ^The column is identified by the second, third and fourth parameters to
+** this function. ^(The second parameter is either the name of the database
+** (i.e. "main", "temp", or an attached database) containing the specified
+** table or NULL.)^ ^If it is NULL, then all attached databases are searched
+** for the table using the same algorithm used by the database engine to
+** resolve unqualified table references.
+**
+** ^The third and fourth parameters to this function are the table and column
+** name of the desired column, respectively.
+**
+** ^Metadata is returned by writing to the memory locations passed as the 5th
+** and subsequent parameters to this function. ^Any of these arguments may be
+** NULL, in which case the corresponding element of metadata is omitted.
+**
+** ^(<blockquote>
+** <table border="1">
+** <tr><th> Parameter <th> Output<br>Type <th> Description
+**
+** <tr><td> 5th <td> const char* <td> Data type
+** <tr><td> 6th <td> const char* <td> Name of default collation sequence
+** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint
+** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY
+** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT]
+** </table>
+** </blockquote>)^
+**
+** ^The memory pointed to by the character pointers returned for the
+** declaration type and collation sequence is valid until the next
+** call to any SQLite API function.
+**
+** ^If the specified table is actually a view, an [error code] is returned.
+**
+** ^If the specified column is "rowid", "oid" or "_rowid_" and the table
+** is not a [WITHOUT ROWID] table and an
+** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output
+** parameters are set for the explicitly declared column. ^(If there is no
+** [INTEGER PRIMARY KEY] column, then the outputs
+** for the [rowid] are set as follows:
+**
+** <pre>
+** data type: "INTEGER"
+** collation sequence: "BINARY"
+** not null: 0
+** primary key: 1
+** auto increment: 0
+** </pre>)^
+**
+** ^This function causes all database schemas to be read from disk and
+** parsed, if that has not already been done, and returns an error if
+** any errors are encountered while loading the schema.
+*/
+SQLITE_API int sqlite3_table_column_metadata(
+ sqlite3 *db, /* Connection handle */
+ const char *zDbName, /* Database name or NULL */
+ const char *zTableName, /* Table name */
+ const char *zColumnName, /* Column name */
+ char const **pzDataType, /* OUTPUT: Declared data type */
+ char const **pzCollSeq, /* OUTPUT: Collation sequence name */
+ int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
+ int *pPrimaryKey, /* OUTPUT: True if column part of PK */
+ int *pAutoinc /* OUTPUT: True if column is auto-increment */
+);
+
+/*
+** CAPI3REF: Load An Extension
+** METHOD: sqlite3
+**
+** ^This interface loads an SQLite extension library from the named file.
+**
+** ^The sqlite3_load_extension() interface attempts to load an
+** [SQLite extension] library contained in the file zFile. If
+** the file cannot be loaded directly, attempts are made to load
+** with various operating-system specific extensions added.
+** So for example, if "samplelib" cannot be loaded, then names like
+** "samplelib.so" or "samplelib.dylib" or "samplelib.dll" might
+** be tried also.
+**
+** ^The entry point is zProc.
+** ^(zProc may be 0, in which case SQLite will try to come up with an
+** entry point name on its own. It first tries "sqlite3_extension_init".
+** If that does not work, it constructs a name "sqlite3_X_init" where the
+** X is consists of the lower-case equivalent of all ASCII alphabetic
+** characters in the filename from the last "/" to the first following
+** "." and omitting any initial "lib".)^
+** ^The sqlite3_load_extension() interface returns
+** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
+** ^If an error occurs and pzErrMsg is not 0, then the
+** [sqlite3_load_extension()] interface shall attempt to
+** fill *pzErrMsg with error message text stored in memory
+** obtained from [sqlite3_malloc()]. The calling function
+** should free this memory by calling [sqlite3_free()].
+**
+** ^Extension loading must be enabled using
+** [sqlite3_enable_load_extension()] or
+** [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],1,NULL)
+** prior to calling this API,
+** otherwise an error will be returned.
+**
+** <b>Security warning:</b> It is recommended that the
+** [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method be used to enable only this
+** interface. The use of the [sqlite3_enable_load_extension()] interface
+** should be avoided. This will keep the SQL function [load_extension()]
+** disabled and prevent SQL injections from giving attackers
+** access to extension loading capabilities.
+**
+** See also the [load_extension() SQL function].
+*/
+SQLITE_API int sqlite3_load_extension(
+ sqlite3 *db, /* Load the extension into this database connection */
+ const char *zFile, /* Name of the shared library containing extension */
+ const char *zProc, /* Entry point. Derived from zFile if 0 */
+ char **pzErrMsg /* Put error message here if not 0 */
+);
+
+/*
+** CAPI3REF: Enable Or Disable Extension Loading
+** METHOD: sqlite3
+**
+** ^So as not to open security holes in older applications that are
+** unprepared to deal with [extension loading], and as a means of disabling
+** [extension loading] while evaluating user-entered SQL, the following API
+** is provided to turn the [sqlite3_load_extension()] mechanism on and off.
+**
+** ^Extension loading is off by default.
+** ^Call the sqlite3_enable_load_extension() routine with onoff==1
+** to turn extension loading on and call it with onoff==0 to turn
+** it back off again.
+**
+** ^This interface enables or disables both the C-API
+** [sqlite3_load_extension()] and the SQL function [load_extension()].
+** ^(Use [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],..)
+** to enable or disable only the C-API.)^
+**
+** <b>Security warning:</b> It is recommended that extension loading
+** be enabled using the [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method
+** rather than this interface, so the [load_extension()] SQL function
+** remains disabled. This will prevent SQL injections from giving attackers
+** access to extension loading capabilities.
+*/
+SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
+
+/*
+** CAPI3REF: Automatically Load Statically Linked Extensions
+**
+** ^This interface causes the xEntryPoint() function to be invoked for
+** each new [database connection] that is created. The idea here is that
+** xEntryPoint() is the entry point for a statically linked [SQLite extension]
+** that is to be automatically loaded into all new database connections.
+**
+** ^(Even though the function prototype shows that xEntryPoint() takes
+** no arguments and returns void, SQLite invokes xEntryPoint() with three
+** arguments and expects an integer result as if the signature of the
+** entry point where as follows:
+**
+** <blockquote><pre>
+** int xEntryPoint(
+** sqlite3 *db,
+** const char **pzErrMsg,
+** const struct sqlite3_api_routines *pThunk
+** );
+** </pre></blockquote>)^
+**
+** If the xEntryPoint routine encounters an error, it should make *pzErrMsg
+** point to an appropriate error message (obtained from [sqlite3_mprintf()])
+** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg
+** is NULL before calling the xEntryPoint(). ^SQLite will invoke
+** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any
+** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()],
+** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail.
+**
+** ^Calling sqlite3_auto_extension(X) with an entry point X that is already
+** on the list of automatic extensions is a harmless no-op. ^No entry point
+** will be called more than once for each database connection that is opened.
+**
+** See also: [sqlite3_reset_auto_extension()]
+** and [sqlite3_cancel_auto_extension()]
+*/
+SQLITE_API int sqlite3_auto_extension(void(*xEntryPoint)(void));
+
+/*
+** CAPI3REF: Cancel Automatic Extension Loading
+**
+** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the
+** initialization routine X that was registered using a prior call to
+** [sqlite3_auto_extension(X)]. ^The [sqlite3_cancel_auto_extension(X)]
+** routine returns 1 if initialization routine X was successfully
+** unregistered and it returns 0 if X was not on the list of initialization
+** routines.
+*/
+SQLITE_API int sqlite3_cancel_auto_extension(void(*xEntryPoint)(void));
+
+/*
+** CAPI3REF: Reset Automatic Extension Loading
+**
+** ^This interface disables all automatic extensions previously
+** registered using [sqlite3_auto_extension()].
+*/
+SQLITE_API void sqlite3_reset_auto_extension(void);
+
+/*
+** The interface to the virtual-table mechanism is currently considered
+** to be experimental. The interface might change in incompatible ways.
+** If this is a problem for you, do not use the interface at this time.
+**
+** When the virtual-table mechanism stabilizes, we will declare the
+** interface fixed, support it indefinitely, and remove this comment.
+*/
+
+/*
+** Structures used by the virtual table interface
+*/
+typedef struct sqlite3_vtab sqlite3_vtab;
+typedef struct sqlite3_index_info sqlite3_index_info;
+typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
+typedef struct sqlite3_module sqlite3_module;
+
+/*
+** CAPI3REF: Virtual Table Object
+** KEYWORDS: sqlite3_module {virtual table module}
+**
+** This structure, sometimes called a "virtual table module",
+** defines the implementation of a [virtual table].
+** This structure consists mostly of methods for the module.
+**
+** ^A virtual table module is created by filling in a persistent
+** instance of this structure and passing a pointer to that instance
+** to [sqlite3_create_module()] or [sqlite3_create_module_v2()].
+** ^The registration remains valid until it is replaced by a different
+** module or until the [database connection] closes. The content
+** of this structure must not change while it is registered with
+** any database connection.
+*/
+struct sqlite3_module {
+ int iVersion;
+ int (*xCreate)(sqlite3*, void *pAux,
+ int argc, const char *const*argv,
+ sqlite3_vtab **ppVTab, char**);
+ int (*xConnect)(sqlite3*, void *pAux,
+ int argc, const char *const*argv,
+ sqlite3_vtab **ppVTab, char**);
+ int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
+ int (*xDisconnect)(sqlite3_vtab *pVTab);
+ int (*xDestroy)(sqlite3_vtab *pVTab);
+ int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
+ int (*xClose)(sqlite3_vtab_cursor*);
+ int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
+ int argc, sqlite3_value **argv);
+ int (*xNext)(sqlite3_vtab_cursor*);
+ int (*xEof)(sqlite3_vtab_cursor*);
+ int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);
+ int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);
+ int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);
+ int (*xBegin)(sqlite3_vtab *pVTab);
+ int (*xSync)(sqlite3_vtab *pVTab);
+ int (*xCommit)(sqlite3_vtab *pVTab);
+ int (*xRollback)(sqlite3_vtab *pVTab);
+ int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
+ void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
+ void **ppArg);
+ int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
+ /* The methods above are in version 1 of the sqlite_module object. Those
+ ** below are for version 2 and greater. */
+ int (*xSavepoint)(sqlite3_vtab *pVTab, int);
+ int (*xRelease)(sqlite3_vtab *pVTab, int);
+ int (*xRollbackTo)(sqlite3_vtab *pVTab, int);
+ /* The methods above are in versions 1 and 2 of the sqlite_module object.
+ ** Those below are for version 3 and greater. */
+ int (*xShadowName)(const char*);
+};
+
+/*
+** CAPI3REF: Virtual Table Indexing Information
+** KEYWORDS: sqlite3_index_info
+**
+** The sqlite3_index_info structure and its substructures is used as part
+** of the [virtual table] interface to
+** pass information into and receive the reply from the [xBestIndex]
+** method of a [virtual table module]. The fields under **Inputs** are the
+** inputs to xBestIndex and are read-only. xBestIndex inserts its
+** results into the **Outputs** fields.
+**
+** ^(The aConstraint[] array records WHERE clause constraints of the form:
+**
+** <blockquote>column OP expr</blockquote>
+**
+** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is
+** stored in aConstraint[].op using one of the
+** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^
+** ^(The index of the column is stored in
+** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the
+** expr on the right-hand side can be evaluated (and thus the constraint
+** is usable) and false if it cannot.)^
+**
+** ^The optimizer automatically inverts terms of the form "expr OP column"
+** and makes other simplifications to the WHERE clause in an attempt to
+** get as many WHERE clause terms into the form shown above as possible.
+** ^The aConstraint[] array only reports WHERE clause terms that are
+** relevant to the particular virtual table being queried.
+**
+** ^Information about the ORDER BY clause is stored in aOrderBy[].
+** ^Each term of aOrderBy records a column of the ORDER BY clause.
+**
+** The colUsed field indicates which columns of the virtual table may be
+** required by the current scan. Virtual table columns are numbered from
+** zero in the order in which they appear within the CREATE TABLE statement
+** passed to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62),
+** the corresponding bit is set within the colUsed mask if the column may be
+** required by SQLite. If the table has at least 64 columns and any column
+** to the right of the first 63 is required, then bit 63 of colUsed is also
+** set. In other words, column iCol may be required if the expression
+** (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) evaluates to
+** non-zero.
+**
+** The [xBestIndex] method must fill aConstraintUsage[] with information
+** about what parameters to pass to xFilter. ^If argvIndex>0 then
+** the right-hand side of the corresponding aConstraint[] is evaluated
+** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit
+** is true, then the constraint is assumed to be fully handled by the
+** virtual table and might not be checked again by the byte code.)^ ^(The
+** aConstraintUsage[].omit flag is an optimization hint. When the omit flag
+** is left in its default setting of false, the constraint will always be
+** checked separately in byte code. If the omit flag is change to true, then
+** the constraint may or may not be checked in byte code. In other words,
+** when the omit flag is true there is no guarantee that the constraint will
+** not be checked again using byte code.)^
+**
+** ^The idxNum and idxPtr values are recorded and passed into the
+** [xFilter] method.
+** ^[sqlite3_free()] is used to free idxPtr if and only if
+** needToFreeIdxPtr is true.
+**
+** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in
+** the correct order to satisfy the ORDER BY clause so that no separate
+** sorting step is required.
+**
+** ^The estimatedCost value is an estimate of the cost of a particular
+** strategy. A cost of N indicates that the cost of the strategy is similar
+** to a linear scan of an SQLite table with N rows. A cost of log(N)
+** indicates that the expense of the operation is similar to that of a
+** binary search on a unique indexed field of an SQLite table with N rows.
+**
+** ^The estimatedRows value is an estimate of the number of rows that
+** will be returned by the strategy.
+**
+** The xBestIndex method may optionally populate the idxFlags field with a
+** mask of SQLITE_INDEX_SCAN_* flags. Currently there is only one such flag -
+** SQLITE_INDEX_SCAN_UNIQUE. If the xBestIndex method sets this flag, SQLite
+** assumes that the strategy may visit at most one row.
+**
+** Additionally, if xBestIndex sets the SQLITE_INDEX_SCAN_UNIQUE flag, then
+** SQLite also assumes that if a call to the xUpdate() method is made as
+** part of the same statement to delete or update a virtual table row and the
+** implementation returns SQLITE_CONSTRAINT, then there is no need to rollback
+** any database changes. In other words, if the xUpdate() returns
+** SQLITE_CONSTRAINT, the database contents must be exactly as they were
+** before xUpdate was called. By contrast, if SQLITE_INDEX_SCAN_UNIQUE is not
+** set and xUpdate returns SQLITE_CONSTRAINT, any database changes made by
+** the xUpdate method are automatically rolled back by SQLite.
+**
+** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info
+** structure for SQLite [version 3.8.2] ([dateof:3.8.2]).
+** If a virtual table extension is
+** used with an SQLite version earlier than 3.8.2, the results of attempting
+** to read or write the estimatedRows field are undefined (but are likely
+** to include crashing the application). The estimatedRows field should
+** therefore only be used if [sqlite3_libversion_number()] returns a
+** value greater than or equal to 3008002. Similarly, the idxFlags field
+** was added for [version 3.9.0] ([dateof:3.9.0]).
+** It may therefore only be used if
+** sqlite3_libversion_number() returns a value greater than or equal to
+** 3009000.
+*/
+struct sqlite3_index_info {
+ /* Inputs */
+ int nConstraint; /* Number of entries in aConstraint */
+ struct sqlite3_index_constraint {
+ int iColumn; /* Column constrained. -1 for ROWID */
+ unsigned char op; /* Constraint operator */
+ unsigned char usable; /* True if this constraint is usable */
+ int iTermOffset; /* Used internally - xBestIndex should ignore */
+ } *aConstraint; /* Table of WHERE clause constraints */
+ int nOrderBy; /* Number of terms in the ORDER BY clause */
+ struct sqlite3_index_orderby {
+ int iColumn; /* Column number */
+ unsigned char desc; /* True for DESC. False for ASC. */
+ } *aOrderBy; /* The ORDER BY clause */
+ /* Outputs */
+ struct sqlite3_index_constraint_usage {
+ int argvIndex; /* if >0, constraint is part of argv to xFilter */
+ unsigned char omit; /* Do not code a test for this constraint */
+ } *aConstraintUsage;
+ int idxNum; /* Number used to identify the index */
+ char *idxStr; /* String, possibly obtained from sqlite3_malloc */
+ int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
+ int orderByConsumed; /* True if output is already ordered */
+ double estimatedCost; /* Estimated cost of using this index */
+ /* Fields below are only available in SQLite 3.8.2 and later */
+ sqlite3_int64 estimatedRows; /* Estimated number of rows returned */
+ /* Fields below are only available in SQLite 3.9.0 and later */
+ int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */
+ /* Fields below are only available in SQLite 3.10.0 and later */
+ sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */
+};
+
+/*
+** CAPI3REF: Virtual Table Scan Flags
+**
+** Virtual table implementations are allowed to set the
+** [sqlite3_index_info].idxFlags field to some combination of
+** these bits.
+*/
+#define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */
+
+/*
+** CAPI3REF: Virtual Table Constraint Operator Codes
+**
+** These macros define the allowed values for the
+** [sqlite3_index_info].aConstraint[].op field. Each value represents
+** an operator that is part of a constraint term in the wHERE clause of
+** a query that uses a [virtual table].
+*/
+#define SQLITE_INDEX_CONSTRAINT_EQ 2
+#define SQLITE_INDEX_CONSTRAINT_GT 4
+#define SQLITE_INDEX_CONSTRAINT_LE 8
+#define SQLITE_INDEX_CONSTRAINT_LT 16
+#define SQLITE_INDEX_CONSTRAINT_GE 32
+#define SQLITE_INDEX_CONSTRAINT_MATCH 64
+#define SQLITE_INDEX_CONSTRAINT_LIKE 65
+#define SQLITE_INDEX_CONSTRAINT_GLOB 66
+#define SQLITE_INDEX_CONSTRAINT_REGEXP 67
+#define SQLITE_INDEX_CONSTRAINT_NE 68
+#define SQLITE_INDEX_CONSTRAINT_ISNOT 69
+#define SQLITE_INDEX_CONSTRAINT_ISNOTNULL 70
+#define SQLITE_INDEX_CONSTRAINT_ISNULL 71
+#define SQLITE_INDEX_CONSTRAINT_IS 72
+#define SQLITE_INDEX_CONSTRAINT_FUNCTION 150
+
+/*
+** CAPI3REF: Register A Virtual Table Implementation
+** METHOD: sqlite3
+**
+** ^These routines are used to register a new [virtual table module] name.
+** ^Module names must be registered before
+** creating a new [virtual table] using the module and before using a
+** preexisting [virtual table] for the module.
+**
+** ^The module name is registered on the [database connection] specified
+** by the first parameter. ^The name of the module is given by the
+** second parameter. ^The third parameter is a pointer to
+** the implementation of the [virtual table module]. ^The fourth
+** parameter is an arbitrary client data pointer that is passed through
+** into the [xCreate] and [xConnect] methods of the virtual table module
+** when a new virtual table is be being created or reinitialized.
+**
+** ^The sqlite3_create_module_v2() interface has a fifth parameter which
+** is a pointer to a destructor for the pClientData. ^SQLite will
+** invoke the destructor function (if it is not NULL) when SQLite
+** no longer needs the pClientData pointer. ^The destructor will also
+** be invoked if the call to sqlite3_create_module_v2() fails.
+** ^The sqlite3_create_module()
+** interface is equivalent to sqlite3_create_module_v2() with a NULL
+** destructor.
+**
+** ^If the third parameter (the pointer to the sqlite3_module object) is
+** NULL then no new module is create and any existing modules with the
+** same name are dropped.
+**
+** See also: [sqlite3_drop_modules()]
+*/
+SQLITE_API int sqlite3_create_module(
+ sqlite3 *db, /* SQLite connection to register module with */
+ const char *zName, /* Name of the module */
+ const sqlite3_module *p, /* Methods for the module */
+ void *pClientData /* Client data for xCreate/xConnect */
+);
+SQLITE_API int sqlite3_create_module_v2(
+ sqlite3 *db, /* SQLite connection to register module with */
+ const char *zName, /* Name of the module */
+ const sqlite3_module *p, /* Methods for the module */
+ void *pClientData, /* Client data for xCreate/xConnect */
+ void(*xDestroy)(void*) /* Module destructor function */
+);
+
+/*
+** CAPI3REF: Remove Unnecessary Virtual Table Implementations
+** METHOD: sqlite3
+**
+** ^The sqlite3_drop_modules(D,L) interface removes all virtual
+** table modules from database connection D except those named on list L.
+** The L parameter must be either NULL or a pointer to an array of pointers
+** to strings where the array is terminated by a single NULL pointer.
+** ^If the L parameter is NULL, then all virtual table modules are removed.
+**
+** See also: [sqlite3_create_module()]
+*/
+SQLITE_API int sqlite3_drop_modules(
+ sqlite3 *db, /* Remove modules from this connection */
+ const char **azKeep /* Except, do not remove the ones named here */
+);
+
+/*
+** CAPI3REF: Virtual Table Instance Object
+** KEYWORDS: sqlite3_vtab
+**
+** Every [virtual table module] implementation uses a subclass
+** of this object to describe a particular instance
+** of the [virtual table]. Each subclass will
+** be tailored to the specific needs of the module implementation.
+** The purpose of this superclass is to define certain fields that are
+** common to all module implementations.
+**
+** ^Virtual tables methods can set an error message by assigning a
+** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should
+** take care that any prior string is freed by a call to [sqlite3_free()]
+** prior to assigning a new string to zErrMsg. ^After the error message
+** is delivered up to the client application, the string will be automatically
+** freed by sqlite3_free() and the zErrMsg field will be zeroed.
+*/
+struct sqlite3_vtab {
+ const sqlite3_module *pModule; /* The module for this virtual table */
+ int nRef; /* Number of open cursors */
+ char *zErrMsg; /* Error message from sqlite3_mprintf() */
+ /* Virtual table implementations will typically add additional fields */
+};
+
+/*
+** CAPI3REF: Virtual Table Cursor Object
+** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor}
+**
+** Every [virtual table module] implementation uses a subclass of the
+** following structure to describe cursors that point into the
+** [virtual table] and are used
+** to loop through the virtual table. Cursors are created using the
+** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed
+** by the [sqlite3_module.xClose | xClose] method. Cursors are used
+** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods
+** of the module. Each module implementation will define
+** the content of a cursor structure to suit its own needs.
+**
+** This superclass exists in order to define fields of the cursor that
+** are common to all implementations.
+*/
+struct sqlite3_vtab_cursor {
+ sqlite3_vtab *pVtab; /* Virtual table of this cursor */
+ /* Virtual table implementations will typically add additional fields */
+};
+
+/*
+** CAPI3REF: Declare The Schema Of A Virtual Table
+**
+** ^The [xCreate] and [xConnect] methods of a
+** [virtual table module] call this interface
+** to declare the format (the names and datatypes of the columns) of
+** the virtual tables they implement.
+*/
+SQLITE_API int sqlite3_declare_vtab(sqlite3*, const char *zSQL);
+
+/*
+** CAPI3REF: Overload A Function For A Virtual Table
+** METHOD: sqlite3
+**
+** ^(Virtual tables can provide alternative implementations of functions
+** using the [xFindFunction] method of the [virtual table module].
+** But global versions of those functions
+** must exist in order to be overloaded.)^
+**
+** ^(This API makes sure a global version of a function with a particular
+** name and number of parameters exists. If no such function exists
+** before this API is called, a new function is created.)^ ^The implementation
+** of the new function always causes an exception to be thrown. So
+** the new function is not good for anything by itself. Its only
+** purpose is to be a placeholder function that can be overloaded
+** by a [virtual table].
+*/
+SQLITE_API int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);
+
+/*
+** The interface to the virtual-table mechanism defined above (back up
+** to a comment remarkably similar to this one) is currently considered
+** to be experimental. The interface might change in incompatible ways.
+** If this is a problem for you, do not use the interface at this time.
+**
+** When the virtual-table mechanism stabilizes, we will declare the
+** interface fixed, support it indefinitely, and remove this comment.
+*/
+
+/*
+** CAPI3REF: A Handle To An Open BLOB
+** KEYWORDS: {BLOB handle} {BLOB handles}
+**
+** An instance of this object represents an open BLOB on which
+** [sqlite3_blob_open | incremental BLOB I/O] can be performed.
+** ^Objects of this type are created by [sqlite3_blob_open()]
+** and destroyed by [sqlite3_blob_close()].
+** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
+** can be used to read or write small subsections of the BLOB.
+** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes.
+*/
+typedef struct sqlite3_blob sqlite3_blob;
+
+/*
+** CAPI3REF: Open A BLOB For Incremental I/O
+** METHOD: sqlite3
+** CONSTRUCTOR: sqlite3_blob
+**
+** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located
+** in row iRow, column zColumn, table zTable in database zDb;
+** in other words, the same BLOB that would be selected by:
+**
+** <pre>
+** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
+** </pre>)^
+**
+** ^(Parameter zDb is not the filename that contains the database, but
+** rather the symbolic name of the database. For attached databases, this is
+** the name that appears after the AS keyword in the [ATTACH] statement.
+** For the main database file, the database name is "main". For TEMP
+** tables, the database name is "temp".)^
+**
+** ^If the flags parameter is non-zero, then the BLOB is opened for read
+** and write access. ^If the flags parameter is zero, the BLOB is opened for
+** read-only access.
+**
+** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is stored
+** in *ppBlob. Otherwise an [error code] is returned and, unless the error
+** code is SQLITE_MISUSE, *ppBlob is set to NULL.)^ ^This means that, provided
+** the API is not misused, it is always safe to call [sqlite3_blob_close()]
+** on *ppBlob after this function it returns.
+**
+** This function fails with SQLITE_ERROR if any of the following are true:
+** <ul>
+** <li> ^(Database zDb does not exist)^,
+** <li> ^(Table zTable does not exist within database zDb)^,
+** <li> ^(Table zTable is a WITHOUT ROWID table)^,
+** <li> ^(Column zColumn does not exist)^,
+** <li> ^(Row iRow is not present in the table)^,
+** <li> ^(The specified column of row iRow contains a value that is not
+** a TEXT or BLOB value)^,
+** <li> ^(Column zColumn is part of an index, PRIMARY KEY or UNIQUE
+** constraint and the blob is being opened for read/write access)^,
+** <li> ^([foreign key constraints | Foreign key constraints] are enabled,
+** column zColumn is part of a [child key] definition and the blob is
+** being opened for read/write access)^.
+** </ul>
+**
+** ^Unless it returns SQLITE_MISUSE, this function sets the
+** [database connection] error code and message accessible via
+** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions.
+**
+** A BLOB referenced by sqlite3_blob_open() may be read using the
+** [sqlite3_blob_read()] interface and modified by using
+** [sqlite3_blob_write()]. The [BLOB handle] can be moved to a
+** different row of the same table using the [sqlite3_blob_reopen()]
+** interface. However, the column, table, or database of a [BLOB handle]
+** cannot be changed after the [BLOB handle] is opened.
+**
+** ^(If the row that a BLOB handle points to is modified by an
+** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects
+** then the BLOB handle is marked as "expired".
+** This is true if any column of the row is changed, even a column
+** other than the one the BLOB handle is open on.)^
+** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for
+** an expired BLOB handle fail with a return code of [SQLITE_ABORT].
+** ^(Changes written into a BLOB prior to the BLOB expiring are not
+** rolled back by the expiration of the BLOB. Such changes will eventually
+** commit if the transaction continues to completion.)^
+**
+** ^Use the [sqlite3_blob_bytes()] interface to determine the size of
+** the opened blob. ^The size of a blob may not be changed by this
+** interface. Use the [UPDATE] SQL command to change the size of a
+** blob.
+**
+** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces
+** and the built-in [zeroblob] SQL function may be used to create a
+** zero-filled blob to read or write using the incremental-blob interface.
+**
+** To avoid a resource leak, every open [BLOB handle] should eventually
+** be released by a call to [sqlite3_blob_close()].
+**
+** See also: [sqlite3_blob_close()],
+** [sqlite3_blob_reopen()], [sqlite3_blob_read()],
+** [sqlite3_blob_bytes()], [sqlite3_blob_write()].
+*/
+SQLITE_API int sqlite3_blob_open(
+ sqlite3*,
+ const char *zDb,
+ const char *zTable,
+ const char *zColumn,
+ sqlite3_int64 iRow,
+ int flags,
+ sqlite3_blob **ppBlob
+);
+
+/*
+** CAPI3REF: Move a BLOB Handle to a New Row
+** METHOD: sqlite3_blob
+**
+** ^This function is used to move an existing [BLOB handle] so that it points
+** to a different row of the same database table. ^The new row is identified
+** by the rowid value passed as the second argument. Only the row can be
+** changed. ^The database, table and column on which the blob handle is open
+** remain the same. Moving an existing [BLOB handle] to a new row is
+** faster than closing the existing handle and opening a new one.
+**
+** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] -
+** it must exist and there must be either a blob or text value stored in
+** the nominated column.)^ ^If the new row is not present in the table, or if
+** it does not contain a blob or text value, or if another error occurs, an
+** SQLite error code is returned and the blob handle is considered aborted.
+** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or
+** [sqlite3_blob_reopen()] on an aborted blob handle immediately return
+** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle
+** always returns zero.
+**
+** ^This function sets the database handle error code and message.
+*/
+SQLITE_API int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64);
+
+/*
+** CAPI3REF: Close A BLOB Handle
+** DESTRUCTOR: sqlite3_blob
+**
+** ^This function closes an open [BLOB handle]. ^(The BLOB handle is closed
+** unconditionally. Even if this routine returns an error code, the
+** handle is still closed.)^
+**
+** ^If the blob handle being closed was opened for read-write access, and if
+** the database is in auto-commit mode and there are no other open read-write
+** blob handles or active write statements, the current transaction is
+** committed. ^If an error occurs while committing the transaction, an error
+** code is returned and the transaction rolled back.
+**
+** Calling this function with an argument that is not a NULL pointer or an
+** open blob handle results in undefined behaviour. ^Calling this routine
+** with a null pointer (such as would be returned by a failed call to
+** [sqlite3_blob_open()]) is a harmless no-op. ^Otherwise, if this function
+** is passed a valid open blob handle, the values returned by the
+** sqlite3_errcode() and sqlite3_errmsg() functions are set before returning.
+*/
+SQLITE_API int sqlite3_blob_close(sqlite3_blob *);
+
+/*
+** CAPI3REF: Return The Size Of An Open BLOB
+** METHOD: sqlite3_blob
+**
+** ^Returns the size in bytes of the BLOB accessible via the
+** successfully opened [BLOB handle] in its only argument. ^The
+** incremental blob I/O routines can only read or overwriting existing
+** blob content; they cannot change the size of a blob.
+**
+** This routine only works on a [BLOB handle] which has been created
+** by a prior successful call to [sqlite3_blob_open()] and which has not
+** been closed by [sqlite3_blob_close()]. Passing any other pointer in
+** to this routine results in undefined and probably undesirable behavior.
+*/
+SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *);
+
+/*
+** CAPI3REF: Read Data From A BLOB Incrementally
+** METHOD: sqlite3_blob
+**
+** ^(This function is used to read data from an open [BLOB handle] into a
+** caller-supplied buffer. N bytes of data are copied into buffer Z
+** from the open BLOB, starting at offset iOffset.)^
+**
+** ^If offset iOffset is less than N bytes from the end of the BLOB,
+** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is
+** less than zero, [SQLITE_ERROR] is returned and no data is read.
+** ^The size of the blob (and hence the maximum value of N+iOffset)
+** can be determined using the [sqlite3_blob_bytes()] interface.
+**
+** ^An attempt to read from an expired [BLOB handle] fails with an
+** error code of [SQLITE_ABORT].
+**
+** ^(On success, sqlite3_blob_read() returns SQLITE_OK.
+** Otherwise, an [error code] or an [extended error code] is returned.)^
+**
+** This routine only works on a [BLOB handle] which has been created
+** by a prior successful call to [sqlite3_blob_open()] and which has not
+** been closed by [sqlite3_blob_close()]. Passing any other pointer in
+** to this routine results in undefined and probably undesirable behavior.
+**
+** See also: [sqlite3_blob_write()].
+*/
+SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset);
+
+/*
+** CAPI3REF: Write Data Into A BLOB Incrementally
+** METHOD: sqlite3_blob
+**
+** ^(This function is used to write data into an open [BLOB handle] from a
+** caller-supplied buffer. N bytes of data are copied from the buffer Z
+** into the open BLOB, starting at offset iOffset.)^
+**
+** ^(On success, sqlite3_blob_write() returns SQLITE_OK.
+** Otherwise, an [error code] or an [extended error code] is returned.)^
+** ^Unless SQLITE_MISUSE is returned, this function sets the
+** [database connection] error code and message accessible via
+** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions.
+**
+** ^If the [BLOB handle] passed as the first argument was not opened for
+** writing (the flags parameter to [sqlite3_blob_open()] was zero),
+** this function returns [SQLITE_READONLY].
+**
+** This function may only modify the contents of the BLOB; it is
+** not possible to increase the size of a BLOB using this API.
+** ^If offset iOffset is less than N bytes from the end of the BLOB,
+** [SQLITE_ERROR] is returned and no data is written. The size of the
+** BLOB (and hence the maximum value of N+iOffset) can be determined
+** using the [sqlite3_blob_bytes()] interface. ^If N or iOffset are less
+** than zero [SQLITE_ERROR] is returned and no data is written.
+**
+** ^An attempt to write to an expired [BLOB handle] fails with an
+** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred
+** before the [BLOB handle] expired are not rolled back by the
+** expiration of the handle, though of course those changes might
+** have been overwritten by the statement that expired the BLOB handle
+** or by other independent statements.
+**
+** This routine only works on a [BLOB handle] which has been created
+** by a prior successful call to [sqlite3_blob_open()] and which has not
+** been closed by [sqlite3_blob_close()]. Passing any other pointer in
+** to this routine results in undefined and probably undesirable behavior.
+**
+** See also: [sqlite3_blob_read()].
+*/
+SQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);
+
+/*
+** CAPI3REF: Virtual File System Objects
+**
+** A virtual filesystem (VFS) is an [sqlite3_vfs] object
+** that SQLite uses to interact
+** with the underlying operating system. Most SQLite builds come with a
+** single default VFS that is appropriate for the host computer.
+** New VFSes can be registered and existing VFSes can be unregistered.
+** The following interfaces are provided.
+**
+** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name.
+** ^Names are case sensitive.
+** ^Names are zero-terminated UTF-8 strings.
+** ^If there is no match, a NULL pointer is returned.
+** ^If zVfsName is NULL then the default VFS is returned.
+**
+** ^New VFSes are registered with sqlite3_vfs_register().
+** ^Each new VFS becomes the default VFS if the makeDflt flag is set.
+** ^The same VFS can be registered multiple times without injury.
+** ^To make an existing VFS into the default VFS, register it again
+** with the makeDflt flag set. If two different VFSes with the
+** same name are registered, the behavior is undefined. If a
+** VFS is registered with a name that is NULL or an empty string,
+** then the behavior is undefined.
+**
+** ^Unregister a VFS with the sqlite3_vfs_unregister() interface.
+** ^(If the default VFS is unregistered, another VFS is chosen as
+** the default. The choice for the new VFS is arbitrary.)^
+*/
+SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
+SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
+SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
+
+/*
+** CAPI3REF: Mutexes
+**
+** The SQLite core uses these routines for thread
+** synchronization. Though they are intended for internal
+** use by SQLite, code that links against SQLite is
+** permitted to use any of these routines.
+**
+** The SQLite source code contains multiple implementations
+** of these mutex routines. An appropriate implementation
+** is selected automatically at compile-time. The following
+** implementations are available in the SQLite core:
+**
+** <ul>
+** <li> SQLITE_MUTEX_PTHREADS
+** <li> SQLITE_MUTEX_W32
+** <li> SQLITE_MUTEX_NOOP
+** </ul>
+**
+** The SQLITE_MUTEX_NOOP implementation is a set of routines
+** that does no real locking and is appropriate for use in
+** a single-threaded application. The SQLITE_MUTEX_PTHREADS and
+** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix
+** and Windows.
+**
+** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
+** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
+** implementation is included with the library. In this case the
+** application must supply a custom mutex implementation using the
+** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function
+** before calling sqlite3_initialize() or any other public sqlite3_
+** function that calls sqlite3_initialize().
+**
+** ^The sqlite3_mutex_alloc() routine allocates a new
+** mutex and returns a pointer to it. ^The sqlite3_mutex_alloc()
+** routine returns NULL if it is unable to allocate the requested
+** mutex. The argument to sqlite3_mutex_alloc() must one of these
+** integer constants:
+**
+** <ul>
+** <li> SQLITE_MUTEX_FAST
+** <li> SQLITE_MUTEX_RECURSIVE
+** <li> SQLITE_MUTEX_STATIC_MASTER
+** <li> SQLITE_MUTEX_STATIC_MEM
+** <li> SQLITE_MUTEX_STATIC_OPEN
+** <li> SQLITE_MUTEX_STATIC_PRNG
+** <li> SQLITE_MUTEX_STATIC_LRU
+** <li> SQLITE_MUTEX_STATIC_PMEM
+** <li> SQLITE_MUTEX_STATIC_APP1
+** <li> SQLITE_MUTEX_STATIC_APP2
+** <li> SQLITE_MUTEX_STATIC_APP3
+** <li> SQLITE_MUTEX_STATIC_VFS1
+** <li> SQLITE_MUTEX_STATIC_VFS2
+** <li> SQLITE_MUTEX_STATIC_VFS3
+** </ul>
+**
+** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE)
+** cause sqlite3_mutex_alloc() to create
+** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
+** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
+** The mutex implementation does not need to make a distinction
+** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
+** not want to. SQLite will only request a recursive mutex in
+** cases where it really needs one. If a faster non-recursive mutex
+** implementation is available on the host platform, the mutex subsystem
+** might return such a mutex in response to SQLITE_MUTEX_FAST.
+**
+** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other
+** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return
+** a pointer to a static preexisting mutex. ^Nine static mutexes are
+** used by the current version of SQLite. Future versions of SQLite
+** may add additional static mutexes. Static mutexes are for internal
+** use by SQLite only. Applications that use SQLite mutexes should
+** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
+** SQLITE_MUTEX_RECURSIVE.
+**
+** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
+** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
+** returns a different mutex on every call. ^For the static
+** mutex types, the same mutex is returned on every call that has
+** the same type number.
+**
+** ^The sqlite3_mutex_free() routine deallocates a previously
+** allocated dynamic mutex. Attempting to deallocate a static
+** mutex results in undefined behavior.
+**
+** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
+** to enter a mutex. ^If another thread is already within the mutex,
+** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
+** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK]
+** upon successful entry. ^(Mutexes created using
+** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
+** In such cases, the
+** mutex must be exited an equal number of times before another thread
+** can enter.)^ If the same thread tries to enter any mutex other
+** than an SQLITE_MUTEX_RECURSIVE more than once, the behavior is undefined.
+**
+** ^(Some systems (for example, Windows 95) do not support the operation
+** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try()
+** will always return SQLITE_BUSY. The SQLite core only ever uses
+** sqlite3_mutex_try() as an optimization so this is acceptable
+** behavior.)^
+**
+** ^The sqlite3_mutex_leave() routine exits a mutex that was
+** previously entered by the same thread. The behavior
+** is undefined if the mutex is not currently entered by the
+** calling thread or is not currently allocated.
+**
+** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or
+** sqlite3_mutex_leave() is a NULL pointer, then all three routines
+** behave as no-ops.
+**
+** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
+*/
+SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int);
+SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*);
+SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*);
+SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*);
+SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*);
+
+/*
+** CAPI3REF: Mutex Methods Object
+**
+** An instance of this structure defines the low-level routines
+** used to allocate and use mutexes.
+**
+** Usually, the default mutex implementations provided by SQLite are
+** sufficient, however the application has the option of substituting a custom
+** implementation for specialized deployments or systems for which SQLite
+** does not provide a suitable implementation. In this case, the application
+** creates and populates an instance of this structure to pass
+** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option.
+** Additionally, an instance of this structure can be used as an
+** output variable when querying the system for the current mutex
+** implementation, using the [SQLITE_CONFIG_GETMUTEX] option.
+**
+** ^The xMutexInit method defined by this structure is invoked as
+** part of system initialization by the sqlite3_initialize() function.
+** ^The xMutexInit routine is called by SQLite exactly once for each
+** effective call to [sqlite3_initialize()].
+**
+** ^The xMutexEnd method defined by this structure is invoked as
+** part of system shutdown by the sqlite3_shutdown() function. The
+** implementation of this method is expected to release all outstanding
+** resources obtained by the mutex methods implementation, especially
+** those obtained by the xMutexInit method. ^The xMutexEnd()
+** interface is invoked exactly once for each call to [sqlite3_shutdown()].
+**
+** ^(The remaining seven methods defined by this structure (xMutexAlloc,
+** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and
+** xMutexNotheld) implement the following interfaces (respectively):
+**
+** <ul>
+** <li> [sqlite3_mutex_alloc()] </li>
+** <li> [sqlite3_mutex_free()] </li>
+** <li> [sqlite3_mutex_enter()] </li>
+** <li> [sqlite3_mutex_try()] </li>
+** <li> [sqlite3_mutex_leave()] </li>
+** <li> [sqlite3_mutex_held()] </li>
+** <li> [sqlite3_mutex_notheld()] </li>
+** </ul>)^
+**
+** The only difference is that the public sqlite3_XXX functions enumerated
+** above silently ignore any invocations that pass a NULL pointer instead
+** of a valid mutex handle. The implementations of the methods defined
+** by this structure are not required to handle this case. The results
+** of passing a NULL pointer instead of a valid mutex handle are undefined
+** (i.e. it is acceptable to provide an implementation that segfaults if
+** it is passed a NULL pointer).
+**
+** The xMutexInit() method must be threadsafe. It must be harmless to
+** invoke xMutexInit() multiple times within the same process and without
+** intervening calls to xMutexEnd(). Second and subsequent calls to
+** xMutexInit() must be no-ops.
+**
+** xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()]
+** and its associates). Similarly, xMutexAlloc() must not use SQLite memory
+** allocation for a static mutex. ^However xMutexAlloc() may use SQLite
+** memory allocation for a fast or recursive mutex.
+**
+** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is
+** called, but only if the prior call to xMutexInit returned SQLITE_OK.
+** If xMutexInit fails in any way, it is expected to clean up after itself
+** prior to returning.
+*/
+typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
+struct sqlite3_mutex_methods {
+ int (*xMutexInit)(void);
+ int (*xMutexEnd)(void);
+ sqlite3_mutex *(*xMutexAlloc)(int);
+ void (*xMutexFree)(sqlite3_mutex *);
+ void (*xMutexEnter)(sqlite3_mutex *);
+ int (*xMutexTry)(sqlite3_mutex *);
+ void (*xMutexLeave)(sqlite3_mutex *);
+ int (*xMutexHeld)(sqlite3_mutex *);
+ int (*xMutexNotheld)(sqlite3_mutex *);
+};
+
+/*
+** CAPI3REF: Mutex Verification Routines
+**
+** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
+** are intended for use inside assert() statements. The SQLite core
+** never uses these routines except inside an assert() and applications
+** are advised to follow the lead of the core. The SQLite core only
+** provides implementations for these routines when it is compiled
+** with the SQLITE_DEBUG flag. External mutex implementations
+** are only required to provide these routines if SQLITE_DEBUG is
+** defined and if NDEBUG is not defined.
+**
+** These routines should return true if the mutex in their argument
+** is held or not held, respectively, by the calling thread.
+**
+** The implementation is not required to provide versions of these
+** routines that actually work. If the implementation does not provide working
+** versions of these routines, it should at least provide stubs that always
+** return true so that one does not get spurious assertion failures.
+**
+** If the argument to sqlite3_mutex_held() is a NULL pointer then
+** the routine should return 1. This seems counter-intuitive since
+** clearly the mutex cannot be held if it does not exist. But
+** the reason the mutex does not exist is because the build is not
+** using mutexes. And we do not want the assert() containing the
+** call to sqlite3_mutex_held() to fail, so a non-zero return is
+** the appropriate thing to do. The sqlite3_mutex_notheld()
+** interface should also return 1 when given a NULL pointer.
+*/
+#ifndef NDEBUG
+SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*);
+SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*);
+#endif
+
+/*
+** CAPI3REF: Mutex Types
+**
+** The [sqlite3_mutex_alloc()] interface takes a single argument
+** which is one of these integer constants.
+**
+** The set of static mutexes may change from one SQLite release to the
+** next. Applications that override the built-in mutex logic must be
+** prepared to accommodate additional static mutexes.
+*/
+#define SQLITE_MUTEX_FAST 0
+#define SQLITE_MUTEX_RECURSIVE 1
+#define SQLITE_MUTEX_STATIC_MASTER 2
+#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */
+#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */
+#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */
+#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_randomness() */
+#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */
+#define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */
+#define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */
+#define SQLITE_MUTEX_STATIC_APP1 8 /* For use by application */
+#define SQLITE_MUTEX_STATIC_APP2 9 /* For use by application */
+#define SQLITE_MUTEX_STATIC_APP3 10 /* For use by application */
+#define SQLITE_MUTEX_STATIC_VFS1 11 /* For use by built-in VFS */
+#define SQLITE_MUTEX_STATIC_VFS2 12 /* For use by extension VFS */
+#define SQLITE_MUTEX_STATIC_VFS3 13 /* For use by application VFS */
+
+/*
+** CAPI3REF: Retrieve the mutex for a database connection
+** METHOD: sqlite3
+**
+** ^This interface returns a pointer the [sqlite3_mutex] object that
+** serializes access to the [database connection] given in the argument
+** when the [threading mode] is Serialized.
+** ^If the [threading mode] is Single-thread or Multi-thread then this
+** routine returns a NULL pointer.
+*/
+SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
+
+/*
+** CAPI3REF: Low-Level Control Of Database Files
+** METHOD: sqlite3
+** KEYWORDS: {file control}
+**
+** ^The [sqlite3_file_control()] interface makes a direct call to the
+** xFileControl method for the [sqlite3_io_methods] object associated
+** with a particular database identified by the second argument. ^The
+** name of the database is "main" for the main database or "temp" for the
+** TEMP database, or the name that appears after the AS keyword for
+** databases that are added using the [ATTACH] SQL command.
+** ^A NULL pointer can be used in place of "main" to refer to the
+** main database file.
+** ^The third and fourth parameters to this routine
+** are passed directly through to the second and third parameters of
+** the xFileControl method. ^The return value of the xFileControl
+** method becomes the return value of this routine.
+**
+** A few opcodes for [sqlite3_file_control()] are handled directly
+** by the SQLite core and never invoke the
+** sqlite3_io_methods.xFileControl method.
+** ^The [SQLITE_FCNTL_FILE_POINTER] value for the op parameter causes
+** a pointer to the underlying [sqlite3_file] object to be written into
+** the space pointed to by the 4th parameter. The
+** [SQLITE_FCNTL_JOURNAL_POINTER] works similarly except that it returns
+** the [sqlite3_file] object associated with the journal file instead of
+** the main database. The [SQLITE_FCNTL_VFS_POINTER] opcode returns
+** a pointer to the underlying [sqlite3_vfs] object for the file.
+** The [SQLITE_FCNTL_DATA_VERSION] returns the data version counter
+** from the pager.
+**
+** ^If the second parameter (zDbName) does not match the name of any
+** open database file, then SQLITE_ERROR is returned. ^This error
+** code is not remembered and will not be recalled by [sqlite3_errcode()]
+** or [sqlite3_errmsg()]. The underlying xFileControl method might
+** also return SQLITE_ERROR. There is no way to distinguish between
+** an incorrect zDbName and an SQLITE_ERROR return from the underlying
+** xFileControl method.
+**
+** See also: [file control opcodes]
+*/
+SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
+
+/*
+** CAPI3REF: Testing Interface
+**
+** ^The sqlite3_test_control() interface is used to read out internal
+** state of SQLite and to inject faults into SQLite for testing
+** purposes. ^The first parameter is an operation code that determines
+** the number, meaning, and operation of all subsequent parameters.
+**
+** This interface is not for use by applications. It exists solely
+** for verifying the correct operation of the SQLite library. Depending
+** on how the SQLite library is compiled, this interface might not exist.
+**
+** The details of the operation codes, their meanings, the parameters
+** they take, and what they do are all subject to change without notice.
+** Unlike most of the SQLite API, this function is not guaranteed to
+** operate consistently from one release to the next.
+*/
+SQLITE_API int sqlite3_test_control(int op, ...);
+
+/*
+** CAPI3REF: Testing Interface Operation Codes
+**
+** These constants are the valid operation code parameters used
+** as the first argument to [sqlite3_test_control()].
+**
+** These parameters and their meanings are subject to change
+** without notice. These values are for testing purposes only.
+** Applications should not use any of these parameters or the
+** [sqlite3_test_control()] interface.
+*/
+#define SQLITE_TESTCTRL_FIRST 5
+#define SQLITE_TESTCTRL_PRNG_SAVE 5
+#define SQLITE_TESTCTRL_PRNG_RESTORE 6
+#define SQLITE_TESTCTRL_PRNG_RESET 7 /* NOT USED */
+#define SQLITE_TESTCTRL_BITVEC_TEST 8
+#define SQLITE_TESTCTRL_FAULT_INSTALL 9
+#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10
+#define SQLITE_TESTCTRL_PENDING_BYTE 11
+#define SQLITE_TESTCTRL_ASSERT 12
+#define SQLITE_TESTCTRL_ALWAYS 13
+#define SQLITE_TESTCTRL_RESERVE 14 /* NOT USED */
+#define SQLITE_TESTCTRL_OPTIMIZATIONS 15
+#define SQLITE_TESTCTRL_ISKEYWORD 16 /* NOT USED */
+#define SQLITE_TESTCTRL_SCRATCHMALLOC 17 /* NOT USED */
+#define SQLITE_TESTCTRL_INTERNAL_FUNCTIONS 17
+#define SQLITE_TESTCTRL_LOCALTIME_FAULT 18
+#define SQLITE_TESTCTRL_EXPLAIN_STMT 19 /* NOT USED */
+#define SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD 19
+#define SQLITE_TESTCTRL_NEVER_CORRUPT 20
+#define SQLITE_TESTCTRL_VDBE_COVERAGE 21
+#define SQLITE_TESTCTRL_BYTEORDER 22
+#define SQLITE_TESTCTRL_ISINIT 23
+#define SQLITE_TESTCTRL_SORTER_MMAP 24
+#define SQLITE_TESTCTRL_IMPOSTER 25
+#define SQLITE_TESTCTRL_PARSER_COVERAGE 26
+#define SQLITE_TESTCTRL_RESULT_INTREAL 27
+#define SQLITE_TESTCTRL_PRNG_SEED 28
+#define SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS 29
+#define SQLITE_TESTCTRL_LAST 29 /* Largest TESTCTRL */
+
+/*
+** CAPI3REF: SQL Keyword Checking
+**
+** These routines provide access to the set of SQL language keywords
+** recognized by SQLite. Applications can uses these routines to determine
+** whether or not a specific identifier needs to be escaped (for example,
+** by enclosing in double-quotes) so as not to confuse the parser.
+**
+** The sqlite3_keyword_count() interface returns the number of distinct
+** keywords understood by SQLite.
+**
+** The sqlite3_keyword_name(N,Z,L) interface finds the N-th keyword and
+** makes *Z point to that keyword expressed as UTF8 and writes the number
+** of bytes in the keyword into *L. The string that *Z points to is not
+** zero-terminated. The sqlite3_keyword_name(N,Z,L) routine returns
+** SQLITE_OK if N is within bounds and SQLITE_ERROR if not. If either Z
+** or L are NULL or invalid pointers then calls to
+** sqlite3_keyword_name(N,Z,L) result in undefined behavior.
+**
+** The sqlite3_keyword_check(Z,L) interface checks to see whether or not
+** the L-byte UTF8 identifier that Z points to is a keyword, returning non-zero
+** if it is and zero if not.
+**
+** The parser used by SQLite is forgiving. It is often possible to use
+** a keyword as an identifier as long as such use does not result in a
+** parsing ambiguity. For example, the statement
+** "CREATE TABLE BEGIN(REPLACE,PRAGMA,END);" is accepted by SQLite, and
+** creates a new table named "BEGIN" with three columns named
+** "REPLACE", "PRAGMA", and "END". Nevertheless, best practice is to avoid
+** using keywords as identifiers. Common techniques used to avoid keyword
+** name collisions include:
+** <ul>
+** <li> Put all identifier names inside double-quotes. This is the official
+** SQL way to escape identifier names.
+** <li> Put identifier names inside [...]. This is not standard SQL,
+** but it is what SQL Server does and so lots of programmers use this
+** technique.
+** <li> Begin every identifier with the letter "Z" as no SQL keywords start
+** with "Z".
+** <li> Include a digit somewhere in every identifier name.
+** </ul>
+**
+** Note that the number of keywords understood by SQLite can depend on
+** compile-time options. For example, "VACUUM" is not a keyword if
+** SQLite is compiled with the [-DSQLITE_OMIT_VACUUM] option. Also,
+** new keywords may be added to future releases of SQLite.
+*/
+SQLITE_API int sqlite3_keyword_count(void);
+SQLITE_API int sqlite3_keyword_name(int,const char**,int*);
+SQLITE_API int sqlite3_keyword_check(const char*,int);
+
+/*
+** CAPI3REF: Dynamic String Object
+** KEYWORDS: {dynamic string}
+**
+** An instance of the sqlite3_str object contains a dynamically-sized
+** string under construction.
+**
+** The lifecycle of an sqlite3_str object is as follows:
+** <ol>
+** <li> ^The sqlite3_str object is created using [sqlite3_str_new()].
+** <li> ^Text is appended to the sqlite3_str object using various
+** methods, such as [sqlite3_str_appendf()].
+** <li> ^The sqlite3_str object is destroyed and the string it created
+** is returned using the [sqlite3_str_finish()] interface.
+** </ol>
+*/
+typedef struct sqlite3_str sqlite3_str;
+
+/*
+** CAPI3REF: Create A New Dynamic String Object
+** CONSTRUCTOR: sqlite3_str
+**
+** ^The [sqlite3_str_new(D)] interface allocates and initializes
+** a new [sqlite3_str] object. To avoid memory leaks, the object returned by
+** [sqlite3_str_new()] must be freed by a subsequent call to
+** [sqlite3_str_finish(X)].
+**
+** ^The [sqlite3_str_new(D)] interface always returns a pointer to a
+** valid [sqlite3_str] object, though in the event of an out-of-memory
+** error the returned object might be a special singleton that will
+** silently reject new text, always return SQLITE_NOMEM from
+** [sqlite3_str_errcode()], always return 0 for
+** [sqlite3_str_length()], and always return NULL from
+** [sqlite3_str_finish(X)]. It is always safe to use the value
+** returned by [sqlite3_str_new(D)] as the sqlite3_str parameter
+** to any of the other [sqlite3_str] methods.
+**
+** The D parameter to [sqlite3_str_new(D)] may be NULL. If the
+** D parameter in [sqlite3_str_new(D)] is not NULL, then the maximum
+** length of the string contained in the [sqlite3_str] object will be
+** the value set for [sqlite3_limit](D,[SQLITE_LIMIT_LENGTH]) instead
+** of [SQLITE_MAX_LENGTH].
+*/
+SQLITE_API sqlite3_str *sqlite3_str_new(sqlite3*);
+
+/*
+** CAPI3REF: Finalize A Dynamic String
+** DESTRUCTOR: sqlite3_str
+**
+** ^The [sqlite3_str_finish(X)] interface destroys the sqlite3_str object X
+** and returns a pointer to a memory buffer obtained from [sqlite3_malloc64()]
+** that contains the constructed string. The calling application should
+** pass the returned value to [sqlite3_free()] to avoid a memory leak.
+** ^The [sqlite3_str_finish(X)] interface may return a NULL pointer if any
+** errors were encountered during construction of the string. ^The
+** [sqlite3_str_finish(X)] interface will also return a NULL pointer if the
+** string in [sqlite3_str] object X is zero bytes long.
+*/
+SQLITE_API char *sqlite3_str_finish(sqlite3_str*);
+
+/*
+** CAPI3REF: Add Content To A Dynamic String
+** METHOD: sqlite3_str
+**
+** These interfaces add content to an sqlite3_str object previously obtained
+** from [sqlite3_str_new()].
+**
+** ^The [sqlite3_str_appendf(X,F,...)] and
+** [sqlite3_str_vappendf(X,F,V)] interfaces uses the [built-in printf]
+** functionality of SQLite to append formatted text onto the end of
+** [sqlite3_str] object X.
+**
+** ^The [sqlite3_str_append(X,S,N)] method appends exactly N bytes from string S
+** onto the end of the [sqlite3_str] object X. N must be non-negative.
+** S must contain at least N non-zero bytes of content. To append a
+** zero-terminated string in its entirety, use the [sqlite3_str_appendall()]
+** method instead.
+**
+** ^The [sqlite3_str_appendall(X,S)] method appends the complete content of
+** zero-terminated string S onto the end of [sqlite3_str] object X.
+**
+** ^The [sqlite3_str_appendchar(X,N,C)] method appends N copies of the
+** single-byte character C onto the end of [sqlite3_str] object X.
+** ^This method can be used, for example, to add whitespace indentation.
+**
+** ^The [sqlite3_str_reset(X)] method resets the string under construction
+** inside [sqlite3_str] object X back to zero bytes in length.
+**
+** These methods do not return a result code. ^If an error occurs, that fact
+** is recorded in the [sqlite3_str] object and can be recovered by a
+** subsequent call to [sqlite3_str_errcode(X)].
+*/
+SQLITE_API void sqlite3_str_appendf(sqlite3_str*, const char *zFormat, ...);
+SQLITE_API void sqlite3_str_vappendf(sqlite3_str*, const char *zFormat, va_list);
+SQLITE_API void sqlite3_str_append(sqlite3_str*, const char *zIn, int N);
+SQLITE_API void sqlite3_str_appendall(sqlite3_str*, const char *zIn);
+SQLITE_API void sqlite3_str_appendchar(sqlite3_str*, int N, char C);
+SQLITE_API void sqlite3_str_reset(sqlite3_str*);
+
+/*
+** CAPI3REF: Status Of A Dynamic String
+** METHOD: sqlite3_str
+**
+** These interfaces return the current status of an [sqlite3_str] object.
+**
+** ^If any prior errors have occurred while constructing the dynamic string
+** in sqlite3_str X, then the [sqlite3_str_errcode(X)] method will return
+** an appropriate error code. ^The [sqlite3_str_errcode(X)] method returns
+** [SQLITE_NOMEM] following any out-of-memory error, or
+** [SQLITE_TOOBIG] if the size of the dynamic string exceeds
+** [SQLITE_MAX_LENGTH], or [SQLITE_OK] if there have been no errors.
+**
+** ^The [sqlite3_str_length(X)] method returns the current length, in bytes,
+** of the dynamic string under construction in [sqlite3_str] object X.
+** ^The length returned by [sqlite3_str_length(X)] does not include the
+** zero-termination byte.
+**
+** ^The [sqlite3_str_value(X)] method returns a pointer to the current
+** content of the dynamic string under construction in X. The value
+** returned by [sqlite3_str_value(X)] is managed by the sqlite3_str object X
+** and might be freed or altered by any subsequent method on the same
+** [sqlite3_str] object. Applications must not used the pointer returned
+** [sqlite3_str_value(X)] after any subsequent method call on the same
+** object. ^Applications may change the content of the string returned
+** by [sqlite3_str_value(X)] as long as they do not write into any bytes
+** outside the range of 0 to [sqlite3_str_length(X)] and do not read or
+** write any byte after any subsequent sqlite3_str method call.
+*/
+SQLITE_API int sqlite3_str_errcode(sqlite3_str*);
+SQLITE_API int sqlite3_str_length(sqlite3_str*);
+SQLITE_API char *sqlite3_str_value(sqlite3_str*);
+
+/*
+** CAPI3REF: SQLite Runtime Status
+**
+** ^These interfaces are used to retrieve runtime status information
+** about the performance of SQLite, and optionally to reset various
+** highwater marks. ^The first argument is an integer code for
+** the specific parameter to measure. ^(Recognized integer codes
+** are of the form [status parameters | SQLITE_STATUS_...].)^
+** ^The current value of the parameter is returned into *pCurrent.
+** ^The highest recorded value is returned in *pHighwater. ^If the
+** resetFlag is true, then the highest record value is reset after
+** *pHighwater is written. ^(Some parameters do not record the highest
+** value. For those parameters
+** nothing is written into *pHighwater and the resetFlag is ignored.)^
+** ^(Other parameters record only the highwater mark and not the current
+** value. For these latter parameters nothing is written into *pCurrent.)^
+**
+** ^The sqlite3_status() and sqlite3_status64() routines return
+** SQLITE_OK on success and a non-zero [error code] on failure.
+**
+** If either the current value or the highwater mark is too large to
+** be represented by a 32-bit integer, then the values returned by
+** sqlite3_status() are undefined.
+**
+** See also: [sqlite3_db_status()]
+*/
+SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag);
+SQLITE_API int sqlite3_status64(
+ int op,
+ sqlite3_int64 *pCurrent,
+ sqlite3_int64 *pHighwater,
+ int resetFlag
+);
+
+
+/*
+** CAPI3REF: Status Parameters
+** KEYWORDS: {status parameters}
+**
+** These integer constants designate various run-time status parameters
+** that can be returned by [sqlite3_status()].
+**
+** <dl>
+** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt>
+** <dd>This parameter is the current amount of memory checked out
+** using [sqlite3_malloc()], either directly or indirectly. The
+** figure includes calls made to [sqlite3_malloc()] by the application
+** and internal memory usage by the SQLite library. Auxiliary page-cache
+** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in
+** this parameter. The amount returned is the sum of the allocation
+** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^
+**
+** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt>
+** <dd>This parameter records the largest memory allocation request
+** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their
+** internal equivalents). Only the value returned in the
+** *pHighwater parameter to [sqlite3_status()] is of interest.
+** The value written into the *pCurrent parameter is undefined.</dd>)^
+**
+** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt>
+** <dd>This parameter records the number of separate memory allocations
+** currently checked out.</dd>)^
+**
+** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt>
+** <dd>This parameter returns the number of pages used out of the
+** [pagecache memory allocator] that was configured using
+** [SQLITE_CONFIG_PAGECACHE]. The
+** value returned is in pages, not in bytes.</dd>)^
+**
+** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]]
+** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
+** <dd>This parameter returns the number of bytes of page cache
+** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE]
+** buffer and where forced to overflow to [sqlite3_malloc()]. The
+** returned value includes allocations that overflowed because they
+** where too large (they were larger than the "sz" parameter to
+** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
+** no space was left in the page cache.</dd>)^
+**
+** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
+** <dd>This parameter records the largest memory allocation request
+** handed to the [pagecache memory allocator]. Only the value returned in the
+** *pHighwater parameter to [sqlite3_status()] is of interest.
+** The value written into the *pCurrent parameter is undefined.</dd>)^
+**
+** [[SQLITE_STATUS_SCRATCH_USED]] <dt>SQLITE_STATUS_SCRATCH_USED</dt>
+** <dd>No longer used.</dd>
+**
+** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
+** <dd>No longer used.</dd>
+**
+** [[SQLITE_STATUS_SCRATCH_SIZE]] <dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
+** <dd>No longer used.</dd>
+**
+** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt>
+** <dd>The *pHighwater parameter records the deepest parser stack.
+** The *pCurrent value is undefined. The *pHighwater value is only
+** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^
+** </dl>
+**
+** New status parameters may be added from time to time.
+*/
+#define SQLITE_STATUS_MEMORY_USED 0
+#define SQLITE_STATUS_PAGECACHE_USED 1
+#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2
+#define SQLITE_STATUS_SCRATCH_USED 3 /* NOT USED */
+#define SQLITE_STATUS_SCRATCH_OVERFLOW 4 /* NOT USED */
+#define SQLITE_STATUS_MALLOC_SIZE 5
+#define SQLITE_STATUS_PARSER_STACK 6
+#define SQLITE_STATUS_PAGECACHE_SIZE 7
+#define SQLITE_STATUS_SCRATCH_SIZE 8 /* NOT USED */
+#define SQLITE_STATUS_MALLOC_COUNT 9
+
+/*
+** CAPI3REF: Database Connection Status
+** METHOD: sqlite3
+**
+** ^This interface is used to retrieve runtime status information
+** about a single [database connection]. ^The first argument is the
+** database connection object to be interrogated. ^The second argument
+** is an integer constant, taken from the set of
+** [SQLITE_DBSTATUS options], that
+** determines the parameter to interrogate. The set of
+** [SQLITE_DBSTATUS options] is likely
+** to grow in future releases of SQLite.
+**
+** ^The current value of the requested parameter is written into *pCur
+** and the highest instantaneous value is written into *pHiwtr. ^If
+** the resetFlg is true, then the highest instantaneous value is
+** reset back down to the current value.
+**
+** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a
+** non-zero [error code] on failure.
+**
+** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
+*/
+SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);
+
+/*
+** CAPI3REF: Status Parameters for database connections
+** KEYWORDS: {SQLITE_DBSTATUS options}
+**
+** These constants are the available integer "verbs" that can be passed as
+** the second argument to the [sqlite3_db_status()] interface.
+**
+** New verbs may be added in future releases of SQLite. Existing verbs
+** might be discontinued. Applications should check the return code from
+** [sqlite3_db_status()] to make sure that the call worked.
+** The [sqlite3_db_status()] interface will return a non-zero error code
+** if a discontinued or unsupported verb is invoked.
+**
+** <dl>
+** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt>
+** <dd>This parameter returns the number of lookaside memory slots currently
+** checked out.</dd>)^
+**
+** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt>
+** <dd>This parameter returns the number of malloc attempts that were
+** satisfied using lookaside memory. Only the high-water value is meaningful;
+** the current value is always zero.)^
+**
+** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]]
+** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt>
+** <dd>This parameter returns the number malloc attempts that might have
+** been satisfied using lookaside memory but failed due to the amount of
+** memory requested being larger than the lookaside slot size.
+** Only the high-water value is meaningful;
+** the current value is always zero.)^
+**
+** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]]
+** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt>
+** <dd>This parameter returns the number malloc attempts that might have
+** been satisfied using lookaside memory but failed due to all lookaside
+** memory already being in use.
+** Only the high-water value is meaningful;
+** the current value is always zero.)^
+**
+** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt>
+** <dd>This parameter returns the approximate number of bytes of heap
+** memory used by all pager caches associated with the database connection.)^
+** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0.
+**
+** [[SQLITE_DBSTATUS_CACHE_USED_SHARED]]
+** ^(<dt>SQLITE_DBSTATUS_CACHE_USED_SHARED</dt>
+** <dd>This parameter is similar to DBSTATUS_CACHE_USED, except that if a
+** pager cache is shared between two or more connections the bytes of heap
+** memory used by that pager cache is divided evenly between the attached
+** connections.)^ In other words, if none of the pager caches associated
+** with the database connection are shared, this request returns the same
+** value as DBSTATUS_CACHE_USED. Or, if one or more or the pager caches are
+** shared, the value returned by this call will be smaller than that returned
+** by DBSTATUS_CACHE_USED. ^The highwater mark associated with
+** SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0.
+**
+** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt>
+** <dd>This parameter returns the approximate number of bytes of heap
+** memory used to store the schema for all databases associated
+** with the connection - main, temp, and any [ATTACH]-ed databases.)^
+** ^The full amount of memory used by the schemas is reported, even if the
+** schema memory is shared with other database connections due to
+** [shared cache mode] being enabled.
+** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0.
+**
+** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt>
+** <dd>This parameter returns the approximate number of bytes of heap
+** and lookaside memory used by all prepared statements associated with
+** the database connection.)^
+** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0.
+** </dd>
+**
+** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt>
+** <dd>This parameter returns the number of pager cache hits that have
+** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT
+** is always 0.
+** </dd>
+**
+** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt>
+** <dd>This parameter returns the number of pager cache misses that have
+** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS
+** is always 0.
+** </dd>
+**
+** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt>
+** <dd>This parameter returns the number of dirty cache entries that have
+** been written to disk. Specifically, the number of pages written to the
+** wal file in wal mode databases, or the number of pages written to the
+** database file in rollback mode databases. Any pages written as part of
+** transaction rollback or database recovery operations are not included.
+** If an IO or other error occurs while writing a page to disk, the effect
+** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The
+** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0.
+** </dd>
+**
+** [[SQLITE_DBSTATUS_CACHE_SPILL]] ^(<dt>SQLITE_DBSTATUS_CACHE_SPILL</dt>
+** <dd>This parameter returns the number of dirty cache entries that have
+** been written to disk in the middle of a transaction due to the page
+** cache overflowing. Transactions are more efficient if they are written
+** to disk all at once. When pages spill mid-transaction, that introduces
+** additional overhead. This parameter can be used help identify
+** inefficiencies that can be resolved by increasing the cache size.
+** </dd>
+**
+** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(<dt>SQLITE_DBSTATUS_DEFERRED_FKS</dt>
+** <dd>This parameter returns zero for the current value if and only if
+** all foreign key constraints (deferred or immediate) have been
+** resolved.)^ ^The highwater mark is always 0.
+** </dd>
+** </dl>
+*/
+#define SQLITE_DBSTATUS_LOOKASIDE_USED 0
+#define SQLITE_DBSTATUS_CACHE_USED 1
+#define SQLITE_DBSTATUS_SCHEMA_USED 2
+#define SQLITE_DBSTATUS_STMT_USED 3
+#define SQLITE_DBSTATUS_LOOKASIDE_HIT 4
+#define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5
+#define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6
+#define SQLITE_DBSTATUS_CACHE_HIT 7
+#define SQLITE_DBSTATUS_CACHE_MISS 8
+#define SQLITE_DBSTATUS_CACHE_WRITE 9
+#define SQLITE_DBSTATUS_DEFERRED_FKS 10
+#define SQLITE_DBSTATUS_CACHE_USED_SHARED 11
+#define SQLITE_DBSTATUS_CACHE_SPILL 12
+#define SQLITE_DBSTATUS_MAX 12 /* Largest defined DBSTATUS */
+
+
+/*
+** CAPI3REF: Prepared Statement Status
+** METHOD: sqlite3_stmt
+**
+** ^(Each prepared statement maintains various
+** [SQLITE_STMTSTATUS counters] that measure the number
+** of times it has performed specific operations.)^ These counters can
+** be used to monitor the performance characteristics of the prepared
+** statements. For example, if the number of table steps greatly exceeds
+** the number of table searches or result rows, that would tend to indicate
+** that the prepared statement is using a full table scan rather than
+** an index.
+**
+** ^(This interface is used to retrieve and reset counter values from
+** a [prepared statement]. The first argument is the prepared statement
+** object to be interrogated. The second argument
+** is an integer code for a specific [SQLITE_STMTSTATUS counter]
+** to be interrogated.)^
+** ^The current value of the requested counter is returned.
+** ^If the resetFlg is true, then the counter is reset to zero after this
+** interface call returns.
+**
+** See also: [sqlite3_status()] and [sqlite3_db_status()].
+*/
+SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
+
+/*
+** CAPI3REF: Status Parameters for prepared statements
+** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters}
+**
+** These preprocessor macros define integer codes that name counter
+** values associated with the [sqlite3_stmt_status()] interface.
+** The meanings of the various counters are as follows:
+**
+** <dl>
+** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>
+** <dd>^This is the number of times that SQLite has stepped forward in
+** a table as part of a full table scan. Large numbers for this counter
+** may indicate opportunities for performance improvement through
+** careful use of indices.</dd>
+**
+** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt>
+** <dd>^This is the number of sort operations that have occurred.
+** A non-zero value in this counter may indicate an opportunity to
+** improvement performance through careful use of indices.</dd>
+**
+** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt>
+** <dd>^This is the number of rows inserted into transient indices that
+** were created automatically in order to help joins run faster.
+** A non-zero value in this counter may indicate an opportunity to
+** improvement performance by adding permanent indices that do not
+** need to be reinitialized each time the statement is run.</dd>
+**
+** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt>
+** <dd>^This is the number of virtual machine operations executed
+** by the prepared statement if that number is less than or equal
+** to 2147483647. The number of virtual machine operations can be
+** used as a proxy for the total work done by the prepared statement.
+** If the number of virtual machine operations exceeds 2147483647
+** then the value returned by this statement status code is undefined.
+**
+** [[SQLITE_STMTSTATUS_REPREPARE]] <dt>SQLITE_STMTSTATUS_REPREPARE</dt>
+** <dd>^This is the number of times that the prepare statement has been
+** automatically regenerated due to schema changes or changes to
+** [bound parameters] that might affect the query plan.
+**
+** [[SQLITE_STMTSTATUS_RUN]] <dt>SQLITE_STMTSTATUS_RUN</dt>
+** <dd>^This is the number of times that the prepared statement has
+** been run. A single "run" for the purposes of this counter is one
+** or more calls to [sqlite3_step()] followed by a call to [sqlite3_reset()].
+** The counter is incremented on the first [sqlite3_step()] call of each
+** cycle.
+**
+** [[SQLITE_STMTSTATUS_MEMUSED]] <dt>SQLITE_STMTSTATUS_MEMUSED</dt>
+** <dd>^This is the approximate number of bytes of heap memory
+** used to store the prepared statement. ^This value is not actually
+** a counter, and so the resetFlg parameter to sqlite3_stmt_status()
+** is ignored when the opcode is SQLITE_STMTSTATUS_MEMUSED.
+** </dd>
+** </dl>
+*/
+#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1
+#define SQLITE_STMTSTATUS_SORT 2
+#define SQLITE_STMTSTATUS_AUTOINDEX 3
+#define SQLITE_STMTSTATUS_VM_STEP 4
+#define SQLITE_STMTSTATUS_REPREPARE 5
+#define SQLITE_STMTSTATUS_RUN 6
+#define SQLITE_STMTSTATUS_MEMUSED 99
+
+/*
+** CAPI3REF: Custom Page Cache Object
+**
+** The sqlite3_pcache type is opaque. It is implemented by
+** the pluggable module. The SQLite core has no knowledge of
+** its size or internal structure and never deals with the
+** sqlite3_pcache object except by holding and passing pointers
+** to the object.
+**
+** See [sqlite3_pcache_methods2] for additional information.
+*/
+typedef struct sqlite3_pcache sqlite3_pcache;
+
+/*
+** CAPI3REF: Custom Page Cache Object
+**
+** The sqlite3_pcache_page object represents a single page in the
+** page cache. The page cache will allocate instances of this
+** object. Various methods of the page cache use pointers to instances
+** of this object as parameters or as their return value.
+**
+** See [sqlite3_pcache_methods2] for additional information.
+*/
+typedef struct sqlite3_pcache_page sqlite3_pcache_page;
+struct sqlite3_pcache_page {
+ void *pBuf; /* The content of the page */
+ void *pExtra; /* Extra information associated with the page */
+};
+
+/*
+** CAPI3REF: Application Defined Page Cache.
+** KEYWORDS: {page cache}
+**
+** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can
+** register an alternative page cache implementation by passing in an
+** instance of the sqlite3_pcache_methods2 structure.)^
+** In many applications, most of the heap memory allocated by
+** SQLite is used for the page cache.
+** By implementing a
+** custom page cache using this API, an application can better control
+** the amount of memory consumed by SQLite, the way in which
+** that memory is allocated and released, and the policies used to
+** determine exactly which parts of a database file are cached and for
+** how long.
+**
+** The alternative page cache mechanism is an
+** extreme measure that is only needed by the most demanding applications.
+** The built-in page cache is recommended for most uses.
+**
+** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an
+** internal buffer by SQLite within the call to [sqlite3_config]. Hence
+** the application may discard the parameter after the call to
+** [sqlite3_config()] returns.)^
+**
+** [[the xInit() page cache method]]
+** ^(The xInit() method is called once for each effective
+** call to [sqlite3_initialize()])^
+** (usually only once during the lifetime of the process). ^(The xInit()
+** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^
+** The intent of the xInit() method is to set up global data structures
+** required by the custom page cache implementation.
+** ^(If the xInit() method is NULL, then the
+** built-in default page cache is used instead of the application defined
+** page cache.)^
+**
+** [[the xShutdown() page cache method]]
+** ^The xShutdown() method is called by [sqlite3_shutdown()].
+** It can be used to clean up
+** any outstanding resources before process shutdown, if required.
+** ^The xShutdown() method may be NULL.
+**
+** ^SQLite automatically serializes calls to the xInit method,
+** so the xInit method need not be threadsafe. ^The
+** xShutdown method is only called from [sqlite3_shutdown()] so it does
+** not need to be threadsafe either. All other methods must be threadsafe
+** in multithreaded applications.
+**
+** ^SQLite will never invoke xInit() more than once without an intervening
+** call to xShutdown().
+**
+** [[the xCreate() page cache methods]]
+** ^SQLite invokes the xCreate() method to construct a new cache instance.
+** SQLite will typically create one cache instance for each open database file,
+** though this is not guaranteed. ^The
+** first parameter, szPage, is the size in bytes of the pages that must
+** be allocated by the cache. ^szPage will always a power of two. ^The
+** second parameter szExtra is a number of bytes of extra storage
+** associated with each page cache entry. ^The szExtra parameter will
+** a number less than 250. SQLite will use the
+** extra szExtra bytes on each page to store metadata about the underlying
+** database page on disk. The value passed into szExtra depends
+** on the SQLite version, the target platform, and how SQLite was compiled.
+** ^The third argument to xCreate(), bPurgeable, is true if the cache being
+** created will be used to cache database pages of a file stored on disk, or
+** false if it is used for an in-memory database. The cache implementation
+** does not have to do anything special based with the value of bPurgeable;
+** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will
+** never invoke xUnpin() except to deliberately delete a page.
+** ^In other words, calls to xUnpin() on a cache with bPurgeable set to
+** false will always have the "discard" flag set to true.
+** ^Hence, a cache created with bPurgeable false will
+** never contain any unpinned pages.
+**
+** [[the xCachesize() page cache method]]
+** ^(The xCachesize() method may be called at any time by SQLite to set the
+** suggested maximum cache-size (number of pages stored by) the cache
+** instance passed as the first argument. This is the value configured using
+** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable
+** parameter, the implementation is not required to do anything with this
+** value; it is advisory only.
+**
+** [[the xPagecount() page cache methods]]
+** The xPagecount() method must return the number of pages currently
+** stored in the cache, both pinned and unpinned.
+**
+** [[the xFetch() page cache methods]]
+** The xFetch() method locates a page in the cache and returns a pointer to
+** an sqlite3_pcache_page object associated with that page, or a NULL pointer.
+** The pBuf element of the returned sqlite3_pcache_page object will be a
+** pointer to a buffer of szPage bytes used to store the content of a
+** single database page. The pExtra element of sqlite3_pcache_page will be
+** a pointer to the szExtra bytes of extra storage that SQLite has requested
+** for each entry in the page cache.
+**
+** The page to be fetched is determined by the key. ^The minimum key value
+** is 1. After it has been retrieved using xFetch, the page is considered
+** to be "pinned".
+**
+** If the requested page is already in the page cache, then the page cache
+** implementation must return a pointer to the page buffer with its content
+** intact. If the requested page is not already in the cache, then the
+** cache implementation should use the value of the createFlag
+** parameter to help it determined what action to take:
+**
+** <table border=1 width=85% align=center>
+** <tr><th> createFlag <th> Behavior when page is not already in cache
+** <tr><td> 0 <td> Do not allocate a new page. Return NULL.
+** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so.
+** Otherwise return NULL.
+** <tr><td> 2 <td> Make every effort to allocate a new page. Only return
+** NULL if allocating a new page is effectively impossible.
+** </table>
+**
+** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite
+** will only use a createFlag of 2 after a prior call with a createFlag of 1
+** failed.)^ In between the xFetch() calls, SQLite may
+** attempt to unpin one or more cache pages by spilling the content of
+** pinned pages to disk and synching the operating system disk cache.
+**
+** [[the xUnpin() page cache method]]
+** ^xUnpin() is called by SQLite with a pointer to a currently pinned page
+** as its second argument. If the third parameter, discard, is non-zero,
+** then the page must be evicted from the cache.
+** ^If the discard parameter is
+** zero, then the page may be discarded or retained at the discretion of
+** page cache implementation. ^The page cache implementation
+** may choose to evict unpinned pages at any time.
+**
+** The cache must not perform any reference counting. A single
+** call to xUnpin() unpins the page regardless of the number of prior calls
+** to xFetch().
+**
+** [[the xRekey() page cache methods]]
+** The xRekey() method is used to change the key value associated with the
+** page passed as the second argument. If the cache
+** previously contains an entry associated with newKey, it must be
+** discarded. ^Any prior cache entry associated with newKey is guaranteed not
+** to be pinned.
+**
+** When SQLite calls the xTruncate() method, the cache must discard all
+** existing cache entries with page numbers (keys) greater than or equal
+** to the value of the iLimit parameter passed to xTruncate(). If any
+** of these pages are pinned, they are implicitly unpinned, meaning that
+** they can be safely discarded.
+**
+** [[the xDestroy() page cache method]]
+** ^The xDestroy() method is used to delete a cache allocated by xCreate().
+** All resources associated with the specified cache should be freed. ^After
+** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*]
+** handle invalid, and will not use it with any other sqlite3_pcache_methods2
+** functions.
+**
+** [[the xShrink() page cache method]]
+** ^SQLite invokes the xShrink() method when it wants the page cache to
+** free up as much of heap memory as possible. The page cache implementation
+** is not obligated to free any memory, but well-behaved implementations should
+** do their best.
+*/
+typedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2;
+struct sqlite3_pcache_methods2 {
+ int iVersion;
+ void *pArg;
+ int (*xInit)(void*);
+ void (*xShutdown)(void*);
+ sqlite3_pcache *(*xCreate)(int szPage, int szExtra, int bPurgeable);
+ void (*xCachesize)(sqlite3_pcache*, int nCachesize);
+ int (*xPagecount)(sqlite3_pcache*);
+ sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
+ void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard);
+ void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*,
+ unsigned oldKey, unsigned newKey);
+ void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
+ void (*xDestroy)(sqlite3_pcache*);
+ void (*xShrink)(sqlite3_pcache*);
+};
+
+/*
+** This is the obsolete pcache_methods object that has now been replaced
+** by sqlite3_pcache_methods2. This object is not used by SQLite. It is
+** retained in the header file for backwards compatibility only.
+*/
+typedef struct sqlite3_pcache_methods sqlite3_pcache_methods;
+struct sqlite3_pcache_methods {
+ void *pArg;
+ int (*xInit)(void*);
+ void (*xShutdown)(void*);
+ sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable);
+ void (*xCachesize)(sqlite3_pcache*, int nCachesize);
+ int (*xPagecount)(sqlite3_pcache*);
+ void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
+ void (*xUnpin)(sqlite3_pcache*, void*, int discard);
+ void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey);
+ void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
+ void (*xDestroy)(sqlite3_pcache*);
+};
+
+
+/*
+** CAPI3REF: Online Backup Object
+**
+** The sqlite3_backup object records state information about an ongoing
+** online backup operation. ^The sqlite3_backup object is created by
+** a call to [sqlite3_backup_init()] and is destroyed by a call to
+** [sqlite3_backup_finish()].
+**
+** See Also: [Using the SQLite Online Backup API]
+*/
+typedef struct sqlite3_backup sqlite3_backup;
+
+/*
+** CAPI3REF: Online Backup API.
+**
+** The backup API copies the content of one database into another.
+** It is useful either for creating backups of databases or
+** for copying in-memory databases to or from persistent files.
+**
+** See Also: [Using the SQLite Online Backup API]
+**
+** ^SQLite holds a write transaction open on the destination database file
+** for the duration of the backup operation.
+** ^The source database is read-locked only while it is being read;
+** it is not locked continuously for the entire backup operation.
+** ^Thus, the backup may be performed on a live source database without
+** preventing other database connections from
+** reading or writing to the source database while the backup is underway.
+**
+** ^(To perform a backup operation:
+** <ol>
+** <li><b>sqlite3_backup_init()</b> is called once to initialize the
+** backup,
+** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer
+** the data between the two databases, and finally
+** <li><b>sqlite3_backup_finish()</b> is called to release all resources
+** associated with the backup operation.
+** </ol>)^
+** There should be exactly one call to sqlite3_backup_finish() for each
+** successful call to sqlite3_backup_init().
+**
+** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b>
+**
+** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the
+** [database connection] associated with the destination database
+** and the database name, respectively.
+** ^The database name is "main" for the main database, "temp" for the
+** temporary database, or the name specified after the AS keyword in
+** an [ATTACH] statement for an attached database.
+** ^The S and M arguments passed to
+** sqlite3_backup_init(D,N,S,M) identify the [database connection]
+** and database name of the source database, respectively.
+** ^The source and destination [database connections] (parameters S and D)
+** must be different or else sqlite3_backup_init(D,N,S,M) will fail with
+** an error.
+**
+** ^A call to sqlite3_backup_init() will fail, returning NULL, if
+** there is already a read or read-write transaction open on the
+** destination database.
+**
+** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is
+** returned and an error code and error message are stored in the
+** destination [database connection] D.
+** ^The error code and message for the failed call to sqlite3_backup_init()
+** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or
+** [sqlite3_errmsg16()] functions.
+** ^A successful call to sqlite3_backup_init() returns a pointer to an
+** [sqlite3_backup] object.
+** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and
+** sqlite3_backup_finish() functions to perform the specified backup
+** operation.
+**
+** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b>
+**
+** ^Function sqlite3_backup_step(B,N) will copy up to N pages between
+** the source and destination databases specified by [sqlite3_backup] object B.
+** ^If N is negative, all remaining source pages are copied.
+** ^If sqlite3_backup_step(B,N) successfully copies N pages and there
+** are still more pages to be copied, then the function returns [SQLITE_OK].
+** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages
+** from source to destination, then it returns [SQLITE_DONE].
+** ^If an error occurs while running sqlite3_backup_step(B,N),
+** then an [error code] is returned. ^As well as [SQLITE_OK] and
+** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY],
+** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an
+** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code.
+**
+** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if
+** <ol>
+** <li> the destination database was opened read-only, or
+** <li> the destination database is using write-ahead-log journaling
+** and the destination and source page sizes differ, or
+** <li> the destination database is an in-memory database and the
+** destination and source page sizes differ.
+** </ol>)^
+**
+** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then
+** the [sqlite3_busy_handler | busy-handler function]
+** is invoked (if one is specified). ^If the
+** busy-handler returns non-zero before the lock is available, then
+** [SQLITE_BUSY] is returned to the caller. ^In this case the call to
+** sqlite3_backup_step() can be retried later. ^If the source
+** [database connection]
+** is being used to write to the source database when sqlite3_backup_step()
+** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this
+** case the call to sqlite3_backup_step() can be retried later on. ^(If
+** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or
+** [SQLITE_READONLY] is returned, then
+** there is no point in retrying the call to sqlite3_backup_step(). These
+** errors are considered fatal.)^ The application must accept
+** that the backup operation has failed and pass the backup operation handle
+** to the sqlite3_backup_finish() to release associated resources.
+**
+** ^The first call to sqlite3_backup_step() obtains an exclusive lock
+** on the destination file. ^The exclusive lock is not released until either
+** sqlite3_backup_finish() is called or the backup operation is complete
+** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to
+** sqlite3_backup_step() obtains a [shared lock] on the source database that
+** lasts for the duration of the sqlite3_backup_step() call.
+** ^Because the source database is not locked between calls to
+** sqlite3_backup_step(), the source database may be modified mid-way
+** through the backup process. ^If the source database is modified by an
+** external process or via a database connection other than the one being
+** used by the backup operation, then the backup will be automatically
+** restarted by the next call to sqlite3_backup_step(). ^If the source
+** database is modified by the using the same database connection as is used
+** by the backup operation, then the backup database is automatically
+** updated at the same time.
+**
+** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b>
+**
+** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the
+** application wishes to abandon the backup operation, the application
+** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish().
+** ^The sqlite3_backup_finish() interfaces releases all
+** resources associated with the [sqlite3_backup] object.
+** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any
+** active write-transaction on the destination database is rolled back.
+** The [sqlite3_backup] object is invalid
+** and may not be used following a call to sqlite3_backup_finish().
+**
+** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no
+** sqlite3_backup_step() errors occurred, regardless or whether or not
+** sqlite3_backup_step() completed.
+** ^If an out-of-memory condition or IO error occurred during any prior
+** sqlite3_backup_step() call on the same [sqlite3_backup] object, then
+** sqlite3_backup_finish() returns the corresponding [error code].
+**
+** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step()
+** is not a permanent error and does not affect the return value of
+** sqlite3_backup_finish().
+**
+** [[sqlite3_backup_remaining()]] [[sqlite3_backup_pagecount()]]
+** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b>
+**
+** ^The sqlite3_backup_remaining() routine returns the number of pages still
+** to be backed up at the conclusion of the most recent sqlite3_backup_step().
+** ^The sqlite3_backup_pagecount() routine returns the total number of pages
+** in the source database at the conclusion of the most recent
+** sqlite3_backup_step().
+** ^(The values returned by these functions are only updated by
+** sqlite3_backup_step(). If the source database is modified in a way that
+** changes the size of the source database or the number of pages remaining,
+** those changes are not reflected in the output of sqlite3_backup_pagecount()
+** and sqlite3_backup_remaining() until after the next
+** sqlite3_backup_step().)^
+**
+** <b>Concurrent Usage of Database Handles</b>
+**
+** ^The source [database connection] may be used by the application for other
+** purposes while a backup operation is underway or being initialized.
+** ^If SQLite is compiled and configured to support threadsafe database
+** connections, then the source database connection may be used concurrently
+** from within other threads.
+**
+** However, the application must guarantee that the destination
+** [database connection] is not passed to any other API (by any thread) after
+** sqlite3_backup_init() is called and before the corresponding call to
+** sqlite3_backup_finish(). SQLite does not currently check to see
+** if the application incorrectly accesses the destination [database connection]
+** and so no error code is reported, but the operations may malfunction
+** nevertheless. Use of the destination database connection while a
+** backup is in progress might also also cause a mutex deadlock.
+**
+** If running in [shared cache mode], the application must
+** guarantee that the shared cache used by the destination database
+** is not accessed while the backup is running. In practice this means
+** that the application must guarantee that the disk file being
+** backed up to is not accessed by any connection within the process,
+** not just the specific connection that was passed to sqlite3_backup_init().
+**
+** The [sqlite3_backup] object itself is partially threadsafe. Multiple
+** threads may safely make multiple concurrent calls to sqlite3_backup_step().
+** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount()
+** APIs are not strictly speaking threadsafe. If they are invoked at the
+** same time as another thread is invoking sqlite3_backup_step() it is
+** possible that they return invalid values.
+*/
+SQLITE_API sqlite3_backup *sqlite3_backup_init(
+ sqlite3 *pDest, /* Destination database handle */
+ const char *zDestName, /* Destination database name */
+ sqlite3 *pSource, /* Source database handle */
+ const char *zSourceName /* Source database name */
+);
+SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage);
+SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p);
+SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p);
+SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p);
+
+/*
+** CAPI3REF: Unlock Notification
+** METHOD: sqlite3
+**
+** ^When running in shared-cache mode, a database operation may fail with
+** an [SQLITE_LOCKED] error if the required locks on the shared-cache or
+** individual tables within the shared-cache cannot be obtained. See
+** [SQLite Shared-Cache Mode] for a description of shared-cache locking.
+** ^This API may be used to register a callback that SQLite will invoke
+** when the connection currently holding the required lock relinquishes it.
+** ^This API is only available if the library was compiled with the
+** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined.
+**
+** See Also: [Using the SQLite Unlock Notification Feature].
+**
+** ^Shared-cache locks are released when a database connection concludes
+** its current transaction, either by committing it or rolling it back.
+**
+** ^When a connection (known as the blocked connection) fails to obtain a
+** shared-cache lock and SQLITE_LOCKED is returned to the caller, the
+** identity of the database connection (the blocking connection) that
+** has locked the required resource is stored internally. ^After an
+** application receives an SQLITE_LOCKED error, it may call the
+** sqlite3_unlock_notify() method with the blocked connection handle as
+** the first argument to register for a callback that will be invoked
+** when the blocking connections current transaction is concluded. ^The
+** callback is invoked from within the [sqlite3_step] or [sqlite3_close]
+** call that concludes the blocking connection's transaction.
+**
+** ^(If sqlite3_unlock_notify() is called in a multi-threaded application,
+** there is a chance that the blocking connection will have already
+** concluded its transaction by the time sqlite3_unlock_notify() is invoked.
+** If this happens, then the specified callback is invoked immediately,
+** from within the call to sqlite3_unlock_notify().)^
+**
+** ^If the blocked connection is attempting to obtain a write-lock on a
+** shared-cache table, and more than one other connection currently holds
+** a read-lock on the same table, then SQLite arbitrarily selects one of
+** the other connections to use as the blocking connection.
+**
+** ^(There may be at most one unlock-notify callback registered by a
+** blocked connection. If sqlite3_unlock_notify() is called when the
+** blocked connection already has a registered unlock-notify callback,
+** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is
+** called with a NULL pointer as its second argument, then any existing
+** unlock-notify callback is canceled. ^The blocked connections
+** unlock-notify callback may also be canceled by closing the blocked
+** connection using [sqlite3_close()].
+**
+** The unlock-notify callback is not reentrant. If an application invokes
+** any sqlite3_xxx API functions from within an unlock-notify callback, a
+** crash or deadlock may be the result.
+**
+** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always
+** returns SQLITE_OK.
+**
+** <b>Callback Invocation Details</b>
+**
+** When an unlock-notify callback is registered, the application provides a
+** single void* pointer that is passed to the callback when it is invoked.
+** However, the signature of the callback function allows SQLite to pass
+** it an array of void* context pointers. The first argument passed to
+** an unlock-notify callback is a pointer to an array of void* pointers,
+** and the second is the number of entries in the array.
+**
+** When a blocking connection's transaction is concluded, there may be
+** more than one blocked connection that has registered for an unlock-notify
+** callback. ^If two or more such blocked connections have specified the
+** same callback function, then instead of invoking the callback function
+** multiple times, it is invoked once with the set of void* context pointers
+** specified by the blocked connections bundled together into an array.
+** This gives the application an opportunity to prioritize any actions
+** related to the set of unblocked database connections.
+**
+** <b>Deadlock Detection</b>
+**
+** Assuming that after registering for an unlock-notify callback a
+** database waits for the callback to be issued before taking any further
+** action (a reasonable assumption), then using this API may cause the
+** application to deadlock. For example, if connection X is waiting for
+** connection Y's transaction to be concluded, and similarly connection
+** Y is waiting on connection X's transaction, then neither connection
+** will proceed and the system may remain deadlocked indefinitely.
+**
+** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock
+** detection. ^If a given call to sqlite3_unlock_notify() would put the
+** system in a deadlocked state, then SQLITE_LOCKED is returned and no
+** unlock-notify callback is registered. The system is said to be in
+** a deadlocked state if connection A has registered for an unlock-notify
+** callback on the conclusion of connection B's transaction, and connection
+** B has itself registered for an unlock-notify callback when connection
+** A's transaction is concluded. ^Indirect deadlock is also detected, so
+** the system is also considered to be deadlocked if connection B has
+** registered for an unlock-notify callback on the conclusion of connection
+** C's transaction, where connection C is waiting on connection A. ^Any
+** number of levels of indirection are allowed.
+**
+** <b>The "DROP TABLE" Exception</b>
+**
+** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost
+** always appropriate to call sqlite3_unlock_notify(). There is however,
+** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement,
+** SQLite checks if there are any currently executing SELECT statements
+** that belong to the same connection. If there are, SQLITE_LOCKED is
+** returned. In this case there is no "blocking connection", so invoking
+** sqlite3_unlock_notify() results in the unlock-notify callback being
+** invoked immediately. If the application then re-attempts the "DROP TABLE"
+** or "DROP INDEX" query, an infinite loop might be the result.
+**
+** One way around this problem is to check the extended error code returned
+** by an sqlite3_step() call. ^(If there is a blocking connection, then the
+** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in
+** the special "DROP TABLE/INDEX" case, the extended error code is just
+** SQLITE_LOCKED.)^
+*/
+SQLITE_API int sqlite3_unlock_notify(
+ sqlite3 *pBlocked, /* Waiting connection */
+ void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */
+ void *pNotifyArg /* Argument to pass to xNotify */
+);
+
+
+/*
+** CAPI3REF: String Comparison
+**
+** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications
+** and extensions to compare the contents of two buffers containing UTF-8
+** strings in a case-independent fashion, using the same definition of "case
+** independence" that SQLite uses internally when comparing identifiers.
+*/
+SQLITE_API int sqlite3_stricmp(const char *, const char *);
+SQLITE_API int sqlite3_strnicmp(const char *, const char *, int);
+
+/*
+** CAPI3REF: String Globbing
+*
+** ^The [sqlite3_strglob(P,X)] interface returns zero if and only if
+** string X matches the [GLOB] pattern P.
+** ^The definition of [GLOB] pattern matching used in
+** [sqlite3_strglob(P,X)] is the same as for the "X GLOB P" operator in the
+** SQL dialect understood by SQLite. ^The [sqlite3_strglob(P,X)] function
+** is case sensitive.
+**
+** Note that this routine returns zero on a match and non-zero if the strings
+** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()].
+**
+** See also: [sqlite3_strlike()].
+*/
+SQLITE_API int sqlite3_strglob(const char *zGlob, const char *zStr);
+
+/*
+** CAPI3REF: String LIKE Matching
+*
+** ^The [sqlite3_strlike(P,X,E)] interface returns zero if and only if
+** string X matches the [LIKE] pattern P with escape character E.
+** ^The definition of [LIKE] pattern matching used in
+** [sqlite3_strlike(P,X,E)] is the same as for the "X LIKE P ESCAPE E"
+** operator in the SQL dialect understood by SQLite. ^For "X LIKE P" without
+** the ESCAPE clause, set the E parameter of [sqlite3_strlike(P,X,E)] to 0.
+** ^As with the LIKE operator, the [sqlite3_strlike(P,X,E)] function is case
+** insensitive - equivalent upper and lower case ASCII characters match
+** one another.
+**
+** ^The [sqlite3_strlike(P,X,E)] function matches Unicode characters, though
+** only ASCII characters are case folded.
+**
+** Note that this routine returns zero on a match and non-zero if the strings
+** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()].
+**
+** See also: [sqlite3_strglob()].
+*/
+SQLITE_API int sqlite3_strlike(const char *zGlob, const char *zStr, unsigned int cEsc);
+
+/*
+** CAPI3REF: Error Logging Interface
+**
+** ^The [sqlite3_log()] interface writes a message into the [error log]
+** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()].
+** ^If logging is enabled, the zFormat string and subsequent arguments are
+** used with [sqlite3_snprintf()] to generate the final output string.
+**
+** The sqlite3_log() interface is intended for use by extensions such as
+** virtual tables, collating functions, and SQL functions. While there is
+** nothing to prevent an application from calling sqlite3_log(), doing so
+** is considered bad form.
+**
+** The zFormat string must not be NULL.
+**
+** To avoid deadlocks and other threading problems, the sqlite3_log() routine
+** will not use dynamically allocated memory. The log message is stored in
+** a fixed-length buffer on the stack. If the log message is longer than
+** a few hundred characters, it will be truncated to the length of the
+** buffer.
+*/
+SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...);
+
+/*
+** CAPI3REF: Write-Ahead Log Commit Hook
+** METHOD: sqlite3
+**
+** ^The [sqlite3_wal_hook()] function is used to register a callback that
+** is invoked each time data is committed to a database in wal mode.
+**
+** ^(The callback is invoked by SQLite after the commit has taken place and
+** the associated write-lock on the database released)^, so the implementation
+** may read, write or [checkpoint] the database as required.
+**
+** ^The first parameter passed to the callback function when it is invoked
+** is a copy of the third parameter passed to sqlite3_wal_hook() when
+** registering the callback. ^The second is a copy of the database handle.
+** ^The third parameter is the name of the database that was written to -
+** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter
+** is the number of pages currently in the write-ahead log file,
+** including those that were just committed.
+**
+** The callback function should normally return [SQLITE_OK]. ^If an error
+** code is returned, that error will propagate back up through the
+** SQLite code base to cause the statement that provoked the callback
+** to report an error, though the commit will have still occurred. If the
+** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value
+** that does not correspond to any valid SQLite error code, the results
+** are undefined.
+**
+** A single database handle may have at most a single write-ahead log callback
+** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any
+** previously registered write-ahead log callback. ^Note that the
+** [sqlite3_wal_autocheckpoint()] interface and the
+** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will
+** overwrite any prior [sqlite3_wal_hook()] settings.
+*/
+SQLITE_API void *sqlite3_wal_hook(
+ sqlite3*,
+ int(*)(void *,sqlite3*,const char*,int),
+ void*
+);
+
+/*
+** CAPI3REF: Configure an auto-checkpoint
+** METHOD: sqlite3
+**
+** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around
+** [sqlite3_wal_hook()] that causes any database on [database connection] D
+** to automatically [checkpoint]
+** after committing a transaction if there are N or
+** more frames in the [write-ahead log] file. ^Passing zero or
+** a negative value as the nFrame parameter disables automatic
+** checkpoints entirely.
+**
+** ^The callback registered by this function replaces any existing callback
+** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback
+** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism
+** configured by this function.
+**
+** ^The [wal_autocheckpoint pragma] can be used to invoke this interface
+** from SQL.
+**
+** ^Checkpoints initiated by this mechanism are
+** [sqlite3_wal_checkpoint_v2|PASSIVE].
+**
+** ^Every new [database connection] defaults to having the auto-checkpoint
+** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT]
+** pages. The use of this interface
+** is only necessary if the default setting is found to be suboptimal
+** for a particular application.
+*/
+SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N);
+
+/*
+** CAPI3REF: Checkpoint a database
+** METHOD: sqlite3
+**
+** ^(The sqlite3_wal_checkpoint(D,X) is equivalent to
+** [sqlite3_wal_checkpoint_v2](D,X,[SQLITE_CHECKPOINT_PASSIVE],0,0).)^
+**
+** In brief, sqlite3_wal_checkpoint(D,X) causes the content in the
+** [write-ahead log] for database X on [database connection] D to be
+** transferred into the database file and for the write-ahead log to
+** be reset. See the [checkpointing] documentation for addition
+** information.
+**
+** This interface used to be the only way to cause a checkpoint to
+** occur. But then the newer and more powerful [sqlite3_wal_checkpoint_v2()]
+** interface was added. This interface is retained for backwards
+** compatibility and as a convenience for applications that need to manually
+** start a callback but which do not need the full power (and corresponding
+** complication) of [sqlite3_wal_checkpoint_v2()].
+*/
+SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb);
+
+/*
+** CAPI3REF: Checkpoint a database
+** METHOD: sqlite3
+**
+** ^(The sqlite3_wal_checkpoint_v2(D,X,M,L,C) interface runs a checkpoint
+** operation on database X of [database connection] D in mode M. Status
+** information is written back into integers pointed to by L and C.)^
+** ^(The M parameter must be a valid [checkpoint mode]:)^
+**
+** <dl>
+** <dt>SQLITE_CHECKPOINT_PASSIVE<dd>
+** ^Checkpoint as many frames as possible without waiting for any database
+** readers or writers to finish, then sync the database file if all frames
+** in the log were checkpointed. ^The [busy-handler callback]
+** is never invoked in the SQLITE_CHECKPOINT_PASSIVE mode.
+** ^On the other hand, passive mode might leave the checkpoint unfinished
+** if there are concurrent readers or writers.
+**
+** <dt>SQLITE_CHECKPOINT_FULL<dd>
+** ^This mode blocks (it invokes the
+** [sqlite3_busy_handler|busy-handler callback]) until there is no
+** database writer and all readers are reading from the most recent database
+** snapshot. ^It then checkpoints all frames in the log file and syncs the
+** database file. ^This mode blocks new database writers while it is pending,
+** but new database readers are allowed to continue unimpeded.
+**
+** <dt>SQLITE_CHECKPOINT_RESTART<dd>
+** ^This mode works the same way as SQLITE_CHECKPOINT_FULL with the addition
+** that after checkpointing the log file it blocks (calls the
+** [busy-handler callback])
+** until all readers are reading from the database file only. ^This ensures
+** that the next writer will restart the log file from the beginning.
+** ^Like SQLITE_CHECKPOINT_FULL, this mode blocks new
+** database writer attempts while it is pending, but does not impede readers.
+**
+** <dt>SQLITE_CHECKPOINT_TRUNCATE<dd>
+** ^This mode works the same way as SQLITE_CHECKPOINT_RESTART with the
+** addition that it also truncates the log file to zero bytes just prior
+** to a successful return.
+** </dl>
+**
+** ^If pnLog is not NULL, then *pnLog is set to the total number of frames in
+** the log file or to -1 if the checkpoint could not run because
+** of an error or because the database is not in [WAL mode]. ^If pnCkpt is not
+** NULL,then *pnCkpt is set to the total number of checkpointed frames in the
+** log file (including any that were already checkpointed before the function
+** was called) or to -1 if the checkpoint could not run due to an error or
+** because the database is not in WAL mode. ^Note that upon successful
+** completion of an SQLITE_CHECKPOINT_TRUNCATE, the log file will have been
+** truncated to zero bytes and so both *pnLog and *pnCkpt will be set to zero.
+**
+** ^All calls obtain an exclusive "checkpoint" lock on the database file. ^If
+** any other process is running a checkpoint operation at the same time, the
+** lock cannot be obtained and SQLITE_BUSY is returned. ^Even if there is a
+** busy-handler configured, it will not be invoked in this case.
+**
+** ^The SQLITE_CHECKPOINT_FULL, RESTART and TRUNCATE modes also obtain the
+** exclusive "writer" lock on the database file. ^If the writer lock cannot be
+** obtained immediately, and a busy-handler is configured, it is invoked and
+** the writer lock retried until either the busy-handler returns 0 or the lock
+** is successfully obtained. ^The busy-handler is also invoked while waiting for
+** database readers as described above. ^If the busy-handler returns 0 before
+** the writer lock is obtained or while waiting for database readers, the
+** checkpoint operation proceeds from that point in the same way as
+** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible
+** without blocking any further. ^SQLITE_BUSY is returned in this case.
+**
+** ^If parameter zDb is NULL or points to a zero length string, then the
+** specified operation is attempted on all WAL databases [attached] to
+** [database connection] db. In this case the
+** values written to output parameters *pnLog and *pnCkpt are undefined. ^If
+** an SQLITE_BUSY error is encountered when processing one or more of the
+** attached WAL databases, the operation is still attempted on any remaining
+** attached databases and SQLITE_BUSY is returned at the end. ^If any other
+** error occurs while processing an attached database, processing is abandoned
+** and the error code is returned to the caller immediately. ^If no error
+** (SQLITE_BUSY or otherwise) is encountered while processing the attached
+** databases, SQLITE_OK is returned.
+**
+** ^If database zDb is the name of an attached database that is not in WAL
+** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. ^If
+** zDb is not NULL (or a zero length string) and is not the name of any
+** attached database, SQLITE_ERROR is returned to the caller.
+**
+** ^Unless it returns SQLITE_MISUSE,
+** the sqlite3_wal_checkpoint_v2() interface
+** sets the error information that is queried by
+** [sqlite3_errcode()] and [sqlite3_errmsg()].
+**
+** ^The [PRAGMA wal_checkpoint] command can be used to invoke this interface
+** from SQL.
+*/
+SQLITE_API int sqlite3_wal_checkpoint_v2(
+ sqlite3 *db, /* Database handle */
+ const char *zDb, /* Name of attached database (or NULL) */
+ int eMode, /* SQLITE_CHECKPOINT_* value */
+ int *pnLog, /* OUT: Size of WAL log in frames */
+ int *pnCkpt /* OUT: Total number of frames checkpointed */
+);
+
+/*
+** CAPI3REF: Checkpoint Mode Values
+** KEYWORDS: {checkpoint mode}
+**
+** These constants define all valid values for the "checkpoint mode" passed
+** as the third parameter to the [sqlite3_wal_checkpoint_v2()] interface.
+** See the [sqlite3_wal_checkpoint_v2()] documentation for details on the
+** meaning of each of these checkpoint modes.
+*/
+#define SQLITE_CHECKPOINT_PASSIVE 0 /* Do as much as possible w/o blocking */
+#define SQLITE_CHECKPOINT_FULL 1 /* Wait for writers, then checkpoint */
+#define SQLITE_CHECKPOINT_RESTART 2 /* Like FULL but wait for for readers */
+#define SQLITE_CHECKPOINT_TRUNCATE 3 /* Like RESTART but also truncate WAL */
+
+/*
+** CAPI3REF: Virtual Table Interface Configuration
+**
+** This function may be called by either the [xConnect] or [xCreate] method
+** of a [virtual table] implementation to configure
+** various facets of the virtual table interface.
+**
+** If this interface is invoked outside the context of an xConnect or
+** xCreate virtual table method then the behavior is undefined.
+**
+** In the call sqlite3_vtab_config(D,C,...) the D parameter is the
+** [database connection] in which the virtual table is being created and
+** which is passed in as the first argument to the [xConnect] or [xCreate]
+** method that is invoking sqlite3_vtab_config(). The C parameter is one
+** of the [virtual table configuration options]. The presence and meaning
+** of parameters after C depend on which [virtual table configuration option]
+** is used.
+*/
+SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...);
+
+/*
+** CAPI3REF: Virtual Table Configuration Options
+** KEYWORDS: {virtual table configuration options}
+** KEYWORDS: {virtual table configuration option}
+**
+** These macros define the various options to the
+** [sqlite3_vtab_config()] interface that [virtual table] implementations
+** can use to customize and optimize their behavior.
+**
+** <dl>
+** [[SQLITE_VTAB_CONSTRAINT_SUPPORT]]
+** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT</dt>
+** <dd>Calls of the form
+** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported,
+** where X is an integer. If X is zero, then the [virtual table] whose
+** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not
+** support constraints. In this configuration (which is the default) if
+** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire
+** statement is rolled back as if [ON CONFLICT | OR ABORT] had been
+** specified as part of the users SQL statement, regardless of the actual
+** ON CONFLICT mode specified.
+**
+** If X is non-zero, then the virtual table implementation guarantees
+** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before
+** any modifications to internal or persistent data structures have been made.
+** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite
+** is able to roll back a statement or database transaction, and abandon
+** or continue processing the current SQL statement as appropriate.
+** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns
+** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode
+** had been ABORT.
+**
+** Virtual table implementations that are required to handle OR REPLACE
+** must do so within the [xUpdate] method. If a call to the
+** [sqlite3_vtab_on_conflict()] function indicates that the current ON
+** CONFLICT policy is REPLACE, the virtual table implementation should
+** silently replace the appropriate rows within the xUpdate callback and
+** return SQLITE_OK. Or, if this is not possible, it may return
+** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT
+** constraint handling.
+** </dd>
+**
+** [[SQLITE_VTAB_DIRECTONLY]]<dt>SQLITE_VTAB_DIRECTONLY</dt>
+** <dd>Calls of the form
+** [sqlite3_vtab_config](db,SQLITE_VTAB_DIRECTONLY) from within the
+** the [xConnect] or [xCreate] methods of a [virtual table] implmentation
+** prohibits that virtual table from being used from within triggers and
+** views.
+** </dd>
+**
+** [[SQLITE_VTAB_INNOCUOUS]]<dt>SQLITE_VTAB_INNOCUOUS</dt>
+** <dd>Calls of the form
+** [sqlite3_vtab_config](db,SQLITE_VTAB_INNOCUOUS) from within the
+** the [xConnect] or [xCreate] methods of a [virtual table] implmentation
+** identify that virtual table as being safe to use from within triggers
+** and views. Conceptually, the SQLITE_VTAB_INNOCUOUS tag means that the
+** virtual table can do no serious harm even if it is controlled by a
+** malicious hacker. Developers should avoid setting the SQLITE_VTAB_INNOCUOUS
+** flag unless absolutely necessary.
+** </dd>
+** </dl>
+*/
+#define SQLITE_VTAB_CONSTRAINT_SUPPORT 1
+#define SQLITE_VTAB_INNOCUOUS 2
+#define SQLITE_VTAB_DIRECTONLY 3
+
+/*
+** CAPI3REF: Determine The Virtual Table Conflict Policy
+**
+** This function may only be called from within a call to the [xUpdate] method
+** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The
+** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL],
+** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode
+** of the SQL statement that triggered the call to the [xUpdate] method of the
+** [virtual table].
+*/
+SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *);
+
+/*
+** CAPI3REF: Determine If Virtual Table Column Access Is For UPDATE
+**
+** If the sqlite3_vtab_nochange(X) routine is called within the [xColumn]
+** method of a [virtual table], then it returns true if and only if the
+** column is being fetched as part of an UPDATE operation during which the
+** column value will not change. Applications might use this to substitute
+** a return value that is less expensive to compute and that the corresponding
+** [xUpdate] method understands as a "no-change" value.
+**
+** If the [xColumn] method calls sqlite3_vtab_nochange() and finds that
+** the column is not changed by the UPDATE statement, then the xColumn
+** method can optionally return without setting a result, without calling
+** any of the [sqlite3_result_int|sqlite3_result_xxxxx() interfaces].
+** In that case, [sqlite3_value_nochange(X)] will return true for the
+** same column in the [xUpdate] method.
+*/
+SQLITE_API int sqlite3_vtab_nochange(sqlite3_context*);
+
+/*
+** CAPI3REF: Determine The Collation For a Virtual Table Constraint
+**
+** This function may only be called from within a call to the [xBestIndex]
+** method of a [virtual table].
+**
+** The first argument must be the sqlite3_index_info object that is the
+** first parameter to the xBestIndex() method. The second argument must be
+** an index into the aConstraint[] array belonging to the sqlite3_index_info
+** structure passed to xBestIndex. This function returns a pointer to a buffer
+** containing the name of the collation sequence for the corresponding
+** constraint.
+*/
+SQLITE_API SQLITE_EXPERIMENTAL const char *sqlite3_vtab_collation(sqlite3_index_info*,int);
+
+/*
+** CAPI3REF: Conflict resolution modes
+** KEYWORDS: {conflict resolution mode}
+**
+** These constants are returned by [sqlite3_vtab_on_conflict()] to
+** inform a [virtual table] implementation what the [ON CONFLICT] mode
+** is for the SQL statement being evaluated.
+**
+** Note that the [SQLITE_IGNORE] constant is also used as a potential
+** return value from the [sqlite3_set_authorizer()] callback and that
+** [SQLITE_ABORT] is also a [result code].
+*/
+#define SQLITE_ROLLBACK 1
+/* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */
+#define SQLITE_FAIL 3
+/* #define SQLITE_ABORT 4 // Also an error code */
+#define SQLITE_REPLACE 5
+
+/*
+** CAPI3REF: Prepared Statement Scan Status Opcodes
+** KEYWORDS: {scanstatus options}
+**
+** The following constants can be used for the T parameter to the
+** [sqlite3_stmt_scanstatus(S,X,T,V)] interface. Each constant designates a
+** different metric for sqlite3_stmt_scanstatus() to return.
+**
+** When the value returned to V is a string, space to hold that string is
+** managed by the prepared statement S and will be automatically freed when
+** S is finalized.
+**
+** <dl>
+** [[SQLITE_SCANSTAT_NLOOP]] <dt>SQLITE_SCANSTAT_NLOOP</dt>
+** <dd>^The [sqlite3_int64] variable pointed to by the V parameter will be
+** set to the total number of times that the X-th loop has run.</dd>
+**
+** [[SQLITE_SCANSTAT_NVISIT]] <dt>SQLITE_SCANSTAT_NVISIT</dt>
+** <dd>^The [sqlite3_int64] variable pointed to by the V parameter will be set
+** to the total number of rows examined by all iterations of the X-th loop.</dd>
+**
+** [[SQLITE_SCANSTAT_EST]] <dt>SQLITE_SCANSTAT_EST</dt>
+** <dd>^The "double" variable pointed to by the V parameter will be set to the
+** query planner's estimate for the average number of rows output from each
+** iteration of the X-th loop. If the query planner's estimates was accurate,
+** then this value will approximate the quotient NVISIT/NLOOP and the
+** product of this value for all prior loops with the same SELECTID will
+** be the NLOOP value for the current loop.
+**
+** [[SQLITE_SCANSTAT_NAME]] <dt>SQLITE_SCANSTAT_NAME</dt>
+** <dd>^The "const char *" variable pointed to by the V parameter will be set
+** to a zero-terminated UTF-8 string containing the name of the index or table
+** used for the X-th loop.
+**
+** [[SQLITE_SCANSTAT_EXPLAIN]] <dt>SQLITE_SCANSTAT_EXPLAIN</dt>
+** <dd>^The "const char *" variable pointed to by the V parameter will be set
+** to a zero-terminated UTF-8 string containing the [EXPLAIN QUERY PLAN]
+** description for the X-th loop.
+**
+** [[SQLITE_SCANSTAT_SELECTID]] <dt>SQLITE_SCANSTAT_SELECT</dt>
+** <dd>^The "int" variable pointed to by the V parameter will be set to the
+** "select-id" for the X-th loop. The select-id identifies which query or
+** subquery the loop is part of. The main query has a select-id of zero.
+** The select-id is the same value as is output in the first column
+** of an [EXPLAIN QUERY PLAN] query.
+** </dl>
+*/
+#define SQLITE_SCANSTAT_NLOOP 0
+#define SQLITE_SCANSTAT_NVISIT 1
+#define SQLITE_SCANSTAT_EST 2
+#define SQLITE_SCANSTAT_NAME 3
+#define SQLITE_SCANSTAT_EXPLAIN 4
+#define SQLITE_SCANSTAT_SELECTID 5
+
+/*
+** CAPI3REF: Prepared Statement Scan Status
+** METHOD: sqlite3_stmt
+**
+** This interface returns information about the predicted and measured
+** performance for pStmt. Advanced applications can use this
+** interface to compare the predicted and the measured performance and
+** issue warnings and/or rerun [ANALYZE] if discrepancies are found.
+**
+** Since this interface is expected to be rarely used, it is only
+** available if SQLite is compiled using the [SQLITE_ENABLE_STMT_SCANSTATUS]
+** compile-time option.
+**
+** The "iScanStatusOp" parameter determines which status information to return.
+** The "iScanStatusOp" must be one of the [scanstatus options] or the behavior
+** of this interface is undefined.
+** ^The requested measurement is written into a variable pointed to by
+** the "pOut" parameter.
+** Parameter "idx" identifies the specific loop to retrieve statistics for.
+** Loops are numbered starting from zero. ^If idx is out of range - less than
+** zero or greater than or equal to the total number of loops used to implement
+** the statement - a non-zero value is returned and the variable that pOut
+** points to is unchanged.
+**
+** ^Statistics might not be available for all loops in all statements. ^In cases
+** where there exist loops with no available statistics, this function behaves
+** as if the loop did not exist - it returns non-zero and leave the variable
+** that pOut points to unchanged.
+**
+** See also: [sqlite3_stmt_scanstatus_reset()]
+*/
+SQLITE_API int sqlite3_stmt_scanstatus(
+ sqlite3_stmt *pStmt, /* Prepared statement for which info desired */
+ int idx, /* Index of loop to report on */
+ int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */
+ void *pOut /* Result written here */
+);
+
+/*
+** CAPI3REF: Zero Scan-Status Counters
+** METHOD: sqlite3_stmt
+**
+** ^Zero all [sqlite3_stmt_scanstatus()] related event counters.
+**
+** This API is only available if the library is built with pre-processor
+** symbol [SQLITE_ENABLE_STMT_SCANSTATUS] defined.
+*/
+SQLITE_API void sqlite3_stmt_scanstatus_reset(sqlite3_stmt*);
+
+/*
+** CAPI3REF: Flush caches to disk mid-transaction
+**
+** ^If a write-transaction is open on [database connection] D when the
+** [sqlite3_db_cacheflush(D)] interface invoked, any dirty
+** pages in the pager-cache that are not currently in use are written out
+** to disk. A dirty page may be in use if a database cursor created by an
+** active SQL statement is reading from it, or if it is page 1 of a database
+** file (page 1 is always "in use"). ^The [sqlite3_db_cacheflush(D)]
+** interface flushes caches for all schemas - "main", "temp", and
+** any [attached] databases.
+**
+** ^If this function needs to obtain extra database locks before dirty pages
+** can be flushed to disk, it does so. ^If those locks cannot be obtained
+** immediately and there is a busy-handler callback configured, it is invoked
+** in the usual manner. ^If the required lock still cannot be obtained, then
+** the database is skipped and an attempt made to flush any dirty pages
+** belonging to the next (if any) database. ^If any databases are skipped
+** because locks cannot be obtained, but no other error occurs, this
+** function returns SQLITE_BUSY.
+**
+** ^If any other error occurs while flushing dirty pages to disk (for
+** example an IO error or out-of-memory condition), then processing is
+** abandoned and an SQLite [error code] is returned to the caller immediately.
+**
+** ^Otherwise, if no error occurs, [sqlite3_db_cacheflush()] returns SQLITE_OK.
+**
+** ^This function does not set the database handle error code or message
+** returned by the [sqlite3_errcode()] and [sqlite3_errmsg()] functions.
+*/
+SQLITE_API int sqlite3_db_cacheflush(sqlite3*);
+
+/*
+** CAPI3REF: The pre-update hook.
+**
+** ^These interfaces are only available if SQLite is compiled using the
+** [SQLITE_ENABLE_PREUPDATE_HOOK] compile-time option.
+**
+** ^The [sqlite3_preupdate_hook()] interface registers a callback function
+** that is invoked prior to each [INSERT], [UPDATE], and [DELETE] operation
+** on a database table.
+** ^At most one preupdate hook may be registered at a time on a single
+** [database connection]; each call to [sqlite3_preupdate_hook()] overrides
+** the previous setting.
+** ^The preupdate hook is disabled by invoking [sqlite3_preupdate_hook()]
+** with a NULL pointer as the second parameter.
+** ^The third parameter to [sqlite3_preupdate_hook()] is passed through as
+** the first parameter to callbacks.
+**
+** ^The preupdate hook only fires for changes to real database tables; the
+** preupdate hook is not invoked for changes to [virtual tables] or to
+** system tables like sqlite_master or sqlite_stat1.
+**
+** ^The second parameter to the preupdate callback is a pointer to
+** the [database connection] that registered the preupdate hook.
+** ^The third parameter to the preupdate callback is one of the constants
+** [SQLITE_INSERT], [SQLITE_DELETE], or [SQLITE_UPDATE] to identify the
+** kind of update operation that is about to occur.
+** ^(The fourth parameter to the preupdate callback is the name of the
+** database within the database connection that is being modified. This
+** will be "main" for the main database or "temp" for TEMP tables or
+** the name given after the AS keyword in the [ATTACH] statement for attached
+** databases.)^
+** ^The fifth parameter to the preupdate callback is the name of the
+** table that is being modified.
+**
+** For an UPDATE or DELETE operation on a [rowid table], the sixth
+** parameter passed to the preupdate callback is the initial [rowid] of the
+** row being modified or deleted. For an INSERT operation on a rowid table,
+** or any operation on a WITHOUT ROWID table, the value of the sixth
+** parameter is undefined. For an INSERT or UPDATE on a rowid table the
+** seventh parameter is the final rowid value of the row being inserted
+** or updated. The value of the seventh parameter passed to the callback
+** function is not defined for operations on WITHOUT ROWID tables, or for
+** INSERT operations on rowid tables.
+**
+** The [sqlite3_preupdate_old()], [sqlite3_preupdate_new()],
+** [sqlite3_preupdate_count()], and [sqlite3_preupdate_depth()] interfaces
+** provide additional information about a preupdate event. These routines
+** may only be called from within a preupdate callback. Invoking any of
+** these routines from outside of a preupdate callback or with a
+** [database connection] pointer that is different from the one supplied
+** to the preupdate callback results in undefined and probably undesirable
+** behavior.
+**
+** ^The [sqlite3_preupdate_count(D)] interface returns the number of columns
+** in the row that is being inserted, updated, or deleted.
+**
+** ^The [sqlite3_preupdate_old(D,N,P)] interface writes into P a pointer to
+** a [protected sqlite3_value] that contains the value of the Nth column of
+** the table row before it is updated. The N parameter must be between 0
+** and one less than the number of columns or the behavior will be
+** undefined. This must only be used within SQLITE_UPDATE and SQLITE_DELETE
+** preupdate callbacks; if it is used by an SQLITE_INSERT callback then the
+** behavior is undefined. The [sqlite3_value] that P points to
+** will be destroyed when the preupdate callback returns.
+**
+** ^The [sqlite3_preupdate_new(D,N,P)] interface writes into P a pointer to
+** a [protected sqlite3_value] that contains the value of the Nth column of
+** the table row after it is updated. The N parameter must be between 0
+** and one less than the number of columns or the behavior will be
+** undefined. This must only be used within SQLITE_INSERT and SQLITE_UPDATE
+** preupdate callbacks; if it is used by an SQLITE_DELETE callback then the
+** behavior is undefined. The [sqlite3_value] that P points to
+** will be destroyed when the preupdate callback returns.
+**
+** ^The [sqlite3_preupdate_depth(D)] interface returns 0 if the preupdate
+** callback was invoked as a result of a direct insert, update, or delete
+** operation; or 1 for inserts, updates, or deletes invoked by top-level
+** triggers; or 2 for changes resulting from triggers called by top-level
+** triggers; and so forth.
+**
+** See also: [sqlite3_update_hook()]
+*/
+#if defined(SQLITE_ENABLE_PREUPDATE_HOOK)
+SQLITE_API void *sqlite3_preupdate_hook(
+ sqlite3 *db,
+ void(*xPreUpdate)(
+ void *pCtx, /* Copy of third arg to preupdate_hook() */
+ sqlite3 *db, /* Database handle */
+ int op, /* SQLITE_UPDATE, DELETE or INSERT */
+ char const *zDb, /* Database name */
+ char const *zName, /* Table name */
+ sqlite3_int64 iKey1, /* Rowid of row about to be deleted/updated */
+ sqlite3_int64 iKey2 /* New rowid value (for a rowid UPDATE) */
+ ),
+ void*
+);
+SQLITE_API int sqlite3_preupdate_old(sqlite3 *, int, sqlite3_value **);
+SQLITE_API int sqlite3_preupdate_count(sqlite3 *);
+SQLITE_API int sqlite3_preupdate_depth(sqlite3 *);
+SQLITE_API int sqlite3_preupdate_new(sqlite3 *, int, sqlite3_value **);
+#endif
+
+/*
+** CAPI3REF: Low-level system error code
+**
+** ^Attempt to return the underlying operating system error code or error
+** number that caused the most recent I/O error or failure to open a file.
+** The return value is OS-dependent. For example, on unix systems, after
+** [sqlite3_open_v2()] returns [SQLITE_CANTOPEN], this interface could be
+** called to get back the underlying "errno" that caused the problem, such
+** as ENOSPC, EAUTH, EISDIR, and so forth.
+*/
+SQLITE_API int sqlite3_system_errno(sqlite3*);
+
+/*
+** CAPI3REF: Database Snapshot
+** KEYWORDS: {snapshot} {sqlite3_snapshot}
+**
+** An instance of the snapshot object records the state of a [WAL mode]
+** database for some specific point in history.
+**
+** In [WAL mode], multiple [database connections] that are open on the
+** same database file can each be reading a different historical version
+** of the database file. When a [database connection] begins a read
+** transaction, that connection sees an unchanging copy of the database
+** as it existed for the point in time when the transaction first started.
+** Subsequent changes to the database from other connections are not seen
+** by the reader until a new read transaction is started.
+**
+** The sqlite3_snapshot object records state information about an historical
+** version of the database file so that it is possible to later open a new read
+** transaction that sees that historical version of the database rather than
+** the most recent version.
+*/
+typedef struct sqlite3_snapshot {
+ unsigned char hidden[48];
+} sqlite3_snapshot;
+
+/*
+** CAPI3REF: Record A Database Snapshot
+** CONSTRUCTOR: sqlite3_snapshot
+**
+** ^The [sqlite3_snapshot_get(D,S,P)] interface attempts to make a
+** new [sqlite3_snapshot] object that records the current state of
+** schema S in database connection D. ^On success, the
+** [sqlite3_snapshot_get(D,S,P)] interface writes a pointer to the newly
+** created [sqlite3_snapshot] object into *P and returns SQLITE_OK.
+** If there is not already a read-transaction open on schema S when
+** this function is called, one is opened automatically.
+**
+** The following must be true for this function to succeed. If any of
+** the following statements are false when sqlite3_snapshot_get() is
+** called, SQLITE_ERROR is returned. The final value of *P is undefined
+** in this case.
+**
+** <ul>
+** <li> The database handle must not be in [autocommit mode].
+**
+** <li> Schema S of [database connection] D must be a [WAL mode] database.
+**
+** <li> There must not be a write transaction open on schema S of database
+** connection D.
+**
+** <li> One or more transactions must have been written to the current wal
+** file since it was created on disk (by any connection). This means
+** that a snapshot cannot be taken on a wal mode database with no wal
+** file immediately after it is first opened. At least one transaction
+** must be written to it first.
+** </ul>
+**
+** This function may also return SQLITE_NOMEM. If it is called with the
+** database handle in autocommit mode but fails for some other reason,
+** whether or not a read transaction is opened on schema S is undefined.
+**
+** The [sqlite3_snapshot] object returned from a successful call to
+** [sqlite3_snapshot_get()] must be freed using [sqlite3_snapshot_free()]
+** to avoid a memory leak.
+**
+** The [sqlite3_snapshot_get()] interface is only available when the
+** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used.
+*/
+SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_get(
+ sqlite3 *db,
+ const char *zSchema,
+ sqlite3_snapshot **ppSnapshot
+);
+
+/*
+** CAPI3REF: Start a read transaction on an historical snapshot
+** METHOD: sqlite3_snapshot
+**
+** ^The [sqlite3_snapshot_open(D,S,P)] interface either starts a new read
+** transaction or upgrades an existing one for schema S of
+** [database connection] D such that the read transaction refers to
+** historical [snapshot] P, rather than the most recent change to the
+** database. ^The [sqlite3_snapshot_open()] interface returns SQLITE_OK
+** on success or an appropriate [error code] if it fails.
+**
+** ^In order to succeed, the database connection must not be in
+** [autocommit mode] when [sqlite3_snapshot_open(D,S,P)] is called. If there
+** is already a read transaction open on schema S, then the database handle
+** must have no active statements (SELECT statements that have been passed
+** to sqlite3_step() but not sqlite3_reset() or sqlite3_finalize()).
+** SQLITE_ERROR is returned if either of these conditions is violated, or
+** if schema S does not exist, or if the snapshot object is invalid.
+**
+** ^A call to sqlite3_snapshot_open() will fail to open if the specified
+** snapshot has been overwritten by a [checkpoint]. In this case
+** SQLITE_ERROR_SNAPSHOT is returned.
+**
+** If there is already a read transaction open when this function is
+** invoked, then the same read transaction remains open (on the same
+** database snapshot) if SQLITE_ERROR, SQLITE_BUSY or SQLITE_ERROR_SNAPSHOT
+** is returned. If another error code - for example SQLITE_PROTOCOL or an
+** SQLITE_IOERR error code - is returned, then the final state of the
+** read transaction is undefined. If SQLITE_OK is returned, then the
+** read transaction is now open on database snapshot P.
+**
+** ^(A call to [sqlite3_snapshot_open(D,S,P)] will fail if the
+** database connection D does not know that the database file for
+** schema S is in [WAL mode]. A database connection might not know
+** that the database file is in [WAL mode] if there has been no prior
+** I/O on that database connection, or if the database entered [WAL mode]
+** after the most recent I/O on the database connection.)^
+** (Hint: Run "[PRAGMA application_id]" against a newly opened
+** database connection in order to make it ready to use snapshots.)
+**
+** The [sqlite3_snapshot_open()] interface is only available when the
+** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used.
+*/
+SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_open(
+ sqlite3 *db,
+ const char *zSchema,
+ sqlite3_snapshot *pSnapshot
+);
+
+/*
+** CAPI3REF: Destroy a snapshot
+** DESTRUCTOR: sqlite3_snapshot
+**
+** ^The [sqlite3_snapshot_free(P)] interface destroys [sqlite3_snapshot] P.
+** The application must eventually free every [sqlite3_snapshot] object
+** using this routine to avoid a memory leak.
+**
+** The [sqlite3_snapshot_free()] interface is only available when the
+** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used.
+*/
+SQLITE_API SQLITE_EXPERIMENTAL void sqlite3_snapshot_free(sqlite3_snapshot*);
+
+/*
+** CAPI3REF: Compare the ages of two snapshot handles.
+** METHOD: sqlite3_snapshot
+**
+** The sqlite3_snapshot_cmp(P1, P2) interface is used to compare the ages
+** of two valid snapshot handles.
+**
+** If the two snapshot handles are not associated with the same database
+** file, the result of the comparison is undefined.
+**
+** Additionally, the result of the comparison is only valid if both of the
+** snapshot handles were obtained by calling sqlite3_snapshot_get() since the
+** last time the wal file was deleted. The wal file is deleted when the
+** database is changed back to rollback mode or when the number of database
+** clients drops to zero. If either snapshot handle was obtained before the
+** wal file was last deleted, the value returned by this function
+** is undefined.
+**
+** Otherwise, this API returns a negative value if P1 refers to an older
+** snapshot than P2, zero if the two handles refer to the same database
+** snapshot, and a positive value if P1 is a newer snapshot than P2.
+**
+** This interface is only available if SQLite is compiled with the
+** [SQLITE_ENABLE_SNAPSHOT] option.
+*/
+SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_cmp(
+ sqlite3_snapshot *p1,
+ sqlite3_snapshot *p2
+);
+
+/*
+** CAPI3REF: Recover snapshots from a wal file
+** METHOD: sqlite3_snapshot
+**
+** If a [WAL file] remains on disk after all database connections close
+** (either through the use of the [SQLITE_FCNTL_PERSIST_WAL] [file control]
+** or because the last process to have the database opened exited without
+** calling [sqlite3_close()]) and a new connection is subsequently opened
+** on that database and [WAL file], the [sqlite3_snapshot_open()] interface
+** will only be able to open the last transaction added to the WAL file
+** even though the WAL file contains other valid transactions.
+**
+** This function attempts to scan the WAL file associated with database zDb
+** of database handle db and make all valid snapshots available to
+** sqlite3_snapshot_open(). It is an error if there is already a read
+** transaction open on the database, or if the database is not a WAL mode
+** database.
+**
+** SQLITE_OK is returned if successful, or an SQLite error code otherwise.
+**
+** This interface is only available if SQLite is compiled with the
+** [SQLITE_ENABLE_SNAPSHOT] option.
+*/
+SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb);
+
+/*
+** CAPI3REF: Serialize a database
+**
+** The sqlite3_serialize(D,S,P,F) interface returns a pointer to memory
+** that is a serialization of the S database on [database connection] D.
+** If P is not a NULL pointer, then the size of the database in bytes
+** is written into *P.
+**
+** For an ordinary on-disk database file, the serialization is just a
+** copy of the disk file. For an in-memory database or a "TEMP" database,
+** the serialization is the same sequence of bytes which would be written
+** to disk if that database where backed up to disk.
+**
+** The usual case is that sqlite3_serialize() copies the serialization of
+** the database into memory obtained from [sqlite3_malloc64()] and returns
+** a pointer to that memory. The caller is responsible for freeing the
+** returned value to avoid a memory leak. However, if the F argument
+** contains the SQLITE_SERIALIZE_NOCOPY bit, then no memory allocations
+** are made, and the sqlite3_serialize() function will return a pointer
+** to the contiguous memory representation of the database that SQLite
+** is currently using for that database, or NULL if the no such contiguous
+** memory representation of the database exists. A contiguous memory
+** representation of the database will usually only exist if there has
+** been a prior call to [sqlite3_deserialize(D,S,...)] with the same
+** values of D and S.
+** The size of the database is written into *P even if the
+** SQLITE_SERIALIZE_NOCOPY bit is set but no contiguous copy
+** of the database exists.
+**
+** A call to sqlite3_serialize(D,S,P,F) might return NULL even if the
+** SQLITE_SERIALIZE_NOCOPY bit is omitted from argument F if a memory
+** allocation error occurs.
+**
+** This interface is only available if SQLite is compiled with the
+** [SQLITE_ENABLE_DESERIALIZE] option.
+*/
+SQLITE_API unsigned char *sqlite3_serialize(
+ sqlite3 *db, /* The database connection */
+ const char *zSchema, /* Which DB to serialize. ex: "main", "temp", ... */
+ sqlite3_int64 *piSize, /* Write size of the DB here, if not NULL */
+ unsigned int mFlags /* Zero or more SQLITE_SERIALIZE_* flags */
+);
+
+/*
+** CAPI3REF: Flags for sqlite3_serialize
+**
+** Zero or more of the following constants can be OR-ed together for
+** the F argument to [sqlite3_serialize(D,S,P,F)].
+**
+** SQLITE_SERIALIZE_NOCOPY means that [sqlite3_serialize()] will return
+** a pointer to contiguous in-memory database that it is currently using,
+** without making a copy of the database. If SQLite is not currently using
+** a contiguous in-memory database, then this option causes
+** [sqlite3_serialize()] to return a NULL pointer. SQLite will only be
+** using a contiguous in-memory database if it has been initialized by a
+** prior call to [sqlite3_deserialize()].
+*/
+#define SQLITE_SERIALIZE_NOCOPY 0x001 /* Do no memory allocations */
+
+/*
+** CAPI3REF: Deserialize a database
+**
+** The sqlite3_deserialize(D,S,P,N,M,F) interface causes the
+** [database connection] D to disconnect from database S and then
+** reopen S as an in-memory database based on the serialization contained
+** in P. The serialized database P is N bytes in size. M is the size of
+** the buffer P, which might be larger than N. If M is larger than N, and
+** the SQLITE_DESERIALIZE_READONLY bit is not set in F, then SQLite is
+** permitted to add content to the in-memory database as long as the total
+** size does not exceed M bytes.
+**
+** If the SQLITE_DESERIALIZE_FREEONCLOSE bit is set in F, then SQLite will
+** invoke sqlite3_free() on the serialization buffer when the database
+** connection closes. If the SQLITE_DESERIALIZE_RESIZEABLE bit is set, then
+** SQLite will try to increase the buffer size using sqlite3_realloc64()
+** if writes on the database cause it to grow larger than M bytes.
+**
+** The sqlite3_deserialize() interface will fail with SQLITE_BUSY if the
+** database is currently in a read transaction or is involved in a backup
+** operation.
+**
+** If sqlite3_deserialize(D,S,P,N,M,F) fails for any reason and if the
+** SQLITE_DESERIALIZE_FREEONCLOSE bit is set in argument F, then
+** [sqlite3_free()] is invoked on argument P prior to returning.
+**
+** This interface is only available if SQLite is compiled with the
+** [SQLITE_ENABLE_DESERIALIZE] option.
+*/
+SQLITE_API int sqlite3_deserialize(
+ sqlite3 *db, /* The database connection */
+ const char *zSchema, /* Which DB to reopen with the deserialization */
+ unsigned char *pData, /* The serialized database content */
+ sqlite3_int64 szDb, /* Number bytes in the deserialization */
+ sqlite3_int64 szBuf, /* Total size of buffer pData[] */
+ unsigned mFlags /* Zero or more SQLITE_DESERIALIZE_* flags */
+);
+
+/*
+** CAPI3REF: Flags for sqlite3_deserialize()
+**
+** The following are allowed values for 6th argument (the F argument) to
+** the [sqlite3_deserialize(D,S,P,N,M,F)] interface.
+**
+** The SQLITE_DESERIALIZE_FREEONCLOSE means that the database serialization
+** in the P argument is held in memory obtained from [sqlite3_malloc64()]
+** and that SQLite should take ownership of this memory and automatically
+** free it when it has finished using it. Without this flag, the caller
+** is responsible for freeing any dynamically allocated memory.
+**
+** The SQLITE_DESERIALIZE_RESIZEABLE flag means that SQLite is allowed to
+** grow the size of the database using calls to [sqlite3_realloc64()]. This
+** flag should only be used if SQLITE_DESERIALIZE_FREEONCLOSE is also used.
+** Without this flag, the deserialized database cannot increase in size beyond
+** the number of bytes specified by the M parameter.
+**
+** The SQLITE_DESERIALIZE_READONLY flag means that the deserialized database
+** should be treated as read-only.
+*/
+#define SQLITE_DESERIALIZE_FREEONCLOSE 1 /* Call sqlite3_free() on close */
+#define SQLITE_DESERIALIZE_RESIZEABLE 2 /* Resize using sqlite3_realloc64() */
+#define SQLITE_DESERIALIZE_READONLY 4 /* Database is read-only */
+
+/*
+** Undo the hack that converts floating point types to integer for
+** builds on processors without floating point support.
+*/
+#ifdef SQLITE_OMIT_FLOATING_POINT
+# undef double
+#endif
+
+#ifdef __cplusplus
+} /* End of the 'extern "C"' block */
+#endif
+#endif /* SQLITE3_H */
+
+/******** Begin file sqlite3rtree.h *********/
+/*
+** 2010 August 30
+**
+** The author disclaims copyright to this source code. In place of
+** a legal notice, here is a blessing:
+**
+** May you do good and not evil.
+** May you find forgiveness for yourself and forgive others.
+** May you share freely, never taking more than you give.
+**
+*************************************************************************
+*/
+
+#ifndef _SQLITE3RTREE_H_
+#define _SQLITE3RTREE_H_
+
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry;
+typedef struct sqlite3_rtree_query_info sqlite3_rtree_query_info;
+
+/* The double-precision datatype used by RTree depends on the
+** SQLITE_RTREE_INT_ONLY compile-time option.
+*/
+#ifdef SQLITE_RTREE_INT_ONLY
+ typedef sqlite3_int64 sqlite3_rtree_dbl;
+#else
+ typedef double sqlite3_rtree_dbl;
+#endif
+
+/*
+** Register a geometry callback named zGeom that can be used as part of an
+** R-Tree geometry query as follows:
+**
+** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zGeom(... params ...)
+*/
+SQLITE_API int sqlite3_rtree_geometry_callback(
+ sqlite3 *db,
+ const char *zGeom,
+ int (*xGeom)(sqlite3_rtree_geometry*, int, sqlite3_rtree_dbl*,int*),
+ void *pContext
+);
+
+
+/*
+** A pointer to a structure of the following type is passed as the first
+** argument to callbacks registered using rtree_geometry_callback().
+*/
+struct sqlite3_rtree_geometry {
+ void *pContext; /* Copy of pContext passed to s_r_g_c() */
+ int nParam; /* Size of array aParam[] */
+ sqlite3_rtree_dbl *aParam; /* Parameters passed to SQL geom function */
+ void *pUser; /* Callback implementation user data */
+ void (*xDelUser)(void *); /* Called by SQLite to clean up pUser */
+};
+
+/*
+** Register a 2nd-generation geometry callback named zScore that can be
+** used as part of an R-Tree geometry query as follows:
+**
+** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zQueryFunc(... params ...)
+*/
+SQLITE_API int sqlite3_rtree_query_callback(
+ sqlite3 *db,
+ const char *zQueryFunc,
+ int (*xQueryFunc)(sqlite3_rtree_query_info*),
+ void *pContext,
+ void (*xDestructor)(void*)
+);
+
+
+/*
+** A pointer to a structure of the following type is passed as the
+** argument to scored geometry callback registered using
+** sqlite3_rtree_query_callback().
+**
+** Note that the first 5 fields of this structure are identical to
+** sqlite3_rtree_geometry. This structure is a subclass of
+** sqlite3_rtree_geometry.
+*/
+struct sqlite3_rtree_query_info {
+ void *pContext; /* pContext from when function registered */
+ int nParam; /* Number of function parameters */
+ sqlite3_rtree_dbl *aParam; /* value of function parameters */
+ void *pUser; /* callback can use this, if desired */
+ void (*xDelUser)(void*); /* function to free pUser */
+ sqlite3_rtree_dbl *aCoord; /* Coordinates of node or entry to check */
+ unsigned int *anQueue; /* Number of pending entries in the queue */
+ int nCoord; /* Number of coordinates */
+ int iLevel; /* Level of current node or entry */
+ int mxLevel; /* The largest iLevel value in the tree */
+ sqlite3_int64 iRowid; /* Rowid for current entry */
+ sqlite3_rtree_dbl rParentScore; /* Score of parent node */
+ int eParentWithin; /* Visibility of parent node */
+ int eWithin; /* OUT: Visibility */
+ sqlite3_rtree_dbl rScore; /* OUT: Write the score here */
+ /* The following fields are only available in 3.8.11 and later */
+ sqlite3_value **apSqlParam; /* Original SQL values of parameters */
+};
+
+/*
+** Allowed values for sqlite3_rtree_query.eWithin and .eParentWithin.
+*/
+#define NOT_WITHIN 0 /* Object completely outside of query region */
+#define PARTLY_WITHIN 1 /* Object partially overlaps query region */
+#define FULLY_WITHIN 2 /* Object fully contained within query region */
+
+
+#ifdef __cplusplus
+} /* end of the 'extern "C"' block */
+#endif
+
+#endif /* ifndef _SQLITE3RTREE_H_ */
+
+/******** End of sqlite3rtree.h *********/
+/******** Begin file sqlite3session.h *********/
+
+#if !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION)
+#define __SQLITESESSION_H_ 1
+
+/*
+** Make sure we can call this stuff from C++.
+*/
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+/*
+** CAPI3REF: Session Object Handle
+**
+** An instance of this object is a [session] that can be used to
+** record changes to a database.
+*/
+typedef struct sqlite3_session sqlite3_session;
+
+/*
+** CAPI3REF: Changeset Iterator Handle
+**
+** An instance of this object acts as a cursor for iterating
+** over the elements of a [changeset] or [patchset].
+*/
+typedef struct sqlite3_changeset_iter sqlite3_changeset_iter;
+
+/*
+** CAPI3REF: Create A New Session Object
+** CONSTRUCTOR: sqlite3_session
+**
+** Create a new session object attached to database handle db. If successful,
+** a pointer to the new object is written to *ppSession and SQLITE_OK is
+** returned. If an error occurs, *ppSession is set to NULL and an SQLite
+** error code (e.g. SQLITE_NOMEM) is returned.
+**
+** It is possible to create multiple session objects attached to a single
+** database handle.
+**
+** Session objects created using this function should be deleted using the
+** [sqlite3session_delete()] function before the database handle that they
+** are attached to is itself closed. If the database handle is closed before
+** the session object is deleted, then the results of calling any session
+** module function, including [sqlite3session_delete()] on the session object
+** are undefined.
+**
+** Because the session module uses the [sqlite3_preupdate_hook()] API, it
+** is not possible for an application to register a pre-update hook on a
+** database handle that has one or more session objects attached. Nor is
+** it possible to create a session object attached to a database handle for
+** which a pre-update hook is already defined. The results of attempting
+** either of these things are undefined.
+**
+** The session object will be used to create changesets for tables in
+** database zDb, where zDb is either "main", or "temp", or the name of an
+** attached database. It is not an error if database zDb is not attached
+** to the database when the session object is created.
+*/
+SQLITE_API int sqlite3session_create(
+ sqlite3 *db, /* Database handle */
+ const char *zDb, /* Name of db (e.g. "main") */
+ sqlite3_session **ppSession /* OUT: New session object */
+);
+
+/*
+** CAPI3REF: Delete A Session Object
+** DESTRUCTOR: sqlite3_session
+**
+** Delete a session object previously allocated using
+** [sqlite3session_create()]. Once a session object has been deleted, the
+** results of attempting to use pSession with any other session module
+** function are undefined.
+**
+** Session objects must be deleted before the database handle to which they
+** are attached is closed. Refer to the documentation for
+** [sqlite3session_create()] for details.
+*/
+SQLITE_API void sqlite3session_delete(sqlite3_session *pSession);
+
+
+/*
+** CAPI3REF: Enable Or Disable A Session Object
+** METHOD: sqlite3_session
+**
+** Enable or disable the recording of changes by a session object. When
+** enabled, a session object records changes made to the database. When
+** disabled - it does not. A newly created session object is enabled.
+** Refer to the documentation for [sqlite3session_changeset()] for further
+** details regarding how enabling and disabling a session object affects
+** the eventual changesets.
+**
+** Passing zero to this function disables the session. Passing a value
+** greater than zero enables it. Passing a value less than zero is a
+** no-op, and may be used to query the current state of the session.
+**
+** The return value indicates the final state of the session object: 0 if
+** the session is disabled, or 1 if it is enabled.
+*/
+SQLITE_API int sqlite3session_enable(sqlite3_session *pSession, int bEnable);
+
+/*
+** CAPI3REF: Set Or Clear the Indirect Change Flag
+** METHOD: sqlite3_session
+**
+** Each change recorded by a session object is marked as either direct or
+** indirect. A change is marked as indirect if either:
+**
+** <ul>
+** <li> The session object "indirect" flag is set when the change is
+** made, or
+** <li> The change is made by an SQL trigger or foreign key action
+** instead of directly as a result of a users SQL statement.
+** </ul>
+**
+** If a single row is affected by more than one operation within a session,
+** then the change is considered indirect if all operations meet the criteria
+** for an indirect change above, or direct otherwise.
+**
+** This function is used to set, clear or query the session object indirect
+** flag. If the second argument passed to this function is zero, then the
+** indirect flag is cleared. If it is greater than zero, the indirect flag
+** is set. Passing a value less than zero does not modify the current value
+** of the indirect flag, and may be used to query the current state of the
+** indirect flag for the specified session object.
+**
+** The return value indicates the final state of the indirect flag: 0 if
+** it is clear, or 1 if it is set.
+*/
+SQLITE_API int sqlite3session_indirect(sqlite3_session *pSession, int bIndirect);
+
+/*
+** CAPI3REF: Attach A Table To A Session Object
+** METHOD: sqlite3_session
+**
+** If argument zTab is not NULL, then it is the name of a table to attach
+** to the session object passed as the first argument. All subsequent changes
+** made to the table while the session object is enabled will be recorded. See
+** documentation for [sqlite3session_changeset()] for further details.
+**
+** Or, if argument zTab is NULL, then changes are recorded for all tables
+** in the database. If additional tables are added to the database (by
+** executing "CREATE TABLE" statements) after this call is made, changes for
+** the new tables are also recorded.
+**
+** Changes can only be recorded for tables that have a PRIMARY KEY explicitly
+** defined as part of their CREATE TABLE statement. It does not matter if the
+** PRIMARY KEY is an "INTEGER PRIMARY KEY" (rowid alias) or not. The PRIMARY
+** KEY may consist of a single column, or may be a composite key.
+**
+** It is not an error if the named table does not exist in the database. Nor
+** is it an error if the named table does not have a PRIMARY KEY. However,
+** no changes will be recorded in either of these scenarios.
+**
+** Changes are not recorded for individual rows that have NULL values stored
+** in one or more of their PRIMARY KEY columns.
+**
+** SQLITE_OK is returned if the call completes without error. Or, if an error
+** occurs, an SQLite error code (e.g. SQLITE_NOMEM) is returned.
+**
+** <h3>Special sqlite_stat1 Handling</h3>
+**
+** As of SQLite version 3.22.0, the "sqlite_stat1" table is an exception to
+** some of the rules above. In SQLite, the schema of sqlite_stat1 is:
+** <pre>
+** CREATE TABLE sqlite_stat1(tbl,idx,stat)
+** </pre>
+**
+** Even though sqlite_stat1 does not have a PRIMARY KEY, changes are
+** recorded for it as if the PRIMARY KEY is (tbl,idx). Additionally, changes
+** are recorded for rows for which (idx IS NULL) is true. However, for such
+** rows a zero-length blob (SQL value X'') is stored in the changeset or
+** patchset instead of a NULL value. This allows such changesets to be
+** manipulated by legacy implementations of sqlite3changeset_invert(),
+** concat() and similar.
+**
+** The sqlite3changeset_apply() function automatically converts the
+** zero-length blob back to a NULL value when updating the sqlite_stat1
+** table. However, if the application calls sqlite3changeset_new(),
+** sqlite3changeset_old() or sqlite3changeset_conflict on a changeset
+** iterator directly (including on a changeset iterator passed to a
+** conflict-handler callback) then the X'' value is returned. The application
+** must translate X'' to NULL itself if required.
+**
+** Legacy (older than 3.22.0) versions of the sessions module cannot capture
+** changes made to the sqlite_stat1 table. Legacy versions of the
+** sqlite3changeset_apply() function silently ignore any modifications to the
+** sqlite_stat1 table that are part of a changeset or patchset.
+*/
+SQLITE_API int sqlite3session_attach(
+ sqlite3_session *pSession, /* Session object */
+ const char *zTab /* Table name */
+);
+
+/*
+** CAPI3REF: Set a table filter on a Session Object.
+** METHOD: sqlite3_session
+**
+** The second argument (xFilter) is the "filter callback". For changes to rows
+** in tables that are not attached to the Session object, the filter is called
+** to determine whether changes to the table's rows should be tracked or not.
+** If xFilter returns 0, changes are not tracked. Note that once a table is
+** attached, xFilter will not be called again.
+*/
+SQLITE_API void sqlite3session_table_filter(
+ sqlite3_session *pSession, /* Session object */
+ int(*xFilter)(
+ void *pCtx, /* Copy of third arg to _filter_table() */
+ const char *zTab /* Table name */
+ ),
+ void *pCtx /* First argument passed to xFilter */
+);
+
+/*
+** CAPI3REF: Generate A Changeset From A Session Object
+** METHOD: sqlite3_session
+**
+** Obtain a changeset containing changes to the tables attached to the
+** session object passed as the first argument. If successful,
+** set *ppChangeset to point to a buffer containing the changeset
+** and *pnChangeset to the size of the changeset in bytes before returning
+** SQLITE_OK. If an error occurs, set both *ppChangeset and *pnChangeset to
+** zero and return an SQLite error code.
+**
+** A changeset consists of zero or more INSERT, UPDATE and/or DELETE changes,
+** each representing a change to a single row of an attached table. An INSERT
+** change contains the values of each field of a new database row. A DELETE
+** contains the original values of each field of a deleted database row. An
+** UPDATE change contains the original values of each field of an updated
+** database row along with the updated values for each updated non-primary-key
+** column. It is not possible for an UPDATE change to represent a change that
+** modifies the values of primary key columns. If such a change is made, it
+** is represented in a changeset as a DELETE followed by an INSERT.
+**
+** Changes are not recorded for rows that have NULL values stored in one or
+** more of their PRIMARY KEY columns. If such a row is inserted or deleted,
+** no corresponding change is present in the changesets returned by this
+** function. If an existing row with one or more NULL values stored in
+** PRIMARY KEY columns is updated so that all PRIMARY KEY columns are non-NULL,
+** only an INSERT is appears in the changeset. Similarly, if an existing row
+** with non-NULL PRIMARY KEY values is updated so that one or more of its
+** PRIMARY KEY columns are set to NULL, the resulting changeset contains a
+** DELETE change only.
+**
+** The contents of a changeset may be traversed using an iterator created
+** using the [sqlite3changeset_start()] API. A changeset may be applied to
+** a database with a compatible schema using the [sqlite3changeset_apply()]
+** API.
+**
+** Within a changeset generated by this function, all changes related to a
+** single table are grouped together. In other words, when iterating through
+** a changeset or when applying a changeset to a database, all changes related
+** to a single table are processed before moving on to the next table. Tables
+** are sorted in the same order in which they were attached (or auto-attached)
+** to the sqlite3_session object. The order in which the changes related to
+** a single table are stored is undefined.
+**
+** Following a successful call to this function, it is the responsibility of
+** the caller to eventually free the buffer that *ppChangeset points to using
+** [sqlite3_free()].
+**
+** <h3>Changeset Generation</h3>
+**
+** Once a table has been attached to a session object, the session object
+** records the primary key values of all new rows inserted into the table.
+** It also records the original primary key and other column values of any
+** deleted or updated rows. For each unique primary key value, data is only
+** recorded once - the first time a row with said primary key is inserted,
+** updated or deleted in the lifetime of the session.
+**
+** There is one exception to the previous paragraph: when a row is inserted,
+** updated or deleted, if one or more of its primary key columns contain a
+** NULL value, no record of the change is made.
+**
+** The session object therefore accumulates two types of records - those
+** that consist of primary key values only (created when the user inserts
+** a new record) and those that consist of the primary key values and the
+** original values of other table columns (created when the users deletes
+** or updates a record).
+**
+** When this function is called, the requested changeset is created using
+** both the accumulated records and the current contents of the database
+** file. Specifically:
+**
+** <ul>
+** <li> For each record generated by an insert, the database is queried
+** for a row with a matching primary key. If one is found, an INSERT
+** change is added to the changeset. If no such row is found, no change
+** is added to the changeset.
+**
+** <li> For each record generated by an update or delete, the database is
+** queried for a row with a matching primary key. If such a row is
+** found and one or more of the non-primary key fields have been
+** modified from their original values, an UPDATE change is added to
+** the changeset. Or, if no such row is found in the table, a DELETE
+** change is added to the changeset. If there is a row with a matching
+** primary key in the database, but all fields contain their original
+** values, no change is added to the changeset.
+** </ul>
+**
+** This means, amongst other things, that if a row is inserted and then later
+** deleted while a session object is active, neither the insert nor the delete
+** will be present in the changeset. Or if a row is deleted and then later a
+** row with the same primary key values inserted while a session object is
+** active, the resulting changeset will contain an UPDATE change instead of
+** a DELETE and an INSERT.
+**
+** When a session object is disabled (see the [sqlite3session_enable()] API),
+** it does not accumulate records when rows are inserted, updated or deleted.
+** This may appear to have some counter-intuitive effects if a single row
+** is written to more than once during a session. For example, if a row
+** is inserted while a session object is enabled, then later deleted while
+** the same session object is disabled, no INSERT record will appear in the
+** changeset, even though the delete took place while the session was disabled.
+** Or, if one field of a row is updated while a session is disabled, and
+** another field of the same row is updated while the session is enabled, the
+** resulting changeset will contain an UPDATE change that updates both fields.
+*/
+SQLITE_API int sqlite3session_changeset(
+ sqlite3_session *pSession, /* Session object */
+ int *pnChangeset, /* OUT: Size of buffer at *ppChangeset */
+ void **ppChangeset /* OUT: Buffer containing changeset */
+);
+
+/*
+** CAPI3REF: Load The Difference Between Tables Into A Session
+** METHOD: sqlite3_session
+**
+** If it is not already attached to the session object passed as the first
+** argument, this function attaches table zTbl in the same manner as the
+** [sqlite3session_attach()] function. If zTbl does not exist, or if it
+** does not have a primary key, this function is a no-op (but does not return
+** an error).
+**
+** Argument zFromDb must be the name of a database ("main", "temp" etc.)
+** attached to the same database handle as the session object that contains
+** a table compatible with the table attached to the session by this function.
+** A table is considered compatible if it:
+**
+** <ul>
+** <li> Has the same name,
+** <li> Has the same set of columns declared in the same order, and
+** <li> Has the same PRIMARY KEY definition.
+** </ul>
+**
+** If the tables are not compatible, SQLITE_SCHEMA is returned. If the tables
+** are compatible but do not have any PRIMARY KEY columns, it is not an error
+** but no changes are added to the session object. As with other session
+** APIs, tables without PRIMARY KEYs are simply ignored.
+**
+** This function adds a set of changes to the session object that could be
+** used to update the table in database zFrom (call this the "from-table")
+** so that its content is the same as the table attached to the session
+** object (call this the "to-table"). Specifically:
+**
+** <ul>
+** <li> For each row (primary key) that exists in the to-table but not in
+** the from-table, an INSERT record is added to the session object.
+**
+** <li> For each row (primary key) that exists in the to-table but not in
+** the from-table, a DELETE record is added to the session object.
+**
+** <li> For each row (primary key) that exists in both tables, but features
+** different non-PK values in each, an UPDATE record is added to the
+** session.
+** </ul>
+**
+** To clarify, if this function is called and then a changeset constructed
+** using [sqlite3session_changeset()], then after applying that changeset to
+** database zFrom the contents of the two compatible tables would be
+** identical.
+**
+** It an error if database zFrom does not exist or does not contain the
+** required compatible table.
+**
+** If the operation is successful, SQLITE_OK is returned. Otherwise, an SQLite
+** error code. In this case, if argument pzErrMsg is not NULL, *pzErrMsg
+** may be set to point to a buffer containing an English language error
+** message. It is the responsibility of the caller to free this buffer using
+** sqlite3_free().
+*/
+SQLITE_API int sqlite3session_diff(
+ sqlite3_session *pSession,
+ const char *zFromDb,
+ const char *zTbl,
+ char **pzErrMsg
+);
+
+
+/*
+** CAPI3REF: Generate A Patchset From A Session Object
+** METHOD: sqlite3_session
+**
+** The differences between a patchset and a changeset are that:
+**
+** <ul>
+** <li> DELETE records consist of the primary key fields only. The
+** original values of other fields are omitted.
+** <li> The original values of any modified fields are omitted from
+** UPDATE records.
+** </ul>
+**
+** A patchset blob may be used with up to date versions of all
+** sqlite3changeset_xxx API functions except for sqlite3changeset_invert(),
+** which returns SQLITE_CORRUPT if it is passed a patchset. Similarly,
+** attempting to use a patchset blob with old versions of the
+** sqlite3changeset_xxx APIs also provokes an SQLITE_CORRUPT error.
+**
+** Because the non-primary key "old.*" fields are omitted, no
+** SQLITE_CHANGESET_DATA conflicts can be detected or reported if a patchset
+** is passed to the sqlite3changeset_apply() API. Other conflict types work
+** in the same way as for changesets.
+**
+** Changes within a patchset are ordered in the same way as for changesets
+** generated by the sqlite3session_changeset() function (i.e. all changes for
+** a single table are grouped together, tables appear in the order in which
+** they were attached to the session object).
+*/
+SQLITE_API int sqlite3session_patchset(
+ sqlite3_session *pSession, /* Session object */
+ int *pnPatchset, /* OUT: Size of buffer at *ppPatchset */
+ void **ppPatchset /* OUT: Buffer containing patchset */
+);
+
+/*
+** CAPI3REF: Test if a changeset has recorded any changes.
+**
+** Return non-zero if no changes to attached tables have been recorded by
+** the session object passed as the first argument. Otherwise, if one or
+** more changes have been recorded, return zero.
+**
+** Even if this function returns zero, it is possible that calling
+** [sqlite3session_changeset()] on the session handle may still return a
+** changeset that contains no changes. This can happen when a row in
+** an attached table is modified and then later on the original values
+** are restored. However, if this function returns non-zero, then it is
+** guaranteed that a call to sqlite3session_changeset() will return a
+** changeset containing zero changes.
+*/
+SQLITE_API int sqlite3session_isempty(sqlite3_session *pSession);
+
+/*
+** CAPI3REF: Create An Iterator To Traverse A Changeset
+** CONSTRUCTOR: sqlite3_changeset_iter
+**
+** Create an iterator used to iterate through the contents of a changeset.
+** If successful, *pp is set to point to the iterator handle and SQLITE_OK
+** is returned. Otherwise, if an error occurs, *pp is set to zero and an
+** SQLite error code is returned.
+**
+** The following functions can be used to advance and query a changeset
+** iterator created by this function:
+**
+** <ul>
+** <li> [sqlite3changeset_next()]
+** <li> [sqlite3changeset_op()]
+** <li> [sqlite3changeset_new()]
+** <li> [sqlite3changeset_old()]
+** </ul>
+**
+** It is the responsibility of the caller to eventually destroy the iterator
+** by passing it to [sqlite3changeset_finalize()]. The buffer containing the
+** changeset (pChangeset) must remain valid until after the iterator is
+** destroyed.
+**
+** Assuming the changeset blob was created by one of the
+** [sqlite3session_changeset()], [sqlite3changeset_concat()] or
+** [sqlite3changeset_invert()] functions, all changes within the changeset
+** that apply to a single table are grouped together. This means that when
+** an application iterates through a changeset using an iterator created by
+** this function, all changes that relate to a single table are visited
+** consecutively. There is no chance that the iterator will visit a change
+** the applies to table X, then one for table Y, and then later on visit
+** another change for table X.
+**
+** The behavior of sqlite3changeset_start_v2() and its streaming equivalent
+** may be modified by passing a combination of
+** [SQLITE_CHANGESETSTART_INVERT | supported flags] as the 4th parameter.
+**
+** Note that the sqlite3changeset_start_v2() API is still <b>experimental</b>
+** and therefore subject to change.
+*/
+SQLITE_API int sqlite3changeset_start(
+ sqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */
+ int nChangeset, /* Size of changeset blob in bytes */
+ void *pChangeset /* Pointer to blob containing changeset */
+);
+SQLITE_API int sqlite3changeset_start_v2(
+ sqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */
+ int nChangeset, /* Size of changeset blob in bytes */
+ void *pChangeset, /* Pointer to blob containing changeset */
+ int flags /* SESSION_CHANGESETSTART_* flags */
+);
+
+/*
+** CAPI3REF: Flags for sqlite3changeset_start_v2
+**
+** The following flags may passed via the 4th parameter to
+** [sqlite3changeset_start_v2] and [sqlite3changeset_start_v2_strm]:
+**
+** <dt>SQLITE_CHANGESETAPPLY_INVERT <dd>
+** Invert the changeset while iterating through it. This is equivalent to
+** inverting a changeset using sqlite3changeset_invert() before applying it.
+** It is an error to specify this flag with a patchset.
+*/
+#define SQLITE_CHANGESETSTART_INVERT 0x0002
+
+
+/*
+** CAPI3REF: Advance A Changeset Iterator
+** METHOD: sqlite3_changeset_iter
+**
+** This function may only be used with iterators created by the function
+** [sqlite3changeset_start()]. If it is called on an iterator passed to
+** a conflict-handler callback by [sqlite3changeset_apply()], SQLITE_MISUSE
+** is returned and the call has no effect.
+**
+** Immediately after an iterator is created by sqlite3changeset_start(), it
+** does not point to any change in the changeset. Assuming the changeset
+** is not empty, the first call to this function advances the iterator to
+** point to the first change in the changeset. Each subsequent call advances
+** the iterator to point to the next change in the changeset (if any). If
+** no error occurs and the iterator points to a valid change after a call
+** to sqlite3changeset_next() has advanced it, SQLITE_ROW is returned.
+** Otherwise, if all changes in the changeset have already been visited,
+** SQLITE_DONE is returned.
+**
+** If an error occurs, an SQLite error code is returned. Possible error
+** codes include SQLITE_CORRUPT (if the changeset buffer is corrupt) or
+** SQLITE_NOMEM.
+*/
+SQLITE_API int sqlite3changeset_next(sqlite3_changeset_iter *pIter);
+
+/*
+** CAPI3REF: Obtain The Current Operation From A Changeset Iterator
+** METHOD: sqlite3_changeset_iter
+**
+** The pIter argument passed to this function may either be an iterator
+** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator
+** created by [sqlite3changeset_start()]. In the latter case, the most recent
+** call to [sqlite3changeset_next()] must have returned [SQLITE_ROW]. If this
+** is not the case, this function returns [SQLITE_MISUSE].
+**
+** If argument pzTab is not NULL, then *pzTab is set to point to a
+** nul-terminated utf-8 encoded string containing the name of the table
+** affected by the current change. The buffer remains valid until either
+** sqlite3changeset_next() is called on the iterator or until the
+** conflict-handler function returns. If pnCol is not NULL, then *pnCol is
+** set to the number of columns in the table affected by the change. If
+** pbIndirect is not NULL, then *pbIndirect is set to true (1) if the change
+** is an indirect change, or false (0) otherwise. See the documentation for
+** [sqlite3session_indirect()] for a description of direct and indirect
+** changes. Finally, if pOp is not NULL, then *pOp is set to one of
+** [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE], depending on the
+** type of change that the iterator currently points to.
+**
+** If no error occurs, SQLITE_OK is returned. If an error does occur, an
+** SQLite error code is returned. The values of the output variables may not
+** be trusted in this case.
+*/
+SQLITE_API int sqlite3changeset_op(
+ sqlite3_changeset_iter *pIter, /* Iterator object */
+ const char **pzTab, /* OUT: Pointer to table name */
+ int *pnCol, /* OUT: Number of columns in table */
+ int *pOp, /* OUT: SQLITE_INSERT, DELETE or UPDATE */
+ int *pbIndirect /* OUT: True for an 'indirect' change */
+);
+
+/*
+** CAPI3REF: Obtain The Primary Key Definition Of A Table
+** METHOD: sqlite3_changeset_iter
+**
+** For each modified table, a changeset includes the following:
+**
+** <ul>
+** <li> The number of columns in the table, and
+** <li> Which of those columns make up the tables PRIMARY KEY.
+** </ul>
+**
+** This function is used to find which columns comprise the PRIMARY KEY of
+** the table modified by the change that iterator pIter currently points to.
+** If successful, *pabPK is set to point to an array of nCol entries, where
+** nCol is the number of columns in the table. Elements of *pabPK are set to
+** 0x01 if the corresponding column is part of the tables primary key, or
+** 0x00 if it is not.
+**
+** If argument pnCol is not NULL, then *pnCol is set to the number of columns
+** in the table.
+**
+** If this function is called when the iterator does not point to a valid
+** entry, SQLITE_MISUSE is returned and the output variables zeroed. Otherwise,
+** SQLITE_OK is returned and the output variables populated as described
+** above.
+*/
+SQLITE_API int sqlite3changeset_pk(
+ sqlite3_changeset_iter *pIter, /* Iterator object */
+ unsigned char **pabPK, /* OUT: Array of boolean - true for PK cols */
+ int *pnCol /* OUT: Number of entries in output array */
+);
+
+/*
+** CAPI3REF: Obtain old.* Values From A Changeset Iterator
+** METHOD: sqlite3_changeset_iter
+**
+** The pIter argument passed to this function may either be an iterator
+** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator
+** created by [sqlite3changeset_start()]. In the latter case, the most recent
+** call to [sqlite3changeset_next()] must have returned SQLITE_ROW.
+** Furthermore, it may only be called if the type of change that the iterator
+** currently points to is either [SQLITE_DELETE] or [SQLITE_UPDATE]. Otherwise,
+** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL.
+**
+** Argument iVal must be greater than or equal to 0, and less than the number
+** of columns in the table affected by the current change. Otherwise,
+** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
+**
+** If successful, this function sets *ppValue to point to a protected
+** sqlite3_value object containing the iVal'th value from the vector of
+** original row values stored as part of the UPDATE or DELETE change and
+** returns SQLITE_OK. The name of the function comes from the fact that this
+** is similar to the "old.*" columns available to update or delete triggers.
+**
+** If some other error occurs (e.g. an OOM condition), an SQLite error code
+** is returned and *ppValue is set to NULL.
+*/
+SQLITE_API int sqlite3changeset_old(
+ sqlite3_changeset_iter *pIter, /* Changeset iterator */
+ int iVal, /* Column number */
+ sqlite3_value **ppValue /* OUT: Old value (or NULL pointer) */
+);
+
+/*
+** CAPI3REF: Obtain new.* Values From A Changeset Iterator
+** METHOD: sqlite3_changeset_iter
+**
+** The pIter argument passed to this function may either be an iterator
+** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator
+** created by [sqlite3changeset_start()]. In the latter case, the most recent
+** call to [sqlite3changeset_next()] must have returned SQLITE_ROW.
+** Furthermore, it may only be called if the type of change that the iterator
+** currently points to is either [SQLITE_UPDATE] or [SQLITE_INSERT]. Otherwise,
+** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL.
+**
+** Argument iVal must be greater than or equal to 0, and less than the number
+** of columns in the table affected by the current change. Otherwise,
+** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
+**
+** If successful, this function sets *ppValue to point to a protected
+** sqlite3_value object containing the iVal'th value from the vector of
+** new row values stored as part of the UPDATE or INSERT change and
+** returns SQLITE_OK. If the change is an UPDATE and does not include
+** a new value for the requested column, *ppValue is set to NULL and
+** SQLITE_OK returned. The name of the function comes from the fact that
+** this is similar to the "new.*" columns available to update or delete
+** triggers.
+**
+** If some other error occurs (e.g. an OOM condition), an SQLite error code
+** is returned and *ppValue is set to NULL.
+*/
+SQLITE_API int sqlite3changeset_new(
+ sqlite3_changeset_iter *pIter, /* Changeset iterator */
+ int iVal, /* Column number */
+ sqlite3_value **ppValue /* OUT: New value (or NULL pointer) */
+);
+
+/*
+** CAPI3REF: Obtain Conflicting Row Values From A Changeset Iterator
+** METHOD: sqlite3_changeset_iter
+**
+** This function should only be used with iterator objects passed to a
+** conflict-handler callback by [sqlite3changeset_apply()] with either
+** [SQLITE_CHANGESET_DATA] or [SQLITE_CHANGESET_CONFLICT]. If this function
+** is called on any other iterator, [SQLITE_MISUSE] is returned and *ppValue
+** is set to NULL.
+**
+** Argument iVal must be greater than or equal to 0, and less than the number
+** of columns in the table affected by the current change. Otherwise,
+** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
+**
+** If successful, this function sets *ppValue to point to a protected
+** sqlite3_value object containing the iVal'th value from the
+** "conflicting row" associated with the current conflict-handler callback
+** and returns SQLITE_OK.
+**
+** If some other error occurs (e.g. an OOM condition), an SQLite error code
+** is returned and *ppValue is set to NULL.
+*/
+SQLITE_API int sqlite3changeset_conflict(
+ sqlite3_changeset_iter *pIter, /* Changeset iterator */
+ int iVal, /* Column number */
+ sqlite3_value **ppValue /* OUT: Value from conflicting row */
+);
+
+/*
+** CAPI3REF: Determine The Number Of Foreign Key Constraint Violations
+** METHOD: sqlite3_changeset_iter
+**
+** This function may only be called with an iterator passed to an
+** SQLITE_CHANGESET_FOREIGN_KEY conflict handler callback. In this case
+** it sets the output variable to the total number of known foreign key
+** violations in the destination database and returns SQLITE_OK.
+**
+** In all other cases this function returns SQLITE_MISUSE.
+*/
+SQLITE_API int sqlite3changeset_fk_conflicts(
+ sqlite3_changeset_iter *pIter, /* Changeset iterator */
+ int *pnOut /* OUT: Number of FK violations */
+);
+
+
+/*
+** CAPI3REF: Finalize A Changeset Iterator
+** METHOD: sqlite3_changeset_iter
+**
+** This function is used to finalize an iterator allocated with
+** [sqlite3changeset_start()].
+**
+** This function should only be called on iterators created using the
+** [sqlite3changeset_start()] function. If an application calls this
+** function with an iterator passed to a conflict-handler by
+** [sqlite3changeset_apply()], [SQLITE_MISUSE] is immediately returned and the
+** call has no effect.
+**
+** If an error was encountered within a call to an sqlite3changeset_xxx()
+** function (for example an [SQLITE_CORRUPT] in [sqlite3changeset_next()] or an
+** [SQLITE_NOMEM] in [sqlite3changeset_new()]) then an error code corresponding
+** to that error is returned by this function. Otherwise, SQLITE_OK is
+** returned. This is to allow the following pattern (pseudo-code):
+**
+** <pre>
+** sqlite3changeset_start();
+** while( SQLITE_ROW==sqlite3changeset_next() ){
+** // Do something with change.
+** }
+** rc = sqlite3changeset_finalize();
+** if( rc!=SQLITE_OK ){
+** // An error has occurred
+** }
+** </pre>
+*/
+SQLITE_API int sqlite3changeset_finalize(sqlite3_changeset_iter *pIter);
+
+/*
+** CAPI3REF: Invert A Changeset
+**
+** This function is used to "invert" a changeset object. Applying an inverted
+** changeset to a database reverses the effects of applying the uninverted
+** changeset. Specifically:
+**
+** <ul>
+** <li> Each DELETE change is changed to an INSERT, and
+** <li> Each INSERT change is changed to a DELETE, and
+** <li> For each UPDATE change, the old.* and new.* values are exchanged.
+** </ul>
+**
+** This function does not change the order in which changes appear within
+** the changeset. It merely reverses the sense of each individual change.
+**
+** If successful, a pointer to a buffer containing the inverted changeset
+** is stored in *ppOut, the size of the same buffer is stored in *pnOut, and
+** SQLITE_OK is returned. If an error occurs, both *pnOut and *ppOut are
+** zeroed and an SQLite error code returned.
+**
+** It is the responsibility of the caller to eventually call sqlite3_free()
+** on the *ppOut pointer to free the buffer allocation following a successful
+** call to this function.
+**
+** WARNING/TODO: This function currently assumes that the input is a valid
+** changeset. If it is not, the results are undefined.
+*/
+SQLITE_API int sqlite3changeset_invert(
+ int nIn, const void *pIn, /* Input changeset */
+ int *pnOut, void **ppOut /* OUT: Inverse of input */
+);
+
+/*
+** CAPI3REF: Concatenate Two Changeset Objects
+**
+** This function is used to concatenate two changesets, A and B, into a
+** single changeset. The result is a changeset equivalent to applying
+** changeset A followed by changeset B.
+**
+** This function combines the two input changesets using an
+** sqlite3_changegroup object. Calling it produces similar results as the
+** following code fragment:
+**
+** <pre>
+** sqlite3_changegroup *pGrp;
+** rc = sqlite3_changegroup_new(&pGrp);
+** if( rc==SQLITE_OK ) rc = sqlite3changegroup_add(pGrp, nA, pA);
+** if( rc==SQLITE_OK ) rc = sqlite3changegroup_add(pGrp, nB, pB);
+** if( rc==SQLITE_OK ){
+** rc = sqlite3changegroup_output(pGrp, pnOut, ppOut);
+** }else{
+** *ppOut = 0;
+** *pnOut = 0;
+** }
+** </pre>
+**
+** Refer to the sqlite3_changegroup documentation below for details.
+*/
+SQLITE_API int sqlite3changeset_concat(
+ int nA, /* Number of bytes in buffer pA */
+ void *pA, /* Pointer to buffer containing changeset A */
+ int nB, /* Number of bytes in buffer pB */
+ void *pB, /* Pointer to buffer containing changeset B */
+ int *pnOut, /* OUT: Number of bytes in output changeset */
+ void **ppOut /* OUT: Buffer containing output changeset */
+);
+
+
+/*
+** CAPI3REF: Changegroup Handle
+**
+** A changegroup is an object used to combine two or more
+** [changesets] or [patchsets]
+*/
+typedef struct sqlite3_changegroup sqlite3_changegroup;
+
+/*
+** CAPI3REF: Create A New Changegroup Object
+** CONSTRUCTOR: sqlite3_changegroup
+**
+** An sqlite3_changegroup object is used to combine two or more changesets
+** (or patchsets) into a single changeset (or patchset). A single changegroup
+** object may combine changesets or patchsets, but not both. The output is
+** always in the same format as the input.
+**
+** If successful, this function returns SQLITE_OK and populates (*pp) with
+** a pointer to a new sqlite3_changegroup object before returning. The caller
+** should eventually free the returned object using a call to
+** sqlite3changegroup_delete(). If an error occurs, an SQLite error code
+** (i.e. SQLITE_NOMEM) is returned and *pp is set to NULL.
+**
+** The usual usage pattern for an sqlite3_changegroup object is as follows:
+**
+** <ul>
+** <li> It is created using a call to sqlite3changegroup_new().
+**
+** <li> Zero or more changesets (or patchsets) are added to the object
+** by calling sqlite3changegroup_add().
+**
+** <li> The result of combining all input changesets together is obtained
+** by the application via a call to sqlite3changegroup_output().
+**
+** <li> The object is deleted using a call to sqlite3changegroup_delete().
+** </ul>
+**
+** Any number of calls to add() and output() may be made between the calls to
+** new() and delete(), and in any order.
+**
+** As well as the regular sqlite3changegroup_add() and
+** sqlite3changegroup_output() functions, also available are the streaming
+** versions sqlite3changegroup_add_strm() and sqlite3changegroup_output_strm().
+*/
+SQLITE_API int sqlite3changegroup_new(sqlite3_changegroup **pp);
+
+/*
+** CAPI3REF: Add A Changeset To A Changegroup
+** METHOD: sqlite3_changegroup
+**
+** Add all changes within the changeset (or patchset) in buffer pData (size
+** nData bytes) to the changegroup.
+**
+** If the buffer contains a patchset, then all prior calls to this function
+** on the same changegroup object must also have specified patchsets. Or, if
+** the buffer contains a changeset, so must have the earlier calls to this
+** function. Otherwise, SQLITE_ERROR is returned and no changes are added
+** to the changegroup.
+**
+** Rows within the changeset and changegroup are identified by the values in
+** their PRIMARY KEY columns. A change in the changeset is considered to
+** apply to the same row as a change already present in the changegroup if
+** the two rows have the same primary key.
+**
+** Changes to rows that do not already appear in the changegroup are
+** simply copied into it. Or, if both the new changeset and the changegroup
+** contain changes that apply to a single row, the final contents of the
+** changegroup depends on the type of each change, as follows:
+**
+** <table border=1 style="margin-left:8ex;margin-right:8ex">
+** <tr><th style="white-space:pre">Existing Change </th>
+** <th style="white-space:pre">New Change </th>
+** <th>Output Change
+** <tr><td>INSERT <td>INSERT <td>
+** The new change is ignored. This case does not occur if the new
+** changeset was recorded immediately after the changesets already
+** added to the changegroup.
+** <tr><td>INSERT <td>UPDATE <td>
+** The INSERT change remains in the changegroup. The values in the
+** INSERT change are modified as if the row was inserted by the
+** existing change and then updated according to the new change.
+** <tr><td>INSERT <td>DELETE <td>
+** The existing INSERT is removed from the changegroup. The DELETE is
+** not added.
+** <tr><td>UPDATE <td>INSERT <td>
+** The new change is ignored. This case does not occur if the new
+** changeset was recorded immediately after the changesets already
+** added to the changegroup.
+** <tr><td>UPDATE <td>UPDATE <td>
+** The existing UPDATE remains within the changegroup. It is amended
+** so that the accompanying values are as if the row was updated once
+** by the existing change and then again by the new change.
+** <tr><td>UPDATE <td>DELETE <td>
+** The existing UPDATE is replaced by the new DELETE within the
+** changegroup.
+** <tr><td>DELETE <td>INSERT <td>
+** If one or more of the column values in the row inserted by the
+** new change differ from those in the row deleted by the existing
+** change, the existing DELETE is replaced by an UPDATE within the
+** changegroup. Otherwise, if the inserted row is exactly the same
+** as the deleted row, the existing DELETE is simply discarded.
+** <tr><td>DELETE <td>UPDATE <td>
+** The new change is ignored. This case does not occur if the new
+** changeset was recorded immediately after the changesets already
+** added to the changegroup.
+** <tr><td>DELETE <td>DELETE <td>
+** The new change is ignored. This case does not occur if the new
+** changeset was recorded immediately after the changesets already
+** added to the changegroup.
+** </table>
+**
+** If the new changeset contains changes to a table that is already present
+** in the changegroup, then the number of columns and the position of the
+** primary key columns for the table must be consistent. If this is not the
+** case, this function fails with SQLITE_SCHEMA. If the input changeset
+** appears to be corrupt and the corruption is detected, SQLITE_CORRUPT is
+** returned. Or, if an out-of-memory condition occurs during processing, this
+** function returns SQLITE_NOMEM. In all cases, if an error occurs the state
+** of the final contents of the changegroup is undefined.
+**
+** If no error occurs, SQLITE_OK is returned.
+*/
+SQLITE_API int sqlite3changegroup_add(sqlite3_changegroup*, int nData, void *pData);
+
+/*
+** CAPI3REF: Obtain A Composite Changeset From A Changegroup
+** METHOD: sqlite3_changegroup
+**
+** Obtain a buffer containing a changeset (or patchset) representing the
+** current contents of the changegroup. If the inputs to the changegroup
+** were themselves changesets, the output is a changeset. Or, if the
+** inputs were patchsets, the output is also a patchset.
+**
+** As with the output of the sqlite3session_changeset() and
+** sqlite3session_patchset() functions, all changes related to a single
+** table are grouped together in the output of this function. Tables appear
+** in the same order as for the very first changeset added to the changegroup.
+** If the second or subsequent changesets added to the changegroup contain
+** changes for tables that do not appear in the first changeset, they are
+** appended onto the end of the output changeset, again in the order in
+** which they are first encountered.
+**
+** If an error occurs, an SQLite error code is returned and the output
+** variables (*pnData) and (*ppData) are set to 0. Otherwise, SQLITE_OK
+** is returned and the output variables are set to the size of and a
+** pointer to the output buffer, respectively. In this case it is the
+** responsibility of the caller to eventually free the buffer using a
+** call to sqlite3_free().
+*/
+SQLITE_API int sqlite3changegroup_output(
+ sqlite3_changegroup*,
+ int *pnData, /* OUT: Size of output buffer in bytes */
+ void **ppData /* OUT: Pointer to output buffer */
+);
+
+/*
+** CAPI3REF: Delete A Changegroup Object
+** DESTRUCTOR: sqlite3_changegroup
+*/
+SQLITE_API void sqlite3changegroup_delete(sqlite3_changegroup*);
+
+/*
+** CAPI3REF: Apply A Changeset To A Database
+**
+** Apply a changeset or patchset to a database. These functions attempt to
+** update the "main" database attached to handle db with the changes found in
+** the changeset passed via the second and third arguments.
+**
+** The fourth argument (xFilter) passed to these functions is the "filter
+** callback". If it is not NULL, then for each table affected by at least one
+** change in the changeset, the filter callback is invoked with
+** the table name as the second argument, and a copy of the context pointer
+** passed as the sixth argument as the first. If the "filter callback"
+** returns zero, then no attempt is made to apply any changes to the table.
+** Otherwise, if the return value is non-zero or the xFilter argument to
+** is NULL, all changes related to the table are attempted.
+**
+** For each table that is not excluded by the filter callback, this function
+** tests that the target database contains a compatible table. A table is
+** considered compatible if all of the following are true:
+**
+** <ul>
+** <li> The table has the same name as the name recorded in the
+** changeset, and
+** <li> The table has at least as many columns as recorded in the
+** changeset, and
+** <li> The table has primary key columns in the same position as
+** recorded in the changeset.
+** </ul>
+**
+** If there is no compatible table, it is not an error, but none of the
+** changes associated with the table are applied. A warning message is issued
+** via the sqlite3_log() mechanism with the error code SQLITE_SCHEMA. At most
+** one such warning is issued for each table in the changeset.
+**
+** For each change for which there is a compatible table, an attempt is made
+** to modify the table contents according to the UPDATE, INSERT or DELETE
+** change. If a change cannot be applied cleanly, the conflict handler
+** function passed as the fifth argument to sqlite3changeset_apply() may be
+** invoked. A description of exactly when the conflict handler is invoked for
+** each type of change is below.
+**
+** Unlike the xFilter argument, xConflict may not be passed NULL. The results
+** of passing anything other than a valid function pointer as the xConflict
+** argument are undefined.
+**
+** Each time the conflict handler function is invoked, it must return one
+** of [SQLITE_CHANGESET_OMIT], [SQLITE_CHANGESET_ABORT] or
+** [SQLITE_CHANGESET_REPLACE]. SQLITE_CHANGESET_REPLACE may only be returned
+** if the second argument passed to the conflict handler is either
+** SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If the conflict-handler
+** returns an illegal value, any changes already made are rolled back and
+** the call to sqlite3changeset_apply() returns SQLITE_MISUSE. Different
+** actions are taken by sqlite3changeset_apply() depending on the value
+** returned by each invocation of the conflict-handler function. Refer to
+** the documentation for the three
+** [SQLITE_CHANGESET_OMIT|available return values] for details.
+**
+** <dl>
+** <dt>DELETE Changes<dd>
+** For each DELETE change, the function checks if the target database
+** contains a row with the same primary key value (or values) as the
+** original row values stored in the changeset. If it does, and the values
+** stored in all non-primary key columns also match the values stored in
+** the changeset the row is deleted from the target database.
+**
+** If a row with matching primary key values is found, but one or more of
+** the non-primary key fields contains a value different from the original
+** row value stored in the changeset, the conflict-handler function is
+** invoked with [SQLITE_CHANGESET_DATA] as the second argument. If the
+** database table has more columns than are recorded in the changeset,
+** only the values of those non-primary key fields are compared against
+** the current database contents - any trailing database table columns
+** are ignored.
+**
+** If no row with matching primary key values is found in the database,
+** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND]
+** passed as the second argument.
+**
+** If the DELETE operation is attempted, but SQLite returns SQLITE_CONSTRAINT
+** (which can only happen if a foreign key constraint is violated), the
+** conflict-handler function is invoked with [SQLITE_CHANGESET_CONSTRAINT]
+** passed as the second argument. This includes the case where the DELETE
+** operation is attempted because an earlier call to the conflict handler
+** function returned [SQLITE_CHANGESET_REPLACE].
+**
+** <dt>INSERT Changes<dd>
+** For each INSERT change, an attempt is made to insert the new row into
+** the database. If the changeset row contains fewer fields than the
+** database table, the trailing fields are populated with their default
+** values.
+**
+** If the attempt to insert the row fails because the database already
+** contains a row with the same primary key values, the conflict handler
+** function is invoked with the second argument set to
+** [SQLITE_CHANGESET_CONFLICT].
+**
+** If the attempt to insert the row fails because of some other constraint
+** violation (e.g. NOT NULL or UNIQUE), the conflict handler function is
+** invoked with the second argument set to [SQLITE_CHANGESET_CONSTRAINT].
+** This includes the case where the INSERT operation is re-attempted because
+** an earlier call to the conflict handler function returned
+** [SQLITE_CHANGESET_REPLACE].
+**
+** <dt>UPDATE Changes<dd>
+** For each UPDATE change, the function checks if the target database
+** contains a row with the same primary key value (or values) as the
+** original row values stored in the changeset. If it does, and the values
+** stored in all modified non-primary key columns also match the values
+** stored in the changeset the row is updated within the target database.
+**
+** If a row with matching primary key values is found, but one or more of
+** the modified non-primary key fields contains a value different from an
+** original row value stored in the changeset, the conflict-handler function
+** is invoked with [SQLITE_CHANGESET_DATA] as the second argument. Since
+** UPDATE changes only contain values for non-primary key fields that are
+** to be modified, only those fields need to match the original values to
+** avoid the SQLITE_CHANGESET_DATA conflict-handler callback.
+**
+** If no row with matching primary key values is found in the database,
+** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND]
+** passed as the second argument.
+**
+** If the UPDATE operation is attempted, but SQLite returns
+** SQLITE_CONSTRAINT, the conflict-handler function is invoked with
+** [SQLITE_CHANGESET_CONSTRAINT] passed as the second argument.
+** This includes the case where the UPDATE operation is attempted after
+** an earlier call to the conflict handler function returned
+** [SQLITE_CHANGESET_REPLACE].
+** </dl>
+**
+** It is safe to execute SQL statements, including those that write to the
+** table that the callback related to, from within the xConflict callback.
+** This can be used to further customize the application's conflict
+** resolution strategy.
+**
+** All changes made by these functions are enclosed in a savepoint transaction.
+** If any other error (aside from a constraint failure when attempting to
+** write to the target database) occurs, then the savepoint transaction is
+** rolled back, restoring the target database to its original state, and an
+** SQLite error code returned.
+**
+** If the output parameters (ppRebase) and (pnRebase) are non-NULL and
+** the input is a changeset (not a patchset), then sqlite3changeset_apply_v2()
+** may set (*ppRebase) to point to a "rebase" that may be used with the
+** sqlite3_rebaser APIs buffer before returning. In this case (*pnRebase)
+** is set to the size of the buffer in bytes. It is the responsibility of the
+** caller to eventually free any such buffer using sqlite3_free(). The buffer
+** is only allocated and populated if one or more conflicts were encountered
+** while applying the patchset. See comments surrounding the sqlite3_rebaser
+** APIs for further details.
+**
+** The behavior of sqlite3changeset_apply_v2() and its streaming equivalent
+** may be modified by passing a combination of
+** [SQLITE_CHANGESETAPPLY_NOSAVEPOINT | supported flags] as the 9th parameter.
+**
+** Note that the sqlite3changeset_apply_v2() API is still <b>experimental</b>
+** and therefore subject to change.
+*/
+SQLITE_API int sqlite3changeset_apply(
+ sqlite3 *db, /* Apply change to "main" db of this handle */
+ int nChangeset, /* Size of changeset in bytes */
+ void *pChangeset, /* Changeset blob */
+ int(*xFilter)(
+ void *pCtx, /* Copy of sixth arg to _apply() */
+ const char *zTab /* Table name */
+ ),
+ int(*xConflict)(
+ void *pCtx, /* Copy of sixth arg to _apply() */
+ int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
+ sqlite3_changeset_iter *p /* Handle describing change and conflict */
+ ),
+ void *pCtx /* First argument passed to xConflict */
+);
+SQLITE_API int sqlite3changeset_apply_v2(
+ sqlite3 *db, /* Apply change to "main" db of this handle */
+ int nChangeset, /* Size of changeset in bytes */
+ void *pChangeset, /* Changeset blob */
+ int(*xFilter)(
+ void *pCtx, /* Copy of sixth arg to _apply() */
+ const char *zTab /* Table name */
+ ),
+ int(*xConflict)(
+ void *pCtx, /* Copy of sixth arg to _apply() */
+ int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
+ sqlite3_changeset_iter *p /* Handle describing change and conflict */
+ ),
+ void *pCtx, /* First argument passed to xConflict */
+ void **ppRebase, int *pnRebase, /* OUT: Rebase data */
+ int flags /* SESSION_CHANGESETAPPLY_* flags */
+);
+
+/*
+** CAPI3REF: Flags for sqlite3changeset_apply_v2
+**
+** The following flags may passed via the 9th parameter to
+** [sqlite3changeset_apply_v2] and [sqlite3changeset_apply_v2_strm]:
+**
+** <dl>
+** <dt>SQLITE_CHANGESETAPPLY_NOSAVEPOINT <dd>
+** Usually, the sessions module encloses all operations performed by
+** a single call to apply_v2() or apply_v2_strm() in a [SAVEPOINT]. The
+** SAVEPOINT is committed if the changeset or patchset is successfully
+** applied, or rolled back if an error occurs. Specifying this flag
+** causes the sessions module to omit this savepoint. In this case, if the
+** caller has an open transaction or savepoint when apply_v2() is called,
+** it may revert the partially applied changeset by rolling it back.
+**
+** <dt>SQLITE_CHANGESETAPPLY_INVERT <dd>
+** Invert the changeset before applying it. This is equivalent to inverting
+** a changeset using sqlite3changeset_invert() before applying it. It is
+** an error to specify this flag with a patchset.
+*/
+#define SQLITE_CHANGESETAPPLY_NOSAVEPOINT 0x0001
+#define SQLITE_CHANGESETAPPLY_INVERT 0x0002
+
+/*
+** CAPI3REF: Constants Passed To The Conflict Handler
+**
+** Values that may be passed as the second argument to a conflict-handler.
+**
+** <dl>
+** <dt>SQLITE_CHANGESET_DATA<dd>
+** The conflict handler is invoked with CHANGESET_DATA as the second argument
+** when processing a DELETE or UPDATE change if a row with the required
+** PRIMARY KEY fields is present in the database, but one or more other
+** (non primary-key) fields modified by the update do not contain the
+** expected "before" values.
+**
+** The conflicting row, in this case, is the database row with the matching
+** primary key.
+**
+** <dt>SQLITE_CHANGESET_NOTFOUND<dd>
+** The conflict handler is invoked with CHANGESET_NOTFOUND as the second
+** argument when processing a DELETE or UPDATE change if a row with the
+** required PRIMARY KEY fields is not present in the database.
+**
+** There is no conflicting row in this case. The results of invoking the
+** sqlite3changeset_conflict() API are undefined.
+**
+** <dt>SQLITE_CHANGESET_CONFLICT<dd>
+** CHANGESET_CONFLICT is passed as the second argument to the conflict
+** handler while processing an INSERT change if the operation would result
+** in duplicate primary key values.
+**
+** The conflicting row in this case is the database row with the matching
+** primary key.
+**
+** <dt>SQLITE_CHANGESET_FOREIGN_KEY<dd>
+** If foreign key handling is enabled, and applying a changeset leaves the
+** database in a state containing foreign key violations, the conflict
+** handler is invoked with CHANGESET_FOREIGN_KEY as the second argument
+** exactly once before the changeset is committed. If the conflict handler
+** returns CHANGESET_OMIT, the changes, including those that caused the
+** foreign key constraint violation, are committed. Or, if it returns
+** CHANGESET_ABORT, the changeset is rolled back.
+**
+** No current or conflicting row information is provided. The only function
+** it is possible to call on the supplied sqlite3_changeset_iter handle
+** is sqlite3changeset_fk_conflicts().
+**
+** <dt>SQLITE_CHANGESET_CONSTRAINT<dd>
+** If any other constraint violation occurs while applying a change (i.e.
+** a UNIQUE, CHECK or NOT NULL constraint), the conflict handler is
+** invoked with CHANGESET_CONSTRAINT as the second argument.
+**
+** There is no conflicting row in this case. The results of invoking the
+** sqlite3changeset_conflict() API are undefined.
+**
+** </dl>
+*/
+#define SQLITE_CHANGESET_DATA 1
+#define SQLITE_CHANGESET_NOTFOUND 2
+#define SQLITE_CHANGESET_CONFLICT 3
+#define SQLITE_CHANGESET_CONSTRAINT 4
+#define SQLITE_CHANGESET_FOREIGN_KEY 5
+
+/*
+** CAPI3REF: Constants Returned By The Conflict Handler
+**
+** A conflict handler callback must return one of the following three values.
+**
+** <dl>
+** <dt>SQLITE_CHANGESET_OMIT<dd>
+** If a conflict handler returns this value no special action is taken. The
+** change that caused the conflict is not applied. The session module
+** continues to the next change in the changeset.
+**
+** <dt>SQLITE_CHANGESET_REPLACE<dd>
+** This value may only be returned if the second argument to the conflict
+** handler was SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If this
+** is not the case, any changes applied so far are rolled back and the
+** call to sqlite3changeset_apply() returns SQLITE_MISUSE.
+**
+** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_DATA conflict
+** handler, then the conflicting row is either updated or deleted, depending
+** on the type of change.
+**
+** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_CONFLICT conflict
+** handler, then the conflicting row is removed from the database and a
+** second attempt to apply the change is made. If this second attempt fails,
+** the original row is restored to the database before continuing.
+**
+** <dt>SQLITE_CHANGESET_ABORT<dd>
+** If this value is returned, any changes applied so far are rolled back
+** and the call to sqlite3changeset_apply() returns SQLITE_ABORT.
+** </dl>
+*/
+#define SQLITE_CHANGESET_OMIT 0
+#define SQLITE_CHANGESET_REPLACE 1
+#define SQLITE_CHANGESET_ABORT 2
+
+/*
+** CAPI3REF: Rebasing changesets
+** EXPERIMENTAL
+**
+** Suppose there is a site hosting a database in state S0. And that
+** modifications are made that move that database to state S1 and a
+** changeset recorded (the "local" changeset). Then, a changeset based
+** on S0 is received from another site (the "remote" changeset) and
+** applied to the database. The database is then in state
+** (S1+"remote"), where the exact state depends on any conflict
+** resolution decisions (OMIT or REPLACE) made while applying "remote".
+** Rebasing a changeset is to update it to take those conflict
+** resolution decisions into account, so that the same conflicts
+** do not have to be resolved elsewhere in the network.
+**
+** For example, if both the local and remote changesets contain an
+** INSERT of the same key on "CREATE TABLE t1(a PRIMARY KEY, b)":
+**
+** local: INSERT INTO t1 VALUES(1, 'v1');
+** remote: INSERT INTO t1 VALUES(1, 'v2');
+**
+** and the conflict resolution is REPLACE, then the INSERT change is
+** removed from the local changeset (it was overridden). Or, if the
+** conflict resolution was "OMIT", then the local changeset is modified
+** to instead contain:
+**
+** UPDATE t1 SET b = 'v2' WHERE a=1;
+**
+** Changes within the local changeset are rebased as follows:
+**
+** <dl>
+** <dt>Local INSERT<dd>
+** This may only conflict with a remote INSERT. If the conflict
+** resolution was OMIT, then add an UPDATE change to the rebased
+** changeset. Or, if the conflict resolution was REPLACE, add
+** nothing to the rebased changeset.
+**
+** <dt>Local DELETE<dd>
+** This may conflict with a remote UPDATE or DELETE. In both cases the
+** only possible resolution is OMIT. If the remote operation was a
+** DELETE, then add no change to the rebased changeset. If the remote
+** operation was an UPDATE, then the old.* fields of change are updated
+** to reflect the new.* values in the UPDATE.
+**
+** <dt>Local UPDATE<dd>
+** This may conflict with a remote UPDATE or DELETE. If it conflicts
+** with a DELETE, and the conflict resolution was OMIT, then the update
+** is changed into an INSERT. Any undefined values in the new.* record
+** from the update change are filled in using the old.* values from
+** the conflicting DELETE. Or, if the conflict resolution was REPLACE,
+** the UPDATE change is simply omitted from the rebased changeset.
+**
+** If conflict is with a remote UPDATE and the resolution is OMIT, then
+** the old.* values are rebased using the new.* values in the remote
+** change. Or, if the resolution is REPLACE, then the change is copied
+** into the rebased changeset with updates to columns also updated by
+** the conflicting remote UPDATE removed. If this means no columns would
+** be updated, the change is omitted.
+** </dl>
+**
+** A local change may be rebased against multiple remote changes
+** simultaneously. If a single key is modified by multiple remote
+** changesets, they are combined as follows before the local changeset
+** is rebased:
+**
+** <ul>
+** <li> If there has been one or more REPLACE resolutions on a
+** key, it is rebased according to a REPLACE.
+**
+** <li> If there have been no REPLACE resolutions on a key, then
+** the local changeset is rebased according to the most recent
+** of the OMIT resolutions.
+** </ul>
+**
+** Note that conflict resolutions from multiple remote changesets are
+** combined on a per-field basis, not per-row. This means that in the
+** case of multiple remote UPDATE operations, some fields of a single
+** local change may be rebased for REPLACE while others are rebased for
+** OMIT.
+**
+** In order to rebase a local changeset, the remote changeset must first
+** be applied to the local database using sqlite3changeset_apply_v2() and
+** the buffer of rebase information captured. Then:
+**
+** <ol>
+** <li> An sqlite3_rebaser object is created by calling
+** sqlite3rebaser_create().
+** <li> The new object is configured with the rebase buffer obtained from
+** sqlite3changeset_apply_v2() by calling sqlite3rebaser_configure().
+** If the local changeset is to be rebased against multiple remote
+** changesets, then sqlite3rebaser_configure() should be called
+** multiple times, in the same order that the multiple
+** sqlite3changeset_apply_v2() calls were made.
+** <li> Each local changeset is rebased by calling sqlite3rebaser_rebase().
+** <li> The sqlite3_rebaser object is deleted by calling
+** sqlite3rebaser_delete().
+** </ol>
+*/
+typedef struct sqlite3_rebaser sqlite3_rebaser;
+
+/*
+** CAPI3REF: Create a changeset rebaser object.
+** EXPERIMENTAL
+**
+** Allocate a new changeset rebaser object. If successful, set (*ppNew) to
+** point to the new object and return SQLITE_OK. Otherwise, if an error
+** occurs, return an SQLite error code (e.g. SQLITE_NOMEM) and set (*ppNew)
+** to NULL.
+*/
+SQLITE_API int sqlite3rebaser_create(sqlite3_rebaser **ppNew);
+
+/*
+** CAPI3REF: Configure a changeset rebaser object.
+** EXPERIMENTAL
+**
+** Configure the changeset rebaser object to rebase changesets according
+** to the conflict resolutions described by buffer pRebase (size nRebase
+** bytes), which must have been obtained from a previous call to
+** sqlite3changeset_apply_v2().
+*/
+SQLITE_API int sqlite3rebaser_configure(
+ sqlite3_rebaser*,
+ int nRebase, const void *pRebase
+);
+
+/*
+** CAPI3REF: Rebase a changeset
+** EXPERIMENTAL
+**
+** Argument pIn must point to a buffer containing a changeset nIn bytes
+** in size. This function allocates and populates a buffer with a copy
+** of the changeset rebased according to the configuration of the
+** rebaser object passed as the first argument. If successful, (*ppOut)
+** is set to point to the new buffer containing the rebased changeset and
+** (*pnOut) to its size in bytes and SQLITE_OK returned. It is the
+** responsibility of the caller to eventually free the new buffer using
+** sqlite3_free(). Otherwise, if an error occurs, (*ppOut) and (*pnOut)
+** are set to zero and an SQLite error code returned.
+*/
+SQLITE_API int sqlite3rebaser_rebase(
+ sqlite3_rebaser*,
+ int nIn, const void *pIn,
+ int *pnOut, void **ppOut
+);
+
+/*
+** CAPI3REF: Delete a changeset rebaser object.
+** EXPERIMENTAL
+**
+** Delete the changeset rebaser object and all associated resources. There
+** should be one call to this function for each successful invocation
+** of sqlite3rebaser_create().
+*/
+SQLITE_API void sqlite3rebaser_delete(sqlite3_rebaser *p);
+
+/*
+** CAPI3REF: Streaming Versions of API functions.
+**
+** The six streaming API xxx_strm() functions serve similar purposes to the
+** corresponding non-streaming API functions:
+**
+** <table border=1 style="margin-left:8ex;margin-right:8ex">
+** <tr><th>Streaming function<th>Non-streaming equivalent</th>
+** <tr><td>sqlite3changeset_apply_strm<td>[sqlite3changeset_apply]
+** <tr><td>sqlite3changeset_apply_strm_v2<td>[sqlite3changeset_apply_v2]
+** <tr><td>sqlite3changeset_concat_strm<td>[sqlite3changeset_concat]
+** <tr><td>sqlite3changeset_invert_strm<td>[sqlite3changeset_invert]
+** <tr><td>sqlite3changeset_start_strm<td>[sqlite3changeset_start]
+** <tr><td>sqlite3session_changeset_strm<td>[sqlite3session_changeset]
+** <tr><td>sqlite3session_patchset_strm<td>[sqlite3session_patchset]
+** </table>
+**
+** Non-streaming functions that accept changesets (or patchsets) as input
+** require that the entire changeset be stored in a single buffer in memory.
+** Similarly, those that return a changeset or patchset do so by returning
+** a pointer to a single large buffer allocated using sqlite3_malloc().
+** Normally this is convenient. However, if an application running in a
+** low-memory environment is required to handle very large changesets, the
+** large contiguous memory allocations required can become onerous.
+**
+** In order to avoid this problem, instead of a single large buffer, input
+** is passed to a streaming API functions by way of a callback function that
+** the sessions module invokes to incrementally request input data as it is
+** required. In all cases, a pair of API function parameters such as
+**
+** <pre>
+** int nChangeset,
+** void *pChangeset,
+** </pre>
+**
+** Is replaced by:
+**
+** <pre>
+** int (*xInput)(void *pIn, void *pData, int *pnData),
+** void *pIn,
+** </pre>
+**
+** Each time the xInput callback is invoked by the sessions module, the first
+** argument passed is a copy of the supplied pIn context pointer. The second
+** argument, pData, points to a buffer (*pnData) bytes in size. Assuming no
+** error occurs the xInput method should copy up to (*pnData) bytes of data
+** into the buffer and set (*pnData) to the actual number of bytes copied
+** before returning SQLITE_OK. If the input is completely exhausted, (*pnData)
+** should be set to zero to indicate this. Or, if an error occurs, an SQLite
+** error code should be returned. In all cases, if an xInput callback returns
+** an error, all processing is abandoned and the streaming API function
+** returns a copy of the error code to the caller.
+**
+** In the case of sqlite3changeset_start_strm(), the xInput callback may be
+** invoked by the sessions module at any point during the lifetime of the
+** iterator. If such an xInput callback returns an error, the iterator enters
+** an error state, whereby all subsequent calls to iterator functions
+** immediately fail with the same error code as returned by xInput.
+**
+** Similarly, streaming API functions that return changesets (or patchsets)
+** return them in chunks by way of a callback function instead of via a
+** pointer to a single large buffer. In this case, a pair of parameters such
+** as:
+**
+** <pre>
+** int *pnChangeset,
+** void **ppChangeset,
+** </pre>
+**
+** Is replaced by:
+**
+** <pre>
+** int (*xOutput)(void *pOut, const void *pData, int nData),
+** void *pOut
+** </pre>
+**
+** The xOutput callback is invoked zero or more times to return data to
+** the application. The first parameter passed to each call is a copy of the
+** pOut pointer supplied by the application. The second parameter, pData,
+** points to a buffer nData bytes in size containing the chunk of output
+** data being returned. If the xOutput callback successfully processes the
+** supplied data, it should return SQLITE_OK to indicate success. Otherwise,
+** it should return some other SQLite error code. In this case processing
+** is immediately abandoned and the streaming API function returns a copy
+** of the xOutput error code to the application.
+**
+** The sessions module never invokes an xOutput callback with the third
+** parameter set to a value less than or equal to zero. Other than this,
+** no guarantees are made as to the size of the chunks of data returned.
+*/
+SQLITE_API int sqlite3changeset_apply_strm(
+ sqlite3 *db, /* Apply change to "main" db of this handle */
+ int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */
+ void *pIn, /* First arg for xInput */
+ int(*xFilter)(
+ void *pCtx, /* Copy of sixth arg to _apply() */
+ const char *zTab /* Table name */
+ ),
+ int(*xConflict)(
+ void *pCtx, /* Copy of sixth arg to _apply() */
+ int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
+ sqlite3_changeset_iter *p /* Handle describing change and conflict */
+ ),
+ void *pCtx /* First argument passed to xConflict */
+);
+SQLITE_API int sqlite3changeset_apply_v2_strm(
+ sqlite3 *db, /* Apply change to "main" db of this handle */
+ int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */
+ void *pIn, /* First arg for xInput */
+ int(*xFilter)(
+ void *pCtx, /* Copy of sixth arg to _apply() */
+ const char *zTab /* Table name */
+ ),
+ int(*xConflict)(
+ void *pCtx, /* Copy of sixth arg to _apply() */
+ int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
+ sqlite3_changeset_iter *p /* Handle describing change and conflict */
+ ),
+ void *pCtx, /* First argument passed to xConflict */
+ void **ppRebase, int *pnRebase,
+ int flags
+);
+SQLITE_API int sqlite3changeset_concat_strm(
+ int (*xInputA)(void *pIn, void *pData, int *pnData),
+ void *pInA,
+ int (*xInputB)(void *pIn, void *pData, int *pnData),
+ void *pInB,
+ int (*xOutput)(void *pOut, const void *pData, int nData),
+ void *pOut
+);
+SQLITE_API int sqlite3changeset_invert_strm(
+ int (*xInput)(void *pIn, void *pData, int *pnData),
+ void *pIn,
+ int (*xOutput)(void *pOut, const void *pData, int nData),
+ void *pOut
+);
+SQLITE_API int sqlite3changeset_start_strm(
+ sqlite3_changeset_iter **pp,
+ int (*xInput)(void *pIn, void *pData, int *pnData),
+ void *pIn
+);
+SQLITE_API int sqlite3changeset_start_v2_strm(
+ sqlite3_changeset_iter **pp,
+ int (*xInput)(void *pIn, void *pData, int *pnData),
+ void *pIn,
+ int flags
+);
+SQLITE_API int sqlite3session_changeset_strm(
+ sqlite3_session *pSession,
+ int (*xOutput)(void *pOut, const void *pData, int nData),
+ void *pOut
+);
+SQLITE_API int sqlite3session_patchset_strm(
+ sqlite3_session *pSession,
+ int (*xOutput)(void *pOut, const void *pData, int nData),
+ void *pOut
+);
+SQLITE_API int sqlite3changegroup_add_strm(sqlite3_changegroup*,
+ int (*xInput)(void *pIn, void *pData, int *pnData),
+ void *pIn
+);
+SQLITE_API int sqlite3changegroup_output_strm(sqlite3_changegroup*,
+ int (*xOutput)(void *pOut, const void *pData, int nData),
+ void *pOut
+);
+SQLITE_API int sqlite3rebaser_rebase_strm(
+ sqlite3_rebaser *pRebaser,
+ int (*xInput)(void *pIn, void *pData, int *pnData),
+ void *pIn,
+ int (*xOutput)(void *pOut, const void *pData, int nData),
+ void *pOut
+);
+
+/*
+** CAPI3REF: Configure global parameters
+**
+** The sqlite3session_config() interface is used to make global configuration
+** changes to the sessions module in order to tune it to the specific needs
+** of the application.
+**
+** The sqlite3session_config() interface is not threadsafe. If it is invoked
+** while any other thread is inside any other sessions method then the
+** results are undefined. Furthermore, if it is invoked after any sessions
+** related objects have been created, the results are also undefined.
+**
+** The first argument to the sqlite3session_config() function must be one
+** of the SQLITE_SESSION_CONFIG_XXX constants defined below. The
+** interpretation of the (void*) value passed as the second parameter and
+** the effect of calling this function depends on the value of the first
+** parameter.
+**
+** <dl>
+** <dt>SQLITE_SESSION_CONFIG_STRMSIZE<dd>
+** By default, the sessions module streaming interfaces attempt to input
+** and output data in approximately 1 KiB chunks. This operand may be used
+** to set and query the value of this configuration setting. The pointer
+** passed as the second argument must point to a value of type (int).
+** If this value is greater than 0, it is used as the new streaming data
+** chunk size for both input and output. Before returning, the (int) value
+** pointed to by pArg is set to the final value of the streaming interface
+** chunk size.
+** </dl>
+**
+** This function returns SQLITE_OK if successful, or an SQLite error code
+** otherwise.
+*/
+SQLITE_API int sqlite3session_config(int op, void *pArg);
+
+/*
+** CAPI3REF: Values for sqlite3session_config().
+*/
+#define SQLITE_SESSION_CONFIG_STRMSIZE 1
+
+/*
+** Make sure we can call this stuff from C++.
+*/
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION) */
+
+/******** End of sqlite3session.h *********/
+/******** Begin file fts5.h *********/
+/*
+** 2014 May 31
+**
+** The author disclaims copyright to this source code. In place of
+** a legal notice, here is a blessing:
+**
+** May you do good and not evil.
+** May you find forgiveness for yourself and forgive others.
+** May you share freely, never taking more than you give.
+**
+******************************************************************************
+**
+** Interfaces to extend FTS5. Using the interfaces defined in this file,
+** FTS5 may be extended with:
+**
+** * custom tokenizers, and
+** * custom auxiliary functions.
+*/
+
+
+#ifndef _FTS5_H
+#define _FTS5_H
+
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*************************************************************************
+** CUSTOM AUXILIARY FUNCTIONS
+**
+** Virtual table implementations may overload SQL functions by implementing
+** the sqlite3_module.xFindFunction() method.
+*/
+
+typedef struct Fts5ExtensionApi Fts5ExtensionApi;
+typedef struct Fts5Context Fts5Context;
+typedef struct Fts5PhraseIter Fts5PhraseIter;
+
+typedef void (*fts5_extension_function)(
+ const Fts5ExtensionApi *pApi, /* API offered by current FTS version */
+ Fts5Context *pFts, /* First arg to pass to pApi functions */
+ sqlite3_context *pCtx, /* Context for returning result/error */
+ int nVal, /* Number of values in apVal[] array */
+ sqlite3_value **apVal /* Array of trailing arguments */
+);
+
+struct Fts5PhraseIter {
+ const unsigned char *a;
+ const unsigned char *b;
+};
+
+/*
+** EXTENSION API FUNCTIONS
+**
+** xUserData(pFts):
+** Return a copy of the context pointer the extension function was
+** registered with.
+**
+** xColumnTotalSize(pFts, iCol, pnToken):
+** If parameter iCol is less than zero, set output variable *pnToken
+** to the total number of tokens in the FTS5 table. Or, if iCol is
+** non-negative but less than the number of columns in the table, return
+** the total number of tokens in column iCol, considering all rows in
+** the FTS5 table.
+**
+** If parameter iCol is greater than or equal to the number of columns
+** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g.
+** an OOM condition or IO error), an appropriate SQLite error code is
+** returned.
+**
+** xColumnCount(pFts):
+** Return the number of columns in the table.
+**
+** xColumnSize(pFts, iCol, pnToken):
+** If parameter iCol is less than zero, set output variable *pnToken
+** to the total number of tokens in the current row. Or, if iCol is
+** non-negative but less than the number of columns in the table, set
+** *pnToken to the number of tokens in column iCol of the current row.
+**
+** If parameter iCol is greater than or equal to the number of columns
+** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g.
+** an OOM condition or IO error), an appropriate SQLite error code is
+** returned.
+**
+** This function may be quite inefficient if used with an FTS5 table
+** created with the "columnsize=0" option.
+**
+** xColumnText:
+** This function attempts to retrieve the text of column iCol of the
+** current document. If successful, (*pz) is set to point to a buffer
+** containing the text in utf-8 encoding, (*pn) is set to the size in bytes
+** (not characters) of the buffer and SQLITE_OK is returned. Otherwise,
+** if an error occurs, an SQLite error code is returned and the final values
+** of (*pz) and (*pn) are undefined.
+**
+** xPhraseCount:
+** Returns the number of phrases in the current query expression.
+**
+** xPhraseSize:
+** Returns the number of tokens in phrase iPhrase of the query. Phrases
+** are numbered starting from zero.
+**
+** xInstCount:
+** Set *pnInst to the total number of occurrences of all phrases within
+** the query within the current row. Return SQLITE_OK if successful, or
+** an error code (i.e. SQLITE_NOMEM) if an error occurs.
+**
+** This API can be quite slow if used with an FTS5 table created with the
+** "detail=none" or "detail=column" option. If the FTS5 table is created
+** with either "detail=none" or "detail=column" and "content=" option
+** (i.e. if it is a contentless table), then this API always returns 0.
+**
+** xInst:
+** Query for the details of phrase match iIdx within the current row.
+** Phrase matches are numbered starting from zero, so the iIdx argument
+** should be greater than or equal to zero and smaller than the value
+** output by xInstCount().
+**
+** Usually, output parameter *piPhrase is set to the phrase number, *piCol
+** to the column in which it occurs and *piOff the token offset of the
+** first token of the phrase. Returns SQLITE_OK if successful, or an error
+** code (i.e. SQLITE_NOMEM) if an error occurs.
+**
+** This API can be quite slow if used with an FTS5 table created with the
+** "detail=none" or "detail=column" option.
+**
+** xRowid:
+** Returns the rowid of the current row.
+**
+** xTokenize:
+** Tokenize text using the tokenizer belonging to the FTS5 table.
+**
+** xQueryPhrase(pFts5, iPhrase, pUserData, xCallback):
+** This API function is used to query the FTS table for phrase iPhrase
+** of the current query. Specifically, a query equivalent to:
+**
+** ... FROM ftstable WHERE ftstable MATCH $p ORDER BY rowid
+**
+** with $p set to a phrase equivalent to the phrase iPhrase of the
+** current query is executed. Any column filter that applies to
+** phrase iPhrase of the current query is included in $p. For each
+** row visited, the callback function passed as the fourth argument
+** is invoked. The context and API objects passed to the callback
+** function may be used to access the properties of each matched row.
+** Invoking Api.xUserData() returns a copy of the pointer passed as
+** the third argument to pUserData.
+**
+** If the callback function returns any value other than SQLITE_OK, the
+** query is abandoned and the xQueryPhrase function returns immediately.
+** If the returned value is SQLITE_DONE, xQueryPhrase returns SQLITE_OK.
+** Otherwise, the error code is propagated upwards.
+**
+** If the query runs to completion without incident, SQLITE_OK is returned.
+** Or, if some error occurs before the query completes or is aborted by
+** the callback, an SQLite error code is returned.
+**
+**
+** xSetAuxdata(pFts5, pAux, xDelete)
+**
+** Save the pointer passed as the second argument as the extension function's
+** "auxiliary data". The pointer may then be retrieved by the current or any
+** future invocation of the same fts5 extension function made as part of
+** the same MATCH query using the xGetAuxdata() API.
+**
+** Each extension function is allocated a single auxiliary data slot for
+** each FTS query (MATCH expression). If the extension function is invoked
+** more than once for a single FTS query, then all invocations share a
+** single auxiliary data context.
+**
+** If there is already an auxiliary data pointer when this function is
+** invoked, then it is replaced by the new pointer. If an xDelete callback
+** was specified along with the original pointer, it is invoked at this
+** point.
+**
+** The xDelete callback, if one is specified, is also invoked on the
+** auxiliary data pointer after the FTS5 query has finished.
+**
+** If an error (e.g. an OOM condition) occurs within this function,
+** the auxiliary data is set to NULL and an error code returned. If the
+** xDelete parameter was not NULL, it is invoked on the auxiliary data
+** pointer before returning.
+**
+**
+** xGetAuxdata(pFts5, bClear)
+**
+** Returns the current auxiliary data pointer for the fts5 extension
+** function. See the xSetAuxdata() method for details.
+**
+** If the bClear argument is non-zero, then the auxiliary data is cleared
+** (set to NULL) before this function returns. In this case the xDelete,
+** if any, is not invoked.
+**
+**
+** xRowCount(pFts5, pnRow)
+**
+** This function is used to retrieve the total number of rows in the table.
+** In other words, the same value that would be returned by:
+**
+** SELECT count(*) FROM ftstable;
+**
+** xPhraseFirst()
+** This function is used, along with type Fts5PhraseIter and the xPhraseNext
+** method, to iterate through all instances of a single query phrase within
+** the current row. This is the same information as is accessible via the
+** xInstCount/xInst APIs. While the xInstCount/xInst APIs are more convenient
+** to use, this API may be faster under some circumstances. To iterate
+** through instances of phrase iPhrase, use the following code:
+**
+** Fts5PhraseIter iter;
+** int iCol, iOff;
+** for(pApi->xPhraseFirst(pFts, iPhrase, &iter, &iCol, &iOff);
+** iCol>=0;
+** pApi->xPhraseNext(pFts, &iter, &iCol, &iOff)
+** ){
+** // An instance of phrase iPhrase at offset iOff of column iCol
+** }
+**
+** The Fts5PhraseIter structure is defined above. Applications should not
+** modify this structure directly - it should only be used as shown above
+** with the xPhraseFirst() and xPhraseNext() API methods (and by
+** xPhraseFirstColumn() and xPhraseNextColumn() as illustrated below).
+**
+** This API can be quite slow if used with an FTS5 table created with the
+** "detail=none" or "detail=column" option. If the FTS5 table is created
+** with either "detail=none" or "detail=column" and "content=" option
+** (i.e. if it is a contentless table), then this API always iterates
+** through an empty set (all calls to xPhraseFirst() set iCol to -1).
+**
+** xPhraseNext()
+** See xPhraseFirst above.
+**
+** xPhraseFirstColumn()
+** This function and xPhraseNextColumn() are similar to the xPhraseFirst()
+** and xPhraseNext() APIs described above. The difference is that instead
+** of iterating through all instances of a phrase in the current row, these
+** APIs are used to iterate through the set of columns in the current row
+** that contain one or more instances of a specified phrase. For example:
+**
+** Fts5PhraseIter iter;
+** int iCol;
+** for(pApi->xPhraseFirstColumn(pFts, iPhrase, &iter, &iCol);
+** iCol>=0;
+** pApi->xPhraseNextColumn(pFts, &iter, &iCol)
+** ){
+** // Column iCol contains at least one instance of phrase iPhrase
+** }
+**
+** This API can be quite slow if used with an FTS5 table created with the
+** "detail=none" option. If the FTS5 table is created with either
+** "detail=none" "content=" option (i.e. if it is a contentless table),
+** then this API always iterates through an empty set (all calls to
+** xPhraseFirstColumn() set iCol to -1).
+**
+** The information accessed using this API and its companion
+** xPhraseFirstColumn() may also be obtained using xPhraseFirst/xPhraseNext
+** (or xInst/xInstCount). The chief advantage of this API is that it is
+** significantly more efficient than those alternatives when used with
+** "detail=column" tables.
+**
+** xPhraseNextColumn()
+** See xPhraseFirstColumn above.
+*/
+struct Fts5ExtensionApi {
+ int iVersion; /* Currently always set to 3 */
+
+ void *(*xUserData)(Fts5Context*);
+
+ int (*xColumnCount)(Fts5Context*);
+ int (*xRowCount)(Fts5Context*, sqlite3_int64 *pnRow);
+ int (*xColumnTotalSize)(Fts5Context*, int iCol, sqlite3_int64 *pnToken);
+
+ int (*xTokenize)(Fts5Context*,
+ const char *pText, int nText, /* Text to tokenize */
+ void *pCtx, /* Context passed to xToken() */
+ int (*xToken)(void*, int, const char*, int, int, int) /* Callback */
+ );
+
+ int (*xPhraseCount)(Fts5Context*);
+ int (*xPhraseSize)(Fts5Context*, int iPhrase);
+
+ int (*xInstCount)(Fts5Context*, int *pnInst);
+ int (*xInst)(Fts5Context*, int iIdx, int *piPhrase, int *piCol, int *piOff);
+
+ sqlite3_int64 (*xRowid)(Fts5Context*);
+ int (*xColumnText)(Fts5Context*, int iCol, const char **pz, int *pn);
+ int (*xColumnSize)(Fts5Context*, int iCol, int *pnToken);
+
+ int (*xQueryPhrase)(Fts5Context*, int iPhrase, void *pUserData,
+ int(*)(const Fts5ExtensionApi*,Fts5Context*,void*)
+ );
+ int (*xSetAuxdata)(Fts5Context*, void *pAux, void(*xDelete)(void*));
+ void *(*xGetAuxdata)(Fts5Context*, int bClear);
+
+ int (*xPhraseFirst)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*, int*);
+ void (*xPhraseNext)(Fts5Context*, Fts5PhraseIter*, int *piCol, int *piOff);
+
+ int (*xPhraseFirstColumn)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*);
+ void (*xPhraseNextColumn)(Fts5Context*, Fts5PhraseIter*, int *piCol);
+};
+
+/*
+** CUSTOM AUXILIARY FUNCTIONS
+*************************************************************************/
+
+/*************************************************************************
+** CUSTOM TOKENIZERS
+**
+** Applications may also register custom tokenizer types. A tokenizer
+** is registered by providing fts5 with a populated instance of the
+** following structure. All structure methods must be defined, setting
+** any member of the fts5_tokenizer struct to NULL leads to undefined
+** behaviour. The structure methods are expected to function as follows:
+**
+** xCreate:
+** This function is used to allocate and initialize a tokenizer instance.
+** A tokenizer instance is required to actually tokenize text.
+**
+** The first argument passed to this function is a copy of the (void*)
+** pointer provided by the application when the fts5_tokenizer object
+** was registered with FTS5 (the third argument to xCreateTokenizer()).
+** The second and third arguments are an array of nul-terminated strings
+** containing the tokenizer arguments, if any, specified following the
+** tokenizer name as part of the CREATE VIRTUAL TABLE statement used
+** to create the FTS5 table.
+**
+** The final argument is an output variable. If successful, (*ppOut)
+** should be set to point to the new tokenizer handle and SQLITE_OK
+** returned. If an error occurs, some value other than SQLITE_OK should
+** be returned. In this case, fts5 assumes that the final value of *ppOut
+** is undefined.
+**
+** xDelete:
+** This function is invoked to delete a tokenizer handle previously
+** allocated using xCreate(). Fts5 guarantees that this function will
+** be invoked exactly once for each successful call to xCreate().
+**
+** xTokenize:
+** This function is expected to tokenize the nText byte string indicated
+** by argument pText. pText may or may not be nul-terminated. The first
+** argument passed to this function is a pointer to an Fts5Tokenizer object
+** returned by an earlier call to xCreate().
+**
+** The second argument indicates the reason that FTS5 is requesting
+** tokenization of the supplied text. This is always one of the following
+** four values:
+**
+** <ul><li> <b>FTS5_TOKENIZE_DOCUMENT</b> - A document is being inserted into
+** or removed from the FTS table. The tokenizer is being invoked to
+** determine the set of tokens to add to (or delete from) the
+** FTS index.
+**
+** <li> <b>FTS5_TOKENIZE_QUERY</b> - A MATCH query is being executed
+** against the FTS index. The tokenizer is being called to tokenize
+** a bareword or quoted string specified as part of the query.
+**
+** <li> <b>(FTS5_TOKENIZE_QUERY | FTS5_TOKENIZE_PREFIX)</b> - Same as
+** FTS5_TOKENIZE_QUERY, except that the bareword or quoted string is
+** followed by a "*" character, indicating that the last token
+** returned by the tokenizer will be treated as a token prefix.
+**
+** <li> <b>FTS5_TOKENIZE_AUX</b> - The tokenizer is being invoked to
+** satisfy an fts5_api.xTokenize() request made by an auxiliary
+** function. Or an fts5_api.xColumnSize() request made by the same
+** on a columnsize=0 database.
+** </ul>
+**
+** For each token in the input string, the supplied callback xToken() must
+** be invoked. The first argument to it should be a copy of the pointer
+** passed as the second argument to xTokenize(). The third and fourth
+** arguments are a pointer to a buffer containing the token text, and the
+** size of the token in bytes. The 4th and 5th arguments are the byte offsets
+** of the first byte of and first byte immediately following the text from
+** which the token is derived within the input.
+**
+** The second argument passed to the xToken() callback ("tflags") should
+** normally be set to 0. The exception is if the tokenizer supports
+** synonyms. In this case see the discussion below for details.
+**
+** FTS5 assumes the xToken() callback is invoked for each token in the
+** order that they occur within the input text.
+**
+** If an xToken() callback returns any value other than SQLITE_OK, then
+** the tokenization should be abandoned and the xTokenize() method should
+** immediately return a copy of the xToken() return value. Or, if the
+** input buffer is exhausted, xTokenize() should return SQLITE_OK. Finally,
+** if an error occurs with the xTokenize() implementation itself, it
+** may abandon the tokenization and return any error code other than
+** SQLITE_OK or SQLITE_DONE.
+**
+** SYNONYM SUPPORT
+**
+** Custom tokenizers may also support synonyms. Consider a case in which a
+** user wishes to query for a phrase such as "first place". Using the
+** built-in tokenizers, the FTS5 query 'first + place' will match instances
+** of "first place" within the document set, but not alternative forms
+** such as "1st place". In some applications, it would be better to match
+** all instances of "first place" or "1st place" regardless of which form
+** the user specified in the MATCH query text.
+**
+** There are several ways to approach this in FTS5:
+**
+** <ol><li> By mapping all synonyms to a single token. In this case, using
+** the above example, this means that the tokenizer returns the
+** same token for inputs "first" and "1st". Say that token is in
+** fact "first", so that when the user inserts the document "I won
+** 1st place" entries are added to the index for tokens "i", "won",
+** "first" and "place". If the user then queries for '1st + place',
+** the tokenizer substitutes "first" for "1st" and the query works
+** as expected.
+**
+** <li> By querying the index for all synonyms of each query term
+** separately. In this case, when tokenizing query text, the
+** tokenizer may provide multiple synonyms for a single term
+** within the document. FTS5 then queries the index for each
+** synonym individually. For example, faced with the query:
+**
+** <codeblock>
+** ... MATCH 'first place'</codeblock>
+**
+** the tokenizer offers both "1st" and "first" as synonyms for the
+** first token in the MATCH query and FTS5 effectively runs a query
+** similar to:
+**
+** <codeblock>
+** ... MATCH '(first OR 1st) place'</codeblock>
+**
+** except that, for the purposes of auxiliary functions, the query
+** still appears to contain just two phrases - "(first OR 1st)"
+** being treated as a single phrase.
+**
+** <li> By adding multiple synonyms for a single term to the FTS index.
+** Using this method, when tokenizing document text, the tokenizer
+** provides multiple synonyms for each token. So that when a
+** document such as "I won first place" is tokenized, entries are
+** added to the FTS index for "i", "won", "first", "1st" and
+** "place".
+**
+** This way, even if the tokenizer does not provide synonyms
+** when tokenizing query text (it should not - to do so would be
+** inefficient), it doesn't matter if the user queries for
+** 'first + place' or '1st + place', as there are entries in the
+** FTS index corresponding to both forms of the first token.
+** </ol>
+**
+** Whether it is parsing document or query text, any call to xToken that
+** specifies a <i>tflags</i> argument with the FTS5_TOKEN_COLOCATED bit
+** is considered to supply a synonym for the previous token. For example,
+** when parsing the document "I won first place", a tokenizer that supports
+** synonyms would call xToken() 5 times, as follows:
+**
+** <codeblock>
+** xToken(pCtx, 0, "i", 1, 0, 1);
+** xToken(pCtx, 0, "won", 3, 2, 5);
+** xToken(pCtx, 0, "first", 5, 6, 11);
+** xToken(pCtx, FTS5_TOKEN_COLOCATED, "1st", 3, 6, 11);
+** xToken(pCtx, 0, "place", 5, 12, 17);
+**</codeblock>
+**
+** It is an error to specify the FTS5_TOKEN_COLOCATED flag the first time
+** xToken() is called. Multiple synonyms may be specified for a single token
+** by making multiple calls to xToken(FTS5_TOKEN_COLOCATED) in sequence.
+** There is no limit to the number of synonyms that may be provided for a
+** single token.
+**
+** In many cases, method (1) above is the best approach. It does not add
+** extra data to the FTS index or require FTS5 to query for multiple terms,
+** so it is efficient in terms of disk space and query speed. However, it
+** does not support prefix queries very well. If, as suggested above, the
+** token "first" is substituted for "1st" by the tokenizer, then the query:
+**
+** <codeblock>
+** ... MATCH '1s*'</codeblock>
+**
+** will not match documents that contain the token "1st" (as the tokenizer
+** will probably not map "1s" to any prefix of "first").
+**
+** For full prefix support, method (3) may be preferred. In this case,
+** because the index contains entries for both "first" and "1st", prefix
+** queries such as 'fi*' or '1s*' will match correctly. However, because
+** extra entries are added to the FTS index, this method uses more space
+** within the database.
+**
+** Method (2) offers a midpoint between (1) and (3). Using this method,
+** a query such as '1s*' will match documents that contain the literal
+** token "1st", but not "first" (assuming the tokenizer is not able to
+** provide synonyms for prefixes). However, a non-prefix query like '1st'
+** will match against "1st" and "first". This method does not require
+** extra disk space, as no extra entries are added to the FTS index.
+** On the other hand, it may require more CPU cycles to run MATCH queries,
+** as separate queries of the FTS index are required for each synonym.
+**
+** When using methods (2) or (3), it is important that the tokenizer only
+** provide synonyms when tokenizing document text (method (2)) or query
+** text (method (3)), not both. Doing so will not cause any errors, but is
+** inefficient.
+*/
+typedef struct Fts5Tokenizer Fts5Tokenizer;
+typedef struct fts5_tokenizer fts5_tokenizer;
+struct fts5_tokenizer {
+ int (*xCreate)(void*, const char **azArg, int nArg, Fts5Tokenizer **ppOut);
+ void (*xDelete)(Fts5Tokenizer*);
+ int (*xTokenize)(Fts5Tokenizer*,
+ void *pCtx,
+ int flags, /* Mask of FTS5_TOKENIZE_* flags */
+ const char *pText, int nText,
+ int (*xToken)(
+ void *pCtx, /* Copy of 2nd argument to xTokenize() */
+ int tflags, /* Mask of FTS5_TOKEN_* flags */
+ const char *pToken, /* Pointer to buffer containing token */
+ int nToken, /* Size of token in bytes */
+ int iStart, /* Byte offset of token within input text */
+ int iEnd /* Byte offset of end of token within input text */
+ )
+ );
+};
+
+/* Flags that may be passed as the third argument to xTokenize() */
+#define FTS5_TOKENIZE_QUERY 0x0001
+#define FTS5_TOKENIZE_PREFIX 0x0002
+#define FTS5_TOKENIZE_DOCUMENT 0x0004
+#define FTS5_TOKENIZE_AUX 0x0008
+
+/* Flags that may be passed by the tokenizer implementation back to FTS5
+** as the third argument to the supplied xToken callback. */
+#define FTS5_TOKEN_COLOCATED 0x0001 /* Same position as prev. token */
+
+/*
+** END OF CUSTOM TOKENIZERS
+*************************************************************************/
+
+/*************************************************************************
+** FTS5 EXTENSION REGISTRATION API
+*/
+typedef struct fts5_api fts5_api;
+struct fts5_api {
+ int iVersion; /* Currently always set to 2 */
+
+ /* Create a new tokenizer */
+ int (*xCreateTokenizer)(
+ fts5_api *pApi,
+ const char *zName,
+ void *pContext,
+ fts5_tokenizer *pTokenizer,
+ void (*xDestroy)(void*)
+ );
+
+ /* Find an existing tokenizer */
+ int (*xFindTokenizer)(
+ fts5_api *pApi,
+ const char *zName,
+ void **ppContext,
+ fts5_tokenizer *pTokenizer
+ );
+
+ /* Create a new auxiliary function */
+ int (*xCreateFunction)(
+ fts5_api *pApi,
+ const char *zName,
+ void *pContext,
+ fts5_extension_function xFunction,
+ void (*xDestroy)(void*)
+ );
+};
+
+/*
+** END OF REGISTRATION API
+*************************************************************************/
+
+#ifdef __cplusplus
+} /* end of the 'extern "C"' block */
+#endif
+
+#endif /* _FTS5_H */
+
+/******** End of fts5.h *********/
diff --git a/tool/wrapped_libclang/wrapper.c b/tool/wrapped_libclang/wrapper.c
index aa1e94d..978b7e7 100644
--- a/tool/wrapped_libclang/wrapper.c
+++ b/tool/wrapped_libclang/wrapper.c
@@ -155,38 +155,70 @@
return ptrToCXString(clang_formatDiagnostic(diag, opts));
}
-// alternative typedef for [CXCursorVisitor] using pointer for passing cursor and parent
+// Alternative typedef for [CXCursorVisitor] using pointer for passing cursor and parent
// instead of passing by value
typedef enum CXChildVisitResult (*ModifiedCXCursorVisitor)(CXCursor *cursor,
CXCursor *parent,
CXClientData client_data);
-// holds Pointers to Dart function received from [clang_visitChildren_wrap]
-// called in [_visitorWrap]
struct _stackForVisitChildren
{
ModifiedCXCursorVisitor modifiedVisitor;
struct _stackForVisitChildren *link;
-} * _visitorTop, *_visitorTemp;
-void _push(ModifiedCXCursorVisitor modifiedVisitor)
+} * _visitorTemp;
+
+// Holds list of Isolate-Processor pairs, each having their own stack
+// to hold the vistorFunctions.
+struct _listForIsolateProcessPair
{
- if (_visitorTop == NULL)
+ long long uid;
+ struct _listForIsolateProcessPair *next;
+ struct _stackForVisitChildren *_visitorTop;
+} ipHead, *ipTemp;
+// `ipHead` is used only as head marker and will not contain any information.
+
+// Finds/Creates an Isolate-Processor pair from/in the linkedlist.
+struct _listForIsolateProcessPair *_findIP(long long uid)
+{
+ struct _listForIsolateProcessPair *temp = ipHead.next;
+ while (temp != NULL)
{
- _visitorTop = (struct _stackForVisitChildren *)malloc(1 * sizeof(struct _stackForVisitChildren));
- _visitorTop->link = NULL;
- _visitorTop->modifiedVisitor = modifiedVisitor;
+ if (temp->uid == uid)
+ {
+ return temp;
+ }
+ temp = temp->next;
+ }
+ // If we reach here this means no IP pair was found and we should create one
+ // and add it to the head of our list.
+ temp = aloc(struct _listForIsolateProcessPair);
+ temp->next = ipHead.next;
+ temp->uid = uid;
+ temp->_visitorTop = NULL;
+ ipHead.next = temp;
+ return temp;
+}
+void _push(ModifiedCXCursorVisitor modifiedVisitor, long long uid)
+{
+ struct _listForIsolateProcessPair *current = _findIP(uid);
+ if (current->_visitorTop == NULL)
+ {
+ current->_visitorTop = aloc(struct _stackForVisitChildren);
+ current->_visitorTop->link = NULL;
+ current->_visitorTop->modifiedVisitor = modifiedVisitor;
}
else
{
- _visitorTemp = (struct _stackForVisitChildren *)malloc(1 * sizeof(struct _stackForVisitChildren));
- _visitorTemp->link = _visitorTop;
+ _visitorTemp = aloc(struct _stackForVisitChildren);
+ _visitorTemp->link = current->_visitorTop;
_visitorTemp->modifiedVisitor = modifiedVisitor;
- _visitorTop = _visitorTemp;
+ current->_visitorTop = _visitorTemp;
}
}
-void _pop()
+void _pop(long long uid)
{
- _visitorTemp = _visitorTop;
+ struct _listForIsolateProcessPair *current = _findIP(uid);
+ _visitorTemp = current->_visitorTop;
if (_visitorTemp == NULL)
{
@@ -194,30 +226,36 @@
return;
}
else
- _visitorTemp = _visitorTop->link;
- free(_visitorTop);
- _visitorTop = _visitorTemp;
+ _visitorTemp = current->_visitorTop->link;
+ free(current->_visitorTop);
+ current->_visitorTop = _visitorTemp;
}
-ModifiedCXCursorVisitor _top()
+ModifiedCXCursorVisitor _top(long long uid)
{
- return _visitorTop->modifiedVisitor;
+ return _findIP(uid)->_visitorTop->modifiedVisitor;
}
+
// Do not write binding for this function.
// used by [clang_visitChildren_wrap].
enum CXChildVisitResult
_visitorwrap(CXCursor cursor, CXCursor parent, CXClientData clientData)
{
- enum CXChildVisitResult e = (_top()(ptrToCXCursor(cursor), ptrToCXCursor(parent), clientData));
+ // Use clientData (which is a unique ID) to get reference to the stack which
+ // this particular process-isolate pair uses.
+ long long uid = *((long long *)clientData);
+ enum CXChildVisitResult e = (_top(uid)(ptrToCXCursor(cursor), ptrToCXCursor(parent), clientData));
return e;
}
/** Visitor is a function pointer with parameters having pointers to cxcursor
* instead of cxcursor by default. */
-unsigned clang_visitChildren_wrap(CXCursor *parent, ModifiedCXCursorVisitor _modifiedVisitor, CXClientData clientData)
+unsigned clang_visitChildren_wrap(CXCursor *parent, ModifiedCXCursorVisitor _modifiedVisitor, long long uid)
{
- _push(_modifiedVisitor);
+ long long *clientData = aloc(long long);
+ *clientData = uid;
+ _push(_modifiedVisitor, uid);
unsigned a = clang_visitChildren(*parent, _visitorwrap, clientData);
- _pop();
+ _pop(uid);
return a;
}
