\n**\n** The first argument to sqlite3_config() is an integer\n** [configuration option] that determines\n** what property of SQLite is to be configured. Subsequent arguments\n** vary depending on the [configuration option]\n** in the first argument.\n**\n** For most configuration options, the sqlite3_config() interface\n** may only be invoked prior to library initialization using\n** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].\n** The exceptional configuration options that may be invoked at any time\n** are called \"anytime configuration options\".\n** ^If sqlite3_config() is called after [sqlite3_initialize()] and before\n** [sqlite3_shutdown()] with a first argument that is not an anytime\n** configuration option, then the sqlite3_config() call will return SQLITE_MISUSE.\n** Note, however, that ^sqlite3_config() can be called as part of the\n** implementation of an application-defined [sqlite3_os_init()].\n**\n** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK].\n** ^If the option is unknown or SQLite is unable to set the option\n** then this routine returns a non-zero [error code].\n*/\nSQLITE_API int sqlite3_config(int, ...);\n\n/*\n** CAPI3REF: Configure database connections\n** METHOD: sqlite3\n**\n** The sqlite3_db_config() interface is used to make configuration\n** changes to a [database connection]. The interface is similar to\n** [sqlite3_config()] except that the changes apply to a single\n** [database connection] (specified in the first argument).\n**\n** The second argument to sqlite3_db_config(D,V,...) is the\n** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code\n** that indicates what aspect of the [database connection] is being configured.\n** Subsequent arguments vary depending on the configuration verb.\n**\n** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if\n** the call is considered successful.\n*/\nSQLITE_API int sqlite3_db_config(sqlite3*, int op, ...);\n\n/*\n** CAPI3REF: Memory Allocation Routines\n**\n** An instance of this object defines the interface between SQLite\n** and low-level memory allocation routines.\n**\n** This object is used in only one place in the SQLite interface.\n** A pointer to an instance of this object is the argument to\n** [sqlite3_config()] when the configuration option is\n** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC].\n** By creating an instance of this object\n** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC])\n** during configuration, an application can specify an alternative\n** memory allocation subsystem for SQLite to use for all of its\n** dynamic memory needs.\n**\n** Note that SQLite comes with several [built-in memory allocators]\n** that are perfectly adequate for the overwhelming majority of applications\n** and that this object is only useful to a tiny minority of applications\n** with specialized memory allocation requirements. This object is\n** also used during testing of SQLite in order to specify an alternative\n** memory allocator that simulates memory out-of-memory conditions in\n** order to verify that SQLite recovers gracefully from such\n** conditions.\n**\n** The xMalloc, xRealloc, and xFree methods must work like the\n** malloc(), realloc() and free() functions from the standard C library.\n** ^SQLite guarantees that the second argument to\n** xRealloc is always a value returned by a prior call to xRoundup.\n**\n** xSize should return the allocated size of a memory allocation\n** previously obtained from xMalloc or xRealloc. The allocated size\n** is always at least as big as the requested size but may be larger.\n**\n** The xRoundup method returns what would be the allocated size of\n** a memory allocation given a particular requested size. Most memory\n** allocators round up memory allocations at least to the next multiple\n** of 8. Some allocators round up to a larger multiple or to a power of 2.\n** Every memory allocation request coming in through [sqlite3_malloc()]\n** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0,\n** that causes the corresponding memory allocation to fail.\n**\n** The xInit method initializes the memory allocator. For example,\n** it might allocate any required mutexes or initialize internal data\n** structures. The xShutdown method is invoked (indirectly) by\n** [sqlite3_shutdown()] and should deallocate any resources acquired\n** by xInit. The pAppData pointer is used as the only parameter to\n** xInit and xShutdown.\n**\n** SQLite holds the [SQLITE_MUTEX_STATIC_MAIN] mutex when it invokes\n** the xInit method, so the xInit method need not be threadsafe. The\n** xShutdown method is only called from [sqlite3_shutdown()] so it does\n** not need to be threadsafe either. For all other methods, SQLite\n** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the\n** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which\n** it is by default) and so the methods are automatically serialized.\n** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other\n** methods must be threadsafe or else make their own arrangements for\n** serialization.\n**\n** SQLite will never invoke xInit() more than once without an intervening\n** call to xShutdown().\n*/\ntypedef struct sqlite3_mem_methods sqlite3_mem_methods;\nstruct sqlite3_mem_methods {\n void *(*xMalloc)(int); /* Memory allocation function */\n void (*xFree)(void*); /* Free a prior allocation */\n void *(*xRealloc)(void*,int); /* Resize an allocation */\n int (*xSize)(void*); /* Return the size of an allocation */\n int (*xRoundup)(int); /* Round up request size to allocation size */\n int (*xInit)(void*); /* Initialize the memory allocator */\n void (*xShutdown)(void*); /* Deinitialize the memory allocator */\n void *pAppData; /* Argument to xInit() and xShutdown() */\n};\n\n/*\n** CAPI3REF: Configuration Options\n** KEYWORDS: {configuration option}\n**\n** These constants are the available integer configuration options that\n** can be passed as the first argument to the [sqlite3_config()] interface.\n**\n** Most of the configuration options for sqlite3_config()\n** will only work if invoked prior to [sqlite3_initialize()] or after\n** [sqlite3_shutdown()]. The few exceptions to this rule are called\n** \"anytime configuration options\".\n** ^Calling [sqlite3_config()] with a first argument that is not an\n** anytime configuration option in between calls to [sqlite3_initialize()] and\n** [sqlite3_shutdown()] is a no-op that returns SQLITE_MISUSE.\n**\n** The set of anytime configuration options can change (by insertions\n** and/or deletions) from one release of SQLite to the next.\n** As of SQLite version 3.42.0, the complete set of anytime configuration\n** options is:\n** <ul>\n** <li> SQLITE_CONFIG_LOG\n** <li> SQLITE_CONFIG_PCACHE_HDRSZ\n** </ul>\n**\n** New configuration options may be added in future releases of SQLite.\n** Existing configuration options might be discontinued. Applications\n** should check the return code from [sqlite3_config()] to make sure that\n** the call worked. The [sqlite3_config()] interface will return a\n** non-zero [error code] if a discontinued or unsupported configuration option\n** is invoked.\n**\n** <dl>\n** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt>\n** <dd>There are no arguments to this option. ^This option sets the\n** [threading mode] to Single-thread. In other words, it disables\n** all mutexing and puts SQLite into a mode where it can only be used\n** by a single thread. ^If SQLite is compiled with\n** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then\n** it is not possible to change the [threading mode] from its default\n** value of Single-thread and so [sqlite3_config()] will return\n** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD\n** configuration option.</dd>\n**\n** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt>\n** <dd>There are no arguments to this option. ^This option sets the\n** [threading mode] to Multi-thread. In other words, it disables\n** mutexing on [database connection] and [prepared statement] objects.\n** The application is responsible for serializing access to\n** [database connections] and [prepared statements]. But other mutexes\n** are enabled so that SQLite will be safe to use in a multi-threaded\n** environment as long as no two threads attempt to use the same\n** [database connection] at the same time. ^If SQLite is compiled with\n** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then\n** it is not possible to set the Multi-thread [threading mode] and\n** [sqlite3_config()] will return [SQLITE_ERROR] if called with the\n** SQLITE_CONFIG_MULTITHREAD configuration option.</dd>\n**\n** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt>\n** <dd>There are no arguments to this option. ^This option sets the\n** [threading mode] to Serialized. In other words, this option enables\n** all mutexes including the recursive\n** mutexes on [database connection] and [prepared statement] objects.\n** In this mode (which is the default when SQLite is compiled with\n** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access\n** to [database connections] and [prepared statements] so that the\n** application is free to use the same [database connection] or the\n** same [prepared statement] in different threads at the same time.\n** ^If SQLite is compiled with\n** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then\n** it is not possible to set the Serialized [threading mode] and\n** [sqlite3_config()] will return [SQLITE_ERROR] if called with the\n** SQLITE_CONFIG_SERIALIZED configuration option.</dd>\n**\n** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt>\n** <dd> ^(The SQLITE_CONFIG_MALLOC option takes a single argument which is\n** a pointer to an instance of the [sqlite3_mem_methods] structure.\n** The argument specifies\n** alternative low-level memory allocation routines to be used in place of\n** the memory allocation routines built into SQLite.)^ ^SQLite makes\n** its own private copy of the content of the [sqlite3_mem_methods] structure\n** before the [sqlite3_config()] call returns.</dd>\n**\n** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt>\n** <dd> ^(The SQLITE_CONFIG_GETMALLOC option takes a single argument which\n** is a pointer to an instance of the [sqlite3_mem_methods] structure.\n** The [sqlite3_mem_methods]\n** structure is filled with the currently defined memory allocation routines.)^\n** This option can be used to overload the default memory allocation\n** routines with a wrapper that simulations memory allocation failure or\n** tracks memory usage, for example. </dd>\n**\n** [[SQLITE_CONFIG_SMALL_MALLOC]] <dt>SQLITE_CONFIG_SMALL_MALLOC</dt>\n** <dd> ^The SQLITE_CONFIG_SMALL_MALLOC option takes single argument of\n** type int, interpreted as a boolean, which if true provides a hint to\n** SQLite that it should avoid large memory allocations if possible.\n** SQLite will run faster if it is free to make large memory allocations,\n** but some application might prefer to run slower in exchange for\n** guarantees about memory fragmentation that are possible if large\n** allocations are avoided. This hint is normally off.\n** </dd>\n**\n** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt>\n** <dd> ^The SQLITE_CONFIG_MEMSTATUS option takes single argument of type int,\n** interpreted as a boolean, which enables or disables the collection of\n** memory allocation statistics. ^(When memory allocation statistics are\n** disabled, the following SQLite interfaces become non-operational:\n** <ul>\n** <li> [sqlite3_hard_heap_limit64()]\n** <li> [sqlite3_memory_used()]\n** <li> [sqlite3_memory_highwater()]\n** <li> [sqlite3_soft_heap_limit64()]\n** <li> [sqlite3_status64()]\n** </ul>)^\n** ^Memory allocation statistics are enabled by default unless SQLite is\n** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory\n** allocation statistics are disabled by default.\n** </dd>\n**\n** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt>\n** <dd> The SQLITE_CONFIG_SCRATCH option is no longer used.\n** </dd>\n**\n** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt>\n** <dd> ^The SQLITE_CONFIG_PAGECACHE option specifies a memory pool\n** that SQLite can use for the database page cache with the default page\n** cache implementation.\n** This configuration option is a no-op if an application-defined page\n** cache implementation is loaded using the [SQLITE_CONFIG_PCACHE2].\n** ^There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to\n** 8-byte aligned memory (pMem), the size of each page cache line (sz),\n** and the number of cache lines (N).\n** The sz argument should be the size of the largest database page\n** (a power of two between 512 and 65536) plus some extra bytes for each\n** page header. ^The number of extra bytes needed by the page header\n** can be determined using [SQLITE_CONFIG_PCACHE_HDRSZ].\n** ^It is harmless, apart from the wasted memory,\n** for the sz parameter to be larger than necessary. The pMem\n** argument must be either a NULL pointer or a pointer to an 8-byte\n** aligned block of memory of at least sz*N bytes, otherwise\n** subsequent behavior is undefined.\n** ^When pMem is not NULL, SQLite will strive to use the memory provided\n** to satisfy page cache needs, falling back to [sqlite3_malloc()] if\n** a page cache line is larger than sz bytes or if all of the pMem buffer\n** is exhausted.\n** ^If pMem is NULL and N is non-zero, then each database connection\n** does an initial bulk allocation for page cache memory\n** from [sqlite3_malloc()] sufficient for N cache lines if N is positive or\n** of -1024*N bytes if N is negative, . ^If additional\n** page cache memory is needed beyond what is provided by the initial\n** allocation, then SQLite goes to [sqlite3_malloc()] separately for each\n** additional cache line. </dd>\n**\n** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt>\n** <dd> ^The SQLITE_CONFIG_HEAP option specifies a static memory buffer\n** that SQLite will use for all of its dynamic memory allocation needs\n** beyond those provided for by [SQLITE_CONFIG_PAGECACHE].\n** ^The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled\n** with either [SQLITE_ENABLE_MEMSYS3] or [SQLITE_ENABLE_MEMSYS5] and returns\n** [SQLITE_ERROR] if invoked otherwise.\n** ^There are three arguments to SQLITE_CONFIG_HEAP:\n** An 8-byte aligned pointer to the memory,\n** the number of bytes in the memory buffer, and the minimum allocation size.\n** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts\n** to using its default memory allocator (the system malloc() implementation),\n** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the\n** memory pointer is not NULL then the alternative memory\n** allocator is engaged to handle all of SQLites memory allocation needs.\n** The first pointer (the memory pointer) must be aligned to an 8-byte\n** boundary or subsequent behavior of SQLite will be undefined.\n** The minimum allocation size is capped at 2**12. Reasonable values\n** for the minimum allocation size are 2**5 through 2**8.</dd>\n**\n** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt>\n** <dd> ^(The SQLITE_CONFIG_MUTEX option takes a single argument which is a\n** pointer to an instance of the [sqlite3_mutex_methods] structure.\n** The argument specifies alternative low-level mutex routines to be used\n** in place the mutex routines built into SQLite.)^ ^SQLite makes a copy of\n** the content of the [sqlite3_mutex_methods] structure before the call to\n** [sqlite3_config()] returns. ^If SQLite is compiled with\n** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then\n** the entire mutexing subsystem is omitted from the build and hence calls to\n** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will\n** return [SQLITE_ERROR].</dd>\n**\n** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt>\n** <dd> ^(The SQLITE_CONFIG_GETMUTEX option takes a single argument which\n** is a pointer to an instance of the [sqlite3_mutex_methods] structure. The\n** [sqlite3_mutex_methods]\n** structure is filled with the currently defined mutex routines.)^\n** This option can be used to overload the default mutex allocation\n** routines with a wrapper used to track mutex usage for performance\n** profiling or testing, for example. ^If SQLite is compiled with\n** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then\n** the entire mutexing subsystem is omitted from the build and hence calls to\n** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will\n** return [SQLITE_ERROR].</dd>\n**\n** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt>\n** <dd> ^(The SQLITE_CONFIG_LOOKASIDE option takes two arguments that determine\n** the default size of lookaside memory on each [database connection].\n** The first argument is the\n** size of each lookaside buffer slot and the second is the number of\n** slots allocated to each database connection.)^ ^(SQLITE_CONFIG_LOOKASIDE\n** sets the <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE]\n** option to [sqlite3_db_config()] can be used to change the lookaside\n** configuration on individual connections.)^ </dd>\n**\n** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt>\n** <dd> ^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is\n** a pointer to an [sqlite3_pcache_methods2] object. This object specifies\n** the interface to a custom page cache implementation.)^\n** ^SQLite makes a copy of the [sqlite3_pcache_methods2] object.</dd>\n**\n** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt>\n** <dd> ^(The SQLITE_CONFIG_GETPCACHE2 option takes a single argument which\n** is a pointer to an [sqlite3_pcache_methods2] object. SQLite copies of\n** the current page cache implementation into that object.)^ </dd>\n**\n** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt>\n** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite\n** global [error log].\n** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a\n** function with a call signature of void(*)(void*,int,const char*),\n** and a pointer to void. ^If the function pointer is not NULL, it is\n** invoked by [sqlite3_log()] to process each logging event. ^If the\n** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op.\n** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is\n** passed through as the first parameter to the application-defined logger\n** function whenever that function is invoked. ^The second parameter to\n** the logger function is a copy of the first parameter to the corresponding\n** [sqlite3_log()] call and is intended to be a [result code] or an\n** [extended result code]. ^The third parameter passed to the logger is\n** log message after formatting via [sqlite3_snprintf()].\n** The SQLite logging interface is not reentrant; the logger function\n** supplied by the application must not invoke any SQLite interface.\n** In a multi-threaded application, the application-defined logger\n** function must be threadsafe. </dd>\n**\n** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI\n** <dd>^(The SQLITE_CONFIG_URI option takes a single argument of type int.\n** If non-zero, then URI handling is globally enabled. If the parameter is zero,\n** then URI handling is globally disabled.)^ ^If URI handling is globally\n** enabled, all filenames passed to [sqlite3_open()], [sqlite3_open_v2()],\n** [sqlite3_open16()] or\n** specified as part of [ATTACH] commands are interpreted as URIs, regardless\n** of whether or not the [SQLITE_OPEN_URI] flag is set when the database\n** connection is opened. ^If it is globally disabled, filenames are\n** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the\n** database connection is opened. ^(By default, URI handling is globally\n** disabled. The default value may be changed by compiling with the\n** [SQLITE_USE_URI] symbol defined.)^\n**\n** [[SQLITE_CONFIG_COVERING_INDEX_SCAN]] <dt>SQLITE_CONFIG_COVERING_INDEX_SCAN\n** <dd>^The SQLITE_CONFIG_COVERING_INDEX_SCAN option takes a single integer\n** argument which is interpreted as a boolean in order to enable or disable\n** the use of covering indices for full table scans in the query optimizer.\n** ^The default setting is determined\n** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is \"on\"\n** if that compile-time option is omitted.\n** The ability to disable the use of covering indices for full table scans\n** is because some incorrectly coded legacy applications might malfunction\n** when the optimization is enabled. Providing the ability to\n** disable the optimization allows the older, buggy application code to work\n** without change even with newer versions of SQLite.\n**\n** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]]\n** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE\n** <dd> These options are obsolete and should not be used by new code.\n** They are retained for backwards compatibility but are now no-ops.\n** </dd>\n**\n** [[SQLITE_CONFIG_SQLLOG]]\n** <dt>SQLITE_CONFIG_SQLLOG\n** <dd>This option is only available if sqlite is compiled with the\n** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should\n** be a pointer to a function of type void(*)(void*,sqlite3*,const char*, int).\n** The second should be of type (void*). The callback is invoked by the library\n** in three separate circumstances, identified by the value passed as the\n** fourth parameter. If the fourth parameter is 0, then the database connection\n** passed as the second argument has just been opened. The third argument\n** points to a buffer containing the name of the main database file. If the\n** fourth parameter is 1, then the SQL statement that the third parameter\n** points to has just been executed. Or, if the fourth parameter is 2, then\n** the connection being passed as the second parameter is being closed. The\n** third parameter is passed NULL In this case. An example of using this\n** configuration option can be seen in the \"test_sqllog.c\" source file in\n** the canonical SQLite source tree.</dd>\n**\n** [[SQLITE_CONFIG_MMAP_SIZE]]\n** <dt>SQLITE_CONFIG_MMAP_SIZE\n** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values\n** that are the default mmap size limit (the default setting for\n** [PRAGMA mmap_size]) and the maximum allowed mmap size limit.\n** ^The default setting can be overridden by each database connection using\n** either the [PRAGMA mmap_size] command, or by using the\n** [SQLITE_FCNTL_MMAP_SIZE] file control. ^(The maximum allowed mmap size\n** will be silently truncated if necessary so that it does not exceed the\n** compile-time maximum mmap size set by the\n** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^\n** ^If either argument to this option is negative, then that argument is\n** changed to its compile-time default.\n**\n** [[SQLITE_CONFIG_WIN32_HEAPSIZE]]\n** <dt>SQLITE_CONFIG_WIN32_HEAPSIZE\n** <dd>^The SQLITE_CONFIG_WIN32_HEAPSIZE option is only available if SQLite is\n** compiled for Windows with the [SQLITE_WIN32_MALLOC] pre-processor macro\n** defined. ^SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value\n** that specifies the maximum size of the created heap.\n**\n** [[SQLITE_CONFIG_PCACHE_HDRSZ]]\n** <dt>SQLITE_CONFIG_PCACHE_HDRSZ\n** <dd>^The SQLITE_CONFIG_PCACHE_HDRSZ option takes a single parameter which\n** is a pointer to an integer and writes into that integer the number of extra\n** bytes per page required for each page in [SQLITE_CONFIG_PAGECACHE].\n** The amount of extra space required can change depending on the compiler,\n** target platform, and SQLite version.\n**\n** [[SQLITE_CONFIG_PMASZ]]\n** <dt>SQLITE_CONFIG_PMASZ\n** <dd>^The SQLITE_CONFIG_PMASZ option takes a single parameter which\n** is an unsigned integer and sets the \"Minimum PMA Size\" for the multithreaded\n** sorter to that integer. The default minimum PMA Size is set by the\n** [SQLITE_SORTER_PMASZ] compile-time option. New threads are launched\n** to help with sort operations when multithreaded sorting\n** is enabled (using the [PRAGMA threads] command) and the amount of content\n** to be sorted exceeds the page size times the minimum of the\n** [PRAGMA cache_size] setting and this value.\n**\n** [[SQLITE_CONFIG_STMTJRNL_SPILL]]\n** <dt>SQLITE_CONFIG_STMTJRNL_SPILL\n** <dd>^The SQLITE_CONFIG_STMTJRNL_SPILL option takes a single parameter which\n** becomes the [statement journal] spill-to-disk threshold.\n** [Statement journals] are held in memory until their size (in bytes)\n** exceeds this threshold, at which point they are written to disk.\n** Or if the threshold is -1, statement journals are always held\n** exclusively in memory.\n** Since many statement journals never become large, setting the spill\n** threshold to a value such as 64KiB can greatly reduce the amount of\n** I/O required to support statement rollback.\n** The default value for this setting is controlled by the\n** [SQLITE_STMTJRNL_SPILL] compile-time option.\n**\n** [[SQLITE_CONFIG_SORTERREF_SIZE]]\n** <dt>SQLITE_CONFIG_SORTERREF_SIZE\n** <dd>The SQLITE_CONFIG_SORTERREF_SIZE option accepts a single parameter\n** of type (int) - the new value of the sorter-reference size threshold.\n** Usually, when SQLite uses an external sort to order records according\n** to an ORDER BY clause, all fields required by the caller are present in the\n** sorted records. However, if SQLite determines based on the declared type\n** of a table column that its values are likely to be very large - larger\n** than the configured sorter-reference size threshold - then a reference\n** is stored in each sorted record and the required column values loaded\n** from the database as records are returned in sorted order. The default\n** value for this option is to never use this optimization. Specifying a\n** negative value for this option restores the default behavior.\n** This option is only available if SQLite is compiled with the\n** [SQLITE_ENABLE_SORTER_REFERENCES] compile-time option.\n**\n** [[SQLITE_CONFIG_MEMDB_MAXSIZE]]\n** <dt>SQLITE_CONFIG_MEMDB_MAXSIZE\n** <dd>The SQLITE_CONFIG_MEMDB_MAXSIZE option accepts a single parameter\n** [sqlite3_int64] parameter which is the default maximum size for an in-memory\n** database created using [sqlite3_deserialize()]. This default maximum\n** size can be adjusted up or down for individual databases using the\n** [SQLITE_FCNTL_SIZE_LIMIT] [sqlite3_file_control|file-control]. If this\n** configuration setting is never used, then the default maximum is determined\n** by the [SQLITE_MEMDB_DEFAULT_MAXSIZE] compile-time option. If that\n** compile-time option is not set, then the default maximum is 1073741824.\n**\n** [[SQLITE_CONFIG_ROWID_IN_VIEW]]\n** <dt>SQLITE_CONFIG_ROWID_IN_VIEW\n** <dd>The SQLITE_CONFIG_ROWID_IN_VIEW option enables or disables the ability\n** for VIEWs to have a ROWID. The capability can only be enabled if SQLite is\n** compiled with -DSQLITE_ALLOW_ROWID_IN_VIEW, in which case the capability\n** defaults to on. This configuration option queries the current setting or\n** changes the setting to off or on. The argument is a pointer to an integer.\n** If that integer initially holds a value of 1, then the ability for VIEWs to\n** have ROWIDs is activated. If the integer initially holds zero, then the\n** ability is deactivated. Any other initial value for the integer leaves the\n** setting unchanged. After changes, if any, the integer is written with\n** a 1 or 0, if the ability for VIEWs to have ROWIDs is on or off. If SQLite\n** is compiled without -DSQLITE_ALLOW_ROWID_IN_VIEW (which is the usual and\n** recommended case) then the integer is always filled with zero, regardless\n** if its initial value.\n** </dl>\n*/\n#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */\n#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */\n#define SQLITE_CONFIG_SERIALIZED 3 /* nil */\n#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */\n#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */\n#define SQLITE_CONFIG_SCRATCH 6 /* No longer used */\n#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */\n#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */\n#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */\n#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */\n#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */\n/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */\n#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */\n#define SQLITE_CONFIG_PCACHE 14 /* no-op */\n#define SQLITE_CONFIG_GETPCACHE 15 /* no-op */\n#define SQLITE_CONFIG_LOG 16 /* xFunc, void* */\n#define SQLITE_CONFIG_URI 17 /* int */\n#define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */\n#define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */\n#define SQLITE_CONFIG_COVERING_INDEX_SCAN 20 /* int */\n#define SQLITE_CONFIG_SQLLOG 21 /* xSqllog, void* */\n#define SQLITE_CONFIG_MMAP_SIZE 22 /* sqlite3_int64, sqlite3_int64 */\n#define SQLITE_CONFIG_WIN32_HEAPSIZE 23 /* int nByte */\n#define SQLITE_CONFIG_PCACHE_HDRSZ 24 /* int *psz */\n#define SQLITE_CONFIG_PMASZ 25 /* unsigned int szPma */\n#define SQLITE_CONFIG_STMTJRNL_SPILL 26 /* int nByte */\n#define SQLITE_CONFIG_SMALL_MALLOC 27 /* boolean */\n#define SQLITE_CONFIG_SORTERREF_SIZE 28 /* int nByte */\n#define SQLITE_CONFIG_MEMDB_MAXSIZE 29 /* sqlite3_int64 */\n#define SQLITE_CONFIG_ROWID_IN_VIEW 30 /* int* */\n\n/*\n** CAPI3REF: Database Connection Configuration Options\n**\n** These constants are the available integer configuration options that\n** can be passed as the second parameter to the [sqlite3_db_config()] interface.\n**\n** The [sqlite3_db_config()] interface is a var-args functions. It takes a\n** variable number of parameters, though always at least two. The number of\n** parameters passed into sqlite3_db_config() depends on which of these\n** constants is given as the second parameter. This documentation page\n** refers to parameters beyond the second as \"arguments\". Thus, when this\n** page says \"the N-th argument\" it means \"the N-th parameter past the\n** configuration option\" or \"the (N+2)-th parameter to sqlite3_db_config()\".\n**\n** New configuration options may be added in future releases of SQLite.\n** Existing configuration options might be discontinued. Applications\n** should check the return code from [sqlite3_db_config()] to make sure that\n** the call worked. ^The [sqlite3_db_config()] interface will return a\n** non-zero [error code] if a discontinued or unsupported configuration option\n** is invoked.\n**\n** <dl>\n** [[SQLITE_DBCONFIG_LOOKASIDE]]\n** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt>\n** <dd> The SQLITE_DBCONFIG_LOOKASIDE option is used to adjust the\n** configuration of the lookaside memory allocator within a database\n** connection.\n** The arguments to the SQLITE_DBCONFIG_LOOKASIDE option are <i>not</i>\n** in the [DBCONFIG arguments|usual format].\n** The SQLITE_DBCONFIG_LOOKASIDE option takes three arguments, not two,\n** so that a call to [sqlite3_db_config()] that uses SQLITE_DBCONFIG_LOOKASIDE\n** should have a total of five parameters.\n** ^The first argument (the third parameter to [sqlite3_db_config()] is a\n** pointer to a memory buffer to use for lookaside memory.\n** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb\n** may be NULL in which case SQLite will allocate the\n** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the\n** size of each lookaside buffer slot. ^The third argument is the number of\n** slots. The size of the buffer in the first argument must be greater than\n** or equal to the product of the second and third arguments. The buffer\n** must be aligned to an 8-byte boundary. ^If the second argument to\n** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally\n** rounded down to the next smaller multiple of 8. ^(The lookaside memory\n** configuration for a database connection can only be changed when that\n** connection is not currently using lookaside memory, or in other words\n** when the \"current value\" returned by\n** [sqlite3_db_status](D,[SQLITE_DBSTATUS_LOOKASIDE_USED],...) is zero.\n** Any attempt to change the lookaside memory configuration when lookaside\n** memory is in use leaves the configuration unchanged and returns\n** [SQLITE_BUSY].)^</dd>\n**\n** [[SQLITE_DBCONFIG_ENABLE_FKEY]]\n** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt>\n** <dd> ^This option is used to enable or disable the enforcement of\n** [foreign key constraints]. This is the same setting that is\n** enabled or disabled by the [PRAGMA foreign_keys] statement.\n** The first argument is an integer which is 0 to disable FK enforcement,\n** positive to enable FK enforcement or negative to leave FK enforcement\n** unchanged. The second parameter is a pointer to an integer into which\n** is written 0 or 1 to indicate whether FK enforcement is off or on\n** following this call. The second parameter may be a NULL pointer, in\n** which case the FK enforcement setting is not reported back. </dd>\n**\n** [[SQLITE_DBCONFIG_ENABLE_TRIGGER]]\n** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt>\n** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers].\n** There should be two additional arguments.\n** The first argument is an integer which is 0 to disable triggers,\n** positive to enable triggers or negative to leave the setting unchanged.\n** The second parameter is a pointer to an integer into which\n** is written 0 or 1 to indicate whether triggers are disabled or enabled\n** following this call. The second parameter may be a NULL pointer, in\n** which case the trigger setting is not reported back.\n**\n** <p>Originally this option disabled all triggers. ^(However, since\n** SQLite version 3.35.0, TEMP triggers are still allowed even if\n** this option is off. So, in other words, this option now only disables\n** triggers in the main database schema or in the schemas of [ATTACH]-ed\n** databases.)^ </dd>\n**\n** [[SQLITE_DBCONFIG_ENABLE_VIEW]]\n** <dt>SQLITE_DBCONFIG_ENABLE_VIEW</dt>\n** <dd> ^This option is used to enable or disable [CREATE VIEW | views].\n** There must be two additional arguments.\n** The first argument is an integer which is 0 to disable views,\n** positive to enable views or negative to leave the setting unchanged.\n** The second parameter is a pointer to an integer into which\n** is written 0 or 1 to indicate whether views are disabled or enabled\n** following this call. The second parameter may be a NULL pointer, in\n** which case the view setting is not reported back.\n**\n** <p>Originally this option disabled all views. ^(However, since\n** SQLite version 3.35.0, TEMP views are still allowed even if\n** this option is off. So, in other words, this option now only disables\n** views in the main database schema or in the schemas of ATTACH-ed\n** databases.)^ </dd>\n**\n** [[SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER]]\n** <dt>SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER</dt>\n** <dd> ^This option is used to enable or disable the\n** [fts3_tokenizer()] function which is part of the\n** [FTS3] full-text search engine extension.\n** There must be two additional arguments.\n** The first argument is an integer which is 0 to disable fts3_tokenizer() or\n** positive to enable fts3_tokenizer() or negative to leave the setting\n** unchanged.\n** The second parameter is a pointer to an integer into which\n** is written 0 or 1 to indicate whether fts3_tokenizer is disabled or enabled\n** following this call. The second parameter may be a NULL pointer, in\n** which case the new setting is not reported back. </dd>\n**\n** [[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION]]\n** <dt>SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION</dt>\n** <dd> ^This option is used to enable or disable the [sqlite3_load_extension()]\n** interface independently of the [load_extension()] SQL function.\n** The [sqlite3_enable_load_extension()] API enables or disables both the\n** C-API [sqlite3_load_extension()] and the SQL function [load_extension()].\n** There must be two additional arguments.\n** When the first argument to this interface is 1, then only the C-API is\n** enabled and the SQL function remains disabled. If the first argument to\n** this interface is 0, then both the C-API and the SQL function are disabled.\n** If the first argument is -1, then no changes are made to state of either the\n** C-API or the SQL function.\n** The second parameter is a pointer to an integer into which\n** is written 0 or 1 to indicate whether [sqlite3_load_extension()] interface\n** is disabled or enabled following this call. The second parameter may\n** be a NULL pointer, in which case the new setting is not reported back.\n** </dd>\n**\n** [[SQLITE_DBCONFIG_MAINDBNAME]] <dt>SQLITE_DBCONFIG_MAINDBNAME</dt>\n** <dd> ^This option is used to change the name of the \"main\" database\n** schema. This option does not follow the\n** [DBCONFIG arguments|usual SQLITE_DBCONFIG argument format].\n** This option takes exactly one additional argument so that the\n** [sqlite3_db_config()] call has a total of three parameters. The\n** extra argument must be a pointer to a constant UTF8 string which\n** will become the new schema name in place of \"main\". ^SQLite does\n** not make a copy of the new main schema name string, so the application\n** must ensure that the argument passed into SQLITE_DBCONFIG MAINDBNAME\n** is unchanged until after the database connection closes.\n** </dd>\n**\n** [[SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE]]\n** <dt>SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE</dt>\n** <dd> Usually, when a database in [WAL mode] is closed or detached from a\n** database handle, SQLite checks if if there are other connections to the\n** same database, and if there are no other database connection (if the\n** connection being closed is the last open connection to the database),\n** then SQLite performs a [checkpoint] before closing the connection and\n** deletes the WAL file. The SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE option can\n** be used to override that behavior. The first argument passed to this\n** operation (the third parameter to [sqlite3_db_config()]) is an integer\n** which is positive to disable checkpoints-on-close, or zero (the default)\n** to enable them, and negative to leave the setting unchanged.\n** The second argument (the fourth parameter) is a pointer to an integer\n** into which is written 0 or 1 to indicate whether checkpoints-on-close\n** have been disabled - 0 if they are not disabled, 1 if they are.\n** </dd>\n**\n** [[SQLITE_DBCONFIG_ENABLE_QPSG]] <dt>SQLITE_DBCONFIG_ENABLE_QPSG</dt>\n** <dd>^(The SQLITE_DBCONFIG_ENABLE_QPSG option activates or deactivates\n** the [query planner stability guarantee] (QPSG). When the QPSG is active,\n** a single SQL query statement will always use the same algorithm regardless\n** of values of [bound parameters].)^ The QPSG disables some query optimizations\n** that look at the values of bound parameters, which can make some queries\n** slower. But the QPSG has the advantage of more predictable behavior. With\n** the QPSG active, SQLite will always use the same query plan in the field as\n** was used during testing in the lab.\n** The first argument to this setting is an integer which is 0 to disable\n** the QPSG, positive to enable QPSG, or negative to leave the setting\n** unchanged. The second parameter is a pointer to an integer into which\n** is written 0 or 1 to indicate whether the QPSG is disabled or enabled\n** following this call.\n** </dd>\n**\n** [[SQLITE_DBCONFIG_TRIGGER_EQP]] <dt>SQLITE_DBCONFIG_TRIGGER_EQP</dt>\n** <dd> By default, the output of EXPLAIN QUERY PLAN commands does not\n** include output for any operations performed by trigger programs. This\n** option is used to set or clear (the default) a flag that governs this\n** behavior. The first parameter passed to this operation is an integer -\n** positive to enable output for trigger programs, or zero to disable it,\n** or negative to leave the setting unchanged.\n** The second parameter is a pointer to an integer into which is written\n** 0 or 1 to indicate whether output-for-triggers has been disabled - 0 if\n** it is not disabled, 1 if it is.\n** </dd>\n**\n** [[SQLITE_DBCONFIG_RESET_DATABASE]] <dt>SQLITE_DBCONFIG_RESET_DATABASE</dt>\n** <dd> Set the SQLITE_DBCONFIG_RESET_DATABASE flag and then run\n** [VACUUM] in order to reset a database back to an empty database\n** with no schema and no content. The following process works even for\n** a badly corrupted database file:\n** <ol>\n** <li> If the database connection is newly opened, make sure it has read the\n** database schema by preparing then discarding some query against the\n** database, or calling sqlite3_table_column_metadata(), ignoring any\n** errors. This step is only necessary if the application desires to keep\n** the database in WAL mode after the reset if it was in WAL mode before\n** the reset.\n** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 1, 0);\n** <li> [sqlite3_exec](db, \"[VACUUM]\", 0, 0, 0);\n** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 0, 0);\n** </ol>\n** Because resetting a database is destructive and irreversible, the\n** process requires the use of this obscure API and multiple steps to\n** help ensure that it does not happen by accident. Because this\n** feature must be capable of resetting corrupt databases, and\n** shutting down virtual tables may require access to that corrupt\n** storage, the library must abandon any installed virtual tables\n** without calling their xDestroy() methods.\n**\n** [[SQLITE_DBCONFIG_DEFENSIVE]] <dt>SQLITE_DBCONFIG_DEFENSIVE</dt>\n** <dd>The SQLITE_DBCONFIG_DEFENSIVE option activates or deactivates the\n** \"defensive\" flag for a database connection. When the defensive\n** flag is enabled, language features that allow ordinary SQL to\n** deliberately corrupt the database file are disabled. The disabled\n** features include but are not limited to the following:\n** <ul>\n** <li> The [PRAGMA writable_schema=ON] statement.\n** <li> The [PRAGMA journal_mode=OFF] statement.\n** <li> The [PRAGMA schema_version=N] statement.\n** <li> Writes to the [sqlite_dbpage] virtual table.\n** <li> Direct writes to [shadow tables].\n** </ul>\n** </dd>\n**\n** [[SQLITE_DBCONFIG_WRITABLE_SCHEMA]] <dt>SQLITE_DBCONFIG_WRITABLE_SCHEMA</dt>\n** <dd>The SQLITE_DBCONFIG_WRITABLE_SCHEMA option activates or deactivates the\n** \"writable_schema\" flag. This has the same effect and is logically equivalent\n** to setting [PRAGMA writable_schema=ON] or [PRAGMA writable_schema=OFF].\n** The first argument to this setting is an integer which is 0 to disable\n** the writable_schema, positive to enable writable_schema, or negative to\n** leave the setting unchanged. The second parameter is a pointer to an\n** integer into which is written 0 or 1 to indicate whether the writable_schema\n** is enabled or disabled following this call.\n** </dd>\n**\n** [[SQLITE_DBCONFIG_LEGACY_ALTER_TABLE]]\n** <dt>SQLITE_DBCONFIG_LEGACY_ALTER_TABLE</dt>\n** <dd>The SQLITE_DBCONFIG_LEGACY_ALTER_TABLE option activates or deactivates\n** the legacy behavior of the [ALTER TABLE RENAME] command such it\n** behaves as it did prior to [version 3.24.0] (2018-06-04). See the\n** \"Compatibility Notice\" on the [ALTER TABLE RENAME documentation] for\n** additional information. This feature can also be turned on and off\n** using the [PRAGMA legacy_alter_table] statement.\n** </dd>\n**\n** [[SQLITE_DBCONFIG_DQS_DML]]\n** <dt>SQLITE_DBCONFIG_DQS_DML</dt>\n** <dd>The SQLITE_DBCONFIG_DQS_DML option activates or deactivates\n** the legacy [double-quoted string literal] misfeature for DML statements\n** only, that is DELETE, INSERT, SELECT, and UPDATE statements. The\n** default value of this setting is determined by the [-DSQLITE_DQS]\n** compile-time option.\n** </dd>\n**\n** [[SQLITE_DBCONFIG_DQS_DDL]]\n** <dt>SQLITE_DBCONFIG_DQS_DDL</dt>\n** <dd>The SQLITE_DBCONFIG_DQS option activates or deactivates\n** the legacy [double-quoted string literal] misfeature for DDL statements,\n** such as CREATE TABLE and CREATE INDEX. The\n** default value of this setting is determined by the [-DSQLITE_DQS]\n** compile-time option.\n** </dd>\n**\n** [[SQLITE_DBCONFIG_TRUSTED_SCHEMA]]\n** <dt>SQLITE_DBCONFIG_TRUSTED_SCHEMA</dt>\n** <dd>The SQLITE_DBCONFIG_TRUSTED_SCHEMA option tells SQLite to\n** assume that database schemas are untainted by malicious content.\n** When the SQLITE_DBCONFIG_TRUSTED_SCHEMA option is disabled, SQLite\n** takes additional defensive steps to protect the application from harm\n** including:\n** <ul>\n** <li> Prohibit the use of SQL functions inside triggers, views,\n** CHECK constraints, DEFAULT clauses, expression indexes,\n** partial indexes, or generated columns\n** unless those functions are tagged with [SQLITE_INNOCUOUS].\n** <li> Prohibit the use of virtual tables inside of triggers or views\n** unless those virtual tables are tagged with [SQLITE_VTAB_INNOCUOUS].\n** </ul>\n** This setting defaults to \"on\" for legacy compatibility, however\n** all applications are advised to turn it off if possible. This setting\n** can also be controlled using the [PRAGMA trusted_schema] statement.\n** </dd>\n**\n** [[SQLITE_DBCONFIG_LEGACY_FILE_FORMAT]]\n** <dt>SQLITE_DBCONFIG_LEGACY_FILE_FORMAT</dt>\n** <dd>The SQLITE_DBCONFIG_LEGACY_FILE_FORMAT option activates or deactivates\n** the legacy file format flag. When activated, this flag causes all newly\n** created database file to have a schema format version number (the 4-byte\n** integer found at offset 44 into the database header) of 1. This in turn\n** means that the resulting database file will be readable and writable by\n** any SQLite version back to 3.0.0 ([dateof:3.0.0]). Without this setting,\n** newly created databases are generally not understandable by SQLite versions\n** prior to 3.3.0 ([dateof:3.3.0]). As these words are written, there\n** is now scarcely any need to generate database files that are compatible\n** all the way back to version 3.0.0, and so this setting is of little\n** practical use, but is provided so that SQLite can continue to claim the\n** ability to generate new database files that are compatible with version\n** 3.0.0.\n** <p>Note that when the SQLITE_DBCONFIG_LEGACY_FILE_FORMAT setting is on,\n** the [VACUUM] command will fail with an obscure error when attempting to\n** process a table with generated columns and a descending index. This is\n** not considered a bug since SQLite versions 3.3.0 and earlier do not support\n** either generated columns or descending indexes.\n** </dd>\n**\n** [[SQLITE_DBCONFIG_STMT_SCANSTATUS]]\n** <dt>SQLITE_DBCONFIG_STMT_SCANSTATUS</dt>\n** <dd>The SQLITE_DBCONFIG_STMT_SCANSTATUS option is only useful in\n** SQLITE_ENABLE_STMT_SCANSTATUS builds. In this case, it sets or clears\n** a flag that enables collection of the sqlite3_stmt_scanstatus_v2()\n** statistics. For statistics to be collected, the flag must be set on\n** the database handle both when the SQL statement is prepared and when it\n** is stepped. The flag is set (collection of statistics is enabled)\n** by default. <p>This option takes two arguments: an integer and a pointer to\n** an integer.. The first argument is 1, 0, or -1 to enable, disable, or\n** leave unchanged the statement scanstatus option. If the second argument\n** is not NULL, then the value of the statement scanstatus setting after\n** processing the first argument is written into the integer that the second\n** argument points to.\n** </dd>\n**\n** [[SQLITE_DBCONFIG_REVERSE_SCANORDER]]\n** <dt>SQLITE_DBCONFIG_REVERSE_SCANORDER</dt>\n** <dd>The SQLITE_DBCONFIG_REVERSE_SCANORDER option changes the default order\n** in which tables and indexes are scanned so that the scans start at the end\n** and work toward the beginning rather than starting at the beginning and\n** working toward the end. Setting SQLITE_DBCONFIG_REVERSE_SCANORDER is the\n** same as setting [PRAGMA reverse_unordered_selects]. <p>This option takes\n** two arguments which are an integer and a pointer to an integer. The first\n** argument is 1, 0, or -1 to enable, disable, or leave unchanged the\n** reverse scan order flag, respectively. If the second argument is not NULL,\n** then 0 or 1 is written into the integer that the second argument points to\n** depending on if the reverse scan order flag is set after processing the\n** first argument.\n** </dd>\n**\n** [[SQLITE_DBCONFIG_ENABLE_ATTACH_CREATE]]\n** <dt>SQLITE_DBCONFIG_ENABLE_ATTACH_CREATE</dt>\n** <dd>The SQLITE_DBCONFIG_ENABLE_ATTACH_CREATE option enables or disables\n** the ability of the [ATTACH DATABASE] SQL command to create a new database\n** file if the database filed named in the ATTACH command does not already\n** exist. This ability of ATTACH to create a new database is enabled by\n** default. Applications can disable or reenable the ability for ATTACH to\n** create new database files using this DBCONFIG option.<p>\n** This option takes two arguments which are an integer and a pointer\n** to an integer. The first argument is 1, 0, or -1 to enable, disable, or\n** leave unchanged the attach-create flag, respectively. If the second\n** argument is not NULL, then 0 or 1 is written into the integer that the\n** second argument points to depending on if the attach-create flag is set\n** after processing the first argument.\n** </dd>\n**\n** [[SQLITE_DBCONFIG_ENABLE_ATTACH_WRITE]]\n** <dt>SQLITE_DBCONFIG_ENABLE_ATTACH_WRITE</dt>\n** <dd>The SQLITE_DBCONFIG_ENABLE_ATTACH_WRITE option enables or disables the\n** ability of the [ATTACH DATABASE] SQL command to open a database for writing.\n** This capability is enabled by default. Applications can disable or\n** reenable this capability using the current DBCONFIG option. If the\n** the this capability is disabled, the [ATTACH] command will still work,\n** but the database will be opened read-only. If this option is disabled,\n** then the ability to create a new database using [ATTACH] is also disabled,\n** regardless of the value of the [SQLITE_DBCONFIG_ENABLE_ATTACH_CREATE]\n** option.<p>\n** This option takes two arguments which are an integer and a pointer\n** to an integer. The first argument is 1, 0, or -1 to enable, disable, or\n** leave unchanged the ability to ATTACH another database for writing,\n** respectively. If the second argument is not NULL, then 0 or 1 is written\n** into the integer to which the second argument points, depending on whether\n** the ability to ATTACH a read/write database is enabled or disabled\n** after processing the first argument.\n** </dd>\n**\n** [[SQLITE_DBCONFIG_ENABLE_COMMENTS]]\n** <dt>SQLITE_DBCONFIG_ENABLE_COMMENTS</dt>\n** <dd>The SQLITE_DBCONFIG_ENABLE_COMMENTS option enables or disables the\n** ability to include comments in SQL text. Comments are enabled by default.\n** An application can disable or reenable comments in SQL text using this\n** DBCONFIG option.<p>\n** This option takes two arguments which are an integer and a pointer\n** to an integer. The first argument is 1, 0, or -1 to enable, disable, or\n** leave unchanged the ability to use comments in SQL text,\n** respectively. If the second argument is not NULL, then 0 or 1 is written\n** into the integer that the second argument points to depending on if\n** comments are allowed in SQL text after processing the first argument.\n** </dd>\n**\n** </dl>\n**\n** [[DBCONFIG arguments]] <h3>Arguments To SQLITE_DBCONFIG Options</h3>\n**\n** <p>Most of the SQLITE_DBCONFIG options take two arguments, so that the\n** overall call to [sqlite3_db_config()] has a total of four parameters.\n** The first argument (the third parameter to sqlite3_db_config()) is a integer.\n** The second argument is a pointer to an integer. If the first argument is 1,\n** then the option becomes enabled. If the first integer argument is 0, then the\n** option is disabled. If the first argument is -1, then the option setting\n** is unchanged. The second argument, the pointer to an integer, may be NULL.\n** If the second argument is not NULL, then a value of 0 or 1 is written into\n** the integer to which the second argument points, depending on whether the\n** setting is disabled or enabled after applying any changes specified by\n** the first argument.\n**\n** <p>While most SQLITE_DBCONFIG options use the argument format\n** described in the previous paragraph, the [SQLITE_DBCONFIG_MAINDBNAME]\n** and [SQLITE_DBCONFIG_LOOKASIDE] options are different. See the\n** documentation of those exceptional options for details.\n*/\n#define SQLITE_DBCONFIG_MAINDBNAME 1000 /* const char* */\n#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */\n#define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */\n#define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */\n#define SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER 1004 /* int int* */\n#define SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION 1005 /* int int* */\n#define SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE 1006 /* int int* */\n#define SQLITE_DBCONFIG_ENABLE_QPSG 1007 /* int int* */\n#define SQLITE_DBCONFIG_TRIGGER_EQP 1008 /* int int* */\n#define SQLITE_DBCONFIG_RESET_DATABASE 1009 /* int int* */\n#define SQLITE_DBCONFIG_DEFENSIVE 1010 /* int int* */\n#define SQLITE_DBCONFIG_WRITABLE_SCHEMA 1011 /* int int* */\n#define SQLITE_DBCONFIG_LEGACY_ALTER_TABLE 1012 /* int int* */\n#define SQLITE_DBCONFIG_DQS_DML 1013 /* int int* */\n#define SQLITE_DBCONFIG_DQS_DDL 1014 /* int int* */\n#define SQLITE_DBCONFIG_ENABLE_VIEW 1015 /* int int* */\n#define SQLITE_DBCONFIG_LEGACY_FILE_FORMAT 1016 /* int int* */\n#define SQLITE_DBCONFIG_TRUSTED_SCHEMA 1017 /* int int* */\n#define SQLITE_DBCONFIG_STMT_SCANSTATUS 1018 /* int int* */\n#define SQLITE_DBCONFIG_REVERSE_SCANORDER 1019 /* int int* */\n#define SQLITE_DBCONFIG_ENABLE_ATTACH_CREATE 1020 /* int int* */\n#define SQLITE_DBCONFIG_ENABLE_ATTACH_WRITE 1021 /* int int* */\n#define SQLITE_DBCONFIG_ENABLE_COMMENTS 1022 /* int int* */\n#define SQLITE_DBCONFIG_MAX 1022 /* Largest DBCONFIG */\n\n/*\n** CAPI3REF: Enable Or Disable Extended Result Codes\n** METHOD: sqlite3\n**\n** ^The sqlite3_extended_result_codes() routine enables or disables the\n** [extended result codes] feature of SQLite. ^The extended result\n** codes are disabled by default for historical compatibility.\n*/\nSQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff);\n\n/*\n** CAPI3REF: Last Insert Rowid\n** METHOD: sqlite3\n**\n** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables)\n** has a unique 64-bit signed\n** integer key called the [ROWID | \"rowid\"]. ^The rowid is always available\n** as an undeclared column named ROWID, OID, or _ROWID_ as long as those\n** names are not also used by explicitly declared columns. ^If\n** the table has a column of type [INTEGER PRIMARY KEY] then that column\n** is another alias for the rowid.\n**\n** ^The sqlite3_last_insert_rowid(D) interface usually returns the [rowid] of\n** the most recent successful [INSERT] into a rowid table or [virtual table]\n** on database connection D. ^Inserts into [WITHOUT ROWID] tables are not\n** recorded. ^If no successful [INSERT]s into rowid tables have ever occurred\n** on the database connection D, then sqlite3_last_insert_rowid(D) returns\n** zero.\n**\n** As well as being set automatically as rows are inserted into database\n** tables, the value returned by this function may be set explicitly by\n** [sqlite3_set_last_insert_rowid()]\n**\n** Some virtual table implementations may INSERT rows into rowid tables as\n** part of committing a transaction (e.g. to flush data accumulated in memory\n** to disk). In this case subsequent calls to this function return the rowid\n** associated with these internal INSERT operations, which leads to\n** unintuitive results. Virtual table implementations that do write to rowid\n** tables in this way can avoid this problem by restoring the original\n** rowid value using [sqlite3_set_last_insert_rowid()] before returning\n** control to the user.\n**\n** ^(If an [INSERT] occurs within a trigger then this routine will\n** return the [rowid] of the inserted row as long as the trigger is\n** running. Once the trigger program ends, the value returned\n** by this routine reverts to what it was before the trigger was fired.)^\n**\n** ^An [INSERT] that fails due to a constraint violation is not a\n** successful [INSERT] and does not change the value returned by this\n** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,\n** and INSERT OR ABORT make no changes to the return value of this\n** routine when their insertion fails. ^(When INSERT OR REPLACE\n** encounters a constraint violation, it does not fail. The\n** INSERT continues to completion after deleting rows that caused\n** the constraint problem so INSERT OR REPLACE will always change\n** the return value of this interface.)^\n**\n** ^For the purposes of this routine, an [INSERT] is considered to\n** be successful even if it is subsequently rolled back.\n**\n** This function is accessible to SQL statements via the\n** [last_insert_rowid() SQL function].\n**\n** If a separate thread performs a new [INSERT] on the same\n** database connection while the [sqlite3_last_insert_rowid()]\n** function is running and thus changes the last insert [rowid],\n** then the value returned by [sqlite3_last_insert_rowid()] is\n** unpredictable and might not equal either the old or the new\n** last insert [rowid].\n*/\nSQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);\n\n/*\n** CAPI3REF: Set the Last Insert Rowid value.\n** METHOD: sqlite3\n**\n** The sqlite3_set_last_insert_rowid(D, R) method allows the application to\n** set the value returned by calling sqlite3_last_insert_rowid(D) to R\n** without inserting a row into the database.\n*/\nSQLITE_API void sqlite3_set_last_insert_rowid(sqlite3*,sqlite3_int64);\n\n/*\n** CAPI3REF: Count The Number Of Rows Modified\n** METHOD: sqlite3\n**\n** ^These functions return the number of rows modified, inserted or\n** deleted by the most recently completed INSERT, UPDATE or DELETE\n** statement on the database connection specified by the only parameter.\n** The two functions are identical except for the type of the return value\n** and that if the number of rows modified by the most recent INSERT, UPDATE,\n** or DELETE is greater than the maximum value supported by type \"int\", then\n** the return value of sqlite3_changes() is undefined. ^Executing any other\n** type of SQL statement does not modify the value returned by these functions.\n** For the purposes of this interface, a CREATE TABLE AS SELECT statement\n** does not count as an INSERT, UPDATE or DELETE statement and hence the rows\n** added to the new table by the CREATE TABLE AS SELECT statement are not\n** counted.\n**\n** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are\n** considered - auxiliary changes caused by [CREATE TRIGGER | triggers],\n** [foreign key actions] or [REPLACE] constraint resolution are not counted.\n**\n** Changes to a view that are intercepted by\n** [INSTEAD OF trigger | INSTEAD OF triggers] are not counted. ^The value\n** returned by sqlite3_changes() immediately after an INSERT, UPDATE or\n** DELETE statement run on a view is always zero. Only changes made to real\n** tables are counted.\n**\n** Things are more complicated if the sqlite3_changes() function is\n** executed while a trigger program is running. This may happen if the\n** program uses the [changes() SQL function], or if some other callback\n** function invokes sqlite3_changes() directly. Essentially:\n**\n** <ul>\n** <li> ^(Before entering a trigger program the value returned by\n** sqlite3_changes() function is saved. After the trigger program\n** has finished, the original value is restored.)^\n**\n** <li> ^(Within a trigger program each INSERT, UPDATE and DELETE\n** statement sets the value returned by sqlite3_changes()\n** upon completion as normal. Of course, this value will not include\n** any changes performed by sub-triggers, as the sqlite3_changes()\n** value will be saved and restored after each sub-trigger has run.)^\n** </ul>\n**\n** ^This means that if the changes() SQL function (or similar) is used\n** by the first INSERT, UPDATE or DELETE statement within a trigger, it\n** returns the value as set when the calling statement began executing.\n** ^If it is used by the second or subsequent such statement within a trigger\n** program, the value returned reflects the number of rows modified by the\n** previous INSERT, UPDATE or DELETE statement within the same trigger.\n**\n** If a separate thread makes changes on the same database connection\n** while [sqlite3_changes()] is running then the value returned\n** is unpredictable and not meaningful.\n**\n** See also:\n** <ul>\n** <li> the [sqlite3_total_changes()] interface\n** <li> the [count_changes pragma]\n** <li> the [changes() SQL function]\n** <li> the [data_version pragma]\n** </ul>\n*/\nSQLITE_API int sqlite3_changes(sqlite3*);\nSQLITE_API sqlite3_int64 sqlite3_changes64(sqlite3*);\n\n/*\n** CAPI3REF: Total Number Of Rows Modified\n** METHOD: sqlite3\n**\n** ^These functions return the total number of rows inserted, modified or\n** deleted by all [INSERT], [UPDATE] or [DELETE] statements completed\n** since the database connection was opened, including those executed as\n** part of trigger programs. The two functions are identical except for the\n** type of the return value and that if the number of rows modified by the\n** connection exceeds the maximum value supported by type \"int\", then\n** the return value of sqlite3_total_changes() is undefined. ^Executing\n** any other type of SQL statement does not affect the value returned by\n** sqlite3_total_changes().\n**\n** ^Changes made as part of [foreign key actions] are included in the\n** count, but those made as part of REPLACE constraint resolution are\n** not. ^Changes to a view that are intercepted by INSTEAD OF triggers\n** are not counted.\n**\n** The [sqlite3_total_changes(D)] interface only reports the number\n** of rows that changed due to SQL statement run against database\n** connection D. Any changes by other database connections are ignored.\n** To detect changes against a database file from other database\n** connections use the [PRAGMA data_version] command or the\n** [SQLITE_FCNTL_DATA_VERSION] [file control].\n**\n** If a separate thread makes changes on the same database connection\n** while [sqlite3_total_changes()] is running then the value\n** returned is unpredictable and not meaningful.\n**\n** See also:\n** <ul>\n** <li> the [sqlite3_changes()] interface\n** <li> the [count_changes pragma]\n** <li> the [changes() SQL function]\n** <li> the [data_version pragma]\n** <li> the [SQLITE_FCNTL_DATA_VERSION] [file control]\n** </ul>\n*/\nSQLITE_API int sqlite3_total_changes(sqlite3*);\nSQLITE_API sqlite3_int64 sqlite3_total_changes64(sqlite3*);\n\n/*\n** CAPI3REF: Interrupt A Long-Running Query\n** METHOD: sqlite3\n**\n** ^This function causes any pending database operation to abort and\n** return at its earliest opportunity. This routine is typically\n** called in response to a user action such as pressing \"Cancel\"\n** or Ctrl-C where the user wants a long query operation to halt\n** immediately.\n**\n** ^It is safe to call this routine from a thread different from the\n** thread that is currently running the database operation. But it\n** is not safe to call this routine with a [database connection] that\n** is closed or might close before sqlite3_interrupt() returns.\n**\n** ^If an SQL operation is very nearly finished at the time when\n** sqlite3_interrupt() is called, then it might not have an opportunity\n** to be interrupted and might continue to completion.\n**\n** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT].\n** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE\n** that is inside an explicit transaction, then the entire transaction\n** will be rolled back automatically.\n**\n** ^The sqlite3_interrupt(D) call is in effect until all currently running\n** SQL statements on [database connection] D complete. ^Any new SQL statements\n** that are started after the sqlite3_interrupt() call and before the\n** running statement count reaches zero are interrupted as if they had been\n** running prior to the sqlite3_interrupt() call. ^New SQL statements\n** that are started after the running statement count reaches zero are\n** not effected by the sqlite3_interrupt().\n** ^A call to sqlite3_interrupt(D) that occurs when there are no running\n** SQL statements is a no-op and has no effect on SQL statements\n** that are started after the sqlite3_interrupt() call returns.\n**\n** ^The [sqlite3_is_interrupted(D)] interface can be used to determine whether\n** or not an interrupt is currently in effect for [database connection] D.\n** It returns 1 if an interrupt is currently in effect, or 0 otherwise.\n*/\nSQLITE_API void sqlite3_interrupt(sqlite3*);\nSQLITE_API int sqlite3_is_interrupted(sqlite3*);\n\n/*\n** CAPI3REF: Determine If An SQL Statement Is Complete\n**\n** These routines are useful during command-line input to determine if the\n** currently entered text seems to form a complete SQL statement or\n** if additional input is needed before sending the text into\n** SQLite for parsing. ^These routines return 1 if the input string\n** appears to be a complete SQL statement. ^A statement is judged to be\n** complete if it ends with a semicolon token and is not a prefix of a\n** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within\n** string literals or quoted identifier names or comments are not\n** independent tokens (they are part of the token in which they are\n** embedded) and thus do not count as a statement terminator. ^Whitespace\n** and comments that follow the final semicolon are ignored.\n**\n** ^These routines return 0 if the statement is incomplete. ^If a\n** memory allocation fails, then SQLITE_NOMEM is returned.\n**\n** ^These routines do not parse the SQL statements thus\n** will not detect syntactically incorrect SQL.\n**\n** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior\n** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked\n** automatically by sqlite3_complete16(). If that initialization fails,\n** then the return value from sqlite3_complete16() will be non-zero\n** regardless of whether or not the input SQL is complete.)^\n**\n** The input to [sqlite3_complete()] must be a zero-terminated\n** UTF-8 string.\n**\n** The input to [sqlite3_complete16()] must be a zero-terminated\n** UTF-16 string in native byte order.\n*/\nSQLITE_API int sqlite3_complete(const char *sql);\nSQLITE_API int sqlite3_complete16(const void *sql);\n\n/*\n** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors\n** KEYWORDS: {busy-handler callback} {busy handler}\n** METHOD: sqlite3\n**\n** ^The sqlite3_busy_handler(D,X,P) routine sets a callback function X\n** that might be invoked with argument P whenever\n** an attempt is made to access a database table associated with\n** [database connection] D when another thread\n** or process has the table locked.\n** The sqlite3_busy_handler() interface is used to implement\n** [sqlite3_busy_timeout()] and [PRAGMA busy_timeout].\n**\n** ^If the busy callback is NULL, then [SQLITE_BUSY]\n** is returned immediately upon encountering the lock. ^If the busy callback\n** is not NULL, then the callback might be invoked with two arguments.\n**\n** ^The first argument to the busy handler is a copy of the void* pointer which\n** is the third argument to sqlite3_busy_handler(). ^The second argument to\n** the busy handler callback is the number of times that the busy handler has\n** been invoked previously for the same locking event. ^If the\n** busy callback returns 0, then no additional attempts are made to\n** access the database and [SQLITE_BUSY] is returned\n** to the application.\n** ^If the callback returns non-zero, then another attempt\n** is made to access the database and the cycle repeats.\n**\n** The presence of a busy handler does not guarantee that it will be invoked\n** when there is lock contention. ^If SQLite determines that invoking the busy\n** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]\n** to the application instead of invoking the\n** busy handler.\n** Consider a scenario where one process is holding a read lock that\n** it is trying to promote to a reserved lock and\n** a second process is holding a reserved lock that it is trying\n** to promote to an exclusive lock. The first process cannot proceed\n** because it is blocked by the second and the second process cannot\n** proceed because it is blocked by the first. If both processes\n** invoke the busy handlers, neither will make any progress. Therefore,\n** SQLite returns [SQLITE_BUSY] for the first process, hoping that this\n** will induce the first process to release its read lock and allow\n** the second process to proceed.\n**\n** ^The default busy callback is NULL.\n**\n** ^(There can only be a single busy handler defined for each\n** [database connection]. Setting a new busy handler clears any\n** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()]\n** or evaluating [PRAGMA busy_timeout=N] will change the\n** busy handler and thus clear any previously set busy handler.\n**\n** The busy callback should not take any actions which modify the\n** database connection that invoked the busy handler. In other words,\n** the busy handler is not reentrant. Any such actions\n** result in undefined behavior.\n**\n** A busy handler must not close the database connection\n** or [prepared statement] that invoked the busy handler.\n*/\nSQLITE_API int sqlite3_busy_handler(sqlite3*,int(*)(void*,int),void*);\n\n/*\n** CAPI3REF: Set A Busy Timeout\n** METHOD: sqlite3\n**\n** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps\n** for a specified amount of time when a table is locked. ^The handler\n** will sleep multiple times until at least \"ms\" milliseconds of sleeping\n** have accumulated. ^After at least \"ms\" milliseconds of sleeping,\n** the handler returns 0 which causes [sqlite3_step()] to return\n** [SQLITE_BUSY].\n**\n** ^Calling this routine with an argument less than or equal to zero\n** turns off all busy handlers.\n**\n** ^(There can only be a single busy handler for a particular\n** [database connection] at any given moment. If another busy handler\n** was defined (using [sqlite3_busy_handler()]) prior to calling\n** this routine, that other busy handler is cleared.)^\n**\n** See also: [PRAGMA busy_timeout]\n*/\nSQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms);\n\n/*\n** CAPI3REF: Convenience Routines For Running Queries\n** METHOD: sqlite3\n**\n** This is a legacy interface that is preserved for backwards compatibility.\n** Use of this interface is not recommended.\n**\n** Definition: A <b>result table</b> is memory data structure created by the\n** [sqlite3_get_table()] interface. A result table records the\n** complete query results from one or more queries.\n**\n** The table conceptually has a number of rows and columns. But\n** these numbers are not part of the result table itself. These\n** numbers are obtained separately. Let N be the number of rows\n** and M be the number of columns.\n**\n** A result table is an array of pointers to zero-terminated UTF-8 strings.\n** There are (N+1)*M elements in the array. The first M pointers point\n** to zero-terminated strings that contain the names of the columns.\n** The remaining entries all point to query results. NULL values result\n** in NULL pointers. All other values are in their UTF-8 zero-terminated\n** string representation as returned by [sqlite3_column_text()].\n**\n** A result table might consist of one or more memory allocations.\n** It is not safe to pass a result table directly to [sqlite3_free()].\n** A result table should be deallocated using [sqlite3_free_table()].\n**\n** ^(As an example of the result table format, suppose a query result\n** is as follows:\n**\n** <blockquote><pre>\n** Name | Age\n** -----------------------\n** Alice | 43\n** Bob | 28\n** Cindy | 21\n** </pre></blockquote>\n**\n** There are two columns (M==2) and three rows (N==3). Thus the\n** result table has 8 entries. Suppose the result table is stored\n** in an array named azResult. Then azResult holds this content:\n**\n** <blockquote><pre>\n** azResult[0] = \"Name\";\n** azResult[1] = \"Age\";\n** azResult[2] = \"Alice\";\n** azResult[3] = \"43\";\n** azResult[4] = \"Bob\";\n** azResult[5] = \"28\";\n** azResult[6] = \"Cindy\";\n** azResult[7] = \"21\";\n** </pre></blockquote>)^\n**\n** ^The sqlite3_get_table() function evaluates one or more\n** semicolon-separated SQL statements in the zero-terminated UTF-8\n** string of its 2nd parameter and returns a result table to the\n** pointer given in its 3rd parameter.\n**\n** After the application has finished with the result from sqlite3_get_table(),\n** it must pass the result table pointer to sqlite3_free_table() in order to\n** release the memory that was malloced. Because of the way the\n** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling\n** function must not try to call [sqlite3_free()] directly. Only\n** [sqlite3_free_table()] is able to release the memory properly and safely.\n**\n** The sqlite3_get_table() interface is implemented as a wrapper around\n** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access\n** to any internal data structures of SQLite. It uses only the public\n** interface defined here. As a consequence, errors that occur in the\n** wrapper layer outside of the internal [sqlite3_exec()] call are not\n** reflected in subsequent calls to [sqlite3_errcode()] or\n** [sqlite3_errmsg()].\n*/\nSQLITE_API int sqlite3_get_table(\n sqlite3 *db, /* An open database */\n const char *zSql, /* SQL to be evaluated */\n char ***pazResult, /* Results of the query */\n int *pnRow, /* Number of result rows written here */\n int *pnColumn, /* Number of result columns written here */\n char **pzErrmsg /* Error msg written here */\n);\nSQLITE_API void sqlite3_free_table(char **result);\n\n/*\n** CAPI3REF: Formatted String Printing Functions\n**\n** These routines are work-alikes of the \"printf()\" family of functions\n** from the standard C library.\n** These routines understand most of the common formatting options from\n** the standard library printf()\n** plus some additional non-standard formats ([%q], [%Q], [%w], and [%z]).\n** See the [built-in printf()] documentation for details.\n**\n** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their\n** results into memory obtained from [sqlite3_malloc64()].\n** The strings returned by these two routines should be\n** released by [sqlite3_free()]. ^Both routines return a\n** NULL pointer if [sqlite3_malloc64()] is unable to allocate enough\n** memory to hold the resulting string.\n**\n** ^(The sqlite3_snprintf() routine is similar to \"snprintf()\" from\n** the standard C library. The result is written into the\n** buffer supplied as the second parameter whose size is given by\n** the first parameter. Note that the order of the\n** first two parameters is reversed from snprintf().)^ This is an\n** historical accident that cannot be fixed without breaking\n** backwards compatibility. ^(Note also that sqlite3_snprintf()\n** returns a pointer to its buffer instead of the number of\n** characters actually written into the buffer.)^ We admit that\n** the number of characters written would be a more useful return\n** value but we cannot change the implementation of sqlite3_snprintf()\n** now without breaking compatibility.\n**\n** ^As long as the buffer size is greater than zero, sqlite3_snprintf()\n** guarantees that the buffer is always zero-terminated. ^The first\n** parameter \"n\" is the total size of the buffer, including space for\n** the zero terminator. So the longest string that can be completely\n** written will be n-1 characters.\n**\n** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf().\n**\n** See also: [built-in printf()], [printf() SQL function]\n*/\nSQLITE_API char *sqlite3_mprintf(const char*,...);\nSQLITE_API char *sqlite3_vmprintf(const char*, va_list);\nSQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...);\nSQLITE_API char *sqlite3_vsnprintf(int,char*,const char*, va_list);\n\n/*\n** CAPI3REF: Memory Allocation Subsystem\n**\n** The SQLite core uses these three routines for all of its own\n** internal memory allocation needs. \"Core\" in the previous sentence\n** does not include operating-system specific [VFS] implementation. The\n** Windows VFS uses native malloc() and free() for some operations.\n**\n** ^The sqlite3_malloc() routine returns a pointer to a block\n** of memory at least N bytes in length, where N is the parameter.\n** ^If sqlite3_malloc() is unable to obtain sufficient free\n** memory, it returns a NULL pointer. ^If the parameter N to\n** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns\n** a NULL pointer.\n**\n** ^The sqlite3_malloc64(N) routine works just like\n** sqlite3_malloc(N) except that N is an unsigned 64-bit integer instead\n** of a signed 32-bit integer.\n**\n** ^Calling sqlite3_free() with a pointer previously returned\n** by sqlite3_malloc() or sqlite3_realloc() releases that memory so\n** that it might be reused. ^The sqlite3_free() routine is\n** a no-op if is called with a NULL pointer. Passing a NULL pointer\n** to sqlite3_free() is harmless. After being freed, memory\n** should neither be read nor written. Even reading previously freed\n** memory might result in a segmentation fault or other severe error.\n** Memory corruption, a segmentation fault, or other severe error\n** might result if sqlite3_free() is called with a non-NULL pointer that\n** was not obtained from sqlite3_malloc() or sqlite3_realloc().\n**\n** ^The sqlite3_realloc(X,N) interface attempts to resize a\n** prior memory allocation X to be at least N bytes.\n** ^If the X parameter to sqlite3_realloc(X,N)\n** is a NULL pointer then its behavior is identical to calling\n** sqlite3_malloc(N).\n** ^If the N parameter to sqlite3_realloc(X,N) is zero or\n** negative then the behavior is exactly the same as calling\n** sqlite3_free(X).\n** ^sqlite3_realloc(X,N) returns a pointer to a memory allocation\n** of at least N bytes in size or NULL if insufficient memory is available.\n** ^If M is the size of the prior allocation, then min(N,M) bytes\n** of the prior allocation are copied into the beginning of buffer returned\n** by sqlite3_realloc(X,N) and the prior allocation is freed.\n** ^If sqlite3_realloc(X,N) returns NULL and N is positive, then the\n** prior allocation is not freed.\n**\n** ^The sqlite3_realloc64(X,N) interfaces works the same as\n** sqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead\n** of a 32-bit signed integer.\n**\n** ^If X is a memory allocation previously obtained from sqlite3_malloc(),\n** sqlite3_malloc64(), sqlite3_realloc(), or sqlite3_realloc64(), then\n** sqlite3_msize(X) returns the size of that memory allocation in bytes.\n** ^The value returned by sqlite3_msize(X) might be larger than the number\n** of bytes requested when X was allocated. ^If X is a NULL pointer then\n** sqlite3_msize(X) returns zero. If X points to something that is not\n** the beginning of memory allocation, or if it points to a formerly\n** valid memory allocation that has now been freed, then the behavior\n** of sqlite3_msize(X) is undefined and possibly harmful.\n**\n** ^The memory returned by sqlite3_malloc(), sqlite3_realloc(),\n** sqlite3_malloc64(), and sqlite3_realloc64()\n** is always aligned to at least an 8 byte boundary, or to a\n** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time\n** option is used.\n**\n** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]\n** must be either NULL or else pointers obtained from a prior\n** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have\n** not yet been released.\n**\n** The application must not read or write any part of\n** a block of memory after it has been released using\n** [sqlite3_free()] or [sqlite3_realloc()].\n*/\nSQLITE_API void *sqlite3_malloc(int);\nSQLITE_API void *sqlite3_malloc64(sqlite3_uint64);\nSQLITE_API void *sqlite3_realloc(void*, int);\nSQLITE_API void *sqlite3_realloc64(void*, sqlite3_uint64);\nSQLITE_API void sqlite3_free(void*);\nSQLITE_API sqlite3_uint64 sqlite3_msize(void*);\n\n/*\n** CAPI3REF: Memory Allocator Statistics\n**\n** SQLite provides these two interfaces for reporting on the status\n** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]\n** routines, which form the built-in memory allocation subsystem.\n**\n** ^The [sqlite3_memory_used()] routine returns the number of bytes\n** of memory currently outstanding (malloced but not freed).\n** ^The [sqlite3_memory_highwater()] routine returns the maximum\n** value of [sqlite3_memory_used()] since the high-water mark\n** was last reset. ^The values returned by [sqlite3_memory_used()] and\n** [sqlite3_memory_highwater()] include any overhead\n** added by SQLite in its implementation of [sqlite3_malloc()],\n** but not overhead added by the any underlying system library\n** routines that [sqlite3_malloc()] may call.\n**\n** ^The memory high-water mark is reset to the current value of\n** [sqlite3_memory_used()] if and only if the parameter to\n** [sqlite3_memory_highwater()] is true. ^The value returned\n** by [sqlite3_memory_highwater(1)] is the high-water mark\n** prior to the reset.\n*/\nSQLITE_API sqlite3_int64 sqlite3_memory_used(void);\nSQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag);\n\n/*\n** CAPI3REF: Pseudo-Random Number Generator\n**\n** SQLite contains a high-quality pseudo-random number generator (PRNG) used to\n** select random [ROWID | ROWIDs] when inserting new records into a table that\n** already uses the largest possible [ROWID]. The PRNG is also used for\n** the built-in random() and randomblob() SQL functions. This interface allows\n** applications to access the same PRNG for other purposes.\n**\n** ^A call to this routine stores N bytes of randomness into buffer P.\n** ^The P parameter can be a NULL pointer.\n**\n** ^If this routine has not been previously called or if the previous\n** call had N less than one or a NULL pointer for P, then the PRNG is\n** seeded using randomness obtained from the xRandomness method of\n** the default [sqlite3_vfs] object.\n** ^If the previous call to this routine had an N of 1 or more and a\n** non-NULL P then the pseudo-randomness is generated\n** internally and without recourse to the [sqlite3_vfs] xRandomness\n** method.\n*/\nSQLITE_API void sqlite3_randomness(int N, void *P);\n\n/*\n** CAPI3REF: Compile-Time Authorization Callbacks\n** METHOD: sqlite3\n** KEYWORDS: {authorizer callback}\n**\n** ^This routine registers an authorizer callback with a particular\n** [database connection], supplied in the first argument.\n** ^The authorizer callback is invoked as SQL statements are being compiled\n** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],\n** [sqlite3_prepare_v3()], [sqlite3_prepare16()], [sqlite3_prepare16_v2()],\n** and [sqlite3_prepare16_v3()]. ^At various\n** points during the compilation process, as logic is being created\n** to perform various actions, the authorizer callback is invoked to\n** see if those actions are allowed. ^The authorizer callback should\n** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the\n** specific action but allow the SQL statement to continue to be\n** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be\n** rejected with an error. ^If the authorizer callback returns\n** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]\n** then the [sqlite3_prepare_v2()] or equivalent call that triggered\n** the authorizer will fail with an error message.\n**\n** When the callback returns [SQLITE_OK], that means the operation\n** requested is ok. ^When the callback returns [SQLITE_DENY], the\n** [sqlite3_prepare_v2()] or equivalent call that triggered the\n** authorizer will fail with an error message explaining that\n** access is denied.\n**\n** ^The first parameter to the authorizer callback is a copy of the third\n** parameter to the sqlite3_set_authorizer() interface. ^The second parameter\n** to the callback is an integer [SQLITE_COPY | action code] that specifies\n** the particular action to be authorized. ^The third through sixth parameters\n** to the callback are either NULL pointers or zero-terminated strings\n** that contain additional details about the action to be authorized.\n** Applications must always be prepared to encounter a NULL pointer in any\n** of the third through the sixth parameters of the authorization callback.\n**\n** ^If the action code is [SQLITE_READ]\n** and the callback returns [SQLITE_IGNORE] then the\n** [prepared statement] statement is constructed to substitute\n** a NULL value in place of the table column that would have\n** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE]\n** return can be used to deny an untrusted user access to individual\n** columns of a table.\n** ^When a table is referenced by a [SELECT] but no column values are\n** extracted from that table (for example in a query like\n** \"SELECT count(*) FROM tab\") then the [SQLITE_READ] authorizer callback\n** is invoked once for that table with a column name that is an empty string.\n** ^If the action code is [SQLITE_DELETE] and the callback returns\n** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the\n** [truncate optimization] is disabled and all rows are deleted individually.\n**\n** An authorizer is used when [sqlite3_prepare | preparing]\n** SQL statements from an untrusted source, to ensure that the SQL statements\n** do not try to access data they are not allowed to see, or that they do not\n** try to execute malicious statements that damage the database. For\n** example, an application may allow a user to enter arbitrary\n** SQL queries for evaluation by a database. But the application does\n** not want the user to be able to make arbitrary changes to the\n** database. An authorizer could then be put in place while the\n** user-entered SQL is being [sqlite3_prepare | prepared] that\n** disallows everything except [SELECT] statements.\n**\n** Applications that need to process SQL from untrusted sources\n** might also consider lowering resource limits using [sqlite3_limit()]\n** and limiting database size using the [max_page_count] [PRAGMA]\n** in addition to using an authorizer.\n**\n** ^(Only a single authorizer can be in place on a database connection\n** at a time. Each call to sqlite3_set_authorizer overrides the\n** previous call.)^ ^Disable the authorizer by installing a NULL callback.\n** The authorizer is disabled by default.\n**\n** The authorizer callback must not do anything that will modify\n** the database connection that invoked the authorizer callback.\n** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their\n** database connections for the meaning of \"modify\" in this paragraph.\n**\n** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the\n** statement might be re-prepared during [sqlite3_step()] due to a\n** schema change. Hence, the application should ensure that the\n** correct authorizer callback remains in place during the [sqlite3_step()].\n**\n** ^Note that the authorizer callback is invoked only during\n** [sqlite3_prepare()] or its variants. Authorization is not\n** performed during statement evaluation in [sqlite3_step()], unless\n** as stated in the previous paragraph, sqlite3_step() invokes\n** sqlite3_prepare_v2() to reprepare a statement after a schema change.\n*/\nSQLITE_API int sqlite3_set_authorizer(\n sqlite3*,\n int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),\n void *pUserData\n);\n\n/*\n** CAPI3REF: Authorizer Return Codes\n**\n** The [sqlite3_set_authorizer | authorizer callback function] must\n** return either [SQLITE_OK] or one of these two constants in order\n** to signal SQLite whether or not the action is permitted. See the\n** [sqlite3_set_authorizer | authorizer documentation] for additional\n** information.\n**\n** Note that SQLITE_IGNORE is also used as a [conflict resolution mode]\n** returned from the [sqlite3_vtab_on_conflict()] interface.\n*/\n#define SQLITE_DENY 1 /* Abort the SQL statement with an error */\n#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */\n\n/*\n** CAPI3REF: Authorizer Action Codes\n**\n** The [sqlite3_set_authorizer()] interface registers a callback function\n** that is invoked to authorize certain SQL statement actions. The\n** second parameter to the callback is an integer code that specifies\n** what action is being authorized. These are the integer action codes that\n** the authorizer callback may be passed.\n**\n** These action code values signify what kind of operation is to be\n** authorized. The 3rd and 4th parameters to the authorization\n** callback function will be parameters or NULL depending on which of these\n** codes is used as the second parameter. ^(The 5th parameter to the\n** authorizer callback is the name of the database (\"main\", \"temp\",\n** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback\n** is the name of the inner-most trigger or view that is responsible for\n** the access attempt or NULL if this access attempt is directly from\n** top-level SQL code.\n*/\n/******************************************* 3rd ************ 4th ***********/\n#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */\n#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */\n#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */\n#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */\n#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */\n#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */\n#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */\n#define SQLITE_CREATE_VIEW 8 /* View Name NULL */\n#define SQLITE_DELETE 9 /* Table Name NULL */\n#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */\n#define SQLITE_DROP_TABLE 11 /* Table Name NULL */\n#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */\n#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */\n#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */\n#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */\n#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */\n#define SQLITE_DROP_VIEW 17 /* View Name NULL */\n#define SQLITE_INSERT 18 /* Table Name NULL */\n#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */\n#define SQLITE_READ 20 /* Table Name Column Name */\n#define SQLITE_SELECT 21 /* NULL NULL */\n#define SQLITE_TRANSACTION 22 /* Operation NULL */\n#define SQLITE_UPDATE 23 /* Table Name Column Name */\n#define SQLITE_ATTACH 24 /* Filename NULL */\n#define SQLITE_DETACH 25 /* Database Name NULL */\n#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */\n#define SQLITE_REINDEX 27 /* Index Name NULL */\n#define SQLITE_ANALYZE 28 /* Table Name NULL */\n#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */\n#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */\n#define SQLITE_FUNCTION 31 /* NULL Function Name */\n#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */\n#define SQLITE_COPY 0 /* No longer used */\n#define SQLITE_RECURSIVE 33 /* NULL NULL */\n\n/*\n** CAPI3REF: Deprecated Tracing And Profiling Functions\n** DEPRECATED\n**\n** These routines are deprecated. Use the [sqlite3_trace_v2()] interface\n** instead of the routines described here.\n**\n** These routines register callback functions that can be used for\n** tracing and profiling the execution of SQL statements.\n**\n** ^The callback function registered by sqlite3_trace() is invoked at\n** various times when an SQL statement is being run by [sqlite3_step()].\n** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the\n** SQL statement text as the statement first begins executing.\n** ^(Additional sqlite3_trace() callbacks might occur\n** as each triggered subprogram is entered. The callbacks for triggers\n** contain a UTF-8 SQL comment that identifies the trigger.)^\n**\n** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit\n** the length of [bound parameter] expansion in the output of sqlite3_trace().\n**\n** ^The callback function registered by sqlite3_profile() is invoked\n** as each SQL statement finishes. ^The profile callback contains\n** the original statement text and an estimate of wall-clock time\n** of how long that statement took to run. ^The profile callback\n** time is in units of nanoseconds, however the current implementation\n** is only capable of millisecond resolution so the six least significant\n** digits in the time are meaningless. Future versions of SQLite\n** might provide greater resolution on the profiler callback. Invoking\n** either [sqlite3_trace()] or [sqlite3_trace_v2()] will cancel the\n** profile callback.\n*/\nSQLITE_API SQLITE_DEPRECATED void *sqlite3_trace(sqlite3*,\n void(*xTrace)(void*,const char*), void*);\nSQLITE_API SQLITE_DEPRECATED void *sqlite3_profile(sqlite3*,\n void(*xProfile)(void*,const char*,sqlite3_uint64), void*);\n\n/*\n** CAPI3REF: SQL Trace Event Codes\n** KEYWORDS: SQLITE_TRACE\n**\n** These constants identify classes of events that can be monitored\n** using the [sqlite3_trace_v2()] tracing logic. The M argument\n** to [sqlite3_trace_v2(D,M,X,P)] is an OR-ed combination of one or more of\n** the following constants. ^The first argument to the trace callback\n** is one of the following constants.\n**\n** New tracing constants may be added in future releases.\n**\n** ^A trace callback has four arguments: xCallback(T,C,P,X).\n** ^The T argument is one of the integer type codes above.\n** ^The C argument is a copy of the context pointer passed in as the\n** fourth argument to [sqlite3_trace_v2()].\n** The P and X arguments are pointers whose meanings depend on T.\n**\n** <dl>\n** [[SQLITE_TRACE_STMT]] <dt>SQLITE_TRACE_STMT</dt>\n** <dd>^An SQLITE_TRACE_STMT callback is invoked when a prepared statement\n** first begins running and possibly at other times during the\n** execution of the prepared statement, such as at the start of each\n** trigger subprogram. ^The P argument is a pointer to the\n** [prepared statement]. ^The X argument is a pointer to a string which\n** is the unexpanded SQL text of the prepared statement or an SQL comment\n** that indicates the invocation of a trigger. ^The callback can compute\n** the same text that would have been returned by the legacy [sqlite3_trace()]\n** interface by using the X argument when X begins with \"--\" and invoking\n** [sqlite3_expanded_sql(P)] otherwise.\n**\n** [[SQLITE_TRACE_PROFILE]] <dt>SQLITE_TRACE_PROFILE</dt>\n** <dd>^An SQLITE_TRACE_PROFILE callback provides approximately the same\n** information as is provided by the [sqlite3_profile()] callback.\n** ^The P argument is a pointer to the [prepared statement] and the\n** X argument points to a 64-bit integer which is approximately\n** the number of nanoseconds that the prepared statement took to run.\n** ^The SQLITE_TRACE_PROFILE callback is invoked when the statement finishes.\n**\n** [[SQLITE_TRACE_ROW]] <dt>SQLITE_TRACE_ROW</dt>\n** <dd>^An SQLITE_TRACE_ROW callback is invoked whenever a prepared\n** statement generates a single row of result.\n** ^The P argument is a pointer to the [prepared statement] and the\n** X argument is unused.\n**\n** [[SQLITE_TRACE_CLOSE]] <dt>SQLITE_TRACE_CLOSE</dt>\n** <dd>^An SQLITE_TRACE_CLOSE callback is invoked when a database\n** connection closes.\n** ^The P argument is a pointer to the [database connection] object\n** and the X argument is unused.\n** </dl>\n*/\n#define SQLITE_TRACE_STMT 0x01\n#define SQLITE_TRACE_PROFILE 0x02\n#define SQLITE_TRACE_ROW 0x04\n#define SQLITE_TRACE_CLOSE 0x08\n\n/*\n** CAPI3REF: SQL Trace Hook\n** METHOD: sqlite3\n**\n** ^The sqlite3_trace_v2(D,M,X,P) interface registers a trace callback\n** function X against [database connection] D, using property mask M\n** and context pointer P. ^If the X callback is\n** NULL or if the M mask is zero, then tracing is disabled. The\n** M argument should be the bitwise OR-ed combination of\n** zero or more [SQLITE_TRACE] constants.\n**\n** ^Each call to either sqlite3_trace(D,X,P) or sqlite3_trace_v2(D,M,X,P)\n** overrides (cancels) all prior calls to sqlite3_trace(D,X,P) or\n** sqlite3_trace_v2(D,M,X,P) for the [database connection] D. Each\n** database connection may have at most one trace callback.\n**\n** ^The X callback is invoked whenever any of the events identified by\n** mask M occur. ^The integer return value from the callback is currently\n** ignored, though this may change in future releases. Callback\n** implementations should return zero to ensure future compatibility.\n**\n** ^A trace callback is invoked with four arguments: callback(T,C,P,X).\n** ^The T argument is one of the [SQLITE_TRACE]\n** constants to indicate why the callback was invoked.\n** ^The C argument is a copy of the context pointer.\n** The P and X arguments are pointers whose meanings depend on T.\n**\n** The sqlite3_trace_v2() interface is intended to replace the legacy\n** interfaces [sqlite3_trace()] and [sqlite3_profile()], both of which\n** are deprecated.\n*/\nSQLITE_API int sqlite3_trace_v2(\n sqlite3*,\n unsigned uMask,\n int(*xCallback)(unsigned,void*,void*,void*),\n void *pCtx\n);\n\n/*\n** CAPI3REF: Query Progress Callbacks\n** METHOD: sqlite3\n**\n** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback\n** function X to be invoked periodically during long running calls to\n** [sqlite3_step()] and [sqlite3_prepare()] and similar for\n** database connection D. An example use for this\n** interface is to keep a GUI updated during a large query.\n**\n** ^The parameter P is passed through as the only parameter to the\n** callback function X. ^The parameter N is the approximate number of\n** [virtual machine instructions] that are evaluated between successive\n** invocations of the callback X. ^If N is less than one then the progress\n** handler is disabled.\n**\n** ^Only a single progress handler may be defined at one time per\n** [database connection]; setting a new progress handler cancels the\n** old one. ^Setting parameter X to NULL disables the progress handler.\n** ^The progress handler is also disabled by setting N to a value less\n** than 1.\n**\n** ^If the progress callback returns non-zero, the operation is\n** interrupted. This feature can be used to implement a\n** \"Cancel\" button on a GUI progress dialog box.\n**\n** The progress handler callback must not do anything that will modify\n** the database connection that invoked the progress handler.\n** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their\n** database connections for the meaning of \"modify\" in this paragraph.\n**\n** The progress handler callback would originally only be invoked from the\n** bytecode engine. It still might be invoked during [sqlite3_prepare()]\n** and similar because those routines might force a reparse of the schema\n** which involves running the bytecode engine. However, beginning with\n** SQLite version 3.41.0, the progress handler callback might also be\n** invoked directly from [sqlite3_prepare()] while analyzing and generating\n** code for complex queries.\n*/\nSQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);\n\n/*\n** CAPI3REF: Opening A New Database Connection\n** CONSTRUCTOR: sqlite3\n**\n** ^These routines open an SQLite database file as specified by the\n** filename argument. ^The filename argument is interpreted as UTF-8 for\n** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte\n** order for sqlite3_open16(). ^(A [database connection] handle is usually\n** returned in *ppDb, even if an error occurs. The only exception is that\n** if SQLite is unable to allocate memory to hold the [sqlite3] object,\n** a NULL will be written into *ppDb instead of a pointer to the [sqlite3]\n** object.)^ ^(If the database is opened (and/or created) successfully, then\n** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The\n** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain\n** an English language description of the error following a failure of any\n** of the sqlite3_open() routines.\n**\n** ^The default encoding will be UTF-8 for databases created using\n** sqlite3_open() or sqlite3_open_v2(). ^The default encoding for databases\n** created using sqlite3_open16() will be UTF-16 in the native byte order.\n**\n** Whether or not an error occurs when it is opened, resources\n** associated with the [database connection] handle should be released by\n** passing it to [sqlite3_close()] when it is no longer required.\n**\n** The sqlite3_open_v2() interface works like sqlite3_open()\n** except that it accepts two additional parameters for additional control\n** over the new database connection. ^(The flags parameter to\n** sqlite3_open_v2() must include, at a minimum, one of the following\n** three flag combinations:)^\n**\n** <dl>\n** ^(<dt>[SQLITE_OPEN_READONLY]</dt>\n** <dd>The database is opened in read-only mode. If the database does\n** not already exist, an error is returned.</dd>)^\n**\n** ^(<dt>[SQLITE_OPEN_READWRITE]</dt>\n** <dd>The database is opened for reading and writing if possible, or\n** reading only if the file is write protected by the operating\n** system. In either case the database must already exist, otherwise\n** an error is returned. For historical reasons, if opening in\n** read-write mode fails due to OS-level permissions, an attempt is\n** made to open it in read-only mode. [sqlite3_db_readonly()] can be\n** used to determine whether the database is actually\n** read-write.</dd>)^\n**\n** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt>\n** <dd>The database is opened for reading and writing, and is created if\n** it does not already exist. This is the behavior that is always used for\n** sqlite3_open() and sqlite3_open16().</dd>)^\n** </dl>\n**\n** In addition to the required flags, the following optional flags are\n** also supported:\n**\n** <dl>\n** ^(<dt>[SQLITE_OPEN_URI]</dt>\n** <dd>The filename can be interpreted as a URI if this flag is set.</dd>)^\n**\n** ^(<dt>[SQLITE_OPEN_MEMORY]</dt>\n** <dd>The database will be opened as an in-memory database. The database\n** is named by the \"filename\" argument for the purposes of cache-sharing,\n** if shared cache mode is enabled, but the \"filename\" is otherwise ignored.\n** </dd>)^\n**\n** ^(<dt>[SQLITE_OPEN_NOMUTEX]</dt>\n** <dd>The new database connection will use the \"multi-thread\"\n** [threading mode].)^ This means that separate threads are allowed\n** to use SQLite at the same time, as long as each thread is using\n** a different [database connection].\n**\n** ^(<dt>[SQLITE_OPEN_FULLMUTEX]</dt>\n** <dd>The new database connection will use the \"serialized\"\n** [threading mode].)^ This means the multiple threads can safely\n** attempt to use the same database connection at the same time.\n** (Mutexes will block any actual concurrency, but in this mode\n** there is no harm in trying.)\n**\n** ^(<dt>[SQLITE_OPEN_SHAREDCACHE]</dt>\n** <dd>The database is opened [shared cache] enabled, overriding\n** the default shared cache setting provided by\n** [sqlite3_enable_shared_cache()].)^\n** The [use of shared cache mode is discouraged] and hence shared cache\n** capabilities may be omitted from many builds of SQLite. In such cases,\n** this option is a no-op.\n**\n** ^(<dt>[SQLITE_OPEN_PRIVATECACHE]</dt>\n** <dd>The database is opened [shared cache] disabled, overriding\n** the default shared cache setting provided by\n** [sqlite3_enable_shared_cache()].)^\n**\n** [[OPEN_EXRESCODE]] ^(<dt>[SQLITE_OPEN_EXRESCODE]</dt>\n** <dd>The database connection comes up in \"extended result code mode\".\n** In other words, the database behaves as if\n** [sqlite3_extended_result_codes(db,1)] were called on the database\n** connection as soon as the connection is created. In addition to setting\n** the extended result code mode, this flag also causes [sqlite3_open_v2()]\n** to return an extended result code.</dd>\n**\n** [[OPEN_NOFOLLOW]] ^(<dt>[SQLITE_OPEN_NOFOLLOW]</dt>\n** <dd>The database filename is not allowed to contain a symbolic link</dd>\n** </dl>)^\n**\n** If the 3rd parameter to sqlite3_open_v2() is not one of the\n** required combinations shown above optionally combined with other\n** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits]\n** then the behavior is undefined. Historic versions of SQLite\n** have silently ignored surplus bits in the flags parameter to\n** sqlite3_open_v2(), however that behavior might not be carried through\n** into future versions of SQLite and so applications should not rely\n** upon it. Note in particular that the SQLITE_OPEN_EXCLUSIVE flag is a no-op\n** for sqlite3_open_v2(). The SQLITE_OPEN_EXCLUSIVE does *not* cause\n** the open to fail if the database already exists. The SQLITE_OPEN_EXCLUSIVE\n** flag is intended for use by the [sqlite3_vfs|VFS interface] only, and not\n** by sqlite3_open_v2().\n**\n** ^The fourth parameter to sqlite3_open_v2() is the name of the\n** [sqlite3_vfs] object that defines the operating system interface that\n** the new database connection should use. ^If the fourth parameter is\n** a NULL pointer then the default [sqlite3_vfs] object is used.\n**\n** ^If the filename is \":memory:\", then a private, temporary in-memory database\n** is created for the connection. ^This in-memory database will vanish when\n** the database connection is closed. Future versions of SQLite might\n** make use of additional special filenames that begin with the \":\" character.\n** It is recommended that when a database filename actually does begin with\n** a \":\" character you should prefix the filename with a pathname such as\n** \"./\" to avoid ambiguity.\n**\n** ^If the filename is an empty string, then a private, temporary\n** on-disk database will be created. ^This private database will be\n** automatically deleted as soon as the database connection is closed.\n**\n** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3>\n**\n** ^If [URI filename] interpretation is enabled, and the filename argument\n** begins with \"file:\", then the filename is interpreted as a URI. ^URI\n** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is\n** set in the third argument to sqlite3_open_v2(), or if it has\n** been enabled globally using the [SQLITE_CONFIG_URI] option with the\n** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option.\n** URI filename interpretation is turned off\n** by default, but future releases of SQLite might enable URI filename\n** interpretation by default. See \"[URI filenames]\" for additional\n** information.\n**\n** URI filenames are parsed according to RFC 3986. ^If the URI contains an\n** authority, then it must be either an empty string or the string\n** \"localhost\". ^If the authority is not an empty string or \"localhost\", an\n** error is returned to the caller. ^The fragment component of a URI, if\n** present, is ignored.\n**\n** ^SQLite uses the path component of the URI as the name of the disk file\n** which contains the database. ^If the path begins with a '/' character,\n** then it is interpreted as an absolute path. ^If the path does not begin\n** with a '/' (meaning that the authority section is omitted from the URI)\n** then the path is interpreted as a relative path.\n** ^(On windows, the first component of an absolute path\n** is a drive specification (e.g. \"C:\").)^\n**\n** [[core URI query parameters]]\n** The query component of a URI may contain parameters that are interpreted\n** either by SQLite itself, or by a [VFS | custom VFS implementation].\n** SQLite and its built-in [VFSes] interpret the\n** following query parameters:\n**\n** <ul>\n** <li> <b>vfs</b>: ^The \"vfs\" parameter may be used to specify the name of\n** a VFS object that provides the operating system interface that should\n** be used to access the database file on disk. ^If this option is set to\n** an empty string the default VFS object is used. ^Specifying an unknown\n** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is\n** present, then the VFS specified by the option takes precedence over\n** the value passed as the fourth parameter to sqlite3_open_v2().\n**\n** <li> <b>mode</b>: ^(The mode parameter may be set to either \"ro\", \"rw\",\n** \"rwc\", or \"memory\". Attempting to set it to any other value is\n** an error)^.\n** ^If \"ro\" is specified, then the database is opened for read-only\n** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the\n** third argument to sqlite3_open_v2(). ^If the mode option is set to\n** \"rw\", then the database is opened for read-write (but not create)\n** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had\n** been set. ^Value \"rwc\" is equivalent to setting both\n** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is\n** set to \"memory\" then a pure [in-memory database] that never reads\n** or writes from disk is used. ^It is an error to specify a value for\n** the mode parameter that is less restrictive than that specified by\n** the flags passed in the third parameter to sqlite3_open_v2().\n**\n** <li> <b>cache</b>: ^The cache parameter may be set to either \"shared\" or\n** \"private\". ^Setting it to \"shared\" is equivalent to setting the\n** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to\n** sqlite3_open_v2(). ^Setting the cache parameter to \"private\" is\n** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit.\n** ^If sqlite3_open_v2() is used and the \"cache\" parameter is present in\n** a URI filename, its value overrides any behavior requested by setting\n** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag.\n**\n** <li> <b>psow</b>: ^The psow parameter indicates whether or not the\n** [powersafe overwrite] property does or does not apply to the\n** storage media on which the database file resides.\n**\n** <li> <b>nolock</b>: ^The nolock parameter is a boolean query parameter\n** which if set disables file locking in rollback journal modes. This\n** is useful for accessing a database on a filesystem that does not\n** support locking. Caution: Database corruption might result if two\n** or more processes write to the same database and any one of those\n** processes uses nolock=1.\n**\n** <li> <b>immutable</b>: ^The immutable parameter is a boolean query\n** parameter that indicates that the database file is stored on\n** read-only media. ^When immutable is set, SQLite assumes that the\n** database file cannot be changed, even by a process with higher\n** privilege, and so the database is opened read-only and all locking\n** and change detection is disabled. Caution: Setting the immutable\n** property on a database file that does in fact change can result\n** in incorrect query results and/or [SQLITE_CORRUPT] errors.\n** See also: [SQLITE_IOCAP_IMMUTABLE].\n**\n** </ul>\n**\n** ^Specifying an unknown parameter in the query component of a URI is not an\n** error. Future versions of SQLite might understand additional query\n** parameters. See \"[query parameters with special meaning to SQLite]\" for\n** additional information.\n**\n** [[URI filename examples]] <h3>URI filename examples</h3>\n**\n** <table border=\"1\" align=center cellpadding=5>\n** <tr><th> URI filenames <th> Results\n** <tr><td> file:data.db <td>\n** Open the file \"data.db\" in the current directory.\n** <tr><td> file:/home/fred/data.db<br>\n** file:///home/fred/data.db <br>\n** file://localhost/home/fred/data.db <br> <td>\n** Open the database file \"/home/fred/data.db\".\n** <tr><td> file://darkstar/home/fred/data.db <td>\n** An error. \"darkstar\" is not a recognized authority.\n** <tr><td style=\"white-space:nowrap\">\n** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db\n** <td> Windows only: Open the file \"data.db\" on fred's desktop on drive\n** C:. Note that the %20 escaping in this example is not strictly\n** necessary - space characters can be used literally\n** in URI filenames.\n** <tr><td> file:data.db?mode=ro&cache=private <td>\n** Open file \"data.db\" in the current directory for read-only access.\n** Regardless of whether or not shared-cache mode is enabled by\n** default, use a private cache.\n** <tr><td> file:/home/fred/data.db?vfs=unix-dotfile <td>\n** Open file \"/home/fred/data.db\". Use the special VFS \"unix-dotfile\"\n** that uses dot-files in place of posix advisory locking.\n** <tr><td> file:data.db?mode=readonly <td>\n** An error. \"readonly\" is not a valid option for the \"mode\" parameter.\n** Use \"ro\" instead: \"file:data.db?mode=ro\".\n** </table>\n**\n** ^URI hexadecimal escape sequences (%HH) are supported within the path and\n** query components of a URI. A hexadecimal escape sequence consists of a\n** percent sign - \"%\" - followed by exactly two hexadecimal digits\n** specifying an octet value. ^Before the path or query components of a\n** URI filename are interpreted, they are encoded using UTF-8 and all\n** hexadecimal escape sequences replaced by a single byte containing the\n** corresponding octet. If this process generates an invalid UTF-8 encoding,\n** the results are undefined.\n**\n** <b>Note to Windows users:</b> The encoding used for the filename argument\n** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever\n** codepage is currently defined. Filenames containing international\n** characters must be converted to UTF-8 prior to passing them into\n** sqlite3_open() or sqlite3_open_v2().\n**\n** <b>Note to Windows Runtime users:</b> The temporary directory must be set\n** prior to calling sqlite3_open() or sqlite3_open_v2(). Otherwise, various\n** features that require the use of temporary files may fail.\n**\n** See also: [sqlite3_temp_directory]\n*/\nSQLITE_API int sqlite3_open(\n const char *filename, /* Database filename (UTF-8) */\n sqlite3 **ppDb /* OUT: SQLite db handle */\n);\nSQLITE_API int sqlite3_open16(\n const void *filename, /* Database filename (UTF-16) */\n sqlite3 **ppDb /* OUT: SQLite db handle */\n);\nSQLITE_API int sqlite3_open_v2(\n const char *filename, /* Database filename (UTF-8) */\n sqlite3 **ppDb, /* OUT: SQLite db handle */\n int flags, /* Flags */\n const char *zVfs /* Name of VFS module to use */\n);\n\n/*\n** CAPI3REF: Obtain Values For URI Parameters\n**\n** These are utility routines, useful to [VFS|custom VFS implementations],\n** that check if a database file was a URI that contained a specific query\n** parameter, and if so obtains the value of that query parameter.\n**\n** The first parameter to these interfaces (hereafter referred to\n** as F) must be one of:\n** <ul>\n** <li> A database filename pointer created by the SQLite core and\n** passed into the xOpen() method of a VFS implementation, or\n** <li> A filename obtained from [sqlite3_db_filename()], or\n** <li> A new filename constructed using [sqlite3_create_filename()].\n** </ul>\n** If the F parameter is not one of the above, then the behavior is\n** undefined and probably undesirable. Older versions of SQLite were\n** more tolerant of invalid F parameters than newer versions.\n**\n** If F is a suitable filename (as described in the previous paragraph)\n** and if P is the name of the query parameter, then\n** sqlite3_uri_parameter(F,P) returns the value of the P\n** parameter if it exists or a NULL pointer if P does not appear as a\n** query parameter on F. If P is a query parameter of F and it\n** has no explicit value, then sqlite3_uri_parameter(F,P) returns\n** a pointer to an empty string.\n**\n** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean\n** parameter and returns true (1) or false (0) according to the value\n** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the\n** value of query parameter P is one of \"yes\", \"true\", or \"on\" in any\n** case or if the value begins with a non-zero number. The\n** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of\n** query parameter P is one of \"no\", \"false\", or \"off\" in any case or\n** if the value begins with a numeric zero. If P is not a query\n** parameter on F or if the value of P does not match any of the\n** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0).\n**\n** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a\n** 64-bit signed integer and returns that integer, or D if P does not\n** exist. If the value of P is something other than an integer, then\n** zero is returned.\n**\n** The sqlite3_uri_key(F,N) returns a pointer to the name (not\n** the value) of the N-th query parameter for filename F, or a NULL\n** pointer if N is less than zero or greater than the number of query\n** parameters minus 1. The N value is zero-based so N should be 0 to obtain\n** the name of the first query parameter, 1 for the second parameter, and\n** so forth.\n**\n** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and\n** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and\n** is not a database file pathname pointer that the SQLite core passed\n** into the xOpen VFS method, then the behavior of this routine is undefined\n** and probably undesirable.\n**\n** Beginning with SQLite [version 3.31.0] ([dateof:3.31.0]) the input F\n** parameter can also be the name of a rollback journal file or WAL file\n** in addition to the main database file. Prior to version 3.31.0, these\n** routines would only work if F was the name of the main database file.\n** When the F parameter is the name of the rollback journal or WAL file,\n** it has access to all the same query parameters as were found on the\n** main database file.\n**\n** See the [URI filename] documentation for additional information.\n*/\nSQLITE_API const char *sqlite3_uri_parameter(sqlite3_filename z, const char *zParam);\nSQLITE_API int sqlite3_uri_boolean(sqlite3_filename z, const char *zParam, int bDefault);\nSQLITE_API sqlite3_int64 sqlite3_uri_int64(sqlite3_filename, const char*, sqlite3_int64);\nSQLITE_API const char *sqlite3_uri_key(sqlite3_filename z, int N);\n\n/*\n** CAPI3REF: Translate filenames\n**\n** These routines are available to [VFS|custom VFS implementations] for\n** translating filenames between the main database file, the journal file,\n** and the WAL file.\n**\n** If F is the name of an sqlite database file, journal file, or WAL file\n** passed by the SQLite core into the VFS, then sqlite3_filename_database(F)\n** returns the name of the corresponding database file.\n**\n** If F is the name of an sqlite database file, journal file, or WAL file\n** passed by the SQLite core into the VFS, or if F is a database filename\n** obtained from [sqlite3_db_filename()], then sqlite3_filename_journal(F)\n** returns the name of the corresponding rollback journal file.\n**\n** If F is the name of an sqlite database file, journal file, or WAL file\n** that was passed by the SQLite core into the VFS, or if F is a database\n** filename obtained from [sqlite3_db_filename()], then\n** sqlite3_filename_wal(F) returns the name of the corresponding\n** WAL file.\n**\n** In all of the above, if F is not the name of a database, journal or WAL\n** filename passed into the VFS from the SQLite core and F is not the\n** return value from [sqlite3_db_filename()], then the result is\n** undefined and is likely a memory access violation.\n*/\nSQLITE_API const char *sqlite3_filename_database(sqlite3_filename);\nSQLITE_API const char *sqlite3_filename_journal(sqlite3_filename);\nSQLITE_API const char *sqlite3_filename_wal(sqlite3_filename);\n\n/*\n** CAPI3REF: Database File Corresponding To A Journal\n**\n** ^If X is the name of a rollback or WAL-mode journal file that is\n** passed into the xOpen method of [sqlite3_vfs], then\n** sqlite3_database_file_object(X) returns a pointer to the [sqlite3_file]\n** object that represents the main database file.\n**\n** This routine is intended for use in custom [VFS] implementations\n** only. It is not a general-purpose interface.\n** The argument sqlite3_file_object(X) must be a filename pointer that\n** has been passed into [sqlite3_vfs].xOpen method where the\n** flags parameter to xOpen contains one of the bits\n** [SQLITE_OPEN_MAIN_JOURNAL] or [SQLITE_OPEN_WAL]. Any other use\n** of this routine results in undefined and probably undesirable\n** behavior.\n*/\nSQLITE_API sqlite3_file *sqlite3_database_file_object(const char*);\n\n/*\n** CAPI3REF: Create and Destroy VFS Filenames\n**\n** These interfaces are provided for use by [VFS shim] implementations and\n** are not useful outside of that context.\n**\n** The sqlite3_create_filename(D,J,W,N,P) allocates memory to hold a version of\n** database filename D with corresponding journal file J and WAL file W and\n** with N URI parameters key/values pairs in the array P. The result from\n** sqlite3_create_filename(D,J,W,N,P) is a pointer to a database filename that\n** is safe to pass to routines like:\n** <ul>\n** <li> [sqlite3_uri_parameter()],\n** <li> [sqlite3_uri_boolean()],\n** <li> [sqlite3_uri_int64()],\n** <li> [sqlite3_uri_key()],\n** <li> [sqlite3_filename_database()],\n** <li> [sqlite3_filename_journal()], or\n** <li> [sqlite3_filename_wal()].\n** </ul>\n** If a memory allocation error occurs, sqlite3_create_filename() might\n** return a NULL pointer. The memory obtained from sqlite3_create_filename(X)\n** must be released by a corresponding call to sqlite3_free_filename(Y).\n**\n** The P parameter in sqlite3_create_filename(D,J,W,N,P) should be an array\n** of 2*N pointers to strings. Each pair of pointers in this array corresponds\n** to a key and value for a query parameter. The P parameter may be a NULL\n** pointer if N is zero. None of the 2*N pointers in the P array may be\n** NULL pointers and key pointers should not be empty strings.\n** None of the D, J, or W parameters to sqlite3_create_filename(D,J,W,N,P) may\n** be NULL pointers, though they can be empty strings.\n**\n** The sqlite3_free_filename(Y) routine releases a memory allocation\n** previously obtained from sqlite3_create_filename(). Invoking\n** sqlite3_free_filename(Y) where Y is a NULL pointer is a harmless no-op.\n**\n** If the Y parameter to sqlite3_free_filename(Y) is anything other\n** than a NULL pointer or a pointer previously acquired from\n** sqlite3_create_filename(), then bad things such as heap\n** corruption or segfaults may occur. The value Y should not be\n** used again after sqlite3_free_filename(Y) has been called. This means\n** that if the [sqlite3_vfs.xOpen()] method of a VFS has been called using Y,\n** then the corresponding [sqlite3_module.xClose() method should also be\n** invoked prior to calling sqlite3_free_filename(Y).\n*/\nSQLITE_API sqlite3_filename sqlite3_create_filename(\n const char *zDatabase,\n const char *zJournal,\n const char *zWal,\n int nParam,\n const char **azParam\n);\nSQLITE_API void sqlite3_free_filename(sqlite3_filename);\n\n/*\n** CAPI3REF: Error Codes And Messages\n** METHOD: sqlite3\n**\n** ^If the most recent sqlite3_* API call associated with\n** [database connection] D failed, then the sqlite3_errcode(D) interface\n** returns the numeric [result code] or [extended result code] for that\n** API call.\n** ^The sqlite3_extended_errcode()\n** interface is the same except that it always returns the\n** [extended result code] even when extended result codes are\n** disabled.\n**\n** The values returned by sqlite3_errcode() and/or\n** sqlite3_extended_errcode() might change with each API call.\n** Except, there are some interfaces that are guaranteed to never\n** change the value of the error code. The error-code preserving\n** interfaces include the following:\n**\n** <ul>\n** <li> sqlite3_errcode()\n** <li> sqlite3_extended_errcode()\n** <li> sqlite3_errmsg()\n** <li> sqlite3_errmsg16()\n** <li> sqlite3_error_offset()\n** </ul>\n**\n** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language\n** text that describes the error, as either UTF-8 or UTF-16 respectively,\n** or NULL if no error message is available.\n** (See how SQLite handles [invalid UTF] for exceptions to this rule.)\n** ^(Memory to hold the error message string is managed internally.\n** The application does not need to worry about freeing the result.\n** However, the error string might be overwritten or deallocated by\n** subsequent calls to other SQLite interface functions.)^\n**\n** ^The sqlite3_errstr(E) interface returns the English-language text\n** that describes the [result code] E, as UTF-8, or NULL if E is not an\n** result code for which a text error message is available.\n** ^(Memory to hold the error message string is managed internally\n** and must not be freed by the application)^.\n**\n** ^If the most recent error references a specific token in the input\n** SQL, the sqlite3_error_offset() interface returns the byte offset\n** of the start of that token. ^The byte offset returned by\n** sqlite3_error_offset() assumes that the input SQL is UTF8.\n** ^If the most recent error does not reference a specific token in the input\n** SQL, then the sqlite3_error_offset() function returns -1.\n**\n** When the serialized [threading mode] is in use, it might be the\n** case that a second error occurs on a separate thread in between\n** the time of the first error and the call to these interfaces.\n** When that happens, the second error will be reported since these\n** interfaces always report the most recent result. To avoid\n** this, each thread can obtain exclusive use of the [database connection] D\n** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning\n** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after\n** all calls to the interfaces listed here are completed.\n**\n** If an interface fails with SQLITE_MISUSE, that means the interface\n** was invoked incorrectly by the application. In that case, the\n** error code and message may or may not be set.\n*/\nSQLITE_API int sqlite3_errcode(sqlite3 *db);\nSQLITE_API int sqlite3_extended_errcode(sqlite3 *db);\nSQLITE_API const char *sqlite3_errmsg(sqlite3*);\nSQLITE_API const void *sqlite3_errmsg16(sqlite3*);\nSQLITE_API const char *sqlite3_errstr(int);\nSQLITE_API int sqlite3_error_offset(sqlite3 *db);\n\n/*\n** CAPI3REF: Prepared Statement Object\n** KEYWORDS: {prepared statement} {prepared statements}\n**\n** An instance of this object represents a single SQL statement that\n** has been compiled into binary form and is ready to be evaluated.\n**\n** Think of each SQL statement as a separate computer program. The\n** original SQL text is source code. A prepared statement object\n** is the compiled object code. All SQL must be converted into a\n** prepared statement before it can be run.\n**\n** The life-cycle of a prepared statement object usually goes like this:\n**\n** <ol>\n** <li> Create the prepared statement object using [sqlite3_prepare_v2()].\n** <li> Bind values to [parameters] using the sqlite3_bind_*()\n** interfaces.\n** <li> Run the SQL by calling [sqlite3_step()] one or more times.\n** <li> Reset the prepared statement using [sqlite3_reset()] then go back\n** to step 2. Do this zero or more times.\n** <li> Destroy the object using [sqlite3_finalize()].\n** </ol>\n*/\ntypedef struct sqlite3_stmt sqlite3_stmt;\n\n/*\n** CAPI3REF: Run-time Limits\n** METHOD: sqlite3\n**\n** ^(This interface allows the size of various constructs to be limited\n** on a connection by connection basis. The first parameter is the\n** [database connection] whose limit is to be set or queried. The\n** second parameter is one of the [limit categories] that define a\n** class of constructs to be size limited. The third parameter is the\n** new limit for that construct.)^\n**\n** ^If the new limit is a negative number, the limit is unchanged.\n** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a\n** [limits | hard upper bound]\n** set at compile-time by a C preprocessor macro called\n** [limits | SQLITE_MAX_<i>NAME</i>].\n** (The \"_LIMIT_\" in the name is changed to \"_MAX_\".))^\n** ^Attempts to increase a limit above its hard upper bound are\n** silently truncated to the hard upper bound.\n**\n** ^Regardless of whether or not the limit was changed, the\n** [sqlite3_limit()] interface returns the prior value of the limit.\n** ^Hence, to find the current value of a limit without changing it,\n** simply invoke this interface with the third parameter set to -1.\n**\n** Run-time limits are intended for use in applications that manage\n** both their own internal database and also databases that are controlled\n** by untrusted external sources. An example application might be a\n** web browser that has its own databases for storing history and\n** separate databases controlled by JavaScript applications downloaded\n** off the Internet. The internal databases can be given the\n** large, default limits. Databases managed by external sources can\n** be given much smaller limits designed to prevent a denial of service\n** attack. Developers might also want to use the [sqlite3_set_authorizer()]\n** interface to further control untrusted SQL. The size of the database\n** created by an untrusted script can be contained using the\n** [max_page_count] [PRAGMA].\n**\n** New run-time limit categories may be added in future releases.\n*/\nSQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal);\n\n/*\n** CAPI3REF: Run-Time Limit Categories\n** KEYWORDS: {limit category} {*limit categories}\n**\n** These constants define various performance limits\n** that can be lowered at run-time using [sqlite3_limit()].\n** The synopsis of the meanings of the various limits is shown below.\n** Additional information is available at [limits | Limits in SQLite].\n**\n** <dl>\n** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt>\n** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^\n**\n** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt>\n** <dd>The maximum length of an SQL statement, in bytes.</dd>)^\n**\n** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt>\n** <dd>The maximum number of columns in a table definition or in the\n** result set of a [SELECT] or the maximum number of columns in an index\n** or in an ORDER BY or GROUP BY clause.</dd>)^\n**\n** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt>\n** <dd>The maximum depth of the parse tree on any expression.</dd>)^\n**\n** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt>\n** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^\n**\n** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt>\n** <dd>The maximum number of instructions in a virtual machine program\n** used to implement an SQL statement. If [sqlite3_prepare_v2()] or\n** the equivalent tries to allocate space for more than this many opcodes\n** in a single prepared statement, an SQLITE_NOMEM error is returned.</dd>)^\n**\n** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt>\n** <dd>The maximum number of arguments on a function.</dd>)^\n**\n** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt>\n** <dd>The maximum number of [ATTACH | attached databases].)^</dd>\n**\n** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]]\n** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt>\n** <dd>The maximum length of the pattern argument to the [LIKE] or\n** [GLOB] operators.</dd>)^\n**\n** [[SQLITE_LIMIT_VARIABLE_NUMBER]]\n** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt>\n** <dd>The maximum index number of any [parameter] in an SQL statement.)^\n**\n** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt>\n** <dd>The maximum depth of recursion for triggers.</dd>)^\n**\n** [[SQLITE_LIMIT_WORKER_THREADS]] ^(<dt>SQLITE_LIMIT_WORKER_THREADS</dt>\n** <dd>The maximum number of auxiliary worker threads that a single\n** [prepared statement] may start.</dd>)^\n** </dl>\n*/\n#define SQLITE_LIMIT_LENGTH 0\n#define SQLITE_LIMIT_SQL_LENGTH 1\n#define SQLITE_LIMIT_COLUMN 2\n#define SQLITE_LIMIT_EXPR_DEPTH 3\n#define SQLITE_LIMIT_COMPOUND_SELECT 4\n#define SQLITE_LIMIT_VDBE_OP 5\n#define SQLITE_LIMIT_FUNCTION_ARG 6\n#define SQLITE_LIMIT_ATTACHED 7\n#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8\n#define SQLITE_LIMIT_VARIABLE_NUMBER 9\n#define SQLITE_LIMIT_TRIGGER_DEPTH 10\n#define SQLITE_LIMIT_WORKER_THREADS 11\n\n/*\n** CAPI3REF: Prepare Flags\n**\n** These constants define various flags that can be passed into\n** \"prepFlags\" parameter of the [sqlite3_prepare_v3()] and\n** [sqlite3_prepare16_v3()] interfaces.\n**\n** New flags may be added in future releases of SQLite.\n**\n** <dl>\n** [[SQLITE_PREPARE_PERSISTENT]] ^(<dt>SQLITE_PREPARE_PERSISTENT</dt>\n** <dd>The SQLITE_PREPARE_PERSISTENT flag is a hint to the query planner\n** that the prepared statement will be retained for a long time and\n** probably reused many times.)^ ^Without this flag, [sqlite3_prepare_v3()]\n** and [sqlite3_prepare16_v3()] assume that the prepared statement will\n** be used just once or at most a few times and then destroyed using\n** [sqlite3_finalize()] relatively soon. The current implementation acts\n** on this hint by avoiding the use of [lookaside memory] so as not to\n** deplete the limited store of lookaside memory. Future versions of\n** SQLite may act on this hint differently.\n**\n** [[SQLITE_PREPARE_NORMALIZE]] <dt>SQLITE_PREPARE_NORMALIZE</dt>\n** <dd>The SQLITE_PREPARE_NORMALIZE flag is a no-op. This flag used\n** to be required for any prepared statement that wanted to use the\n** [sqlite3_normalized_sql()] interface. However, the\n** [sqlite3_normalized_sql()] interface is now available to all\n** prepared statements, regardless of whether or not they use this\n** flag.\n**\n** [[SQLITE_PREPARE_NO_VTAB]] <dt>SQLITE_PREPARE_NO_VTAB</dt>\n** <dd>The SQLITE_PREPARE_NO_VTAB flag causes the SQL compiler\n** to return an error (error code SQLITE_ERROR) if the statement uses\n** any virtual tables.\n**\n** [[SQLITE_PREPARE_DONT_LOG]] <dt>SQLITE_PREPARE_DONT_LOG</dt>\n** <dd>The SQLITE_PREPARE_DONT_LOG flag prevents SQL compiler\n** errors from being sent to the error log defined by\n** [SQLITE_CONFIG_LOG]. This can be used, for example, to do test\n** compiles to see if some SQL syntax is well-formed, without generating\n** messages on the global error log when it is not. If the test compile\n** fails, the sqlite3_prepare_v3() call returns the same error indications\n** with or without this flag; it just omits the call to [sqlite3_log()] that\n** logs the error.\n** </dl>\n*/\n#define SQLITE_PREPARE_PERSISTENT 0x01\n#define SQLITE_PREPARE_NORMALIZE 0x02\n#define SQLITE_PREPARE_NO_VTAB 0x04\n#define SQLITE_PREPARE_DONT_LOG 0x10\n\n/*\n** CAPI3REF: Compiling An SQL Statement\n** KEYWORDS: {SQL statement compiler}\n** METHOD: sqlite3\n** CONSTRUCTOR: sqlite3_stmt\n**\n** To execute an SQL statement, it must first be compiled into a byte-code\n** program using one of these routines. Or, in other words, these routines\n** are constructors for the [prepared statement] object.\n**\n** The preferred routine to use is [sqlite3_prepare_v2()]. The\n** [sqlite3_prepare()] interface is legacy and should be avoided.\n** [sqlite3_prepare_v3()] has an extra \"prepFlags\" option that is used\n** for special purposes.\n**\n** The use of the UTF-8 interfaces is preferred, as SQLite currently\n** does all parsing using UTF-8. The UTF-16 interfaces are provided\n** as a convenience. The UTF-16 interfaces work by converting the\n** input text into UTF-8, then invoking the corresponding UTF-8 interface.\n**\n** The first argument, \"db\", is a [database connection] obtained from a\n** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or\n** [sqlite3_open16()]. The database connection must not have been closed.\n**\n** The second argument, \"zSql\", is the statement to be compiled, encoded\n** as either UTF-8 or UTF-16. The sqlite3_prepare(), sqlite3_prepare_v2(),\n** and sqlite3_prepare_v3()\n** interfaces use UTF-8, and sqlite3_prepare16(), sqlite3_prepare16_v2(),\n** and sqlite3_prepare16_v3() use UTF-16.\n**\n** ^If the nByte argument is negative, then zSql is read up to the\n** first zero terminator. ^If nByte is positive, then it is the maximum\n** number of bytes read from zSql. When nByte is positive, zSql is read\n** up to the first zero terminator or until the nByte bytes have been read,\n** whichever comes first. ^If nByte is zero, then no prepared\n** statement is generated.\n** If the caller knows that the supplied string is nul-terminated, then\n** there is a small performance advantage to passing an nByte parameter that\n** is the number of bytes in the input string <i>including</i>\n** the nul-terminator.\n** Note that nByte measure the length of the input in bytes, not\n** characters, even for the UTF-16 interfaces.\n**\n** ^If pzTail is not NULL then *pzTail is made to point to the first byte\n** past the end of the first SQL statement in zSql. These routines only\n** compile the first statement in zSql, so *pzTail is left pointing to\n** what remains uncompiled.\n**\n** ^*ppStmt is left pointing to a compiled [prepared statement] that can be\n** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set\n** to NULL. ^If the input text contains no SQL (if the input is an empty\n** string or a comment) then *ppStmt is set to NULL.\n** The calling procedure is responsible for deleting the compiled\n** SQL statement using [sqlite3_finalize()] after it has finished with it.\n** ppStmt may not be NULL.\n**\n** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK];\n** otherwise an [error code] is returned.\n**\n** The sqlite3_prepare_v2(), sqlite3_prepare_v3(), sqlite3_prepare16_v2(),\n** and sqlite3_prepare16_v3() interfaces are recommended for all new programs.\n** The older interfaces (sqlite3_prepare() and sqlite3_prepare16())\n** are retained for backwards compatibility, but their use is discouraged.\n** ^In the \"vX\" interfaces, the prepared statement\n** that is returned (the [sqlite3_stmt] object) contains a copy of the\n** original SQL text. This causes the [sqlite3_step()] interface to\n** behave differently in three ways:\n**\n** <ol>\n** <li>\n** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it\n** always used to do, [sqlite3_step()] will automatically recompile the SQL\n** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY]\n** retries will occur before sqlite3_step() gives up and returns an error.\n** </li>\n**\n** <li>\n** ^When an error occurs, [sqlite3_step()] will return one of the detailed\n** [error codes] or [extended error codes]. ^The legacy behavior was that\n** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code\n** and the application would have to make a second call to [sqlite3_reset()]\n** in order to find the underlying cause of the problem. With the \"v2\" prepare\n** interfaces, the underlying reason for the error is returned immediately.\n** </li>\n**\n** <li>\n** ^If the specific value bound to a [parameter | host parameter] in the\n** WHERE clause might influence the choice of query plan for a statement,\n** then the statement will be automatically recompiled, as if there had been\n** a schema change, on the first [sqlite3_step()] call following any change\n** to the [sqlite3_bind_text | bindings] of that [parameter].\n** ^The specific value of a WHERE-clause [parameter] might influence the\n** choice of query plan if the parameter is the left-hand side of a [LIKE]\n** or [GLOB] operator or if the parameter is compared to an indexed column\n** and the [SQLITE_ENABLE_STAT4] compile-time option is enabled.\n** </li>\n** </ol>\n**\n** <p>^sqlite3_prepare_v3() differs from sqlite3_prepare_v2() only in having\n** the extra prepFlags parameter, which is a bit array consisting of zero or\n** more of the [SQLITE_PREPARE_PERSISTENT|SQLITE_PREPARE_*] flags. ^The\n** sqlite3_prepare_v2() interface works exactly the same as\n** sqlite3_prepare_v3() with a zero prepFlags parameter.\n*/\nSQLITE_API int sqlite3_prepare(\n sqlite3 *db, /* Database handle */\n const char *zSql, /* SQL statement, UTF-8 encoded */\n int nByte, /* Maximum length of zSql in bytes. */\n sqlite3_stmt **ppStmt, /* OUT: Statement handle */\n const char **pzTail /* OUT: Pointer to unused portion of zSql */\n);\nSQLITE_API int sqlite3_prepare_v2(\n sqlite3 *db, /* Database handle */\n const char *zSql, /* SQL statement, UTF-8 encoded */\n int nByte, /* Maximum length of zSql in bytes. */\n sqlite3_stmt **ppStmt, /* OUT: Statement handle */\n const char **pzTail /* OUT: Pointer to unused portion of zSql */\n);\nSQLITE_API int sqlite3_prepare_v3(\n sqlite3 *db, /* Database handle */\n const char *zSql, /* SQL statement, UTF-8 encoded */\n int nByte, /* Maximum length of zSql in bytes. */\n unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */\n sqlite3_stmt **ppStmt, /* OUT: Statement handle */\n const char **pzTail /* OUT: Pointer to unused portion of zSql */\n);\nSQLITE_API int sqlite3_prepare16(\n sqlite3 *db, /* Database handle */\n const void *zSql, /* SQL statement, UTF-16 encoded */\n int nByte, /* Maximum length of zSql in bytes. */\n sqlite3_stmt **ppStmt, /* OUT: Statement handle */\n const void **pzTail /* OUT: Pointer to unused portion of zSql */\n);\nSQLITE_API int sqlite3_prepare16_v2(\n sqlite3 *db, /* Database handle */\n const void *zSql, /* SQL statement, UTF-16 encoded */\n int nByte, /* Maximum length of zSql in bytes. */\n sqlite3_stmt **ppStmt, /* OUT: Statement handle */\n const void **pzTail /* OUT: Pointer to unused portion of zSql */\n);\nSQLITE_API int sqlite3_prepare16_v3(\n sqlite3 *db, /* Database handle */\n const void *zSql, /* SQL statement, UTF-16 encoded */\n int nByte, /* Maximum length of zSql in bytes. */\n unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */\n sqlite3_stmt **ppStmt, /* OUT: Statement handle */\n const void **pzTail /* OUT: Pointer to unused portion of zSql */\n);\n\n/*\n** CAPI3REF: Retrieving Statement SQL\n** METHOD: sqlite3_stmt\n**\n** ^The sqlite3_sql(P) interface returns a pointer to a copy of the UTF-8\n** SQL text used to create [prepared statement] P if P was\n** created by [sqlite3_prepare_v2()], [sqlite3_prepare_v3()],\n** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()].\n** ^The sqlite3_expanded_sql(P) interface returns a pointer to a UTF-8\n** string containing the SQL text of prepared statement P with\n** [bound parameters] expanded.\n** ^The sqlite3_normalized_sql(P) interface returns a pointer to a UTF-8\n** string containing the normalized SQL text of prepared statement P. The\n** semantics used to normalize a SQL statement are unspecified and subject\n** to change. At a minimum, literal values will be replaced with suitable\n** placeholders.\n**\n** ^(For example, if a prepared statement is created using the SQL\n** text \"SELECT $abc,:xyz\" and if parameter $abc is bound to integer 2345\n** and parameter :xyz is unbound, then sqlite3_sql() will return\n** the original string, \"SELECT $abc,:xyz\" but sqlite3_expanded_sql()\n** will return \"SELECT 2345,NULL\".)^\n**\n** ^The sqlite3_expanded_sql() interface returns NULL if insufficient memory\n** is available to hold the result, or if the result would exceed the\n** the maximum string length determined by the [SQLITE_LIMIT_LENGTH].\n**\n** ^The [SQLITE_TRACE_SIZE_LIMIT] compile-time option limits the size of\n** bound parameter expansions. ^The [SQLITE_OMIT_TRACE] compile-time\n** option causes sqlite3_expanded_sql() to always return NULL.\n**\n** ^The strings returned by sqlite3_sql(P) and sqlite3_normalized_sql(P)\n** are managed by SQLite and are automatically freed when the prepared\n** statement is finalized.\n** ^The string returned by sqlite3_expanded_sql(P), on the other hand,\n** is obtained from [sqlite3_malloc()] and must be freed by the application\n** by passing it to [sqlite3_free()].\n**\n** ^The sqlite3_normalized_sql() interface is only available if\n** the [SQLITE_ENABLE_NORMALIZE] compile-time option is defined.\n*/\nSQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt);\nSQLITE_API char *sqlite3_expanded_sql(sqlite3_stmt *pStmt);\n#ifdef SQLITE_ENABLE_NORMALIZE\nSQLITE_API const char *sqlite3_normalized_sql(sqlite3_stmt *pStmt);\n#endif\n\n/*\n** CAPI3REF: Determine If An SQL Statement Writes The Database\n** METHOD: sqlite3_stmt\n**\n** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if\n** and only if the [prepared statement] X makes no direct changes to\n** the content of the database file.\n**\n** Note that [application-defined SQL functions] or\n** [virtual tables] might change the database indirectly as a side effect.\n** ^(For example, if an application defines a function \"eval()\" that\n** calls [sqlite3_exec()], then the following SQL statement would\n** change the database file through side-effects:\n**\n** <blockquote><pre>\n** SELECT eval('DELETE FROM t1') FROM t2;\n** </pre></blockquote>\n**\n** But because the [SELECT] statement does not change the database file\n** directly, sqlite3_stmt_readonly() would still return true.)^\n**\n** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK],\n** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true,\n** since the statements themselves do not actually modify the database but\n** rather they control the timing of when other statements modify the\n** database. ^The [ATTACH] and [DETACH] statements also cause\n** sqlite3_stmt_readonly() to return true since, while those statements\n** change the configuration of a database connection, they do not make\n** changes to the content of the database files on disk.\n** ^The sqlite3_stmt_readonly() interface returns true for [BEGIN] since\n** [BEGIN] merely sets internal flags, but the [BEGIN|BEGIN IMMEDIATE] and\n** [BEGIN|BEGIN EXCLUSIVE] commands do touch the database and so\n** sqlite3_stmt_readonly() returns false for those commands.\n**\n** ^This routine returns false if there is any possibility that the\n** statement might change the database file. ^A false return does\n** not guarantee that the statement will change the database file.\n** ^For example, an UPDATE statement might have a WHERE clause that\n** makes it a no-op, but the sqlite3_stmt_readonly() result would still\n** be false. ^Similarly, a CREATE TABLE IF NOT EXISTS statement is a\n** read-only no-op if the table already exists, but\n** sqlite3_stmt_readonly() still returns false for such a statement.\n**\n** ^If prepared statement X is an [EXPLAIN] or [EXPLAIN QUERY PLAN]\n** statement, then sqlite3_stmt_readonly(X) returns the same value as\n** if the EXPLAIN or EXPLAIN QUERY PLAN prefix were omitted.\n*/\nSQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt);\n\n/*\n** CAPI3REF: Query The EXPLAIN Setting For A Prepared Statement\n** METHOD: sqlite3_stmt\n**\n** ^The sqlite3_stmt_isexplain(S) interface returns 1 if the\n** prepared statement S is an EXPLAIN statement, or 2 if the\n** statement S is an EXPLAIN QUERY PLAN.\n** ^The sqlite3_stmt_isexplain(S) interface returns 0 if S is\n** an ordinary statement or a NULL pointer.\n*/\nSQLITE_API int sqlite3_stmt_isexplain(sqlite3_stmt *pStmt);\n\n/*\n** CAPI3REF: Change The EXPLAIN Setting For A Prepared Statement\n** METHOD: sqlite3_stmt\n**\n** The sqlite3_stmt_explain(S,E) interface changes the EXPLAIN\n** setting for [prepared statement] S. If E is zero, then S becomes\n** a normal prepared statement. If E is 1, then S behaves as if\n** its SQL text began with \"[EXPLAIN]\". If E is 2, then S behaves as if\n** its SQL text began with \"[EXPLAIN QUERY PLAN]\".\n**\n** Calling sqlite3_stmt_explain(S,E) might cause S to be reprepared.\n** SQLite tries to avoid a reprepare, but a reprepare might be necessary\n** on the first transition into EXPLAIN or EXPLAIN QUERY PLAN mode.\n**\n** Because of the potential need to reprepare, a call to\n** sqlite3_stmt_explain(S,E) will fail with SQLITE_ERROR if S cannot be\n** reprepared because it was created using [sqlite3_prepare()] instead of\n** the newer [sqlite3_prepare_v2()] or [sqlite3_prepare_v3()] interfaces and\n** hence has no saved SQL text with which to reprepare.\n**\n** Changing the explain setting for a prepared statement does not change\n** the original SQL text for the statement. Hence, if the SQL text originally\n** began with EXPLAIN or EXPLAIN QUERY PLAN, but sqlite3_stmt_explain(S,0)\n** is called to convert the statement into an ordinary statement, the EXPLAIN\n** or EXPLAIN QUERY PLAN keywords will still appear in the sqlite3_sql(S)\n** output, even though the statement now acts like a normal SQL statement.\n**\n** This routine returns SQLITE_OK if the explain mode is successfully\n** changed, or an error code if the explain mode could not be changed.\n** The explain mode cannot be changed while a statement is active.\n** Hence, it is good practice to call [sqlite3_reset(S)]\n** immediately prior to calling sqlite3_stmt_explain(S,E).\n*/\nSQLITE_API int sqlite3_stmt_explain(sqlite3_stmt *pStmt, int eMode);\n\n/*\n** CAPI3REF: Determine If A Prepared Statement Has Been Reset\n** METHOD: sqlite3_stmt\n**\n** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the\n** [prepared statement] S has been stepped at least once using\n** [sqlite3_step(S)] but has neither run to completion (returned\n** [SQLITE_DONE] from [sqlite3_step(S)]) nor\n** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S)\n** interface returns false if S is a NULL pointer. If S is not a\n** NULL pointer and is not a pointer to a valid [prepared statement]\n** object, then the behavior is undefined and probably undesirable.\n**\n** This interface can be used in combination [sqlite3_next_stmt()]\n** to locate all prepared statements associated with a database\n** connection that are in need of being reset. This can be used,\n** for example, in diagnostic routines to search for prepared\n** statements that are holding a transaction open.\n*/\nSQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*);\n\n/*\n** CAPI3REF: Dynamically Typed Value Object\n** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}\n**\n** SQLite uses the sqlite3_value object to represent all values\n** that can be stored in a database table. SQLite uses dynamic typing\n** for the values it stores. ^Values stored in sqlite3_value objects\n** can be integers, floating point values, strings, BLOBs, or NULL.\n**\n** An sqlite3_value object may be either \"protected\" or \"unprotected\".\n** Some interfaces require a protected sqlite3_value. Other interfaces\n** will accept either a protected or an unprotected sqlite3_value.\n** Every interface that accepts sqlite3_value arguments specifies\n** whether or not it requires a protected sqlite3_value. The\n** [sqlite3_value_dup()] interface can be used to construct a new\n** protected sqlite3_value from an unprotected sqlite3_value.\n**\n** The terms \"protected\" and \"unprotected\" refer to whether or not\n** a mutex is held. An internal mutex is held for a protected\n** sqlite3_value object but no mutex is held for an unprotected\n** sqlite3_value object. If SQLite is compiled to be single-threaded\n** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0)\n** or if SQLite is run in one of reduced mutex modes\n** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD]\n** then there is no distinction between protected and unprotected\n** sqlite3_value objects and they can be used interchangeably. However,\n** for maximum code portability it is recommended that applications\n** still make the distinction between protected and unprotected\n** sqlite3_value objects even when not strictly required.\n**\n** ^The sqlite3_value objects that are passed as parameters into the\n** implementation of [application-defined SQL functions] are protected.\n** ^The sqlite3_value objects returned by [sqlite3_vtab_rhs_value()]\n** are protected.\n** ^The sqlite3_value object returned by\n** [sqlite3_column_value()] is unprotected.\n** Unprotected sqlite3_value objects may only be used as arguments\n** to [sqlite3_result_value()], [sqlite3_bind_value()], and\n** [sqlite3_value_dup()].\n** The [sqlite3_value_blob | sqlite3_value_type()] family of\n** interfaces require protected sqlite3_value objects.\n*/\ntypedef struct sqlite3_value sqlite3_value;\n\n/*\n** CAPI3REF: SQL Function Context Object\n**\n** The context in which an SQL function executes is stored in an\n** sqlite3_context object. ^A pointer to an sqlite3_context object\n** is always first parameter to [application-defined SQL functions].\n** The application-defined SQL function implementation will pass this\n** pointer through into calls to [sqlite3_result_int | sqlite3_result()],\n** [sqlite3_aggregate_context()], [sqlite3_user_data()],\n** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()],\n** and/or [sqlite3_set_auxdata()].\n*/\ntypedef struct sqlite3_context sqlite3_context;\n\n/*\n** CAPI3REF: Binding Values To Prepared Statements\n** KEYWORDS: {host parameter} {host parameters} {host parameter name}\n** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding}\n** METHOD: sqlite3_stmt\n**\n** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants,\n** literals may be replaced by a [parameter] that matches one of following\n** templates:\n**\n** <ul>\n** <li> ?\n** <li> ?NNN\n** <li> :VVV\n** <li> @VVV\n** <li> $VVV\n** </ul>\n**\n** In the templates above, NNN represents an integer literal,\n** and VVV represents an alphanumeric identifier.)^ ^The values of these\n** parameters (also called \"host parameter names\" or \"SQL parameters\")\n** can be set using the sqlite3_bind_*() routines defined here.\n**\n** ^The first argument to the sqlite3_bind_*() routines is always\n** a pointer to the [sqlite3_stmt] object returned from\n** [sqlite3_prepare_v2()] or its variants.\n**\n** ^The second argument is the index of the SQL parameter to be set.\n** ^The leftmost SQL parameter has an index of 1. ^When the same named\n** SQL parameter is used more than once, second and subsequent\n** occurrences have the same index as the first occurrence.\n** ^The index for named parameters can be looked up using the\n** [sqlite3_bind_parameter_index()] API if desired. ^The index\n** for \"?NNN\" parameters is the value of NNN.\n** ^The NNN value must be between 1 and the [sqlite3_limit()]\n** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 32766).\n**\n** ^The third argument is the value to bind to the parameter.\n** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16()\n** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter\n** is ignored and the end result is the same as sqlite3_bind_null().\n** ^If the third parameter to sqlite3_bind_text() is not NULL, then\n** it should be a pointer to well-formed UTF8 text.\n** ^If the third parameter to sqlite3_bind_text16() is not NULL, then\n** it should be a pointer to well-formed UTF16 text.\n** ^If the third parameter to sqlite3_bind_text64() is not NULL, then\n** it should be a pointer to a well-formed unicode string that is\n** either UTF8 if the sixth parameter is SQLITE_UTF8, or UTF16\n** otherwise.\n**\n** [[byte-order determination rules]] ^The byte-order of\n** UTF16 input text is determined by the byte-order mark (BOM, U+FEFF)\n** found in first character, which is removed, or in the absence of a BOM\n** the byte order is the native byte order of the host\n** machine for sqlite3_bind_text16() or the byte order specified in\n** the 6th parameter for sqlite3_bind_text64().)^\n** ^If UTF16 input text contains invalid unicode\n** characters, then SQLite might change those invalid characters\n** into the unicode replacement character: U+FFFD.\n**\n** ^(In those routines that have a fourth argument, its value is the\n** number of bytes in the parameter. To be clear: the value is the\n** number of <u>bytes</u> in the value, not the number of characters.)^\n** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16()\n** is negative, then the length of the string is\n** the number of bytes up to the first zero terminator.\n** If the fourth parameter to sqlite3_bind_blob() is negative, then\n** the behavior is undefined.\n** If a non-negative fourth parameter is provided to sqlite3_bind_text()\n** or sqlite3_bind_text16() or sqlite3_bind_text64() then\n** that parameter must be the byte offset\n** where the NUL terminator would occur assuming the string were NUL\n** terminated. If any NUL characters occurs at byte offsets less than\n** the value of the fourth parameter then the resulting string value will\n** contain embedded NULs. The result of expressions involving strings\n** with embedded NULs is undefined.\n**\n** ^The fifth argument to the BLOB and string binding interfaces controls\n** or indicates the lifetime of the object referenced by the third parameter.\n** These three options exist:\n** ^ (1) A destructor to dispose of the BLOB or string after SQLite has finished\n** with it may be passed. ^It is called to dispose of the BLOB or string even\n** if the call to the bind API fails, except the destructor is not called if\n** the third parameter is a NULL pointer or the fourth parameter is negative.\n** ^ (2) The special constant, [SQLITE_STATIC], may be passed to indicate that\n** the application remains responsible for disposing of the object. ^In this\n** case, the object and the provided pointer to it must remain valid until\n** either the prepared statement is finalized or the same SQL parameter is\n** bound to something else, whichever occurs sooner.\n** ^ (3) The constant, [SQLITE_TRANSIENT], may be passed to indicate that the\n** object is to be copied prior to the return from sqlite3_bind_*(). ^The\n** object and pointer to it must remain valid until then. ^SQLite will then\n** manage the lifetime of its private copy.\n**\n** ^The sixth argument to sqlite3_bind_text64() must be one of\n** [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE]\n** to specify the encoding of the text in the third parameter. If\n** the sixth argument to sqlite3_bind_text64() is not one of the\n** allowed values shown above, or if the text encoding is different\n** from the encoding specified by the sixth parameter, then the behavior\n** is undefined.\n**\n** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that\n** is filled with zeroes. ^A zeroblob uses a fixed amount of memory\n** (just an integer to hold its size) while it is being processed.\n** Zeroblobs are intended to serve as placeholders for BLOBs whose\n** content is later written using\n** [sqlite3_blob_open | incremental BLOB I/O] routines.\n** ^A negative value for the zeroblob results in a zero-length BLOB.\n**\n** ^The sqlite3_bind_pointer(S,I,P,T,D) routine causes the I-th parameter in\n** [prepared statement] S to have an SQL value of NULL, but to also be\n** associated with the pointer P of type T. ^D is either a NULL pointer or\n** a pointer to a destructor function for P. ^SQLite will invoke the\n** destructor D with a single argument of P when it is finished using\n** P. The T parameter should be a static string, preferably a string\n** literal. The sqlite3_bind_pointer() routine is part of the\n** [pointer passing interface] added for SQLite 3.20.0.\n**\n** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer\n** for the [prepared statement] or with a prepared statement for which\n** [sqlite3_step()] has been called more recently than [sqlite3_reset()],\n** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_()\n** routine is passed a [prepared statement] that has been finalized, the\n** result is undefined and probably harmful.\n**\n** ^Bindings are not cleared by the [sqlite3_reset()] routine.\n** ^Unbound parameters are interpreted as NULL.\n**\n** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an\n** [error code] if anything goes wrong.\n** ^[SQLITE_TOOBIG] might be returned if the size of a string or BLOB\n** exceeds limits imposed by [sqlite3_limit]([SQLITE_LIMIT_LENGTH]) or\n** [SQLITE_MAX_LENGTH].\n** ^[SQLITE_RANGE] is returned if the parameter\n** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails.\n**\n** See also: [sqlite3_bind_parameter_count()],\n** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()].\n*/\nSQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));\nSQLITE_API int sqlite3_bind_blob64(sqlite3_stmt*, int, const void*, sqlite3_uint64,\n void(*)(void*));\nSQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double);\nSQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int);\nSQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);\nSQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int);\nSQLITE_API int sqlite3_bind_text(sqlite3_stmt*,int,const char*,int,void(*)(void*));\nSQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));\nSQLITE_API int sqlite3_bind_text64(sqlite3_stmt*, int, const char*, sqlite3_uint64,\n void(*)(void*), unsigned char encoding);\nSQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);\nSQLITE_API int sqlite3_bind_pointer(sqlite3_stmt*, int, void*, const char*,void(*)(void*));\nSQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);\nSQLITE_API int sqlite3_bind_zeroblob64(sqlite3_stmt*, int, sqlite3_uint64);\n\n/*\n** CAPI3REF: Number Of SQL Parameters\n** METHOD: sqlite3_stmt\n**\n** ^This routine can be used to find the number of [SQL parameters]\n** in a [prepared statement]. SQL parameters are tokens of the\n** form \"?\", \"?NNN\", \":AAA\", \"$AAA\", or \"@AAA\" that serve as\n** placeholders for values that are [sqlite3_bind_blob | bound]\n** to the parameters at a later time.\n**\n** ^(This routine actually returns the index of the largest (rightmost)\n** parameter. For all forms except ?NNN, this will correspond to the\n** number of unique parameters. If parameters of the ?NNN form are used,\n** there may be gaps in the list.)^\n**\n** See also: [sqlite3_bind_blob|sqlite3_bind()],\n** [sqlite3_bind_parameter_name()], and\n** [sqlite3_bind_parameter_index()].\n*/\nSQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*);\n\n/*\n** CAPI3REF: Name Of A Host Parameter\n** METHOD: sqlite3_stmt\n**\n** ^The sqlite3_bind_parameter_name(P,N) interface returns\n** the name of the N-th [SQL parameter] in the [prepared statement] P.\n** ^(SQL parameters of the form \"?NNN\" or \":AAA\" or \"@AAA\" or \"$AAA\"\n** have a name which is the string \"?NNN\" or \":AAA\" or \"@AAA\" or \"$AAA\"\n** respectively.\n** In other words, the initial \":\" or \"$\" or \"@\" or \"?\"\n** is included as part of the name.)^\n** ^Parameters of the form \"?\" without a following integer have no name\n** and are referred to as \"nameless\" or \"anonymous parameters\".\n**\n** ^The first host parameter has an index of 1, not 0.\n**\n** ^If the value N is out of range or if the N-th parameter is\n** nameless, then NULL is returned. ^The returned string is\n** always in UTF-8 encoding even if the named parameter was\n** originally specified as UTF-16 in [sqlite3_prepare16()],\n** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()].\n**\n** See also: [sqlite3_bind_blob|sqlite3_bind()],\n** [sqlite3_bind_parameter_count()], and\n** [sqlite3_bind_parameter_index()].\n*/\nSQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);\n\n/*\n** CAPI3REF: Index Of A Parameter With A Given Name\n** METHOD: sqlite3_stmt\n**\n** ^Return the index of an SQL parameter given its name. ^The\n** index value returned is suitable for use as the second\n** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero\n** is returned if no matching parameter is found. ^The parameter\n** name must be given in UTF-8 even if the original statement\n** was prepared from UTF-16 text using [sqlite3_prepare16_v2()] or\n** [sqlite3_prepare16_v3()].\n**\n** See also: [sqlite3_bind_blob|sqlite3_bind()],\n** [sqlite3_bind_parameter_count()], and\n** [sqlite3_bind_parameter_name()].\n*/\nSQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);\n\n/*\n** CAPI3REF: Reset All Bindings On A Prepared Statement\n** METHOD: sqlite3_stmt\n**\n** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset\n** the [sqlite3_bind_blob | bindings] on a [prepared statement].\n** ^Use this routine to reset all host parameters to NULL.\n*/\nSQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*);\n\n/*\n** CAPI3REF: Number Of Columns In A Result Set\n** METHOD: sqlite3_stmt\n**\n** ^Return the number of columns in the result set returned by the\n** [prepared statement]. ^If this routine returns 0, that means the\n** [prepared statement] returns no data (for example an [UPDATE]).\n** ^However, just because this routine returns a positive number does not\n** mean that one or more rows of data will be returned. ^A SELECT statement\n** will always have a positive sqlite3_column_count() but depending on the\n** WHERE clause constraints and the table content, it might return no rows.\n**\n** See also: [sqlite3_data_count()]\n*/\nSQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt);\n\n/*\n** CAPI3REF: Column Names In A Result Set\n** METHOD: sqlite3_stmt\n**\n** ^These routines return the name assigned to a particular column\n** in the result set of a [SELECT] statement. ^The sqlite3_column_name()\n** interface returns a pointer to a zero-terminated UTF-8 string\n** and sqlite3_column_name16() returns a pointer to a zero-terminated\n** UTF-16 string. ^The first parameter is the [prepared statement]\n** that implements the [SELECT] statement. ^The second parameter is the\n** column number. ^The leftmost column is number 0.\n**\n** ^The returned string pointer is valid until either the [prepared statement]\n** is destroyed by [sqlite3_finalize()] or until the statement is automatically\n** reprepared by the first call to [sqlite3_step()] for a particular run\n** or until the next call to\n** sqlite3_column_name() or sqlite3_column_name16() on the same column.\n**\n** ^If sqlite3_malloc() fails during the processing of either routine\n** (for example during a conversion from UTF-8 to UTF-16) then a\n** NULL pointer is returned.\n**\n** ^The name of a result column is the value of the \"AS\" clause for\n** that column, if there is an AS clause. If there is no AS clause\n** then the name of the column is unspecified and may change from\n** one release of SQLite to the next.\n*/\nSQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N);\nSQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N);\n\n/*\n** CAPI3REF: Source Of Data In A Query Result\n** METHOD: sqlite3_stmt\n**\n** ^These routines provide a means to determine the database, table, and\n** table column that is the origin of a particular result column in\n** [SELECT] statement.\n** ^The name of the database or table or column can be returned as\n** either a UTF-8 or UTF-16 string. ^The _database_ routines return\n** the database name, the _table_ routines return the table name, and\n** the origin_ routines return the column name.\n** ^The returned string is valid until the [prepared statement] is destroyed\n** using [sqlite3_finalize()] or until the statement is automatically\n** reprepared by the first call to [sqlite3_step()] for a particular run\n** or until the same information is requested\n** again in a different encoding.\n**\n** ^The names returned are the original un-aliased names of the\n** database, table, and column.\n**\n** ^The first argument to these interfaces is a [prepared statement].\n** ^These functions return information about the Nth result column returned by\n** the statement, where N is the second function argument.\n** ^The left-most column is column 0 for these routines.\n**\n** ^If the Nth column returned by the statement is an expression or\n** subquery and is not a column value, then all of these functions return\n** NULL. ^These routines might also return NULL if a memory allocation error\n** occurs. ^Otherwise, they return the name of the attached database, table,\n** or column that query result column was extracted from.\n**\n** ^As with all other SQLite APIs, those whose names end with \"16\" return\n** UTF-16 encoded strings and the other functions return UTF-8.\n**\n** ^These APIs are only available if the library was compiled with the\n** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol.\n**\n** If two or more threads call one or more\n** [sqlite3_column_database_name | column metadata interfaces]\n** for the same [prepared statement] and result column\n** at the same time then the results are undefined.\n*/\nSQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int);\nSQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int);\nSQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int);\nSQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int);\nSQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int);\nSQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);\n\n/*\n** CAPI3REF: Declared Datatype Of A Query Result\n** METHOD: sqlite3_stmt\n**\n** ^(The first parameter is a [prepared statement].\n** If this statement is a [SELECT] statement and the Nth column of the\n** returned result set of that [SELECT] is a table column (not an\n** expression or subquery) then the declared type of the table\n** column is returned.)^ ^If the Nth column of the result set is an\n** expression or subquery, then a NULL pointer is returned.\n** ^The returned string is always UTF-8 encoded.\n**\n** ^(For example, given the database schema:\n**\n** CREATE TABLE t1(c1 VARIANT);\n**\n** and the following statement to be compiled:\n**\n** SELECT c1 + 1, c1 FROM t1;\n**\n** this routine would return the string \"VARIANT\" for the second result\n** column (i==1), and a NULL pointer for the first result column (i==0).)^\n**\n** ^SQLite uses dynamic run-time typing. ^So just because a column\n** is declared to contain a particular type does not mean that the\n** data stored in that column is of the declared type. SQLite is\n** strongly typed, but the typing is dynamic not static. ^Type\n** is associated with individual values, not with the containers\n** used to hold those values.\n*/\nSQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int);\nSQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int);\n\n/*\n** CAPI3REF: Evaluate An SQL Statement\n** METHOD: sqlite3_stmt\n**\n** After a [prepared statement] has been prepared using any of\n** [sqlite3_prepare_v2()], [sqlite3_prepare_v3()], [sqlite3_prepare16_v2()],\n** or [sqlite3_prepare16_v3()] or one of the legacy\n** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function\n** must be called one or more times to evaluate the statement.\n**\n** The details of the behavior of the sqlite3_step() interface depend\n** on whether the statement was prepared using the newer \"vX\" interfaces\n** [sqlite3_prepare_v3()], [sqlite3_prepare_v2()], [sqlite3_prepare16_v3()],\n** [sqlite3_prepare16_v2()] or the older legacy\n** interfaces [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the\n** new \"vX\" interface is recommended for new applications but the legacy\n** interface will continue to be supported.\n**\n** ^In the legacy interface, the return value will be either [SQLITE_BUSY],\n** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].\n** ^With the \"v2\" interface, any of the other [result codes] or\n** [extended result codes] might be returned as well.\n**\n** ^[SQLITE_BUSY] means that the database engine was unable to acquire the\n** database locks it needs to do its job. ^If the statement is a [COMMIT]\n** or occurs outside of an explicit transaction, then you can retry the\n** statement. If the statement is not a [COMMIT] and occurs within an\n** explicit transaction then you should rollback the transaction before\n** continuing.\n**\n** ^[SQLITE_DONE] means that the statement has finished executing\n** successfully. sqlite3_step() should not be called again on this virtual\n** machine without first calling [sqlite3_reset()] to reset the virtual\n** machine back to its initial state.\n**\n** ^If the SQL statement being executed returns any data, then [SQLITE_ROW]\n** is returned each time a new row of data is ready for processing by the\n** caller. The values may be accessed using the [column access functions].\n** sqlite3_step() is called again to retrieve the next row of data.\n**\n** ^[SQLITE_ERROR] means that a run-time error (such as a constraint\n** violation) has occurred. sqlite3_step() should not be called again on\n** the VM. More information may be found by calling [sqlite3_errmsg()].\n** ^With the legacy interface, a more specific error code (for example,\n** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth)\n** can be obtained by calling [sqlite3_reset()] on the\n** [prepared statement]. ^In the \"v2\" interface,\n** the more specific error code is returned directly by sqlite3_step().\n**\n** [SQLITE_MISUSE] means that the this routine was called inappropriately.\n** Perhaps it was called on a [prepared statement] that has\n** already been [sqlite3_finalize | finalized] or on one that had\n** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could\n** be the case that the same database connection is being used by two or\n** more threads at the same moment in time.\n**\n** For all versions of SQLite up to and including 3.6.23.1, a call to\n** [sqlite3_reset()] was required after sqlite3_step() returned anything\n** other than [SQLITE_ROW] before any subsequent invocation of\n** sqlite3_step(). Failure to reset the prepared statement using\n** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from\n** sqlite3_step(). But after [version 3.6.23.1] ([dateof:3.6.23.1],\n** sqlite3_step() began\n** calling [sqlite3_reset()] automatically in this circumstance rather\n** than returning [SQLITE_MISUSE]. This is not considered a compatibility\n** break because any application that ever receives an SQLITE_MISUSE error\n** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option\n** can be used to restore the legacy behavior.\n**\n** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step()\n** API always returns a generic error code, [SQLITE_ERROR], following any\n** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call\n** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the\n** specific [error codes] that better describes the error.\n** We admit that this is a goofy design. The problem has been fixed\n** with the \"v2\" interface. If you prepare all of your SQL statements\n** using [sqlite3_prepare_v3()] or [sqlite3_prepare_v2()]\n** or [sqlite3_prepare16_v2()] or [sqlite3_prepare16_v3()] instead\n** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces,\n** then the more specific [error codes] are returned directly\n** by sqlite3_step(). The use of the \"vX\" interfaces is recommended.\n*/\nSQLITE_API int sqlite3_step(sqlite3_stmt*);\n\n/*\n** CAPI3REF: Number of columns in a result set\n** METHOD: sqlite3_stmt\n**\n** ^The sqlite3_data_count(P) interface returns the number of columns in the\n** current row of the result set of [prepared statement] P.\n** ^If prepared statement P does not have results ready to return\n** (via calls to the [sqlite3_column_int | sqlite3_column()] family of\n** interfaces) then sqlite3_data_count(P) returns 0.\n** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer.\n** ^The sqlite3_data_count(P) routine returns 0 if the previous call to\n** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P)\n** will return non-zero if previous call to [sqlite3_step](P) returned\n** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum]\n** where it always returns zero since each step of that multi-step\n** pragma returns 0 columns of data.\n**\n** See also: [sqlite3_column_count()]\n*/\nSQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt);\n\n/*\n** CAPI3REF: Fundamental Datatypes\n** KEYWORDS: SQLITE_TEXT\n**\n** ^(Every value in SQLite has one of five fundamental datatypes:\n**\n** <ul>\n** <li> 64-bit signed integer\n** <li> 64-bit IEEE floating point number\n** <li> string\n** <li> BLOB\n** <li> NULL\n** </ul>)^\n**\n** These constants are codes for each of those types.\n**\n** Note that the SQLITE_TEXT constant was also used in SQLite version 2\n** for a completely different meaning. Software that links against both\n** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not\n** SQLITE_TEXT.\n*/\n#define SQLITE_INTEGER 1\n#define SQLITE_FLOAT 2\n#define SQLITE_BLOB 4\n#define SQLITE_NULL 5\n#ifdef SQLITE_TEXT\n# undef SQLITE_TEXT\n#else\n# define SQLITE_TEXT 3\n#endif\n#define SQLITE3_TEXT 3\n\n/*\n** CAPI3REF: Result Values From A Query\n** KEYWORDS: {column access functions}\n** METHOD: sqlite3_stmt\n**\n** <b>Summary:</b>\n** <blockquote><table border=0 cellpadding=0 cellspacing=0>\n** <tr><td><b>sqlite3_column_blob</b><td>→<td>BLOB result\n** <tr><td><b>sqlite3_column_double</b><td>→<td>REAL result\n** <tr><td><b>sqlite3_column_int</b><td>→<td>32-bit INTEGER result\n** <tr><td><b>sqlite3_column_int64</b><td>→<td>64-bit INTEGER result\n** <tr><td><b>sqlite3_column_text</b><td>→<td>UTF-8 TEXT result\n** <tr><td><b>sqlite3_column_text16</b><td>→<td>UTF-16 TEXT result\n** <tr><td><b>sqlite3_column_value</b><td>→<td>The result as an\n** [sqlite3_value|unprotected sqlite3_value] object.\n** <tr><td> <td> <td> \n** <tr><td><b>sqlite3_column_bytes</b><td>→<td>Size of a BLOB\n** or a UTF-8 TEXT result in bytes\n** <tr><td><b>sqlite3_column_bytes16 </b>\n** <td>→ <td>Size of UTF-16\n** TEXT in bytes\n** <tr><td><b>sqlite3_column_type</b><td>→<td>Default\n** datatype of the result\n** </table></blockquote>\n**\n** <b>Details:</b>\n**\n** ^These routines return information about a single column of the current\n** result row of a query. ^In every case the first argument is a pointer\n** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*]\n** that was returned from [sqlite3_prepare_v2()] or one of its variants)\n** and the second argument is the index of the column for which information\n** should be returned. ^The leftmost column of the result set has the index 0.\n** ^The number of columns in the result can be determined using\n** [sqlite3_column_count()].\n**\n** If the SQL statement does not currently point to a valid row, or if the\n** column index is out of range, the result is undefined.\n** These routines may only be called when the most recent call to\n** [sqlite3_step()] has returned [SQLITE_ROW] and neither\n** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently.\n** If any of these routines are called after [sqlite3_reset()] or\n** [sqlite3_finalize()] or after [sqlite3_step()] has returned\n** something other than [SQLITE_ROW], the results are undefined.\n** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]\n** are called from a different thread while any of these routines\n** are pending, then the results are undefined.\n**\n** The first six interfaces (_blob, _double, _int, _int64, _text, and _text16)\n** each return the value of a result column in a specific data format. If\n** the result column is not initially in the requested format (for example,\n** if the query returns an integer but the sqlite3_column_text() interface\n** is used to extract the value) then an automatic type conversion is performed.\n**\n** ^The sqlite3_column_type() routine returns the\n** [SQLITE_INTEGER | datatype code] for the initial data type\n** of the result column. ^The returned value is one of [SQLITE_INTEGER],\n** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL].\n** The return value of sqlite3_column_type() can be used to decide which\n** of the first six interface should be used to extract the column value.\n** The value returned by sqlite3_column_type() is only meaningful if no\n** automatic type conversions have occurred for the value in question.\n** After a type conversion, the result of calling sqlite3_column_type()\n** is undefined, though harmless. Future\n** versions of SQLite may change the behavior of sqlite3_column_type()\n** following a type conversion.\n**\n** If the result is a BLOB or a TEXT string, then the sqlite3_column_bytes()\n** or sqlite3_column_bytes16() interfaces can be used to determine the size\n** of that BLOB or string.\n**\n** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()\n** routine returns the number of bytes in that BLOB or string.\n** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts\n** the string to UTF-8 and then returns the number of bytes.\n** ^If the result is a numeric value then sqlite3_column_bytes() uses\n** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns\n** the number of bytes in that string.\n** ^If the result is NULL, then sqlite3_column_bytes() returns zero.\n**\n** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16()\n** routine returns the number of bytes in that BLOB or string.\n** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts\n** the string to UTF-16 and then returns the number of bytes.\n** ^If the result is a numeric value then sqlite3_column_bytes16() uses\n** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns\n** the number of bytes in that string.\n** ^If the result is NULL, then sqlite3_column_bytes16() returns zero.\n**\n** ^The values returned by [sqlite3_column_bytes()] and\n** [sqlite3_column_bytes16()] do not include the zero terminators at the end\n** of the string. ^For clarity: the values returned by\n** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of\n** bytes in the string, not the number of characters.\n**\n** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(),\n** even empty strings, are always zero-terminated. ^The return\n** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer.\n**\n** ^Strings returned by sqlite3_column_text16() always have the endianness\n** which is native to the platform, regardless of the text encoding set\n** for the database.\n**\n** <b>Warning:</b> ^The object returned by [sqlite3_column_value()] is an\n** [unprotected sqlite3_value] object. In a multithreaded environment,\n** an unprotected sqlite3_value object may only be used safely with\n** [sqlite3_bind_value()] and [sqlite3_result_value()].\n** If the [unprotected sqlite3_value] object returned by\n** [sqlite3_column_value()] is used in any other way, including calls\n** to routines like [sqlite3_value_int()], [sqlite3_value_text()],\n** or [sqlite3_value_bytes()], the behavior is not threadsafe.\n** Hence, the sqlite3_column_value() interface\n** is normally only useful within the implementation of\n** [application-defined SQL functions] or [virtual tables], not within\n** top-level application code.\n**\n** These routines may attempt to convert the datatype of the result.\n** ^For example, if the internal representation is FLOAT and a text result\n** is requested, [sqlite3_snprintf()] is used internally to perform the\n** conversion automatically. ^(The following table details the conversions\n** that are applied:\n**\n** <blockquote>\n** <table border=\"1\">\n** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion\n**\n** <tr><td> NULL <td> INTEGER <td> Result is 0\n** <tr><td> NULL <td> FLOAT <td> Result is 0.0\n** <tr><td> NULL <td> TEXT <td> Result is a NULL pointer\n** <tr><td> NULL <td> BLOB <td> Result is a NULL pointer\n** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float\n** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer\n** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT\n** <tr><td> FLOAT <td> INTEGER <td> [CAST] to INTEGER\n** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float\n** <tr><td> FLOAT <td> BLOB <td> [CAST] to BLOB\n** <tr><td> TEXT <td> INTEGER <td> [CAST] to INTEGER\n** <tr><td> TEXT <td> FLOAT <td> [CAST] to REAL\n** <tr><td> TEXT <td> BLOB <td> No change\n** <tr><td> BLOB <td> INTEGER <td> [CAST] to INTEGER\n** <tr><td> BLOB <td> FLOAT <td> [CAST] to REAL\n** <tr><td> BLOB <td> TEXT <td> [CAST] to TEXT, ensure zero terminator\n** </table>\n** </blockquote>)^\n**\n** Note that when type conversions occur, pointers returned by prior\n** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or\n** sqlite3_column_text16() may be invalidated.\n** Type conversions and pointer invalidations might occur\n** in the following cases:\n**\n** <ul>\n** <li> The initial content is a BLOB and sqlite3_column_text() or\n** sqlite3_column_text16() is called. A zero-terminator might\n** need to be added to the string.</li>\n** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or\n** sqlite3_column_text16() is called. The content must be converted\n** to UTF-16.</li>\n** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or\n** sqlite3_column_text() is called. The content must be converted\n** to UTF-8.</li>\n** </ul>\n**\n** ^Conversions between UTF-16be and UTF-16le are always done in place and do\n** not invalidate a prior pointer, though of course the content of the buffer\n** that the prior pointer references will have been modified. Other kinds\n** of conversion are done in place when it is possible, but sometimes they\n** are not possible and in those cases prior pointers are invalidated.\n**\n** The safest policy is to invoke these routines\n** in one of the following ways:\n**\n** <ul>\n** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>\n** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>\n** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>\n** </ul>\n**\n** In other words, you should call sqlite3_column_text(),\n** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result\n** into the desired format, then invoke sqlite3_column_bytes() or\n** sqlite3_column_bytes16() to find the size of the result. Do not mix calls\n** to sqlite3_column_text() or sqlite3_column_blob() with calls to\n** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16()\n** with calls to sqlite3_column_bytes().\n**\n** ^The pointers returned are valid until a type conversion occurs as\n** described above, or until [sqlite3_step()] or [sqlite3_reset()] or\n** [sqlite3_finalize()] is called. ^The memory space used to hold strings\n** and BLOBs is freed automatically. Do not pass the pointers returned\n** from [sqlite3_column_blob()], [sqlite3_column_text()], etc. into\n** [sqlite3_free()].\n**\n** As long as the input parameters are correct, these routines will only\n** fail if an out-of-memory error occurs during a format conversion.\n** Only the following subset of interfaces are subject to out-of-memory\n** errors:\n**\n** <ul>\n** <li> sqlite3_column_blob()\n** <li> sqlite3_column_text()\n** <li> sqlite3_column_text16()\n** <li> sqlite3_column_bytes()\n** <li> sqlite3_column_bytes16()\n** </ul>\n**\n** If an out-of-memory error occurs, then the return value from these\n** routines is the same as if the column had contained an SQL NULL value.\n** Valid SQL NULL returns can be distinguished from out-of-memory errors\n** by invoking the [sqlite3_errcode()] immediately after the suspect\n** return value is obtained and before any\n** other SQLite interface is called on the same [database connection].\n*/\nSQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);\nSQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol);\nSQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol);\nSQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);\nSQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);\nSQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);\nSQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);\nSQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol);\nSQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);\nSQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol);\n\n/*\n** CAPI3REF: Destroy A Prepared Statement Object\n** DESTRUCTOR: sqlite3_stmt\n**\n** ^The sqlite3_finalize() function is called to delete a [prepared statement].\n** ^If the most recent evaluation of the statement encountered no errors\n** or if the statement is never been evaluated, then sqlite3_finalize() returns\n** SQLITE_OK. ^If the most recent evaluation of statement S failed, then\n** sqlite3_finalize(S) returns the appropriate [error code] or\n** [extended error code].\n**\n** ^The sqlite3_finalize(S) routine can be called at any point during\n** the life cycle of [prepared statement] S:\n** before statement S is ever evaluated, after\n** one or more calls to [sqlite3_reset()], or after any call\n** to [sqlite3_step()] regardless of whether or not the statement has\n** completed execution.\n**\n** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op.\n**\n** The application must finalize every [prepared statement] in order to avoid\n** resource leaks. It is a grievous error for the application to try to use\n** a prepared statement after it has been finalized. Any use of a prepared\n** statement after it has been finalized can result in undefined and\n** undesirable behavior such as segfaults and heap corruption.\n*/\nSQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt);\n\n/*\n** CAPI3REF: Reset A Prepared Statement Object\n** METHOD: sqlite3_stmt\n**\n** The sqlite3_reset() function is called to reset a [prepared statement]\n** object back to its initial state, ready to be re-executed.\n** ^Any SQL statement variables that had values bound to them using\n** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values.\n** Use [sqlite3_clear_bindings()] to reset the bindings.\n**\n** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S\n** back to the beginning of its program.\n**\n** ^The return code from [sqlite3_reset(S)] indicates whether or not\n** the previous evaluation of prepared statement S completed successfully.\n** ^If [sqlite3_step(S)] has never before been called on S or if\n** [sqlite3_step(S)] has not been called since the previous call\n** to [sqlite3_reset(S)], then [sqlite3_reset(S)] will return\n** [SQLITE_OK].\n**\n** ^If the most recent call to [sqlite3_step(S)] for the\n** [prepared statement] S indicated an error, then\n** [sqlite3_reset(S)] returns an appropriate [error code].\n** ^The [sqlite3_reset(S)] interface might also return an [error code]\n** if there were no prior errors but the process of resetting\n** the prepared statement caused a new error. ^For example, if an\n** [INSERT] statement with a [RETURNING] clause is only stepped one time,\n** that one call to [sqlite3_step(S)] might return SQLITE_ROW but\n** the overall statement might still fail and the [sqlite3_reset(S)] call\n** might return SQLITE_BUSY if locking constraints prevent the\n** database change from committing. Therefore, it is important that\n** applications check the return code from [sqlite3_reset(S)] even if\n** no prior call to [sqlite3_step(S)] indicated a problem.\n**\n** ^The [sqlite3_reset(S)] interface does not change the values\n** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S.\n*/\nSQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);\n\n\n/*\n** CAPI3REF: Create Or Redefine SQL Functions\n** KEYWORDS: {function creation routines}\n** METHOD: sqlite3\n**\n** ^These functions (collectively known as \"function creation routines\")\n** are used to add SQL functions or aggregates or to redefine the behavior\n** of existing SQL functions or aggregates. The only differences between\n** the three \"sqlite3_create_function*\" routines are the text encoding\n** expected for the second parameter (the name of the function being\n** created) and the presence or absence of a destructor callback for\n** the application data pointer. Function sqlite3_create_window_function()\n** is similar, but allows the user to supply the extra callback functions\n** needed by [aggregate window functions].\n**\n** ^The first parameter is the [database connection] to which the SQL\n** function is to be added. ^If an application uses more than one database\n** connection then application-defined SQL functions must be added\n** to each database connection separately.\n**\n** ^The second parameter is the name of the SQL function to be created or\n** redefined. ^The length of the name is limited to 255 bytes in a UTF-8\n** representation, exclusive of the zero-terminator. ^Note that the name\n** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes.\n** ^Any attempt to create a function with a longer name\n** will result in [SQLITE_MISUSE] being returned.\n**\n** ^The third parameter (nArg)\n** is the number of arguments that the SQL function or\n** aggregate takes. ^If this parameter is -1, then the SQL function or\n** aggregate may take any number of arguments between 0 and the limit\n** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third\n** parameter is less than -1 or greater than 127 then the behavior is\n** undefined.\n**\n** ^The fourth parameter, eTextRep, specifies what\n** [SQLITE_UTF8 | text encoding] this SQL function prefers for\n** its parameters. The application should set this parameter to\n** [SQLITE_UTF16LE] if the function implementation invokes\n** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the\n** implementation invokes [sqlite3_value_text16be()] on an input, or\n** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8]\n** otherwise. ^The same SQL function may be registered multiple times using\n** different preferred text encodings, with different implementations for\n** each encoding.\n** ^When multiple implementations of the same function are available, SQLite\n** will pick the one that involves the least amount of data conversion.\n**\n** ^The fourth parameter may optionally be ORed with [SQLITE_DETERMINISTIC]\n** to signal that the function will always return the same result given\n** the same inputs within a single SQL statement. Most SQL functions are\n** deterministic. The built-in [random()] SQL function is an example of a\n** function that is not deterministic. The SQLite query planner is able to\n** perform additional optimizations on deterministic functions, so use\n** of the [SQLITE_DETERMINISTIC] flag is recommended where possible.\n**\n** ^The fourth parameter may also optionally include the [SQLITE_DIRECTONLY]\n** flag, which if present prevents the function from being invoked from\n** within VIEWs, TRIGGERs, CHECK constraints, generated column expressions,\n** index expressions, or the WHERE clause of partial indexes.\n**\n** For best security, the [SQLITE_DIRECTONLY] flag is recommended for\n** all application-defined SQL functions that do not need to be\n** used inside of triggers, view, CHECK constraints, or other elements of\n** the database schema. This flags is especially recommended for SQL\n** functions that have side effects or reveal internal application state.\n** Without this flag, an attacker might be able to modify the schema of\n** a database file to include invocations of the function with parameters\n** chosen by the attacker, which the application will then execute when\n** the database file is opened and read.\n**\n** ^(The fifth parameter is an arbitrary pointer. The implementation of the\n** function can gain access to this pointer using [sqlite3_user_data()].)^\n**\n** ^The sixth, seventh and eighth parameters passed to the three\n** \"sqlite3_create_function*\" functions, xFunc, xStep and xFinal, are\n** pointers to C-language functions that implement the SQL function or\n** aggregate. ^A scalar SQL function requires an implementation of the xFunc\n** callback only; NULL pointers must be passed as the xStep and xFinal\n** parameters. ^An aggregate SQL function requires an implementation of xStep\n** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing\n** SQL function or aggregate, pass NULL pointers for all three function\n** callbacks.\n**\n** ^The sixth, seventh, eighth and ninth parameters (xStep, xFinal, xValue\n** and xInverse) passed to sqlite3_create_window_function are pointers to\n** C-language callbacks that implement the new function. xStep and xFinal\n** must both be non-NULL. xValue and xInverse may either both be NULL, in\n** which case a regular aggregate function is created, or must both be\n** non-NULL, in which case the new function may be used as either an aggregate\n** or aggregate window function. More details regarding the implementation\n** of aggregate window functions are\n** [user-defined window functions|available here].\n**\n** ^(If the final parameter to sqlite3_create_function_v2() or\n** sqlite3_create_window_function() is not NULL, then it is destructor for\n** the application data pointer. The destructor is invoked when the function\n** is deleted, either by being overloaded or when the database connection\n** closes.)^ ^The destructor is also invoked if the call to\n** sqlite3_create_function_v2() fails. ^When the destructor callback is\n** invoked, it is passed a single argument which is a copy of the application\n** data pointer which was the fifth parameter to sqlite3_create_function_v2().\n**\n** ^It is permitted to register multiple implementations of the same\n** functions with the same name but with either differing numbers of\n** arguments or differing preferred text encodings. ^SQLite will use\n** the implementation that most closely matches the way in which the\n** SQL function is used. ^A function implementation with a non-negative\n** nArg parameter is a better match than a function implementation with\n** a negative nArg. ^A function where the preferred text encoding\n** matches the database encoding is a better\n** match than a function where the encoding is different.\n** ^A function where the encoding difference is between UTF16le and UTF16be\n** is a closer match than a function where the encoding difference is\n** between UTF8 and UTF16.\n**\n** ^Built-in functions may be overloaded by new application-defined functions.\n**\n** ^An application-defined function is permitted to call other\n** SQLite interfaces. However, such calls must not\n** close the database connection nor finalize or reset the prepared\n** statement in which the function is running.\n*/\nSQLITE_API int sqlite3_create_function(\n sqlite3 *db,\n const char *zFunctionName,\n int nArg,\n int eTextRep,\n void *pApp,\n void (*xFunc)(sqlite3_context*,int,sqlite3_value**),\n void (*xStep)(sqlite3_context*,int,sqlite3_value**),\n void (*xFinal)(sqlite3_context*)\n);\nSQLITE_API int sqlite3_create_function16(\n sqlite3 *db,\n const void *zFunctionName,\n int nArg,\n int eTextRep,\n void *pApp,\n void (*xFunc)(sqlite3_context*,int,sqlite3_value**),\n void (*xStep)(sqlite3_context*,int,sqlite3_value**),\n void (*xFinal)(sqlite3_context*)\n);\nSQLITE_API int sqlite3_create_function_v2(\n sqlite3 *db,\n const char *zFunctionName,\n int nArg,\n int eTextRep,\n void *pApp,\n void (*xFunc)(sqlite3_context*,int,sqlite3_value**),\n void (*xStep)(sqlite3_context*,int,sqlite3_value**),\n void (*xFinal)(sqlite3_context*),\n void(*xDestroy)(void*)\n);\nSQLITE_API int sqlite3_create_window_function(\n sqlite3 *db,\n const char *zFunctionName,\n int nArg,\n int eTextRep,\n void *pApp,\n void (*xStep)(sqlite3_context*,int,sqlite3_value**),\n void (*xFinal)(sqlite3_context*),\n void (*xValue)(sqlite3_context*),\n void (*xInverse)(sqlite3_context*,int,sqlite3_value**),\n void(*xDestroy)(void*)\n);\n\n/*\n** CAPI3REF: Text Encodings\n**\n** These constant define integer codes that represent the various\n** text encodings supported by SQLite.\n*/\n#define SQLITE_UTF8 1 /* IMP: R-37514-35566 */\n#define SQLITE_UTF16LE 2 /* IMP: R-03371-37637 */\n#define SQLITE_UTF16BE 3 /* IMP: R-51971-34154 */\n#define SQLITE_UTF16 4 /* Use native byte order */\n#define SQLITE_ANY 5 /* Deprecated */\n#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */\n\n/*\n** CAPI3REF: Function Flags\n**\n** These constants may be ORed together with the\n** [SQLITE_UTF8 | preferred text encoding] as the fourth argument\n** to [sqlite3_create_function()], [sqlite3_create_function16()], or\n** [sqlite3_create_function_v2()].\n**\n** <dl>\n** [[SQLITE_DETERMINISTIC]] <dt>SQLITE_DETERMINISTIC</dt><dd>\n** The SQLITE_DETERMINISTIC flag means that the new function always gives\n** the same output when the input parameters are the same.\n** The [abs|abs() function] is deterministic, for example, but\n** [randomblob|randomblob()] is not. Functions must\n** be deterministic in order to be used in certain contexts such as\n** with the WHERE clause of [partial indexes] or in [generated columns].\n** SQLite might also optimize deterministic functions by factoring them\n** out of inner loops.\n** </dd>\n**\n** [[SQLITE_DIRECTONLY]] <dt>SQLITE_DIRECTONLY</dt><dd>\n** The SQLITE_DIRECTONLY flag means that the function may only be invoked\n** from top-level SQL, and cannot be used in VIEWs or TRIGGERs nor in\n** schema structures such as [CHECK constraints], [DEFAULT clauses],\n** [expression indexes], [partial indexes], or [generated columns].\n** <p>\n** The SQLITE_DIRECTONLY flag is recommended for any\n** [application-defined SQL function]\n** that has side-effects or that could potentially leak sensitive information.\n** This will prevent attacks in which an application is tricked\n** into using a database file that has had its schema surreptitiously\n** modified to invoke the application-defined function in ways that are\n** harmful.\n** <p>\n** Some people say it is good practice to set SQLITE_DIRECTONLY on all\n** [application-defined SQL functions], regardless of whether or not they\n** are security sensitive, as doing so prevents those functions from being used\n** inside of the database schema, and thus ensures that the database\n** can be inspected and modified using generic tools (such as the [CLI])\n** that do not have access to the application-defined functions.\n** </dd>\n**\n** [[SQLITE_INNOCUOUS]] <dt>SQLITE_INNOCUOUS</dt><dd>\n** The SQLITE_INNOCUOUS flag means that the function is unlikely\n** to cause problems even if misused. An innocuous function should have\n** no side effects and should not depend on any values other than its\n** input parameters. The [abs|abs() function] is an example of an\n** innocuous function.\n** The [load_extension() SQL function] is not innocuous because of its\n** side effects.\n** <p> SQLITE_INNOCUOUS is similar to SQLITE_DETERMINISTIC, but is not\n** exactly the same. The [random|random() function] is an example of a\n** function that is innocuous but not deterministic.\n** <p>Some heightened security settings\n** ([SQLITE_DBCONFIG_TRUSTED_SCHEMA] and [PRAGMA trusted_schema=OFF])\n** disable the use of SQL functions inside views and triggers and in\n** schema structures such as [CHECK constraints], [DEFAULT clauses],\n** [expression indexes], [partial indexes], and [generated columns] unless\n** the function is tagged with SQLITE_INNOCUOUS. Most built-in functions\n** are innocuous. Developers are advised to avoid using the\n** SQLITE_INNOCUOUS flag for application-defined functions unless the\n** function has been carefully audited and found to be free of potentially\n** security-adverse side-effects and information-leaks.\n** </dd>\n**\n** [[SQLITE_SUBTYPE]] <dt>SQLITE_SUBTYPE</dt><dd>\n** The SQLITE_SUBTYPE flag indicates to SQLite that a function might call\n** [sqlite3_value_subtype()] to inspect the sub-types of its arguments.\n** This flag instructs SQLite to omit some corner-case optimizations that\n** might disrupt the operation of the [sqlite3_value_subtype()] function,\n** causing it to return zero rather than the correct subtype().\n** All SQL functions that invoke [sqlite3_value_subtype()] should have this\n** property. If the SQLITE_SUBTYPE property is omitted, then the return\n** value from [sqlite3_value_subtype()] might sometimes be zero even though\n** a non-zero subtype was specified by the function argument expression.\n**\n** [[SQLITE_RESULT_SUBTYPE]] <dt>SQLITE_RESULT_SUBTYPE</dt><dd>\n** The SQLITE_RESULT_SUBTYPE flag indicates to SQLite that a function might call\n** [sqlite3_result_subtype()] to cause a sub-type to be associated with its\n** result.\n** Every function that invokes [sqlite3_result_subtype()] should have this\n** property. If it does not, then the call to [sqlite3_result_subtype()]\n** might become a no-op if the function is used as term in an\n** [expression index]. On the other hand, SQL functions that never invoke\n** [sqlite3_result_subtype()] should avoid setting this property, as the\n** purpose of this property is to disable certain optimizations that are\n** incompatible with subtypes.\n**\n** [[SQLITE_SELFORDER1]] <dt>SQLITE_SELFORDER1</dt><dd>\n** The SQLITE_SELFORDER1 flag indicates that the function is an aggregate\n** that internally orders the values provided to the first argument. The\n** ordered-set aggregate SQL notation with a single ORDER BY term can be\n** used to invoke this function. If the ordered-set aggregate notation is\n** used on a function that lacks this flag, then an error is raised. Note\n** that the ordered-set aggregate syntax is only available if SQLite is\n** built using the -DSQLITE_ENABLE_ORDERED_SET_AGGREGATES compile-time option.\n** </dd>\n** </dl>\n*/\n#define SQLITE_DETERMINISTIC 0x000000800\n#define SQLITE_DIRECTONLY 0x000080000\n#define SQLITE_SUBTYPE 0x000100000\n#define SQLITE_INNOCUOUS 0x000200000\n#define SQLITE_RESULT_SUBTYPE 0x001000000\n#define SQLITE_SELFORDER1 0x002000000\n\n/*\n** CAPI3REF: Deprecated Functions\n** DEPRECATED\n**\n** These functions are [deprecated]. In order to maintain\n** backwards compatibility with older code, these functions continue\n** to be supported. However, new applications should avoid\n** the use of these functions. To encourage programmers to avoid\n** these functions, we will not explain what they do.\n*/\n#ifndef SQLITE_OMIT_DEPRECATED\nSQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*);\nSQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*);\nSQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);\nSQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void);\nSQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void);\nSQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),\n void*,sqlite3_int64);\n#endif\n\n/*\n** CAPI3REF: Obtaining SQL Values\n** METHOD: sqlite3_value\n**\n** <b>Summary:</b>\n** <blockquote><table border=0 cellpadding=0 cellspacing=0>\n** <tr><td><b>sqlite3_value_blob</b><td>→<td>BLOB value\n** <tr><td><b>sqlite3_value_double</b><td>→<td>REAL value\n** <tr><td><b>sqlite3_value_int</b><td>→<td>32-bit INTEGER value\n** <tr><td><b>sqlite3_value_int64</b><td>→<td>64-bit INTEGER value\n** <tr><td><b>sqlite3_value_pointer</b><td>→<td>Pointer value\n** <tr><td><b>sqlite3_value_text</b><td>→<td>UTF-8 TEXT value\n** <tr><td><b>sqlite3_value_text16</b><td>→<td>UTF-16 TEXT value in\n** the native byteorder\n** <tr><td><b>sqlite3_value_text16be</b><td>→<td>UTF-16be TEXT value\n** <tr><td><b>sqlite3_value_text16le</b><td>→<td>UTF-16le TEXT value\n** <tr><td> <td> <td> \n** <tr><td><b>sqlite3_value_bytes</b><td>→<td>Size of a BLOB\n** or a UTF-8 TEXT in bytes\n** <tr><td><b>sqlite3_value_bytes16 </b>\n** <td>→ <td>Size of UTF-16\n** TEXT in bytes\n** <tr><td><b>sqlite3_value_type</b><td>→<td>Default\n** datatype of the value\n** <tr><td><b>sqlite3_value_numeric_type </b>\n** <td>→ <td>Best numeric datatype of the value\n** <tr><td><b>sqlite3_value_nochange </b>\n** <td>→ <td>True if the column is unchanged in an UPDATE\n** against a virtual table.\n** <tr><td><b>sqlite3_value_frombind </b>\n** <td>→ <td>True if value originated from a [bound parameter]\n** </table></blockquote>\n**\n** <b>Details:</b>\n**\n** These routines extract type, size, and content information from\n** [protected sqlite3_value] objects. Protected sqlite3_value objects\n** are used to pass parameter information into the functions that\n** implement [application-defined SQL functions] and [virtual tables].\n**\n** These routines work only with [protected sqlite3_value] objects.\n** Any attempt to use these routines on an [unprotected sqlite3_value]\n** is not threadsafe.\n**\n** ^These routines work just like the corresponding [column access functions]\n** except that these routines take a single [protected sqlite3_value] object\n** pointer instead of a [sqlite3_stmt*] pointer and an integer column number.\n**\n** ^The sqlite3_value_text16() interface extracts a UTF-16 string\n** in the native byte-order of the host machine. ^The\n** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces\n** extract UTF-16 strings as big-endian and little-endian respectively.\n**\n** ^If [sqlite3_value] object V was initialized\n** using [sqlite3_bind_pointer(S,I,P,X,D)] or [sqlite3_result_pointer(C,P,X,D)]\n** and if X and Y are strings that compare equal according to strcmp(X,Y),\n** then sqlite3_value_pointer(V,Y) will return the pointer P. ^Otherwise,\n** sqlite3_value_pointer(V,Y) returns a NULL. The sqlite3_bind_pointer()\n** routine is part of the [pointer passing interface] added for SQLite 3.20.0.\n**\n** ^(The sqlite3_value_type(V) interface returns the\n** [SQLITE_INTEGER | datatype code] for the initial datatype of the\n** [sqlite3_value] object V. The returned value is one of [SQLITE_INTEGER],\n** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL].)^\n** Other interfaces might change the datatype for an sqlite3_value object.\n** For example, if the datatype is initially SQLITE_INTEGER and\n** sqlite3_value_text(V) is called to extract a text value for that\n** integer, then subsequent calls to sqlite3_value_type(V) might return\n** SQLITE_TEXT. Whether or not a persistent internal datatype conversion\n** occurs is undefined and may change from one release of SQLite to the next.\n**\n** ^(The sqlite3_value_numeric_type() interface attempts to apply\n** numeric affinity to the value. This means that an attempt is\n** made to convert the value to an integer or floating point. If\n** such a conversion is possible without loss of information (in other\n** words, if the value is a string that looks like a number)\n** then the conversion is performed. Otherwise no conversion occurs.\n** The [SQLITE_INTEGER | datatype] after conversion is returned.)^\n**\n** ^Within the [xUpdate] method of a [virtual table], the\n** sqlite3_value_nochange(X) interface returns true if and only if\n** the column corresponding to X is unchanged by the UPDATE operation\n** that the xUpdate method call was invoked to implement and if\n** and the prior [xColumn] method call that was invoked to extracted\n** the value for that column returned without setting a result (probably\n** because it queried [sqlite3_vtab_nochange()] and found that the column\n** was unchanging). ^Within an [xUpdate] method, any value for which\n** sqlite3_value_nochange(X) is true will in all other respects appear\n** to be a NULL value. If sqlite3_value_nochange(X) is invoked anywhere other\n** than within an [xUpdate] method call for an UPDATE statement, then\n** the return value is arbitrary and meaningless.\n**\n** ^The sqlite3_value_frombind(X) interface returns non-zero if the\n** value X originated from one of the [sqlite3_bind_int|sqlite3_bind()]\n** interfaces. ^If X comes from an SQL literal value, or a table column,\n** or an expression, then sqlite3_value_frombind(X) returns zero.\n**\n** Please pay particular attention to the fact that the pointer returned\n** from [sqlite3_value_blob()], [sqlite3_value_text()], or\n** [sqlite3_value_text16()] can be invalidated by a subsequent call to\n** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],\n** or [sqlite3_value_text16()].\n**\n** These routines must be called from the same thread as\n** the SQL function that supplied the [sqlite3_value*] parameters.\n**\n** As long as the input parameter is correct, these routines can only\n** fail if an out-of-memory error occurs during a format conversion.\n** Only the following subset of interfaces are subject to out-of-memory\n** errors:\n**\n** <ul>\n** <li> sqlite3_value_blob()\n** <li> sqlite3_value_text()\n** <li> sqlite3_value_text16()\n** <li> sqlite3_value_text16le()\n** <li> sqlite3_value_text16be()\n** <li> sqlite3_value_bytes()\n** <li> sqlite3_value_bytes16()\n** </ul>\n**\n** If an out-of-memory error occurs, then the return value from these\n** routines is the same as if the column had contained an SQL NULL value.\n** Valid SQL NULL returns can be distinguished from out-of-memory errors\n** by invoking the [sqlite3_errcode()] immediately after the suspect\n** return value is obtained and before any\n** other SQLite interface is called on the same [database connection].\n*/\nSQLITE_API const void *sqlite3_value_blob(sqlite3_value*);\nSQLITE_API double sqlite3_value_double(sqlite3_value*);\nSQLITE_API int sqlite3_value_int(sqlite3_value*);\nSQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*);\nSQLITE_API void *sqlite3_value_pointer(sqlite3_value*, const char*);\nSQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*);\nSQLITE_API const void *sqlite3_value_text16(sqlite3_value*);\nSQLITE_API const void *sqlite3_value_text16le(sqlite3_value*);\nSQLITE_API const void *sqlite3_value_text16be(sqlite3_value*);\nSQLITE_API int sqlite3_value_bytes(sqlite3_value*);\nSQLITE_API int sqlite3_value_bytes16(sqlite3_value*);\nSQLITE_API int sqlite3_value_type(sqlite3_value*);\nSQLITE_API int sqlite3_value_numeric_type(sqlite3_value*);\nSQLITE_API int sqlite3_value_nochange(sqlite3_value*);\nSQLITE_API int sqlite3_value_frombind(sqlite3_value*);\n\n/*\n** CAPI3REF: Report the internal text encoding state of an sqlite3_value object\n** METHOD: sqlite3_value\n**\n** ^(The sqlite3_value_encoding(X) interface returns one of [SQLITE_UTF8],\n** [SQLITE_UTF16BE], or [SQLITE_UTF16LE] according to the current text encoding\n** of the value X, assuming that X has type TEXT.)^ If sqlite3_value_type(X)\n** returns something other than SQLITE_TEXT, then the return value from\n** sqlite3_value_encoding(X) is meaningless. ^Calls to\n** [sqlite3_value_text(X)], [sqlite3_value_text16(X)], [sqlite3_value_text16be(X)],\n** [sqlite3_value_text16le(X)], [sqlite3_value_bytes(X)], or\n** [sqlite3_value_bytes16(X)] might change the encoding of the value X and\n** thus change the return from subsequent calls to sqlite3_value_encoding(X).\n**\n** This routine is intended for used by applications that test and validate\n** the SQLite implementation. This routine is inquiring about the opaque\n** internal state of an [sqlite3_value] object. Ordinary applications should\n** not need to know what the internal state of an sqlite3_value object is and\n** hence should not need to use this interface.\n*/\nSQLITE_API int sqlite3_value_encoding(sqlite3_value*);\n\n/*\n** CAPI3REF: Finding The Subtype Of SQL Values\n** METHOD: sqlite3_value\n**\n** The sqlite3_value_subtype(V) function returns the subtype for\n** an [application-defined SQL function] argument V. The subtype\n** information can be used to pass a limited amount of context from\n** one SQL function to another. Use the [sqlite3_result_subtype()]\n** routine to set the subtype for the return value of an SQL function.\n**\n** Every [application-defined SQL function] that invokes this interface\n** should include the [SQLITE_SUBTYPE] property in the text\n** encoding argument when the function is [sqlite3_create_function|registered].\n** If the [SQLITE_SUBTYPE] property is omitted, then sqlite3_value_subtype()\n** might return zero instead of the upstream subtype in some corner cases.\n*/\nSQLITE_API unsigned int sqlite3_value_subtype(sqlite3_value*);\n\n/*\n** CAPI3REF: Copy And Free SQL Values\n** METHOD: sqlite3_value\n**\n** ^The sqlite3_value_dup(V) interface makes a copy of the [sqlite3_value]\n** object D and returns a pointer to that copy. ^The [sqlite3_value] returned\n** is a [protected sqlite3_value] object even if the input is not.\n** ^The sqlite3_value_dup(V) interface returns NULL if V is NULL or if a\n** memory allocation fails. ^If V is a [pointer value], then the result\n** of sqlite3_value_dup(V) is a NULL value.\n**\n** ^The sqlite3_value_free(V) interface frees an [sqlite3_value] object\n** previously obtained from [sqlite3_value_dup()]. ^If V is a NULL pointer\n** then sqlite3_value_free(V) is a harmless no-op.\n*/\nSQLITE_API sqlite3_value *sqlite3_value_dup(const sqlite3_value*);\nSQLITE_API void sqlite3_value_free(sqlite3_value*);\n\n/*\n** CAPI3REF: Obtain Aggregate Function Context\n** METHOD: sqlite3_context\n**\n** Implementations of aggregate SQL functions use this\n** routine to allocate memory for storing their state.\n**\n** ^The first time the sqlite3_aggregate_context(C,N) routine is called\n** for a particular aggregate function, SQLite allocates\n** N bytes of memory, zeroes out that memory, and returns a pointer\n** to the new memory. ^On second and subsequent calls to\n** sqlite3_aggregate_context() for the same aggregate function instance,\n** the same buffer is returned. Sqlite3_aggregate_context() is normally\n** called once for each invocation of the xStep callback and then one\n** last time when the xFinal callback is invoked. ^(When no rows match\n** an aggregate query, the xStep() callback of the aggregate function\n** implementation is never called and xFinal() is called exactly once.\n** In those cases, sqlite3_aggregate_context() might be called for the\n** first time from within xFinal().)^\n**\n** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer\n** when first called if N is less than or equal to zero or if a memory\n** allocation error occurs.\n**\n** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is\n** determined by the N parameter on first successful call. Changing the\n** value of N in any subsequent call to sqlite3_aggregate_context() within\n** the same aggregate function instance will not resize the memory\n** allocation.)^ Within the xFinal callback, it is customary to set\n** N=0 in calls to sqlite3_aggregate_context(C,N) so that no\n** pointless memory allocations occur.\n**\n** ^SQLite automatically frees the memory allocated by\n** sqlite3_aggregate_context() when the aggregate query concludes.\n**\n** The first parameter must be a copy of the\n** [sqlite3_context | SQL function context] that is the first parameter\n** to the xStep or xFinal callback routine that implements the aggregate\n** function.\n**\n** This routine must be called from the same thread in which\n** the aggregate SQL function is running.\n*/\nSQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);\n\n/*\n** CAPI3REF: User Data For Functions\n** METHOD: sqlite3_context\n**\n** ^The sqlite3_user_data() interface returns a copy of\n** the pointer that was the pUserData parameter (the 5th parameter)\n** of the [sqlite3_create_function()]\n** and [sqlite3_create_function16()] routines that originally\n** registered the application defined function.\n**\n** This routine must be called from the same thread in which\n** the application-defined function is running.\n*/\nSQLITE_API void *sqlite3_user_data(sqlite3_context*);\n\n/*\n** CAPI3REF: Database Connection For Functions\n** METHOD: sqlite3_context\n**\n** ^The sqlite3_context_db_handle() interface returns a copy of\n** the pointer to the [database connection] (the 1st parameter)\n** of the [sqlite3_create_function()]\n** and [sqlite3_create_function16()] routines that originally\n** registered the application defined function.\n*/\nSQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*);\n\n/*\n** CAPI3REF: Function Auxiliary Data\n** METHOD: sqlite3_context\n**\n** These functions may be used by (non-aggregate) SQL functions to\n** associate auxiliary data with argument values. If the same argument\n** value is passed to multiple invocations of the same SQL function during\n** query execution, under some circumstances the associated auxiliary data\n** might be preserved. An example of where this might be useful is in a\n** regular-expression matching function. The compiled version of the regular\n** expression can be stored as auxiliary data associated with the pattern string.\n** Then as long as the pattern string remains the same,\n** the compiled regular expression can be reused on multiple\n** invocations of the same function.\n**\n** ^The sqlite3_get_auxdata(C,N) interface returns a pointer to the auxiliary data\n** associated by the sqlite3_set_auxdata(C,N,P,X) function with the Nth argument\n** value to the application-defined function. ^N is zero for the left-most\n** function argument. ^If there is no auxiliary data\n** associated with the function argument, the sqlite3_get_auxdata(C,N) interface\n** returns a NULL pointer.\n**\n** ^The sqlite3_set_auxdata(C,N,P,X) interface saves P as auxiliary data for the\n** N-th argument of the application-defined function. ^Subsequent\n** calls to sqlite3_get_auxdata(C,N) return P from the most recent\n** sqlite3_set_auxdata(C,N,P,X) call if the auxiliary data is still valid or\n** NULL if the auxiliary data has been discarded.\n** ^After each call to sqlite3_set_auxdata(C,N,P,X) where X is not NULL,\n** SQLite will invoke the destructor function X with parameter P exactly\n** once, when the auxiliary data is discarded.\n** SQLite is free to discard the auxiliary data at any time, including: <ul>\n** <li> ^(when the corresponding function parameter changes)^, or\n** <li> ^(when [sqlite3_reset()] or [sqlite3_finalize()] is called for the\n** SQL statement)^, or\n** <li> ^(when sqlite3_set_auxdata() is invoked again on the same\n** parameter)^, or\n** <li> ^(during the original sqlite3_set_auxdata() call when a memory\n** allocation error occurs.)^\n** <li> ^(during the original sqlite3_set_auxdata() call if the function\n** is evaluated during query planning instead of during query execution,\n** as sometimes happens with [SQLITE_ENABLE_STAT4].)^ </ul>\n**\n** Note the last two bullets in particular. The destructor X in\n** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the\n** sqlite3_set_auxdata() interface even returns. Hence sqlite3_set_auxdata()\n** should be called near the end of the function implementation and the\n** function implementation should not make any use of P after\n** sqlite3_set_auxdata() has been called. Furthermore, a call to\n** sqlite3_get_auxdata() that occurs immediately after a corresponding call\n** to sqlite3_set_auxdata() might still return NULL if an out-of-memory\n** condition occurred during the sqlite3_set_auxdata() call or if the\n** function is being evaluated during query planning rather than during\n** query execution.\n**\n** ^(In practice, auxiliary data is preserved between function calls for\n** function parameters that are compile-time constants, including literal\n** values and [parameters] and expressions composed from the same.)^\n**\n** The value of the N parameter to these interfaces should be non-negative.\n** Future enhancements may make use of negative N values to define new\n** kinds of function caching behavior.\n**\n** These routines must be called from the same thread in which\n** the SQL function is running.\n**\n** See also: [sqlite3_get_clientdata()] and [sqlite3_set_clientdata()].\n*/\nSQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N);\nSQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));\n\n/*\n** CAPI3REF: Database Connection Client Data\n** METHOD: sqlite3\n**\n** These functions are used to associate one or more named pointers\n** with a [database connection].\n** A call to sqlite3_set_clientdata(D,N,P,X) causes the pointer P\n** to be attached to [database connection] D using name N. Subsequent\n** calls to sqlite3_get_clientdata(D,N) will return a copy of pointer P\n** or a NULL pointer if there were no prior calls to\n** sqlite3_set_clientdata() with the same values of D and N.\n** Names are compared using strcmp() and are thus case sensitive.\n**\n** If P and X are both non-NULL, then the destructor X is invoked with\n** argument P on the first of the following occurrences:\n** <ul>\n** <li> An out-of-memory error occurs during the call to\n** sqlite3_set_clientdata() which attempts to register pointer P.\n** <li> A subsequent call to sqlite3_set_clientdata(D,N,P,X) is made\n** with the same D and N parameters.\n** <li> The database connection closes. SQLite does not make any guarantees\n** about the order in which destructors are called, only that all\n** destructors will be called exactly once at some point during the\n** database connection closing process.\n** </ul>\n**\n** SQLite does not do anything with client data other than invoke\n** destructors on the client data at the appropriate time. The intended\n** use for client data is to provide a mechanism for wrapper libraries\n** to store additional information about an SQLite database connection.\n**\n** There is no limit (other than available memory) on the number of different\n** client data pointers (with different names) that can be attached to a\n** single database connection. However, the implementation is optimized\n** for the case of having only one or two different client data names.\n** Applications and wrapper libraries are discouraged from using more than\n** one client data name each.\n**\n** There is no way to enumerate the client data pointers\n** associated with a database connection. The N parameter can be thought\n** of as a secret key such that only code that knows the secret key is able\n** to access the associated data.\n**\n** Security Warning: These interfaces should not be exposed in scripting\n** languages or in other circumstances where it might be possible for an\n** an attacker to invoke them. Any agent that can invoke these interfaces\n** can probably also take control of the process.\n**\n** Database connection client data is only available for SQLite\n** version 3.44.0 ([dateof:3.44.0]) and later.\n**\n** See also: [sqlite3_set_auxdata()] and [sqlite3_get_auxdata()].\n*/\nSQLITE_API void *sqlite3_get_clientdata(sqlite3*,const char*);\nSQLITE_API int sqlite3_set_clientdata(sqlite3*, const char*, void*, void(*)(void*));\n\n/*\n** CAPI3REF: Constants Defining Special Destructor Behavior\n**\n** These are special values for the destructor that is passed in as the\n** final argument to routines like [sqlite3_result_blob()]. ^If the destructor\n** argument is SQLITE_STATIC, it means that the content pointer is constant\n** and will never change. It does not need to be destroyed. ^The\n** SQLITE_TRANSIENT value means that the content will likely change in\n** the near future and that SQLite should make its own private copy of\n** the content before returning.\n**\n** The typedef is necessary to work around problems in certain\n** C++ compilers.\n*/\ntypedef void (*sqlite3_destructor_type)(void*);\n#define SQLITE_STATIC ((sqlite3_destructor_type)0)\n#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)\n\n/*\n** CAPI3REF: Setting The Result Of An SQL Function\n** METHOD: sqlite3_context\n**\n** These routines are used by the xFunc or xFinal callbacks that\n** implement SQL functions and aggregates. See\n** [sqlite3_create_function()] and [sqlite3_create_function16()]\n** for additional information.\n**\n** These functions work very much like the [parameter binding] family of\n** functions used to bind values to host parameters in prepared statements.\n** Refer to the [SQL parameter] documentation for additional information.\n**\n** ^The sqlite3_result_blob() interface sets the result from\n** an application-defined function to be the BLOB whose content is pointed\n** to by the second parameter and which is N bytes long where N is the\n** third parameter.\n**\n** ^The sqlite3_result_zeroblob(C,N) and sqlite3_result_zeroblob64(C,N)\n** interfaces set the result of the application-defined function to be\n** a BLOB containing all zero bytes and N bytes in size.\n**\n** ^The sqlite3_result_double() interface sets the result from\n** an application-defined function to be a floating point value specified\n** by its 2nd argument.\n**\n** ^The sqlite3_result_error() and sqlite3_result_error16() functions\n** cause the implemented SQL function to throw an exception.\n** ^SQLite uses the string pointed to by the\n** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()\n** as the text of an error message. ^SQLite interprets the error\n** message string from sqlite3_result_error() as UTF-8. ^SQLite\n** interprets the string from sqlite3_result_error16() as UTF-16 using\n** the same [byte-order determination rules] as [sqlite3_bind_text16()].\n** ^If the third parameter to sqlite3_result_error()\n** or sqlite3_result_error16() is negative then SQLite takes as the error\n** message all text up through the first zero character.\n** ^If the third parameter to sqlite3_result_error() or\n** sqlite3_result_error16() is non-negative then SQLite takes that many\n** bytes (not characters) from the 2nd parameter as the error message.\n** ^The sqlite3_result_error() and sqlite3_result_error16()\n** routines make a private copy of the error message text before\n** they return. Hence, the calling function can deallocate or\n** modify the text after they return without harm.\n** ^The sqlite3_result_error_code() function changes the error code\n** returned by SQLite as a result of an error in a function. ^By default,\n** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error()\n** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.\n**\n** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an\n** error indicating that a string or BLOB is too long to represent.\n**\n** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an\n** error indicating that a memory allocation failed.\n**\n** ^The sqlite3_result_int() interface sets the return value\n** of the application-defined function to be the 32-bit signed integer\n** value given in the 2nd argument.\n** ^The sqlite3_result_int64() interface sets the return value\n** of the application-defined function to be the 64-bit signed integer\n** value given in the 2nd argument.\n**\n** ^The sqlite3_result_null() interface sets the return value\n** of the application-defined function to be NULL.\n**\n** ^The sqlite3_result_text(), sqlite3_result_text16(),\n** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces\n** set the return value of the application-defined function to be\n** a text string which is represented as UTF-8, UTF-16 native byte order,\n** UTF-16 little endian, or UTF-16 big endian, respectively.\n** ^The sqlite3_result_text64() interface sets the return value of an\n** application-defined function to be a text string in an encoding\n** specified by the fifth (and last) parameter, which must be one\n** of [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE].\n** ^SQLite takes the text result from the application from\n** the 2nd parameter of the sqlite3_result_text* interfaces.\n** ^If the 3rd parameter to any of the sqlite3_result_text* interfaces\n** other than sqlite3_result_text64() is negative, then SQLite computes\n** the string length itself by searching the 2nd parameter for the first\n** zero character.\n** ^If the 3rd parameter to the sqlite3_result_text* interfaces\n** is non-negative, then as many bytes (not characters) of the text\n** pointed to by the 2nd parameter are taken as the application-defined\n** function result. If the 3rd parameter is non-negative, then it\n** must be the byte offset into the string where the NUL terminator would\n** appear if the string where NUL terminated. If any NUL characters occur\n** in the string at a byte offset that is less than the value of the 3rd\n** parameter, then the resulting string will contain embedded NULs and the\n** result of expressions operating on strings with embedded NULs is undefined.\n** ^If the 4th parameter to the sqlite3_result_text* interfaces\n** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that\n** function as the destructor on the text or BLOB result when it has\n** finished using that result.\n** ^If the 4th parameter to the sqlite3_result_text* interfaces or to\n** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite\n** assumes that the text or BLOB result is in constant space and does not\n** copy the content of the parameter nor call a destructor on the content\n** when it has finished using that result.\n** ^If the 4th parameter to the sqlite3_result_text* interfaces\n** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT\n** then SQLite makes a copy of the result into space obtained\n** from [sqlite3_malloc()] before it returns.\n**\n** ^For the sqlite3_result_text16(), sqlite3_result_text16le(), and\n** sqlite3_result_text16be() routines, and for sqlite3_result_text64()\n** when the encoding is not UTF8, if the input UTF16 begins with a\n** byte-order mark (BOM, U+FEFF) then the BOM is removed from the\n** string and the rest of the string is interpreted according to the\n** byte-order specified by the BOM. ^The byte-order specified by\n** the BOM at the beginning of the text overrides the byte-order\n** specified by the interface procedure. ^So, for example, if\n** sqlite3_result_text16le() is invoked with text that begins\n** with bytes 0xfe, 0xff (a big-endian byte-order mark) then the\n** first two bytes of input are skipped and the remaining input\n** is interpreted as UTF16BE text.\n**\n** ^For UTF16 input text to the sqlite3_result_text16(),\n** sqlite3_result_text16be(), sqlite3_result_text16le(), and\n** sqlite3_result_text64() routines, if the text contains invalid\n** UTF16 characters, the invalid characters might be converted\n** into the unicode replacement character, U+FFFD.\n**\n** ^The sqlite3_result_value() interface sets the result of\n** the application-defined function to be a copy of the\n** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The\n** sqlite3_result_value() interface makes a copy of the [sqlite3_value]\n** so that the [sqlite3_value] specified in the parameter may change or\n** be deallocated after sqlite3_result_value() returns without harm.\n** ^A [protected sqlite3_value] object may always be used where an\n** [unprotected sqlite3_value] object is required, so either\n** kind of [sqlite3_value] object can be used with this interface.\n**\n** ^The sqlite3_result_pointer(C,P,T,D) interface sets the result to an\n** SQL NULL value, just like [sqlite3_result_null(C)], except that it\n** also associates the host-language pointer P or type T with that\n** NULL value such that the pointer can be retrieved within an\n** [application-defined SQL function] using [sqlite3_value_pointer()].\n** ^If the D parameter is not NULL, then it is a pointer to a destructor\n** for the P parameter. ^SQLite invokes D with P as its only argument\n** when SQLite is finished with P. The T parameter should be a static\n** string and preferably a string literal. The sqlite3_result_pointer()\n** routine is part of the [pointer passing interface] added for SQLite 3.20.0.\n**\n** If these routines are called from within the different thread\n** than the one containing the application-defined function that received\n** the [sqlite3_context] pointer, the results are undefined.\n*/\nSQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));\nSQLITE_API void sqlite3_result_blob64(sqlite3_context*,const void*,\n sqlite3_uint64,void(*)(void*));\nSQLITE_API void sqlite3_result_double(sqlite3_context*, double);\nSQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int);\nSQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int);\nSQLITE_API void sqlite3_result_error_toobig(sqlite3_context*);\nSQLITE_API void sqlite3_result_error_nomem(sqlite3_context*);\nSQLITE_API void sqlite3_result_error_code(sqlite3_context*, int);\nSQLITE_API void sqlite3_result_int(sqlite3_context*, int);\nSQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);\nSQLITE_API void sqlite3_result_null(sqlite3_context*);\nSQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));\nSQLITE_API void sqlite3_result_text64(sqlite3_context*, const char*,sqlite3_uint64,\n void(*)(void*), unsigned char encoding);\nSQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));\nSQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));\nSQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));\nSQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*);\nSQLITE_API void sqlite3_result_pointer(sqlite3_context*, void*,const char*,void(*)(void*));\nSQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n);\nSQLITE_API int sqlite3_result_zeroblob64(sqlite3_context*, sqlite3_uint64 n);\n\n\n/*\n** CAPI3REF: Setting The Subtype Of An SQL Function\n** METHOD: sqlite3_context\n**\n** The sqlite3_result_subtype(C,T) function causes the subtype of\n** the result from the [application-defined SQL function] with\n** [sqlite3_context] C to be the value T. Only the lower 8 bits\n** of the subtype T are preserved in current versions of SQLite;\n** higher order bits are discarded.\n** The number of subtype bytes preserved by SQLite might increase\n** in future releases of SQLite.\n**\n** Every [application-defined SQL function] that invokes this interface\n** should include the [SQLITE_RESULT_SUBTYPE] property in its\n** text encoding argument when the SQL function is\n** [sqlite3_create_function|registered]. If the [SQLITE_RESULT_SUBTYPE]\n** property is omitted from the function that invokes sqlite3_result_subtype(),\n** then in some cases the sqlite3_result_subtype() might fail to set\n** the result subtype.\n**\n** If SQLite is compiled with -DSQLITE_STRICT_SUBTYPE=1, then any\n** SQL function that invokes the sqlite3_result_subtype() interface\n** and that does not have the SQLITE_RESULT_SUBTYPE property will raise\n** an error. Future versions of SQLite might enable -DSQLITE_STRICT_SUBTYPE=1\n** by default.\n*/\nSQLITE_API void sqlite3_result_subtype(sqlite3_context*,unsigned int);\n\n/*\n** CAPI3REF: Define New Collating Sequences\n** METHOD: sqlite3\n**\n** ^These functions add, remove, or modify a [collation] associated\n** with the [database connection] specified as the first argument.\n**\n** ^The name of the collation is a UTF-8 string\n** for sqlite3_create_collation() and sqlite3_create_collation_v2()\n** and a UTF-16 string in native byte order for sqlite3_create_collation16().\n** ^Collation names that compare equal according to [sqlite3_strnicmp()] are\n** considered to be the same name.\n**\n** ^(The third argument (eTextRep) must be one of the constants:\n** <ul>\n** <li> [SQLITE_UTF8],\n** <li> [SQLITE_UTF16LE],\n** <li> [SQLITE_UTF16BE],\n** <li> [SQLITE_UTF16], or\n** <li> [SQLITE_UTF16_ALIGNED].\n** </ul>)^\n** ^The eTextRep argument determines the encoding of strings passed\n** to the collating function callback, xCompare.\n** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep\n** force strings to be UTF16 with native byte order.\n** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin\n** on an even byte address.\n**\n** ^The fourth argument, pArg, is an application data pointer that is passed\n** through as the first argument to the collating function callback.\n**\n** ^The fifth argument, xCompare, is a pointer to the collating function.\n** ^Multiple collating functions can be registered using the same name but\n** with different eTextRep parameters and SQLite will use whichever\n** function requires the least amount of data transformation.\n** ^If the xCompare argument is NULL then the collating function is\n** deleted. ^When all collating functions having the same name are deleted,\n** that collation is no longer usable.\n**\n** ^The collating function callback is invoked with a copy of the pArg\n** application data pointer and with two strings in the encoding specified\n** by the eTextRep argument. The two integer parameters to the collating\n** function callback are the length of the two strings, in bytes. The collating\n** function must return an integer that is negative, zero, or positive\n** if the first string is less than, equal to, or greater than the second,\n** respectively. A collating function must always return the same answer\n** given the same inputs. If two or more collating functions are registered\n** to the same collation name (using different eTextRep values) then all\n** must give an equivalent answer when invoked with equivalent strings.\n** The collating function must obey the following properties for all\n** strings A, B, and C:\n**\n** <ol>\n** <li> If A==B then B==A.\n** <li> If A==B and B==C then A==C.\n** <li> If A<B THEN B>A.\n** <li> If A<B and B<C then A<C.\n** </ol>\n**\n** If a collating function fails any of the above constraints and that\n** collating function is registered and used, then the behavior of SQLite\n** is undefined.\n**\n** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation()\n** with the addition that the xDestroy callback is invoked on pArg when\n** the collating function is deleted.\n** ^Collating functions are deleted when they are overridden by later\n** calls to the collation creation functions or when the\n** [database connection] is closed using [sqlite3_close()].\n**\n** ^The xDestroy callback is <u>not</u> called if the\n** sqlite3_create_collation_v2() function fails. Applications that invoke\n** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should\n** check the return code and dispose of the application data pointer\n** themselves rather than expecting SQLite to deal with it for them.\n** This is different from every other SQLite interface. The inconsistency\n** is unfortunate but cannot be changed without breaking backwards\n** compatibility.\n**\n** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()].\n*/\nSQLITE_API int sqlite3_create_collation(\n sqlite3*,\n const char *zName,\n int eTextRep,\n void *pArg,\n int(*xCompare)(void*,int,const void*,int,const void*)\n);\nSQLITE_API int sqlite3_create_collation_v2(\n sqlite3*,\n const char *zName,\n int eTextRep,\n void *pArg,\n int(*xCompare)(void*,int,const void*,int,const void*),\n void(*xDestroy)(void*)\n);\nSQLITE_API int sqlite3_create_collation16(\n sqlite3*,\n const void *zName,\n int eTextRep,\n void *pArg,\n int(*xCompare)(void*,int,const void*,int,const void*)\n);\n\n/*\n** CAPI3REF: Collation Needed Callbacks\n** METHOD: sqlite3\n**\n** ^To avoid having to register all collation sequences before a database\n** can be used, a single callback function may be registered with the\n** [database connection] to be invoked whenever an undefined collation\n** sequence is required.\n**\n** ^If the function is registered using the sqlite3_collation_needed() API,\n** then it is passed the names of undefined collation sequences as strings\n** encoded in UTF-8. ^If sqlite3_collation_needed16() is used,\n** the names are passed as UTF-16 in machine native byte order.\n** ^A call to either function replaces the existing collation-needed callback.\n**\n** ^(When the callback is invoked, the first argument passed is a copy\n** of the second argument to sqlite3_collation_needed() or\n** sqlite3_collation_needed16(). The second argument is the database\n** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE],\n** or [SQLITE_UTF16LE], indicating the most desirable form of the collation\n** sequence function required. The fourth parameter is the name of the\n** required collation sequence.)^\n**\n** The callback function should register the desired collation using\n** [sqlite3_create_collation()], [sqlite3_create_collation16()], or\n** [sqlite3_create_collation_v2()].\n*/\nSQLITE_API int sqlite3_collation_needed(\n sqlite3*,\n void*,\n void(*)(void*,sqlite3*,int eTextRep,const char*)\n);\nSQLITE_API int sqlite3_collation_needed16(\n sqlite3*,\n void*,\n void(*)(void*,sqlite3*,int eTextRep,const void*)\n);\n\n#ifdef SQLITE_ENABLE_CEROD\n/*\n** Specify the activation key for a CEROD database. Unless\n** activated, none of the CEROD routines will work.\n*/\nSQLITE_API void sqlite3_activate_cerod(\n const char *zPassPhrase /* Activation phrase */\n);\n#endif\n\n/*\n** CAPI3REF: Suspend Execution For A Short Time\n**\n** The sqlite3_sleep() function causes the current thread to suspend execution\n** for at least a number of milliseconds specified in its parameter.\n**\n** If the operating system does not support sleep requests with\n** millisecond time resolution, then the time will be rounded up to\n** the nearest second. The number of milliseconds of sleep actually\n** requested from the operating system is returned.\n**\n** ^SQLite implements this interface by calling the xSleep()\n** method of the default [sqlite3_vfs] object. If the xSleep() method\n** of the default VFS is not implemented correctly, or not implemented at\n** all, then the behavior of sqlite3_sleep() may deviate from the description\n** in the previous paragraphs.\n**\n** If a negative argument is passed to sqlite3_sleep() the results vary by\n** VFS and operating system. Some system treat a negative argument as an\n** instruction to sleep forever. Others understand it to mean do not sleep\n** at all. ^In SQLite version 3.42.0 and later, a negative\n** argument passed into sqlite3_sleep() is changed to zero before it is relayed\n** down into the xSleep method of the VFS.\n*/\nSQLITE_API int sqlite3_sleep(int);\n\n/*\n** CAPI3REF: Name Of The Folder Holding Temporary Files\n**\n** ^(If this global variable is made to point to a string which is\n** the name of a folder (a.k.a. directory), then all temporary files\n** created by SQLite when using a built-in [sqlite3_vfs | VFS]\n** will be placed in that directory.)^ ^If this variable\n** is a NULL pointer, then SQLite performs a search for an appropriate\n** temporary file directory.\n**\n** Applications are strongly discouraged from using this global variable.\n** It is required to set a temporary folder on Windows Runtime (WinRT).\n** But for all other platforms, it is highly recommended that applications\n** neither read nor write this variable. This global variable is a relic\n** that exists for backwards compatibility of legacy applications and should\n** be avoided in new projects.\n**\n** It is not safe to read or modify this variable in more than one\n** thread at a time. It is not safe to read or modify this variable\n** if a [database connection] is being used at the same time in a separate\n** thread.\n** It is intended that this variable be set once\n** as part of process initialization and before any SQLite interface\n** routines have been called and that this variable remain unchanged\n** thereafter.\n**\n** ^The [temp_store_directory pragma] may modify this variable and cause\n** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,\n** the [temp_store_directory pragma] always assumes that any string\n** that this variable points to is held in memory obtained from\n** [sqlite3_malloc] and the pragma may attempt to free that memory\n** using [sqlite3_free].\n** Hence, if this variable is modified directly, either it should be\n** made NULL or made to point to memory obtained from [sqlite3_malloc]\n** or else the use of the [temp_store_directory pragma] should be avoided.\n** Except when requested by the [temp_store_directory pragma], SQLite\n** does not free the memory that sqlite3_temp_directory points to. If\n** the application wants that memory to be freed, it must do\n** so itself, taking care to only do so after all [database connection]\n** objects have been destroyed.\n**\n** <b>Note to Windows Runtime users:</b> The temporary directory must be set\n** prior to calling [sqlite3_open] or [sqlite3_open_v2]. Otherwise, various\n** features that require the use of temporary files may fail. Here is an\n** example of how to do this using C++ with the Windows Runtime:\n**\n** <blockquote><pre>\n** LPCWSTR zPath = Windows::Storage::ApplicationData::Current->\n** TemporaryFolder->Path->Data();\n** char zPathBuf[MAX_PATH + 1];\n** memset(zPathBuf, 0, sizeof(zPathBuf));\n** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf),\n** NULL, NULL);\n** sqlite3_temp_directory = sqlite3_mprintf(\"%s\", zPathBuf);\n** </pre></blockquote>\n*/\nSQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory;\n\n/*\n** CAPI3REF: Name Of The Folder Holding Database Files\n**\n** ^(If this global variable is made to point to a string which is\n** the name of a folder (a.k.a. directory), then all database files\n** specified with a relative pathname and created or accessed by\n** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed\n** to be relative to that directory.)^ ^If this variable is a NULL\n** pointer, then SQLite assumes that all database files specified\n** with a relative pathname are relative to the current directory\n** for the process. Only the windows VFS makes use of this global\n** variable; it is ignored by the unix VFS.\n**\n** Changing the value of this variable while a database connection is\n** open can result in a corrupt database.\n**\n** It is not safe to read or modify this variable in more than one\n** thread at a time. It is not safe to read or modify this variable\n** if a [database connection] is being used at the same time in a separate\n** thread.\n** It is intended that this variable be set once\n** as part of process initialization and before any SQLite interface\n** routines have been called and that this variable remain unchanged\n** thereafter.\n**\n** ^The [data_store_directory pragma] may modify this variable and cause\n** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,\n** the [data_store_directory pragma] always assumes that any string\n** that this variable points to is held in memory obtained from\n** [sqlite3_malloc] and the pragma may attempt to free that memory\n** using [sqlite3_free].\n** Hence, if this variable is modified directly, either it should be\n** made NULL or made to point to memory obtained from [sqlite3_malloc]\n** or else the use of the [data_store_directory pragma] should be avoided.\n*/\nSQLITE_API SQLITE_EXTERN char *sqlite3_data_directory;\n\n/*\n** CAPI3REF: Win32 Specific Interface\n**\n** These interfaces are available only on Windows. The\n** [sqlite3_win32_set_directory] interface is used to set the value associated\n** with the [sqlite3_temp_directory] or [sqlite3_data_directory] variable, to\n** zValue, depending on the value of the type parameter. The zValue parameter\n** should be NULL to cause the previous value to be freed via [sqlite3_free];\n** a non-NULL value will be copied into memory obtained from [sqlite3_malloc]\n** prior to being used. The [sqlite3_win32_set_directory] interface returns\n** [SQLITE_OK] to indicate success, [SQLITE_ERROR] if the type is unsupported,\n** or [SQLITE_NOMEM] if memory could not be allocated. The value of the\n** [sqlite3_data_directory] variable is intended to act as a replacement for\n** the current directory on the sub-platforms of Win32 where that concept is\n** not present, e.g. WinRT and UWP. The [sqlite3_win32_set_directory8] and\n** [sqlite3_win32_set_directory16] interfaces behave exactly the same as the\n** sqlite3_win32_set_directory interface except the string parameter must be\n** UTF-8 or UTF-16, respectively.\n*/\nSQLITE_API int sqlite3_win32_set_directory(\n unsigned long type, /* Identifier for directory being set or reset */\n void *zValue /* New value for directory being set or reset */\n);\nSQLITE_API int sqlite3_win32_set_directory8(unsigned long type, const char *zValue);\nSQLITE_API int sqlite3_win32_set_directory16(unsigned long type, const void *zValue);\n\n/*\n** CAPI3REF: Win32 Directory Types\n**\n** These macros are only available on Windows. They define the allowed values\n** for the type argument to the [sqlite3_win32_set_directory] interface.\n*/\n#define SQLITE_WIN32_DATA_DIRECTORY_TYPE 1\n#define SQLITE_WIN32_TEMP_DIRECTORY_TYPE 2\n\n/*\n** CAPI3REF: Test For Auto-Commit Mode\n** KEYWORDS: {autocommit mode}\n** METHOD: sqlite3\n**\n** ^The sqlite3_get_autocommit() interface returns non-zero or\n** zero if the given database connection is or is not in autocommit mode,\n** respectively. ^Autocommit mode is on by default.\n** ^Autocommit mode is disabled by a [BEGIN] statement.\n** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].\n**\n** If certain kinds of errors occur on a statement within a multi-statement\n** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR],\n** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the\n** transaction might be rolled back automatically. The only way to\n** find out whether SQLite automatically rolled back the transaction after\n** an error is to use this function.\n**\n** If another thread changes the autocommit status of the database\n** connection while this routine is running, then the return value\n** is undefined.\n*/\nSQLITE_API int sqlite3_get_autocommit(sqlite3*);\n\n/*\n** CAPI3REF: Find The Database Handle Of A Prepared Statement\n** METHOD: sqlite3_stmt\n**\n** ^The sqlite3_db_handle interface returns the [database connection] handle\n** to which a [prepared statement] belongs. ^The [database connection]\n** returned by sqlite3_db_handle is the same [database connection]\n** that was the first argument\n** to the [sqlite3_prepare_v2()] call (or its variants) that was used to\n** create the statement in the first place.\n*/\nSQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*);\n\n/*\n** CAPI3REF: Return The Schema Name For A Database Connection\n** METHOD: sqlite3\n**\n** ^The sqlite3_db_name(D,N) interface returns a pointer to the schema name\n** for the N-th database on database connection D, or a NULL pointer of N is\n** out of range. An N value of 0 means the main database file. An N of 1 is\n** the \"temp\" schema. Larger values of N correspond to various ATTACH-ed\n** databases.\n**\n** Space to hold the string that is returned by sqlite3_db_name() is managed\n** by SQLite itself. The string might be deallocated by any operation that\n** changes the schema, including [ATTACH] or [DETACH] or calls to\n** [sqlite3_serialize()] or [sqlite3_deserialize()], even operations that\n** occur on a different thread. Applications that need to\n** remember the string long-term should make their own copy. Applications that\n** are accessing the same database connection simultaneously on multiple\n** threads should mutex-protect calls to this API and should make their own\n** private copy of the result prior to releasing the mutex.\n*/\nSQLITE_API const char *sqlite3_db_name(sqlite3 *db, int N);\n\n/*\n** CAPI3REF: Return The Filename For A Database Connection\n** METHOD: sqlite3\n**\n** ^The sqlite3_db_filename(D,N) interface returns a pointer to the filename\n** associated with database N of connection D.\n** ^If there is no attached database N on the database\n** connection D, or if database N is a temporary or in-memory database, then\n** this function will return either a NULL pointer or an empty string.\n**\n** ^The string value returned by this routine is owned and managed by\n** the database connection. ^The value will be valid until the database N\n** is [DETACH]-ed or until the database connection closes.\n**\n** ^The filename returned by this function is the output of the\n** xFullPathname method of the [VFS]. ^In other words, the filename\n** will be an absolute pathname, even if the filename used\n** to open the database originally was a URI or relative pathname.\n**\n** If the filename pointer returned by this routine is not NULL, then it\n** can be used as the filename input parameter to these routines:\n** <ul>\n** <li> [sqlite3_uri_parameter()]\n** <li> [sqlite3_uri_boolean()]\n** <li> [sqlite3_uri_int64()]\n** <li> [sqlite3_filename_database()]\n** <li> [sqlite3_filename_journal()]\n** <li> [sqlite3_filename_wal()]\n** </ul>\n*/\nSQLITE_API sqlite3_filename sqlite3_db_filename(sqlite3 *db, const char *zDbName);\n\n/*\n** CAPI3REF: Determine if a database is read-only\n** METHOD: sqlite3\n**\n** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N\n** of connection D is read-only, 0 if it is read/write, or -1 if N is not\n** the name of a database on connection D.\n*/\nSQLITE_API int sqlite3_db_readonly(sqlite3 *db, const char *zDbName);\n\n/*\n** CAPI3REF: Determine the transaction state of a database\n** METHOD: sqlite3\n**\n** ^The sqlite3_txn_state(D,S) interface returns the current\n** [transaction state] of schema S in database connection D. ^If S is NULL,\n** then the highest transaction state of any schema on database connection D\n** is returned. Transaction states are (in order of lowest to highest):\n** <ol>\n** <li value=\"0\"> SQLITE_TXN_NONE\n** <li value=\"1\"> SQLITE_TXN_READ\n** <li value=\"2\"> SQLITE_TXN_WRITE\n** </ol>\n** ^If the S argument to sqlite3_txn_state(D,S) is not the name of\n** a valid schema, then -1 is returned.\n*/\nSQLITE_API int sqlite3_txn_state(sqlite3*,const char *zSchema);\n\n/*\n** CAPI3REF: Allowed return values from sqlite3_txn_state()\n** KEYWORDS: {transaction state}\n**\n** These constants define the current transaction state of a database file.\n** ^The [sqlite3_txn_state(D,S)] interface returns one of these\n** constants in order to describe the transaction state of schema S\n** in [database connection] D.\n**\n** <dl>\n** [[SQLITE_TXN_NONE]] <dt>SQLITE_TXN_NONE</dt>\n** <dd>The SQLITE_TXN_NONE state means that no transaction is currently\n** pending.</dd>\n**\n** [[SQLITE_TXN_READ]] <dt>SQLITE_TXN_READ</dt>\n** <dd>The SQLITE_TXN_READ state means that the database is currently\n** in a read transaction. Content has been read from the database file\n** but nothing in the database file has changed. The transaction state\n** will advanced to SQLITE_TXN_WRITE if any changes occur and there are\n** no other conflicting concurrent write transactions. The transaction\n** state will revert to SQLITE_TXN_NONE following a [ROLLBACK] or\n** [COMMIT].</dd>\n**\n** [[SQLITE_TXN_WRITE]] <dt>SQLITE_TXN_WRITE</dt>\n** <dd>The SQLITE_TXN_WRITE state means that the database is currently\n** in a write transaction. Content has been written to the database file\n** but has not yet committed. The transaction state will change to\n** to SQLITE_TXN_NONE at the next [ROLLBACK] or [COMMIT].</dd>\n*/\n#define SQLITE_TXN_NONE 0\n#define SQLITE_TXN_READ 1\n#define SQLITE_TXN_WRITE 2\n\n/*\n** CAPI3REF: Find the next prepared statement\n** METHOD: sqlite3\n**\n** ^This interface returns a pointer to the next [prepared statement] after\n** pStmt associated with the [database connection] pDb. ^If pStmt is NULL\n** then this interface returns a pointer to the first prepared statement\n** associated with the database connection pDb. ^If no prepared statement\n** satisfies the conditions of this routine, it returns NULL.\n**\n** The [database connection] pointer D in a call to\n** [sqlite3_next_stmt(D,S)] must refer to an open database\n** connection and in particular must not be a NULL pointer.\n*/\nSQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt);\n\n/*\n** CAPI3REF: Commit And Rollback Notification Callbacks\n** METHOD: sqlite3\n**\n** ^The sqlite3_commit_hook() interface registers a callback\n** function to be invoked whenever a transaction is [COMMIT | committed].\n** ^Any callback set by a previous call to sqlite3_commit_hook()\n** for the same database connection is overridden.\n** ^The sqlite3_rollback_hook() interface registers a callback\n** function to be invoked whenever a transaction is [ROLLBACK | rolled back].\n** ^Any callback set by a previous call to sqlite3_rollback_hook()\n** for the same database connection is overridden.\n** ^The pArg argument is passed through to the callback.\n** ^If the callback on a commit hook function returns non-zero,\n** then the commit is converted into a rollback.\n**\n** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions\n** return the P argument from the previous call of the same function\n** on the same [database connection] D, or NULL for\n** the first call for each function on D.\n**\n** The commit and rollback hook callbacks are not reentrant.\n** The callback implementation must not do anything that will modify\n** the database connection that invoked the callback. Any actions\n** to modify the database connection must be deferred until after the\n** completion of the [sqlite3_step()] call that triggered the commit\n** or rollback hook in the first place.\n** Note that running any other SQL statements, including SELECT statements,\n** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify\n** the database connections for the meaning of \"modify\" in this paragraph.\n**\n** ^Registering a NULL function disables the callback.\n**\n** ^When the commit hook callback routine returns zero, the [COMMIT]\n** operation is allowed to continue normally. ^If the commit hook\n** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].\n** ^The rollback hook is invoked on a rollback that results from a commit\n** hook returning non-zero, just as it would be with any other rollback.\n**\n** ^For the purposes of this API, a transaction is said to have been\n** rolled back if an explicit \"ROLLBACK\" statement is executed, or\n** an error or constraint causes an implicit rollback to occur.\n** ^The rollback callback is not invoked if a transaction is\n** automatically rolled back because the database connection is closed.\n**\n** See also the [sqlite3_update_hook()] interface.\n*/\nSQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);\nSQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);\n\n/*\n** CAPI3REF: Autovacuum Compaction Amount Callback\n** METHOD: sqlite3\n**\n** ^The sqlite3_autovacuum_pages(D,C,P,X) interface registers a callback\n** function C that is invoked prior to each autovacuum of the database\n** file. ^The callback is passed a copy of the generic data pointer (P),\n** the schema-name of the attached database that is being autovacuumed,\n** the size of the database file in pages, the number of free pages,\n** and the number of bytes per page, respectively. The callback should\n** return the number of free pages that should be removed by the\n** autovacuum. ^If the callback returns zero, then no autovacuum happens.\n** ^If the value returned is greater than or equal to the number of\n** free pages, then a complete autovacuum happens.\n**\n** <p>^If there are multiple ATTACH-ed database files that are being\n** modified as part of a transaction commit, then the autovacuum pages\n** callback is invoked separately for each file.\n**\n** <p><b>The callback is not reentrant.</b> The callback function should\n** not attempt to invoke any other SQLite interface. If it does, bad\n** things may happen, including segmentation faults and corrupt database\n** files. The callback function should be a simple function that\n** does some arithmetic on its input parameters and returns a result.\n**\n** ^The X parameter to sqlite3_autovacuum_pages(D,C,P,X) is an optional\n** destructor for the P parameter. ^If X is not NULL, then X(P) is\n** invoked whenever the database connection closes or when the callback\n** is overwritten by another invocation of sqlite3_autovacuum_pages().\n**\n** <p>^There is only one autovacuum pages callback per database connection.\n** ^Each call to the sqlite3_autovacuum_pages() interface overrides all\n** previous invocations for that database connection. ^If the callback\n** argument (C) to sqlite3_autovacuum_pages(D,C,P,X) is a NULL pointer,\n** then the autovacuum steps callback is canceled. The return value\n** from sqlite3_autovacuum_pages() is normally SQLITE_OK, but might\n** be some other error code if something goes wrong. The current\n** implementation will only return SQLITE_OK or SQLITE_MISUSE, but other\n** return codes might be added in future releases.\n**\n** <p>If no autovacuum pages callback is specified (the usual case) or\n** a NULL pointer is provided for the callback,\n** then the default behavior is to vacuum all free pages. So, in other\n** words, the default behavior is the same as if the callback function\n** were something like this:\n**\n** <blockquote><pre>\n** unsigned int demonstration_autovac_pages_callback(\n** void *pClientData,\n** const char *zSchema,\n** unsigned int nDbPage,\n** unsigned int nFreePage,\n** unsigned int nBytePerPage\n** ){\n** return nFreePage;\n** }\n** </pre></blockquote>\n*/\nSQLITE_API int sqlite3_autovacuum_pages(\n sqlite3 *db,\n unsigned int(*)(void*,const char*,unsigned int,unsigned int,unsigned int),\n void*,\n void(*)(void*)\n);\n\n\n/*\n** CAPI3REF: Data Change Notification Callbacks\n** METHOD: sqlite3\n**\n** ^The sqlite3_update_hook() interface registers a callback function\n** with the [database connection] identified by the first argument\n** to be invoked whenever a row is updated, inserted or deleted in\n** a [rowid table].\n** ^Any callback set by a previous call to this function\n** for the same database connection is overridden.\n**\n** ^The second argument is a pointer to the function to invoke when a\n** row is updated, inserted or deleted in a rowid table.\n** ^The first argument to the callback is a copy of the third argument\n** to sqlite3_update_hook().\n** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],\n** or [SQLITE_UPDATE], depending on the operation that caused the callback\n** to be invoked.\n** ^The third and fourth arguments to the callback contain pointers to the\n** database and table name containing the affected row.\n** ^The final callback parameter is the [rowid] of the row.\n** ^In the case of an update, this is the [rowid] after the update takes place.\n**\n** ^(The update hook is not invoked when internal system tables are\n** modified (i.e. sqlite_sequence).)^\n** ^The update hook is not invoked when [WITHOUT ROWID] tables are modified.\n**\n** ^In the current implementation, the update hook\n** is not invoked when conflicting rows are deleted because of an\n** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook\n** invoked when rows are deleted using the [truncate optimization].\n** The exceptions defined in this paragraph might change in a future\n** release of SQLite.\n**\n** Whether the update hook is invoked before or after the\n** corresponding change is currently unspecified and may differ\n** depending on the type of change. Do not rely on the order of the\n** hook call with regards to the final result of the operation which\n** triggers the hook.\n**\n** The update hook implementation must not do anything that will modify\n** the database connection that invoked the update hook. Any actions\n** to modify the database connection must be deferred until after the\n** completion of the [sqlite3_step()] call that triggered the update hook.\n** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their\n** database connections for the meaning of \"modify\" in this paragraph.\n**\n** ^The sqlite3_update_hook(D,C,P) function\n** returns the P argument from the previous call\n** on the same [database connection] D, or NULL for\n** the first call on D.\n**\n** See also the [sqlite3_commit_hook()], [sqlite3_rollback_hook()],\n** and [sqlite3_preupdate_hook()] interfaces.\n*/\nSQLITE_API void *sqlite3_update_hook(\n sqlite3*,\n void(*)(void *,int ,char const *,char const *,sqlite3_int64),\n void*\n);\n\n/*\n** CAPI3REF: Enable Or Disable Shared Pager Cache\n**\n** ^(This routine enables or disables the sharing of the database cache\n** and schema data structures between [database connection | connections]\n** to the same database. Sharing is enabled if the argument is true\n** and disabled if the argument is false.)^\n**\n** This interface is omitted if SQLite is compiled with\n** [-DSQLITE_OMIT_SHARED_CACHE]. The [-DSQLITE_OMIT_SHARED_CACHE]\n** compile-time option is recommended because the\n** [use of shared cache mode is discouraged].\n**\n** ^Cache sharing is enabled and disabled for an entire process.\n** This is a change as of SQLite [version 3.5.0] ([dateof:3.5.0]).\n** In prior versions of SQLite,\n** sharing was enabled or disabled for each thread separately.\n**\n** ^(The cache sharing mode set by this interface effects all subsequent\n** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].\n** Existing database connections continue to use the sharing mode\n** that was in effect at the time they were opened.)^\n**\n** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled\n** successfully. An [error code] is returned otherwise.)^\n**\n** ^Shared cache is disabled by default. It is recommended that it stay\n** that way. In other words, do not use this routine. This interface\n** continues to be provided for historical compatibility, but its use is\n** discouraged. Any use of shared cache is discouraged. If shared cache\n** must be used, it is recommended that shared cache only be enabled for\n** individual database connections using the [sqlite3_open_v2()] interface\n** with the [SQLITE_OPEN_SHAREDCACHE] flag.\n**\n** Note: This method is disabled on MacOS X 10.7 and iOS version 5.0\n** and will always return SQLITE_MISUSE. On those systems,\n** shared cache mode should be enabled per-database connection via\n** [sqlite3_open_v2()] with [SQLITE_OPEN_SHAREDCACHE].\n**\n** This interface is threadsafe on processors where writing a\n** 32-bit integer is atomic.\n**\n** See Also: [SQLite Shared-Cache Mode]\n*/\nSQLITE_API int sqlite3_enable_shared_cache(int);\n\n/*\n** CAPI3REF: Attempt To Free Heap Memory\n**\n** ^The sqlite3_release_memory() interface attempts to free N bytes\n** of heap memory by deallocating non-essential memory allocations\n** held by the database library. Memory used to cache database\n** pages to improve performance is an example of non-essential memory.\n** ^sqlite3_release_memory() returns the number of bytes actually freed,\n** which might be more or less than the amount requested.\n** ^The sqlite3_release_memory() routine is a no-op returning zero\n** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT].\n**\n** See also: [sqlite3_db_release_memory()]\n*/\nSQLITE_API int sqlite3_release_memory(int);\n\n/*\n** CAPI3REF: Free Memory Used By A Database Connection\n** METHOD: sqlite3\n**\n** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap\n** memory as possible from database connection D. Unlike the\n** [sqlite3_release_memory()] interface, this interface is in effect even\n** when the [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is\n** omitted.\n**\n** See also: [sqlite3_release_memory()]\n*/\nSQLITE_API int sqlite3_db_release_memory(sqlite3*);\n\n/*\n** CAPI3REF: Impose A Limit On Heap Size\n**\n** These interfaces impose limits on the amount of heap memory that will be\n** by all database connections within a single process.\n**\n** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the\n** soft limit on the amount of heap memory that may be allocated by SQLite.\n** ^SQLite strives to keep heap memory utilization below the soft heap\n** limit by reducing the number of pages held in the page cache\n** as heap memory usages approaches the limit.\n** ^The soft heap limit is \"soft\" because even though SQLite strives to stay\n** below the limit, it will exceed the limit rather than generate\n** an [SQLITE_NOMEM] error. In other words, the soft heap limit\n** is advisory only.\n**\n** ^The sqlite3_hard_heap_limit64(N) interface sets a hard upper bound of\n** N bytes on the amount of memory that will be allocated. ^The\n** sqlite3_hard_heap_limit64(N) interface is similar to\n** sqlite3_soft_heap_limit64(N) except that memory allocations will fail\n** when the hard heap limit is reached.\n**\n** ^The return value from both sqlite3_soft_heap_limit64() and\n** sqlite3_hard_heap_limit64() is the size of\n** the heap limit prior to the call, or negative in the case of an\n** error. ^If the argument N is negative\n** then no change is made to the heap limit. Hence, the current\n** size of heap limits can be determined by invoking\n** sqlite3_soft_heap_limit64(-1) or sqlite3_hard_heap_limit(-1).\n**\n** ^Setting the heap limits to zero disables the heap limiter mechanism.\n**\n** ^The soft heap limit may not be greater than the hard heap limit.\n** ^If the hard heap limit is enabled and if sqlite3_soft_heap_limit(N)\n** is invoked with a value of N that is greater than the hard heap limit,\n** the soft heap limit is set to the value of the hard heap limit.\n** ^The soft heap limit is automatically enabled whenever the hard heap\n** limit is enabled. ^When sqlite3_hard_heap_limit64(N) is invoked and\n** the soft heap limit is outside the range of 1..N, then the soft heap\n** limit is set to N. ^Invoking sqlite3_soft_heap_limit64(0) when the\n** hard heap limit is enabled makes the soft heap limit equal to the\n** hard heap limit.\n**\n** The memory allocation limits can also be adjusted using\n** [PRAGMA soft_heap_limit] and [PRAGMA hard_heap_limit].\n**\n** ^(The heap limits are not enforced in the current implementation\n** if one or more of following conditions are true:\n**\n** <ul>\n** <li> The limit value is set to zero.\n** <li> Memory accounting is disabled using a combination of the\n** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and\n** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option.\n** <li> An alternative page cache implementation is specified using\n** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...).\n** <li> The page cache allocates from its own memory pool supplied\n** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than\n** from the heap.\n** </ul>)^\n**\n** The circumstances under which SQLite will enforce the heap limits may\n** changes in future releases of SQLite.\n*/\nSQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N);\nSQLITE_API sqlite3_int64 sqlite3_hard_heap_limit64(sqlite3_int64 N);\n\n/*\n** CAPI3REF: Deprecated Soft Heap Limit Interface\n** DEPRECATED\n**\n** This is a deprecated version of the [sqlite3_soft_heap_limit64()]\n** interface. This routine is provided for historical compatibility\n** only. All new applications should use the\n** [sqlite3_soft_heap_limit64()] interface rather than this one.\n*/\nSQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N);\n\n\n/*\n** CAPI3REF: Extract Metadata About A Column Of A Table\n** METHOD: sqlite3\n**\n** ^(The sqlite3_table_column_metadata(X,D,T,C,....) routine returns\n** information about column C of table T in database D\n** on [database connection] X.)^ ^The sqlite3_table_column_metadata()\n** interface returns SQLITE_OK and fills in the non-NULL pointers in\n** the final five arguments with appropriate values if the specified\n** column exists. ^The sqlite3_table_column_metadata() interface returns\n** SQLITE_ERROR if the specified column does not exist.\n** ^If the column-name parameter to sqlite3_table_column_metadata() is a\n** NULL pointer, then this routine simply checks for the existence of the\n** table and returns SQLITE_OK if the table exists and SQLITE_ERROR if it\n** does not. If the table name parameter T in a call to\n** sqlite3_table_column_metadata(X,D,T,C,...) is NULL then the result is\n** undefined behavior.\n**\n** ^The column is identified by the second, third and fourth parameters to\n** this function. ^(The second parameter is either the name of the database\n** (i.e. \"main\", \"temp\", or an attached database) containing the specified\n** table or NULL.)^ ^If it is NULL, then all attached databases are searched\n** for the table using the same algorithm used by the database engine to\n** resolve unqualified table references.\n**\n** ^The third and fourth parameters to this function are the table and column\n** name of the desired column, respectively.\n**\n** ^Metadata is returned by writing to the memory locations passed as the 5th\n** and subsequent parameters to this function. ^Any of these arguments may be\n** NULL, in which case the corresponding element of metadata is omitted.\n**\n** ^(<blockquote>\n** <table border=\"1\">\n** <tr><th> Parameter <th> Output<br>Type <th> Description\n**\n** <tr><td> 5th <td> const char* <td> Data type\n** <tr><td> 6th <td> const char* <td> Name of default collation sequence\n** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint\n** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY\n** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT]\n** </table>\n** </blockquote>)^\n**\n** ^The memory pointed to by the character pointers returned for the\n** declaration type and collation sequence is valid until the next\n** call to any SQLite API function.\n**\n** ^If the specified table is actually a view, an [error code] is returned.\n**\n** ^If the specified column is \"rowid\", \"oid\" or \"_rowid_\" and the table\n** is not a [WITHOUT ROWID] table and an\n** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output\n** parameters are set for the explicitly declared column. ^(If there is no\n** [INTEGER PRIMARY KEY] column, then the outputs\n** for the [rowid] are set as follows:\n**\n** <pre>\n** data type: \"INTEGER\"\n** collation sequence: \"BINARY\"\n** not null: 0\n** primary key: 1\n** auto increment: 0\n** </pre>)^\n**\n** ^This function causes all database schemas to be read from disk and\n** parsed, if that has not already been done, and returns an error if\n** any errors are encountered while loading the schema.\n*/\nSQLITE_API int sqlite3_table_column_metadata(\n sqlite3 *db, /* Connection handle */\n const char *zDbName, /* Database name or NULL */\n const char *zTableName, /* Table name */\n const char *zColumnName, /* Column name */\n char const **pzDataType, /* OUTPUT: Declared data type */\n char const **pzCollSeq, /* OUTPUT: Collation sequence name */\n int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */\n int *pPrimaryKey, /* OUTPUT: True if column part of PK */\n int *pAutoinc /* OUTPUT: True if column is auto-increment */\n);\n\n/*\n** CAPI3REF: Load An Extension\n** METHOD: sqlite3\n**\n** ^This interface loads an SQLite extension library from the named file.\n**\n** ^The sqlite3_load_extension() interface attempts to load an\n** [SQLite extension] library contained in the file zFile. If\n** the file cannot be loaded directly, attempts are made to load\n** with various operating-system specific extensions added.\n** So for example, if \"samplelib\" cannot be loaded, then names like\n** \"samplelib.so\" or \"samplelib.dylib\" or \"samplelib.dll\" might\n** be tried also.\n**\n** ^The entry point is zProc.\n** ^(zProc may be 0, in which case SQLite will try to come up with an\n** entry point name on its own. It first tries \"sqlite3_extension_init\".\n** If that does not work, it constructs a name \"sqlite3_X_init\" where the\n** X is consists of the lower-case equivalent of all ASCII alphabetic\n** characters in the filename from the last \"/\" to the first following\n** \".\" and omitting any initial \"lib\".)^\n** ^The sqlite3_load_extension() interface returns\n** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.\n** ^If an error occurs and pzErrMsg is not 0, then the\n** [sqlite3_load_extension()] interface shall attempt to\n** fill *pzErrMsg with error message text stored in memory\n** obtained from [sqlite3_malloc()]. The calling function\n** should free this memory by calling [sqlite3_free()].\n**\n** ^Extension loading must be enabled using\n** [sqlite3_enable_load_extension()] or\n** [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],1,NULL)\n** prior to calling this API,\n** otherwise an error will be returned.\n**\n** <b>Security warning:</b> It is recommended that the\n** [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method be used to enable only this\n** interface. The use of the [sqlite3_enable_load_extension()] interface\n** should be avoided. This will keep the SQL function [load_extension()]\n** disabled and prevent SQL injections from giving attackers\n** access to extension loading capabilities.\n**\n** See also the [load_extension() SQL function].\n*/\nSQLITE_API int sqlite3_load_extension(\n sqlite3 *db, /* Load the extension into this database connection */\n const char *zFile, /* Name of the shared library containing extension */\n const char *zProc, /* Entry point. Derived from zFile if 0 */\n char **pzErrMsg /* Put error message here if not 0 */\n);\n\n/*\n** CAPI3REF: Enable Or Disable Extension Loading\n** METHOD: sqlite3\n**\n** ^So as not to open security holes in older applications that are\n** unprepared to deal with [extension loading], and as a means of disabling\n** [extension loading] while evaluating user-entered SQL, the following API\n** is provided to turn the [sqlite3_load_extension()] mechanism on and off.\n**\n** ^Extension loading is off by default.\n** ^Call the sqlite3_enable_load_extension() routine with onoff==1\n** to turn extension loading on and call it with onoff==0 to turn\n** it back off again.\n**\n** ^This interface enables or disables both the C-API\n** [sqlite3_load_extension()] and the SQL function [load_extension()].\n** ^(Use [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],..)\n** to enable or disable only the C-API.)^\n**\n** <b>Security warning:</b> It is recommended that extension loading\n** be enabled using the [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method\n** rather than this interface, so the [load_extension()] SQL function\n** remains disabled. This will prevent SQL injections from giving attackers\n** access to extension loading capabilities.\n*/\nSQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff);\n\n/*\n** CAPI3REF: Automatically Load Statically Linked Extensions\n**\n** ^This interface causes the xEntryPoint() function to be invoked for\n** each new [database connection] that is created. The idea here is that\n** xEntryPoint() is the entry point for a statically linked [SQLite extension]\n** that is to be automatically loaded into all new database connections.\n**\n** ^(Even though the function prototype shows that xEntryPoint() takes\n** no arguments and returns void, SQLite invokes xEntryPoint() with three\n** arguments and expects an integer result as if the signature of the\n** entry point where as follows:\n**\n** <blockquote><pre>\n** int xEntryPoint(\n** sqlite3 *db,\n** const char **pzErrMsg,\n** const struct sqlite3_api_routines *pThunk\n** );\n** </pre></blockquote>)^\n**\n** If the xEntryPoint routine encounters an error, it should make *pzErrMsg\n** point to an appropriate error message (obtained from [sqlite3_mprintf()])\n** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg\n** is NULL before calling the xEntryPoint(). ^SQLite will invoke\n** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any\n** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()],\n** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail.\n**\n** ^Calling sqlite3_auto_extension(X) with an entry point X that is already\n** on the list of automatic extensions is a harmless no-op. ^No entry point\n** will be called more than once for each database connection that is opened.\n**\n** See also: [sqlite3_reset_auto_extension()]\n** and [sqlite3_cancel_auto_extension()]\n*/\nSQLITE_API int sqlite3_auto_extension(void(*xEntryPoint)(void));\n\n/*\n** CAPI3REF: Cancel Automatic Extension Loading\n**\n** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the\n** initialization routine X that was registered using a prior call to\n** [sqlite3_auto_extension(X)]. ^The [sqlite3_cancel_auto_extension(X)]\n** routine returns 1 if initialization routine X was successfully\n** unregistered and it returns 0 if X was not on the list of initialization\n** routines.\n*/\nSQLITE_API int sqlite3_cancel_auto_extension(void(*xEntryPoint)(void));\n\n/*\n** CAPI3REF: Reset Automatic Extension Loading\n**\n** ^This interface disables all automatic extensions previously\n** registered using [sqlite3_auto_extension()].\n*/\nSQLITE_API void sqlite3_reset_auto_extension(void);\n\n/*\n** Structures used by the virtual table interface\n*/\ntypedef struct sqlite3_vtab sqlite3_vtab;\ntypedef struct sqlite3_index_info sqlite3_index_info;\ntypedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;\ntypedef struct sqlite3_module sqlite3_module;\n\n/*\n** CAPI3REF: Virtual Table Object\n** KEYWORDS: sqlite3_module {virtual table module}\n**\n** This structure, sometimes called a \"virtual table module\",\n** defines the implementation of a [virtual table].\n** This structure consists mostly of methods for the module.\n**\n** ^A virtual table module is created by filling in a persistent\n** instance of this structure and passing a pointer to that instance\n** to [sqlite3_create_module()] or [sqlite3_create_module_v2()].\n** ^The registration remains valid until it is replaced by a different\n** module or until the [database connection] closes. The content\n** of this structure must not change while it is registered with\n** any database connection.\n*/\nstruct sqlite3_module {\n int iVersion;\n int (*xCreate)(sqlite3*, void *pAux,\n int argc, const char *const*argv,\n sqlite3_vtab **ppVTab, char**);\n int (*xConnect)(sqlite3*, void *pAux,\n int argc, const char *const*argv,\n sqlite3_vtab **ppVTab, char**);\n int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);\n int (*xDisconnect)(sqlite3_vtab *pVTab);\n int (*xDestroy)(sqlite3_vtab *pVTab);\n int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);\n int (*xClose)(sqlite3_vtab_cursor*);\n int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,\n int argc, sqlite3_value **argv);\n int (*xNext)(sqlite3_vtab_cursor*);\n int (*xEof)(sqlite3_vtab_cursor*);\n int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);\n int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);\n int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);\n int (*xBegin)(sqlite3_vtab *pVTab);\n int (*xSync)(sqlite3_vtab *pVTab);\n int (*xCommit)(sqlite3_vtab *pVTab);\n int (*xRollback)(sqlite3_vtab *pVTab);\n int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,\n void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),\n void **ppArg);\n int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);\n /* The methods above are in version 1 of the sqlite_module object. Those\n ** below are for version 2 and greater. */\n int (*xSavepoint)(sqlite3_vtab *pVTab, int);\n int (*xRelease)(sqlite3_vtab *pVTab, int);\n int (*xRollbackTo)(sqlite3_vtab *pVTab, int);\n /* The methods above are in versions 1 and 2 of the sqlite_module object.\n ** Those below are for version 3 and greater. */\n int (*xShadowName)(const char*);\n /* The methods above are in versions 1 through 3 of the sqlite_module object.\n ** Those below are for version 4 and greater. */\n int (*xIntegrity)(sqlite3_vtab *pVTab, const char *zSchema,\n const char *zTabName, int mFlags, char **pzErr);\n};\n\n/*\n** CAPI3REF: Virtual Table Indexing Information\n** KEYWORDS: sqlite3_index_info\n**\n** The sqlite3_index_info structure and its substructures is used as part\n** of the [virtual table] interface to\n** pass information into and receive the reply from the [xBestIndex]\n** method of a [virtual table module]. The fields under **Inputs** are the\n** inputs to xBestIndex and are read-only. xBestIndex inserts its\n** results into the **Outputs** fields.\n**\n** ^(The aConstraint[] array records WHERE clause constraints of the form:\n**\n** <blockquote>column OP expr</blockquote>\n**\n** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is\n** stored in aConstraint[].op using one of the\n** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^\n** ^(The index of the column is stored in\n** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the\n** expr on the right-hand side can be evaluated (and thus the constraint\n** is usable) and false if it cannot.)^\n**\n** ^The optimizer automatically inverts terms of the form \"expr OP column\"\n** and makes other simplifications to the WHERE clause in an attempt to\n** get as many WHERE clause terms into the form shown above as possible.\n** ^The aConstraint[] array only reports WHERE clause terms that are\n** relevant to the particular virtual table being queried.\n**\n** ^Information about the ORDER BY clause is stored in aOrderBy[].\n** ^Each term of aOrderBy records a column of the ORDER BY clause.\n**\n** The colUsed field indicates which columns of the virtual table may be\n** required by the current scan. Virtual table columns are numbered from\n** zero in the order in which they appear within the CREATE TABLE statement\n** passed to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62),\n** the corresponding bit is set within the colUsed mask if the column may be\n** required by SQLite. If the table has at least 64 columns and any column\n** to the right of the first 63 is required, then bit 63 of colUsed is also\n** set. In other words, column iCol may be required if the expression\n** (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) evaluates to\n** non-zero.\n**\n** The [xBestIndex] method must fill aConstraintUsage[] with information\n** about what parameters to pass to xFilter. ^If argvIndex>0 then\n** the right-hand side of the corresponding aConstraint[] is evaluated\n** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit\n** is true, then the constraint is assumed to be fully handled by the\n** virtual table and might not be checked again by the byte code.)^ ^(The\n** aConstraintUsage[].omit flag is an optimization hint. When the omit flag\n** is left in its default setting of false, the constraint will always be\n** checked separately in byte code. If the omit flag is change to true, then\n** the constraint may or may not be checked in byte code. In other words,\n** when the omit flag is true there is no guarantee that the constraint will\n** not be checked again using byte code.)^\n**\n** ^The idxNum and idxStr values are recorded and passed into the\n** [xFilter] method.\n** ^[sqlite3_free()] is used to free idxStr if and only if\n** needToFreeIdxStr is true.\n**\n** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in\n** the correct order to satisfy the ORDER BY clause so that no separate\n** sorting step is required.\n**\n** ^The estimatedCost value is an estimate of the cost of a particular\n** strategy. A cost of N indicates that the cost of the strategy is similar\n** to a linear scan of an SQLite table with N rows. A cost of log(N)\n** indicates that the expense of the operation is similar to that of a\n** binary search on a unique indexed field of an SQLite table with N rows.\n**\n** ^The estimatedRows value is an estimate of the number of rows that\n** will be returned by the strategy.\n**\n** The xBestIndex method may optionally populate the idxFlags field with a\n** mask of SQLITE_INDEX_SCAN_* flags. One such flag is\n** [SQLITE_INDEX_SCAN_HEX], which if set causes the [EXPLAIN QUERY PLAN]\n** output to show the idxNum has hex instead of as decimal. Another flag is\n** SQLITE_INDEX_SCAN_UNIQUE, which if set indicates that the query plan will\n** return at most one row.\n**\n** Additionally, if xBestIndex sets the SQLITE_INDEX_SCAN_UNIQUE flag, then\n** SQLite also assumes that if a call to the xUpdate() method is made as\n** part of the same statement to delete or update a virtual table row and the\n** implementation returns SQLITE_CONSTRAINT, then there is no need to rollback\n** any database changes. In other words, if the xUpdate() returns\n** SQLITE_CONSTRAINT, the database contents must be exactly as they were\n** before xUpdate was called. By contrast, if SQLITE_INDEX_SCAN_UNIQUE is not\n** set and xUpdate returns SQLITE_CONSTRAINT, any database changes made by\n** the xUpdate method are automatically rolled back by SQLite.\n**\n** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info\n** structure for SQLite [version 3.8.2] ([dateof:3.8.2]).\n** If a virtual table extension is\n** used with an SQLite version earlier than 3.8.2, the results of attempting\n** to read or write the estimatedRows field are undefined (but are likely\n** to include crashing the application). The estimatedRows field should\n** therefore only be used if [sqlite3_libversion_number()] returns a\n** value greater than or equal to 3008002. Similarly, the idxFlags field\n** was added for [version 3.9.0] ([dateof:3.9.0]).\n** It may therefore only be used if\n** sqlite3_libversion_number() returns a value greater than or equal to\n** 3009000.\n*/\nstruct sqlite3_index_info {\n /* Inputs */\n int nConstraint; /* Number of entries in aConstraint */\n struct sqlite3_index_constraint {\n int iColumn; /* Column constrained. -1 for ROWID */\n unsigned char op; /* Constraint operator */\n unsigned char usable; /* True if this constraint is usable */\n int iTermOffset; /* Used internally - xBestIndex should ignore */\n } *aConstraint; /* Table of WHERE clause constraints */\n int nOrderBy; /* Number of terms in the ORDER BY clause */\n struct sqlite3_index_orderby {\n int iColumn; /* Column number */\n unsigned char desc; /* True for DESC. False for ASC. */\n } *aOrderBy; /* The ORDER BY clause */\n /* Outputs */\n struct sqlite3_index_constraint_usage {\n int argvIndex; /* if >0, constraint is part of argv to xFilter */\n unsigned char omit; /* Do not code a test for this constraint */\n } *aConstraintUsage;\n int idxNum; /* Number used to identify the index */\n char *idxStr; /* String, possibly obtained from sqlite3_malloc */\n int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */\n int orderByConsumed; /* True if output is already ordered */\n double estimatedCost; /* Estimated cost of using this index */\n /* Fields below are only available in SQLite 3.8.2 and later */\n sqlite3_int64 estimatedRows; /* Estimated number of rows returned */\n /* Fields below are only available in SQLite 3.9.0 and later */\n int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */\n /* Fields below are only available in SQLite 3.10.0 and later */\n sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */\n};\n\n/*\n** CAPI3REF: Virtual Table Scan Flags\n**\n** Virtual table implementations are allowed to set the\n** [sqlite3_index_info].idxFlags field to some combination of\n** these bits.\n*/\n#define SQLITE_INDEX_SCAN_UNIQUE 0x00000001 /* Scan visits at most 1 row */\n#define SQLITE_INDEX_SCAN_HEX 0x00000002 /* Display idxNum as hex */\n /* in EXPLAIN QUERY PLAN */\n\n/*\n** CAPI3REF: Virtual Table Constraint Operator Codes\n**\n** These macros define the allowed values for the\n** [sqlite3_index_info].aConstraint[].op field. Each value represents\n** an operator that is part of a constraint term in the WHERE clause of\n** a query that uses a [virtual table].\n**\n** ^The left-hand operand of the operator is given by the corresponding\n** aConstraint[].iColumn field. ^An iColumn of -1 indicates the left-hand\n** operand is the rowid.\n** The SQLITE_INDEX_CONSTRAINT_LIMIT and SQLITE_INDEX_CONSTRAINT_OFFSET\n** operators have no left-hand operand, and so for those operators the\n** corresponding aConstraint[].iColumn is meaningless and should not be\n** used.\n**\n** All operator values from SQLITE_INDEX_CONSTRAINT_FUNCTION through\n** value 255 are reserved to represent functions that are overloaded\n** by the [xFindFunction|xFindFunction method] of the virtual table\n** implementation.\n**\n** The right-hand operands for each constraint might be accessible using\n** the [sqlite3_vtab_rhs_value()] interface. Usually the right-hand\n** operand is only available if it appears as a single constant literal\n** in the input SQL. If the right-hand operand is another column or an\n** expression (even a constant expression) or a parameter, then the\n** sqlite3_vtab_rhs_value() probably will not be able to extract it.\n** ^The SQLITE_INDEX_CONSTRAINT_ISNULL and\n** SQLITE_INDEX_CONSTRAINT_ISNOTNULL operators have no right-hand operand\n** and hence calls to sqlite3_vtab_rhs_value() for those operators will\n** always return SQLITE_NOTFOUND.\n**\n** The collating sequence to be used for comparison can be found using\n** the [sqlite3_vtab_collation()] interface. For most real-world virtual\n** tables, the collating sequence of constraints does not matter (for example\n** because the constraints are numeric) and so the sqlite3_vtab_collation()\n** interface is not commonly needed.\n*/\n#define SQLITE_INDEX_CONSTRAINT_EQ 2\n#define SQLITE_INDEX_CONSTRAINT_GT 4\n#define SQLITE_INDEX_CONSTRAINT_LE 8\n#define SQLITE_INDEX_CONSTRAINT_LT 16\n#define SQLITE_INDEX_CONSTRAINT_GE 32\n#define SQLITE_INDEX_CONSTRAINT_MATCH 64\n#define SQLITE_INDEX_CONSTRAINT_LIKE 65\n#define SQLITE_INDEX_CONSTRAINT_GLOB 66\n#define SQLITE_INDEX_CONSTRAINT_REGEXP 67\n#define SQLITE_INDEX_CONSTRAINT_NE 68\n#define SQLITE_INDEX_CONSTRAINT_ISNOT 69\n#define SQLITE_INDEX_CONSTRAINT_ISNOTNULL 70\n#define SQLITE_INDEX_CONSTRAINT_ISNULL 71\n#define SQLITE_INDEX_CONSTRAINT_IS 72\n#define SQLITE_INDEX_CONSTRAINT_LIMIT 73\n#define SQLITE_INDEX_CONSTRAINT_OFFSET 74\n#define SQLITE_INDEX_CONSTRAINT_FUNCTION 150\n\n/*\n** CAPI3REF: Register A Virtual Table Implementation\n** METHOD: sqlite3\n**\n** ^These routines are used to register a new [virtual table module] name.\n** ^Module names must be registered before\n** creating a new [virtual table] using the module and before using a\n** preexisting [virtual table] for the module.\n**\n** ^The module name is registered on the [database connection] specified\n** by the first parameter. ^The name of the module is given by the\n** second parameter. ^The third parameter is a pointer to\n** the implementation of the [virtual table module]. ^The fourth\n** parameter is an arbitrary client data pointer that is passed through\n** into the [xCreate] and [xConnect] methods of the virtual table module\n** when a new virtual table is be being created or reinitialized.\n**\n** ^The sqlite3_create_module_v2() interface has a fifth parameter which\n** is a pointer to a destructor for the pClientData. ^SQLite will\n** invoke the destructor function (if it is not NULL) when SQLite\n** no longer needs the pClientData pointer. ^The destructor will also\n** be invoked if the call to sqlite3_create_module_v2() fails.\n** ^The sqlite3_create_module()\n** interface is equivalent to sqlite3_create_module_v2() with a NULL\n** destructor.\n**\n** ^If the third parameter (the pointer to the sqlite3_module object) is\n** NULL then no new module is created and any existing modules with the\n** same name are dropped.\n**\n** See also: [sqlite3_drop_modules()]\n*/\nSQLITE_API int sqlite3_create_module(\n sqlite3 *db, /* SQLite connection to register module with */\n const char *zName, /* Name of the module */\n const sqlite3_module *p, /* Methods for the module */\n void *pClientData /* Client data for xCreate/xConnect */\n);\nSQLITE_API int sqlite3_create_module_v2(\n sqlite3 *db, /* SQLite connection to register module with */\n const char *zName, /* Name of the module */\n const sqlite3_module *p, /* Methods for the module */\n void *pClientData, /* Client data for xCreate/xConnect */\n void(*xDestroy)(void*) /* Module destructor function */\n);\n\n/*\n** CAPI3REF: Remove Unnecessary Virtual Table Implementations\n** METHOD: sqlite3\n**\n** ^The sqlite3_drop_modules(D,L) interface removes all virtual\n** table modules from database connection D except those named on list L.\n** The L parameter must be either NULL or a pointer to an array of pointers\n** to strings where the array is terminated by a single NULL pointer.\n** ^If the L parameter is NULL, then all virtual table modules are removed.\n**\n** See also: [sqlite3_create_module()]\n*/\nSQLITE_API int sqlite3_drop_modules(\n sqlite3 *db, /* Remove modules from this connection */\n const char **azKeep /* Except, do not remove the ones named here */\n);\n\n/*\n** CAPI3REF: Virtual Table Instance Object\n** KEYWORDS: sqlite3_vtab\n**\n** Every [virtual table module] implementation uses a subclass\n** of this object to describe a particular instance\n** of the [virtual table]. Each subclass will\n** be tailored to the specific needs of the module implementation.\n** The purpose of this superclass is to define certain fields that are\n** common to all module implementations.\n**\n** ^Virtual tables methods can set an error message by assigning a\n** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should\n** take care that any prior string is freed by a call to [sqlite3_free()]\n** prior to assigning a new string to zErrMsg. ^After the error message\n** is delivered up to the client application, the string will be automatically\n** freed by sqlite3_free() and the zErrMsg field will be zeroed.\n*/\nstruct sqlite3_vtab {\n const sqlite3_module *pModule; /* The module for this virtual table */\n int nRef; /* Number of open cursors */\n char *zErrMsg; /* Error message from sqlite3_mprintf() */\n /* Virtual table implementations will typically add additional fields */\n};\n\n/*\n** CAPI3REF: Virtual Table Cursor Object\n** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor}\n**\n** Every [virtual table module] implementation uses a subclass of the\n** following structure to describe cursors that point into the\n** [virtual table] and are used\n** to loop through the virtual table. Cursors are created using the\n** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed\n** by the [sqlite3_module.xClose | xClose] method. Cursors are used\n** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods\n** of the module. Each module implementation will define\n** the content of a cursor structure to suit its own needs.\n**\n** This superclass exists in order to define fields of the cursor that\n** are common to all implementations.\n*/\nstruct sqlite3_vtab_cursor {\n sqlite3_vtab *pVtab; /* Virtual table of this cursor */\n /* Virtual table implementations will typically add additional fields */\n};\n\n/*\n** CAPI3REF: Declare The Schema Of A Virtual Table\n**\n** ^The [xCreate] and [xConnect] methods of a\n** [virtual table module] call this interface\n** to declare the format (the names and datatypes of the columns) of\n** the virtual tables they implement.\n*/\nSQLITE_API int sqlite3_declare_vtab(sqlite3*, const char *zSQL);\n\n/*\n** CAPI3REF: Overload A Function For A Virtual Table\n** METHOD: sqlite3\n**\n** ^(Virtual tables can provide alternative implementations of functions\n** using the [xFindFunction] method of the [virtual table module].\n** But global versions of those functions\n** must exist in order to be overloaded.)^\n**\n** ^(This API makes sure a global version of a function with a particular\n** name and number of parameters exists. If no such function exists\n** before this API is called, a new function is created.)^ ^The implementation\n** of the new function always causes an exception to be thrown. So\n** the new function is not good for anything by itself. Its only\n** purpose is to be a placeholder function that can be overloaded\n** by a [virtual table].\n*/\nSQLITE_API int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);\n\n/*\n** CAPI3REF: A Handle To An Open BLOB\n** KEYWORDS: {BLOB handle} {BLOB handles}\n**\n** An instance of this object represents an open BLOB on which\n** [sqlite3_blob_open | incremental BLOB I/O] can be performed.\n** ^Objects of this type are created by [sqlite3_blob_open()]\n** and destroyed by [sqlite3_blob_close()].\n** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces\n** can be used to read or write small subsections of the BLOB.\n** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes.\n*/\ntypedef struct sqlite3_blob sqlite3_blob;\n\n/*\n** CAPI3REF: Open A BLOB For Incremental I/O\n** METHOD: sqlite3\n** CONSTRUCTOR: sqlite3_blob\n**\n** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located\n** in row iRow, column zColumn, table zTable in database zDb;\n** in other words, the same BLOB that would be selected by:\n**\n** <pre>\n** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;\n** </pre>)^\n**\n** ^(Parameter zDb is not the filename that contains the database, but\n** rather the symbolic name of the database. For attached databases, this is\n** the name that appears after the AS keyword in the [ATTACH] statement.\n** For the main database file, the database name is \"main\". For TEMP\n** tables, the database name is \"temp\".)^\n**\n** ^If the flags parameter is non-zero, then the BLOB is opened for read\n** and write access. ^If the flags parameter is zero, the BLOB is opened for\n** read-only access.\n**\n** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is stored\n** in *ppBlob. Otherwise an [error code] is returned and, unless the error\n** code is SQLITE_MISUSE, *ppBlob is set to NULL.)^ ^This means that, provided\n** the API is not misused, it is always safe to call [sqlite3_blob_close()]\n** on *ppBlob after this function it returns.\n**\n** This function fails with SQLITE_ERROR if any of the following are true:\n** <ul>\n** <li> ^(Database zDb does not exist)^,\n** <li> ^(Table zTable does not exist within database zDb)^,\n** <li> ^(Table zTable is a WITHOUT ROWID table)^,\n** <li> ^(Column zColumn does not exist)^,\n** <li> ^(Row iRow is not present in the table)^,\n** <li> ^(The specified column of row iRow contains a value that is not\n** a TEXT or BLOB value)^,\n** <li> ^(Column zColumn is part of an index, PRIMARY KEY or UNIQUE\n** constraint and the blob is being opened for read/write access)^,\n** <li> ^([foreign key constraints | Foreign key constraints] are enabled,\n** column zColumn is part of a [child key] definition and the blob is\n** being opened for read/write access)^.\n** </ul>\n**\n** ^Unless it returns SQLITE_MISUSE, this function sets the\n** [database connection] error code and message accessible via\n** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions.\n**\n** A BLOB referenced by sqlite3_blob_open() may be read using the\n** [sqlite3_blob_read()] interface and modified by using\n** [sqlite3_blob_write()]. The [BLOB handle] can be moved to a\n** different row of the same table using the [sqlite3_blob_reopen()]\n** interface. However, the column, table, or database of a [BLOB handle]\n** cannot be changed after the [BLOB handle] is opened.\n**\n** ^(If the row that a BLOB handle points to is modified by an\n** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects\n** then the BLOB handle is marked as \"expired\".\n** This is true if any column of the row is changed, even a column\n** other than the one the BLOB handle is open on.)^\n** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for\n** an expired BLOB handle fail with a return code of [SQLITE_ABORT].\n** ^(Changes written into a BLOB prior to the BLOB expiring are not\n** rolled back by the expiration of the BLOB. Such changes will eventually\n** commit if the transaction continues to completion.)^\n**\n** ^Use the [sqlite3_blob_bytes()] interface to determine the size of\n** the opened blob. ^The size of a blob may not be changed by this\n** interface. Use the [UPDATE] SQL command to change the size of a\n** blob.\n**\n** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces\n** and the built-in [zeroblob] SQL function may be used to create a\n** zero-filled blob to read or write using the incremental-blob interface.\n**\n** To avoid a resource leak, every open [BLOB handle] should eventually\n** be released by a call to [sqlite3_blob_close()].\n**\n** See also: [sqlite3_blob_close()],\n** [sqlite3_blob_reopen()], [sqlite3_blob_read()],\n** [sqlite3_blob_bytes()], [sqlite3_blob_write()].\n*/\nSQLITE_API int sqlite3_blob_open(\n sqlite3*,\n const char *zDb,\n const char *zTable,\n const char *zColumn,\n sqlite3_int64 iRow,\n int flags,\n sqlite3_blob **ppBlob\n);\n\n/*\n** CAPI3REF: Move a BLOB Handle to a New Row\n** METHOD: sqlite3_blob\n**\n** ^This function is used to move an existing [BLOB handle] so that it points\n** to a different row of the same database table. ^The new row is identified\n** by the rowid value passed as the second argument. Only the row can be\n** changed. ^The database, table and column on which the blob handle is open\n** remain the same. Moving an existing [BLOB handle] to a new row is\n** faster than closing the existing handle and opening a new one.\n**\n** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] -\n** it must exist and there must be either a blob or text value stored in\n** the nominated column.)^ ^If the new row is not present in the table, or if\n** it does not contain a blob or text value, or if another error occurs, an\n** SQLite error code is returned and the blob handle is considered aborted.\n** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or\n** [sqlite3_blob_reopen()] on an aborted blob handle immediately return\n** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle\n** always returns zero.\n**\n** ^This function sets the database handle error code and message.\n*/\nSQLITE_API int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64);\n\n/*\n** CAPI3REF: Close A BLOB Handle\n** DESTRUCTOR: sqlite3_blob\n**\n** ^This function closes an open [BLOB handle]. ^(The BLOB handle is closed\n** unconditionally. Even if this routine returns an error code, the\n** handle is still closed.)^\n**\n** ^If the blob handle being closed was opened for read-write access, and if\n** the database is in auto-commit mode and there are no other open read-write\n** blob handles or active write statements, the current transaction is\n** committed. ^If an error occurs while committing the transaction, an error\n** code is returned and the transaction rolled back.\n**\n** Calling this function with an argument that is not a NULL pointer or an\n** open blob handle results in undefined behavior. ^Calling this routine\n** with a null pointer (such as would be returned by a failed call to\n** [sqlite3_blob_open()]) is a harmless no-op. ^Otherwise, if this function\n** is passed a valid open blob handle, the values returned by the\n** sqlite3_errcode() and sqlite3_errmsg() functions are set before returning.\n*/\nSQLITE_API int sqlite3_blob_close(sqlite3_blob *);\n\n/*\n** CAPI3REF: Return The Size Of An Open BLOB\n** METHOD: sqlite3_blob\n**\n** ^Returns the size in bytes of the BLOB accessible via the\n** successfully opened [BLOB handle] in its only argument. ^The\n** incremental blob I/O routines can only read or overwriting existing\n** blob content; they cannot change the size of a blob.\n**\n** This routine only works on a [BLOB handle] which has been created\n** by a prior successful call to [sqlite3_blob_open()] and which has not\n** been closed by [sqlite3_blob_close()]. Passing any other pointer in\n** to this routine results in undefined and probably undesirable behavior.\n*/\nSQLITE_API int sqlite3_blob_bytes(sqlite3_blob *);\n\n/*\n** CAPI3REF: Read Data From A BLOB Incrementally\n** METHOD: sqlite3_blob\n**\n** ^(This function is used to read data from an open [BLOB handle] into a\n** caller-supplied buffer. N bytes of data are copied into buffer Z\n** from the open BLOB, starting at offset iOffset.)^\n**\n** ^If offset iOffset is less than N bytes from the end of the BLOB,\n** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is\n** less than zero, [SQLITE_ERROR] is returned and no data is read.\n** ^The size of the blob (and hence the maximum value of N+iOffset)\n** can be determined using the [sqlite3_blob_bytes()] interface.\n**\n** ^An attempt to read from an expired [BLOB handle] fails with an\n** error code of [SQLITE_ABORT].\n**\n** ^(On success, sqlite3_blob_read() returns SQLITE_OK.\n** Otherwise, an [error code] or an [extended error code] is returned.)^\n**\n** This routine only works on a [BLOB handle] which has been created\n** by a prior successful call to [sqlite3_blob_open()] and which has not\n** been closed by [sqlite3_blob_close()]. Passing any other pointer in\n** to this routine results in undefined and probably undesirable behavior.\n**\n** See also: [sqlite3_blob_write()].\n*/\nSQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset);\n\n/*\n** CAPI3REF: Write Data Into A BLOB Incrementally\n** METHOD: sqlite3_blob\n**\n** ^(This function is used to write data into an open [BLOB handle] from a\n** caller-supplied buffer. N bytes of data are copied from the buffer Z\n** into the open BLOB, starting at offset iOffset.)^\n**\n** ^(On success, sqlite3_blob_write() returns SQLITE_OK.\n** Otherwise, an [error code] or an [extended error code] is returned.)^\n** ^Unless SQLITE_MISUSE is returned, this function sets the\n** [database connection] error code and message accessible via\n** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions.\n**\n** ^If the [BLOB handle] passed as the first argument was not opened for\n** writing (the flags parameter to [sqlite3_blob_open()] was zero),\n** this function returns [SQLITE_READONLY].\n**\n** This function may only modify the contents of the BLOB; it is\n** not possible to increase the size of a BLOB using this API.\n** ^If offset iOffset is less than N bytes from the end of the BLOB,\n** [SQLITE_ERROR] is returned and no data is written. The size of the\n** BLOB (and hence the maximum value of N+iOffset) can be determined\n** using the [sqlite3_blob_bytes()] interface. ^If N or iOffset are less\n** than zero [SQLITE_ERROR] is returned and no data is written.\n**\n** ^An attempt to write to an expired [BLOB handle] fails with an\n** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred\n** before the [BLOB handle] expired are not rolled back by the\n** expiration of the handle, though of course those changes might\n** have been overwritten by the statement that expired the BLOB handle\n** or by other independent statements.\n**\n** This routine only works on a [BLOB handle] which has been created\n** by a prior successful call to [sqlite3_blob_open()] and which has not\n** been closed by [sqlite3_blob_close()]. Passing any other pointer in\n** to this routine results in undefined and probably undesirable behavior.\n**\n** See also: [sqlite3_blob_read()].\n*/\nSQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);\n\n/*\n** CAPI3REF: Virtual File System Objects\n**\n** A virtual filesystem (VFS) is an [sqlite3_vfs] object\n** that SQLite uses to interact\n** with the underlying operating system. Most SQLite builds come with a\n** single default VFS that is appropriate for the host computer.\n** New VFSes can be registered and existing VFSes can be unregistered.\n** The following interfaces are provided.\n**\n** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name.\n** ^Names are case sensitive.\n** ^Names are zero-terminated UTF-8 strings.\n** ^If there is no match, a NULL pointer is returned.\n** ^If zVfsName is NULL then the default VFS is returned.\n**\n** ^New VFSes are registered with sqlite3_vfs_register().\n** ^Each new VFS becomes the default VFS if the makeDflt flag is set.\n** ^The same VFS can be registered multiple times without injury.\n** ^To make an existing VFS into the default VFS, register it again\n** with the makeDflt flag set. If two different VFSes with the\n** same name are registered, the behavior is undefined. If a\n** VFS is registered with a name that is NULL or an empty string,\n** then the behavior is undefined.\n**\n** ^Unregister a VFS with the sqlite3_vfs_unregister() interface.\n** ^(If the default VFS is unregistered, another VFS is chosen as\n** the default. The choice for the new VFS is arbitrary.)^\n*/\nSQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);\nSQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);\nSQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);\n\n/*\n** CAPI3REF: Mutexes\n**\n** The SQLite core uses these routines for thread\n** synchronization. Though they are intended for internal\n** use by SQLite, code that links against SQLite is\n** permitted to use any of these routines.\n**\n** The SQLite source code contains multiple implementations\n** of these mutex routines. An appropriate implementation\n** is selected automatically at compile-time. The following\n** implementations are available in the SQLite core:\n**\n** <ul>\n** <li> SQLITE_MUTEX_PTHREADS\n** <li> SQLITE_MUTEX_W32\n** <li> SQLITE_MUTEX_NOOP\n** </ul>\n**\n** The SQLITE_MUTEX_NOOP implementation is a set of routines\n** that does no real locking and is appropriate for use in\n** a single-threaded application. The SQLITE_MUTEX_PTHREADS and\n** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix\n** and Windows.\n**\n** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor\n** macro defined (with \"-DSQLITE_MUTEX_APPDEF=1\"), then no mutex\n** implementation is included with the library. In this case the\n** application must supply a custom mutex implementation using the\n** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function\n** before calling sqlite3_initialize() or any other public sqlite3_\n** function that calls sqlite3_initialize().\n**\n** ^The sqlite3_mutex_alloc() routine allocates a new\n** mutex and returns a pointer to it. ^The sqlite3_mutex_alloc()\n** routine returns NULL if it is unable to allocate the requested\n** mutex. The argument to sqlite3_mutex_alloc() must one of these\n** integer constants:\n**\n** <ul>\n** <li> SQLITE_MUTEX_FAST\n** <li> SQLITE_MUTEX_RECURSIVE\n** <li> SQLITE_MUTEX_STATIC_MAIN\n** <li> SQLITE_MUTEX_STATIC_MEM\n** <li> SQLITE_MUTEX_STATIC_OPEN\n** <li> SQLITE_MUTEX_STATIC_PRNG\n** <li> SQLITE_MUTEX_STATIC_LRU\n** <li> SQLITE_MUTEX_STATIC_PMEM\n** <li> SQLITE_MUTEX_STATIC_APP1\n** <li> SQLITE_MUTEX_STATIC_APP2\n** <li> SQLITE_MUTEX_STATIC_APP3\n** <li> SQLITE_MUTEX_STATIC_VFS1\n** <li> SQLITE_MUTEX_STATIC_VFS2\n** <li> SQLITE_MUTEX_STATIC_VFS3\n** </ul>\n**\n** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE)\n** cause sqlite3_mutex_alloc() to create\n** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE\n** is used but not necessarily so when SQLITE_MUTEX_FAST is used.\n** The mutex implementation does not need to make a distinction\n** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does\n** not want to. SQLite will only request a recursive mutex in\n** cases where it really needs one. If a faster non-recursive mutex\n** implementation is available on the host platform, the mutex subsystem\n** might return such a mutex in response to SQLITE_MUTEX_FAST.\n**\n** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other\n** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return\n** a pointer to a static preexisting mutex. ^Nine static mutexes are\n** used by the current version of SQLite. Future versions of SQLite\n** may add additional static mutexes. Static mutexes are for internal\n** use by SQLite only. Applications that use SQLite mutexes should\n** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or\n** SQLITE_MUTEX_RECURSIVE.\n**\n** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST\n** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()\n** returns a different mutex on every call. ^For the static\n** mutex types, the same mutex is returned on every call that has\n** the same type number.\n**\n** ^The sqlite3_mutex_free() routine deallocates a previously\n** allocated dynamic mutex. Attempting to deallocate a static\n** mutex results in undefined behavior.\n**\n** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt\n** to enter a mutex. ^If another thread is already within the mutex,\n** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return\n** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK]\n** upon successful entry. ^(Mutexes created using\n** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.\n** In such cases, the\n** mutex must be exited an equal number of times before another thread\n** can enter.)^ If the same thread tries to enter any mutex other\n** than an SQLITE_MUTEX_RECURSIVE more than once, the behavior is undefined.\n**\n** ^(Some systems (for example, Windows 95) do not support the operation\n** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try()\n** will always return SQLITE_BUSY. In most cases the SQLite core only uses\n** sqlite3_mutex_try() as an optimization, so this is acceptable\n** behavior. The exceptions are unix builds that set the\n** SQLITE_ENABLE_SETLK_TIMEOUT build option. In that case a working\n** sqlite3_mutex_try() is required.)^\n**\n** ^The sqlite3_mutex_leave() routine exits a mutex that was\n** previously entered by the same thread. The behavior\n** is undefined if the mutex is not currently entered by the\n** calling thread or is not currently allocated.\n**\n** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(),\n** sqlite3_mutex_leave(), or sqlite3_mutex_free() is a NULL pointer,\n** then any of the four routines behaves as a no-op.\n**\n** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].\n*/\nSQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int);\nSQLITE_API void sqlite3_mutex_free(sqlite3_mutex*);\nSQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*);\nSQLITE_API int sqlite3_mutex_try(sqlite3_mutex*);\nSQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*);\n\n/*\n** CAPI3REF: Mutex Methods Object\n**\n** An instance of this structure defines the low-level routines\n** used to allocate and use mutexes.\n**\n** Usually, the default mutex implementations provided by SQLite are\n** sufficient, however the application has the option of substituting a custom\n** implementation for specialized deployments or systems for which SQLite\n** does not provide a suitable implementation. In this case, the application\n** creates and populates an instance of this structure to pass\n** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option.\n** Additionally, an instance of this structure can be used as an\n** output variable when querying the system for the current mutex\n** implementation, using the [SQLITE_CONFIG_GETMUTEX] option.\n**\n** ^The xMutexInit method defined by this structure is invoked as\n** part of system initialization by the sqlite3_initialize() function.\n** ^The xMutexInit routine is called by SQLite exactly once for each\n** effective call to [sqlite3_initialize()].\n**\n** ^The xMutexEnd method defined by this structure is invoked as\n** part of system shutdown by the sqlite3_shutdown() function. The\n** implementation of this method is expected to release all outstanding\n** resources obtained by the mutex methods implementation, especially\n** those obtained by the xMutexInit method. ^The xMutexEnd()\n** interface is invoked exactly once for each call to [sqlite3_shutdown()].\n**\n** ^(The remaining seven methods defined by this structure (xMutexAlloc,\n** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and\n** xMutexNotheld) implement the following interfaces (respectively):\n**\n** <ul>\n** <li> [sqlite3_mutex_alloc()] </li>\n** <li> [sqlite3_mutex_free()] </li>\n** <li> [sqlite3_mutex_enter()] </li>\n** <li> [sqlite3_mutex_try()] </li>\n** <li> [sqlite3_mutex_leave()] </li>\n** <li> [sqlite3_mutex_held()] </li>\n** <li> [sqlite3_mutex_notheld()] </li>\n** </ul>)^\n**\n** The only difference is that the public sqlite3_XXX functions enumerated\n** above silently ignore any invocations that pass a NULL pointer instead\n** of a valid mutex handle. The implementations of the methods defined\n** by this structure are not required to handle this case. The results\n** of passing a NULL pointer instead of a valid mutex handle are undefined\n** (i.e. it is acceptable to provide an implementation that segfaults if\n** it is passed a NULL pointer).\n**\n** The xMutexInit() method must be threadsafe. It must be harmless to\n** invoke xMutexInit() multiple times within the same process and without\n** intervening calls to xMutexEnd(). Second and subsequent calls to\n** xMutexInit() must be no-ops.\n**\n** xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()]\n** and its associates). Similarly, xMutexAlloc() must not use SQLite memory\n** allocation for a static mutex. ^However xMutexAlloc() may use SQLite\n** memory allocation for a fast or recursive mutex.\n**\n** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is\n** called, but only if the prior call to xMutexInit returned SQLITE_OK.\n** If xMutexInit fails in any way, it is expected to clean up after itself\n** prior to returning.\n*/\ntypedef struct sqlite3_mutex_methods sqlite3_mutex_methods;\nstruct sqlite3_mutex_methods {\n int (*xMutexInit)(void);\n int (*xMutexEnd)(void);\n sqlite3_mutex *(*xMutexAlloc)(int);\n void (*xMutexFree)(sqlite3_mutex *);\n void (*xMutexEnter)(sqlite3_mutex *);\n int (*xMutexTry)(sqlite3_mutex *);\n void (*xMutexLeave)(sqlite3_mutex *);\n int (*xMutexHeld)(sqlite3_mutex *);\n int (*xMutexNotheld)(sqlite3_mutex *);\n};\n\n/*\n** CAPI3REF: Mutex Verification Routines\n**\n** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines\n** are intended for use inside assert() statements. The SQLite core\n** never uses these routines except inside an assert() and applications\n** are advised to follow the lead of the core. The SQLite core only\n** provides implementations for these routines when it is compiled\n** with the SQLITE_DEBUG flag. External mutex implementations\n** are only required to provide these routines if SQLITE_DEBUG is\n** defined and if NDEBUG is not defined.\n**\n** These routines should return true if the mutex in their argument\n** is held or not held, respectively, by the calling thread.\n**\n** The implementation is not required to provide versions of these\n** routines that actually work. If the implementation does not provide working\n** versions of these routines, it should at least provide stubs that always\n** return true so that one does not get spurious assertion failures.\n**\n** If the argument to sqlite3_mutex_held() is a NULL pointer then\n** the routine should return 1. This seems counter-intuitive since\n** clearly the mutex cannot be held if it does not exist. But\n** the reason the mutex does not exist is because the build is not\n** using mutexes. And we do not want the assert() containing the\n** call to sqlite3_mutex_held() to fail, so a non-zero return is\n** the appropriate thing to do. The sqlite3_mutex_notheld()\n** interface should also return 1 when given a NULL pointer.\n*/\n#ifndef NDEBUG\nSQLITE_API int sqlite3_mutex_held(sqlite3_mutex*);\nSQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*);\n#endif\n\n/*\n** CAPI3REF: Mutex Types\n**\n** The [sqlite3_mutex_alloc()] interface takes a single argument\n** which is one of these integer constants.\n**\n** The set of static mutexes may change from one SQLite release to the\n** next. Applications that override the built-in mutex logic must be\n** prepared to accommodate additional static mutexes.\n*/\n#define SQLITE_MUTEX_FAST 0\n#define SQLITE_MUTEX_RECURSIVE 1\n#define SQLITE_MUTEX_STATIC_MAIN 2\n#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */\n#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */\n#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */\n#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_randomness() */\n#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */\n#define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */\n#define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */\n#define SQLITE_MUTEX_STATIC_APP1 8 /* For use by application */\n#define SQLITE_MUTEX_STATIC_APP2 9 /* For use by application */\n#define SQLITE_MUTEX_STATIC_APP3 10 /* For use by application */\n#define SQLITE_MUTEX_STATIC_VFS1 11 /* For use by built-in VFS */\n#define SQLITE_MUTEX_STATIC_VFS2 12 /* For use by extension VFS */\n#define SQLITE_MUTEX_STATIC_VFS3 13 /* For use by application VFS */\n\n/* Legacy compatibility: */\n#define SQLITE_MUTEX_STATIC_MASTER 2\n\n\n/*\n** CAPI3REF: Retrieve the mutex for a database connection\n** METHOD: sqlite3\n**\n** ^This interface returns a pointer the [sqlite3_mutex] object that\n** serializes access to the [database connection] given in the argument\n** when the [threading mode] is Serialized.\n** ^If the [threading mode] is Single-thread or Multi-thread then this\n** routine returns a NULL pointer.\n*/\nSQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);\n\n/*\n** CAPI3REF: Low-Level Control Of Database Files\n** METHOD: sqlite3\n** KEYWORDS: {file control}\n**\n** ^The [sqlite3_file_control()] interface makes a direct call to the\n** xFileControl method for the [sqlite3_io_methods] object associated\n** with a particular database identified by the second argument. ^The\n** name of the database is \"main\" for the main database or \"temp\" for the\n** TEMP database, or the name that appears after the AS keyword for\n** databases that are added using the [ATTACH] SQL command.\n** ^A NULL pointer can be used in place of \"main\" to refer to the\n** main database file.\n** ^The third and fourth parameters to this routine\n** are passed directly through to the second and third parameters of\n** the xFileControl method. ^The return value of the xFileControl\n** method becomes the return value of this routine.\n**\n** A few opcodes for [sqlite3_file_control()] are handled directly\n** by the SQLite core and never invoke the\n** sqlite3_io_methods.xFileControl method.\n** ^The [SQLITE_FCNTL_FILE_POINTER] value for the op parameter causes\n** a pointer to the underlying [sqlite3_file] object to be written into\n** the space pointed to by the 4th parameter. The\n** [SQLITE_FCNTL_JOURNAL_POINTER] works similarly except that it returns\n** the [sqlite3_file] object associated with the journal file instead of\n** the main database. The [SQLITE_FCNTL_VFS_POINTER] opcode returns\n** a pointer to the underlying [sqlite3_vfs] object for the file.\n** The [SQLITE_FCNTL_DATA_VERSION] returns the data version counter\n** from the pager.\n**\n** ^If the second parameter (zDbName) does not match the name of any\n** open database file, then SQLITE_ERROR is returned. ^This error\n** code is not remembered and will not be recalled by [sqlite3_errcode()]\n** or [sqlite3_errmsg()]. The underlying xFileControl method might\n** also return SQLITE_ERROR. There is no way to distinguish between\n** an incorrect zDbName and an SQLITE_ERROR return from the underlying\n** xFileControl method.\n**\n** See also: [file control opcodes]\n*/\nSQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);\n\n/*\n** CAPI3REF: Testing Interface\n**\n** ^The sqlite3_test_control() interface is used to read out internal\n** state of SQLite and to inject faults into SQLite for testing\n** purposes. ^The first parameter is an operation code that determines\n** the number, meaning, and operation of all subsequent parameters.\n**\n** This interface is not for use by applications. It exists solely\n** for verifying the correct operation of the SQLite library. Depending\n** on how the SQLite library is compiled, this interface might not exist.\n**\n** The details of the operation codes, their meanings, the parameters\n** they take, and what they do are all subject to change without notice.\n** Unlike most of the SQLite API, this function is not guaranteed to\n** operate consistently from one release to the next.\n*/\nSQLITE_API int sqlite3_test_control(int op, ...);\n\n/*\n** CAPI3REF: Testing Interface Operation Codes\n**\n** These constants are the valid operation code parameters used\n** as the first argument to [sqlite3_test_control()].\n**\n** These parameters and their meanings are subject to change\n** without notice. These values are for testing purposes only.\n** Applications should not use any of these parameters or the\n** [sqlite3_test_control()] interface.\n*/\n#define SQLITE_TESTCTRL_FIRST 5\n#define SQLITE_TESTCTRL_PRNG_SAVE 5\n#define SQLITE_TESTCTRL_PRNG_RESTORE 6\n#define SQLITE_TESTCTRL_PRNG_RESET 7 /* NOT USED */\n#define SQLITE_TESTCTRL_FK_NO_ACTION 7\n#define SQLITE_TESTCTRL_BITVEC_TEST 8\n#define SQLITE_TESTCTRL_FAULT_INSTALL 9\n#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10\n#define SQLITE_TESTCTRL_PENDING_BYTE 11\n#define SQLITE_TESTCTRL_ASSERT 12\n#define SQLITE_TESTCTRL_ALWAYS 13\n#define SQLITE_TESTCTRL_RESERVE 14 /* NOT USED */\n#define SQLITE_TESTCTRL_JSON_SELFCHECK 14\n#define SQLITE_TESTCTRL_OPTIMIZATIONS 15\n#define SQLITE_TESTCTRL_ISKEYWORD 16 /* NOT USED */\n#define SQLITE_TESTCTRL_GETOPT 16\n#define SQLITE_TESTCTRL_SCRATCHMALLOC 17 /* NOT USED */\n#define SQLITE_TESTCTRL_INTERNAL_FUNCTIONS 17\n#define SQLITE_TESTCTRL_LOCALTIME_FAULT 18\n#define SQLITE_TESTCTRL_EXPLAIN_STMT 19 /* NOT USED */\n#define SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD 19\n#define SQLITE_TESTCTRL_NEVER_CORRUPT 20\n#define SQLITE_TESTCTRL_VDBE_COVERAGE 21\n#define SQLITE_TESTCTRL_BYTEORDER 22\n#define SQLITE_TESTCTRL_ISINIT 23\n#define SQLITE_TESTCTRL_SORTER_MMAP 24\n#define SQLITE_TESTCTRL_IMPOSTER 25\n#define SQLITE_TESTCTRL_PARSER_COVERAGE 26\n#define SQLITE_TESTCTRL_RESULT_INTREAL 27\n#define SQLITE_TESTCTRL_PRNG_SEED 28\n#define SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS 29\n#define SQLITE_TESTCTRL_SEEK_COUNT 30\n#define SQLITE_TESTCTRL_TRACEFLAGS 31\n#define SQLITE_TESTCTRL_TUNE 32\n#define SQLITE_TESTCTRL_LOGEST 33\n#define SQLITE_TESTCTRL_USELONGDOUBLE 34 /* NOT USED */\n#define SQLITE_TESTCTRL_LAST 34 /* Largest TESTCTRL */\n\n/*\n** CAPI3REF: SQL Keyword Checking\n**\n** These routines provide access to the set of SQL language keywords\n** recognized by SQLite. Applications can uses these routines to determine\n** whether or not a specific identifier needs to be escaped (for example,\n** by enclosing in double-quotes) so as not to confuse the parser.\n**\n** The sqlite3_keyword_count() interface returns the number of distinct\n** keywords understood by SQLite.\n**\n** The sqlite3_keyword_name(N,Z,L) interface finds the 0-based N-th keyword and\n** makes *Z point to that keyword expressed as UTF8 and writes the number\n** of bytes in the keyword into *L. The string that *Z points to is not\n** zero-terminated. The sqlite3_keyword_name(N,Z,L) routine returns\n** SQLITE_OK if N is within bounds and SQLITE_ERROR if not. If either Z\n** or L are NULL or invalid pointers then calls to\n** sqlite3_keyword_name(N,Z,L) result in undefined behavior.\n**\n** The sqlite3_keyword_check(Z,L) interface checks to see whether or not\n** the L-byte UTF8 identifier that Z points to is a keyword, returning non-zero\n** if it is and zero if not.\n**\n** The parser used by SQLite is forgiving. It is often possible to use\n** a keyword as an identifier as long as such use does not result in a\n** parsing ambiguity. For example, the statement\n** \"CREATE TABLE BEGIN(REPLACE,PRAGMA,END);\" is accepted by SQLite, and\n** creates a new table named \"BEGIN\" with three columns named\n** \"REPLACE\", \"PRAGMA\", and \"END\". Nevertheless, best practice is to avoid\n** using keywords as identifiers. Common techniques used to avoid keyword\n** name collisions include:\n** <ul>\n** <li> Put all identifier names inside double-quotes. This is the official\n** SQL way to escape identifier names.\n** <li> Put identifier names inside [...]. This is not standard SQL,\n** but it is what SQL Server does and so lots of programmers use this\n** technique.\n** <li> Begin every identifier with the letter \"Z\" as no SQL keywords start\n** with \"Z\".\n** <li> Include a digit somewhere in every identifier name.\n** </ul>\n**\n** Note that the number of keywords understood by SQLite can depend on\n** compile-time options. For example, \"VACUUM\" is not a keyword if\n** SQLite is compiled with the [-DSQLITE_OMIT_VACUUM] option. Also,\n** new keywords may be added to future releases of SQLite.\n*/\nSQLITE_API int sqlite3_keyword_count(void);\nSQLITE_API int sqlite3_keyword_name(int,const char**,int*);\nSQLITE_API int sqlite3_keyword_check(const char*,int);\n\n/*\n** CAPI3REF: Dynamic String Object\n** KEYWORDS: {dynamic string}\n**\n** An instance of the sqlite3_str object contains a dynamically-sized\n** string under construction.\n**\n** The lifecycle of an sqlite3_str object is as follows:\n** <ol>\n** <li> ^The sqlite3_str object is created using [sqlite3_str_new()].\n** <li> ^Text is appended to the sqlite3_str object using various\n** methods, such as [sqlite3_str_appendf()].\n** <li> ^The sqlite3_str object is destroyed and the string it created\n** is returned using the [sqlite3_str_finish()] interface.\n** </ol>\n*/\ntypedef struct sqlite3_str sqlite3_str;\n\n/*\n** CAPI3REF: Create A New Dynamic String Object\n** CONSTRUCTOR: sqlite3_str\n**\n** ^The [sqlite3_str_new(D)] interface allocates and initializes\n** a new [sqlite3_str] object. To avoid memory leaks, the object returned by\n** [sqlite3_str_new()] must be freed by a subsequent call to\n** [sqlite3_str_finish(X)].\n**\n** ^The [sqlite3_str_new(D)] interface always returns a pointer to a\n** valid [sqlite3_str] object, though in the event of an out-of-memory\n** error the returned object might be a special singleton that will\n** silently reject new text, always return SQLITE_NOMEM from\n** [sqlite3_str_errcode()], always return 0 for\n** [sqlite3_str_length()], and always return NULL from\n** [sqlite3_str_finish(X)]. It is always safe to use the value\n** returned by [sqlite3_str_new(D)] as the sqlite3_str parameter\n** to any of the other [sqlite3_str] methods.\n**\n** The D parameter to [sqlite3_str_new(D)] may be NULL. If the\n** D parameter in [sqlite3_str_new(D)] is not NULL, then the maximum\n** length of the string contained in the [sqlite3_str] object will be\n** the value set for [sqlite3_limit](D,[SQLITE_LIMIT_LENGTH]) instead\n** of [SQLITE_MAX_LENGTH].\n*/\nSQLITE_API sqlite3_str *sqlite3_str_new(sqlite3*);\n\n/*\n** CAPI3REF: Finalize A Dynamic String\n** DESTRUCTOR: sqlite3_str\n**\n** ^The [sqlite3_str_finish(X)] interface destroys the sqlite3_str object X\n** and returns a pointer to a memory buffer obtained from [sqlite3_malloc64()]\n** that contains the constructed string. The calling application should\n** pass the returned value to [sqlite3_free()] to avoid a memory leak.\n** ^The [sqlite3_str_finish(X)] interface may return a NULL pointer if any\n** errors were encountered during construction of the string. ^The\n** [sqlite3_str_finish(X)] interface will also return a NULL pointer if the\n** string in [sqlite3_str] object X is zero bytes long.\n*/\nSQLITE_API char *sqlite3_str_finish(sqlite3_str*);\n\n/*\n** CAPI3REF: Add Content To A Dynamic String\n** METHOD: sqlite3_str\n**\n** These interfaces add content to an sqlite3_str object previously obtained\n** from [sqlite3_str_new()].\n**\n** ^The [sqlite3_str_appendf(X,F,...)] and\n** [sqlite3_str_vappendf(X,F,V)] interfaces uses the [built-in printf]\n** functionality of SQLite to append formatted text onto the end of\n** [sqlite3_str] object X.\n**\n** ^The [sqlite3_str_append(X,S,N)] method appends exactly N bytes from string S\n** onto the end of the [sqlite3_str] object X. N must be non-negative.\n** S must contain at least N non-zero bytes of content. To append a\n** zero-terminated string in its entirety, use the [sqlite3_str_appendall()]\n** method instead.\n**\n** ^The [sqlite3_str_appendall(X,S)] method appends the complete content of\n** zero-terminated string S onto the end of [sqlite3_str] object X.\n**\n** ^The [sqlite3_str_appendchar(X,N,C)] method appends N copies of the\n** single-byte character C onto the end of [sqlite3_str] object X.\n** ^This method can be used, for example, to add whitespace indentation.\n**\n** ^The [sqlite3_str_reset(X)] method resets the string under construction\n** inside [sqlite3_str] object X back to zero bytes in length.\n**\n** These methods do not return a result code. ^If an error occurs, that fact\n** is recorded in the [sqlite3_str] object and can be recovered by a\n** subsequent call to [sqlite3_str_errcode(X)].\n*/\nSQLITE_API void sqlite3_str_appendf(sqlite3_str*, const char *zFormat, ...);\nSQLITE_API void sqlite3_str_vappendf(sqlite3_str*, const char *zFormat, va_list);\nSQLITE_API void sqlite3_str_append(sqlite3_str*, const char *zIn, int N);\nSQLITE_API void sqlite3_str_appendall(sqlite3_str*, const char *zIn);\nSQLITE_API void sqlite3_str_appendchar(sqlite3_str*, int N, char C);\nSQLITE_API void sqlite3_str_reset(sqlite3_str*);\n\n/*\n** CAPI3REF: Status Of A Dynamic String\n** METHOD: sqlite3_str\n**\n** These interfaces return the current status of an [sqlite3_str] object.\n**\n** ^If any prior errors have occurred while constructing the dynamic string\n** in sqlite3_str X, then the [sqlite3_str_errcode(X)] method will return\n** an appropriate error code. ^The [sqlite3_str_errcode(X)] method returns\n** [SQLITE_NOMEM] following any out-of-memory error, or\n** [SQLITE_TOOBIG] if the size of the dynamic string exceeds\n** [SQLITE_MAX_LENGTH], or [SQLITE_OK] if there have been no errors.\n**\n** ^The [sqlite3_str_length(X)] method returns the current length, in bytes,\n** of the dynamic string under construction in [sqlite3_str] object X.\n** ^The length returned by [sqlite3_str_length(X)] does not include the\n** zero-termination byte.\n**\n** ^The [sqlite3_str_value(X)] method returns a pointer to the current\n** content of the dynamic string under construction in X. The value\n** returned by [sqlite3_str_value(X)] is managed by the sqlite3_str object X\n** and might be freed or altered by any subsequent method on the same\n** [sqlite3_str] object. Applications must not used the pointer returned\n** [sqlite3_str_value(X)] after any subsequent method call on the same\n** object. ^Applications may change the content of the string returned\n** by [sqlite3_str_value(X)] as long as they do not write into any bytes\n** outside the range of 0 to [sqlite3_str_length(X)] and do not read or\n** write any byte after any subsequent sqlite3_str method call.\n*/\nSQLITE_API int sqlite3_str_errcode(sqlite3_str*);\nSQLITE_API int sqlite3_str_length(sqlite3_str*);\nSQLITE_API char *sqlite3_str_value(sqlite3_str*);\n\n/*\n** CAPI3REF: SQLite Runtime Status\n**\n** ^These interfaces are used to retrieve runtime status information\n** about the performance of SQLite, and optionally to reset various\n** highwater marks. ^The first argument is an integer code for\n** the specific parameter to measure. ^(Recognized integer codes\n** are of the form [status parameters | SQLITE_STATUS_...].)^\n** ^The current value of the parameter is returned into *pCurrent.\n** ^The highest recorded value is returned in *pHighwater. ^If the\n** resetFlag is true, then the highest record value is reset after\n** *pHighwater is written. ^(Some parameters do not record the highest\n** value. For those parameters\n** nothing is written into *pHighwater and the resetFlag is ignored.)^\n** ^(Other parameters record only the highwater mark and not the current\n** value. For these latter parameters nothing is written into *pCurrent.)^\n**\n** ^The sqlite3_status() and sqlite3_status64() routines return\n** SQLITE_OK on success and a non-zero [error code] on failure.\n**\n** If either the current value or the highwater mark is too large to\n** be represented by a 32-bit integer, then the values returned by\n** sqlite3_status() are undefined.\n**\n** See also: [sqlite3_db_status()]\n*/\nSQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag);\nSQLITE_API int sqlite3_status64(\n int op,\n sqlite3_int64 *pCurrent,\n sqlite3_int64 *pHighwater,\n int resetFlag\n);\n\n\n/*\n** CAPI3REF: Status Parameters\n** KEYWORDS: {status parameters}\n**\n** These integer constants designate various run-time status parameters\n** that can be returned by [sqlite3_status()].\n**\n** <dl>\n** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt>\n** <dd>This parameter is the current amount of memory checked out\n** using [sqlite3_malloc()], either directly or indirectly. The\n** figure includes calls made to [sqlite3_malloc()] by the application\n** and internal memory usage by the SQLite library. Auxiliary page-cache\n** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in\n** this parameter. The amount returned is the sum of the allocation\n** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^\n**\n** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt>\n** <dd>This parameter records the largest memory allocation request\n** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their\n** internal equivalents). Only the value returned in the\n** *pHighwater parameter to [sqlite3_status()] is of interest.\n** The value written into the *pCurrent parameter is undefined.</dd>)^\n**\n** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt>\n** <dd>This parameter records the number of separate memory allocations\n** currently checked out.</dd>)^\n**\n** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt>\n** <dd>This parameter returns the number of pages used out of the\n** [pagecache memory allocator] that was configured using\n** [SQLITE_CONFIG_PAGECACHE]. The\n** value returned is in pages, not in bytes.</dd>)^\n**\n** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]]\n** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>\n** <dd>This parameter returns the number of bytes of page cache\n** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE]\n** buffer and where forced to overflow to [sqlite3_malloc()]. The\n** returned value includes allocations that overflowed because they\n** where too large (they were larger than the \"sz\" parameter to\n** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because\n** no space was left in the page cache.</dd>)^\n**\n** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>\n** <dd>This parameter records the largest memory allocation request\n** handed to the [pagecache memory allocator]. Only the value returned in the\n** *pHighwater parameter to [sqlite3_status()] is of interest.\n** The value written into the *pCurrent parameter is undefined.</dd>)^\n**\n** [[SQLITE_STATUS_SCRATCH_USED]] <dt>SQLITE_STATUS_SCRATCH_USED</dt>\n** <dd>No longer used.</dd>\n**\n** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>\n** <dd>No longer used.</dd>\n**\n** [[SQLITE_STATUS_SCRATCH_SIZE]] <dt>SQLITE_STATUS_SCRATCH_SIZE</dt>\n** <dd>No longer used.</dd>\n**\n** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt>\n** <dd>The *pHighwater parameter records the deepest parser stack.\n** The *pCurrent value is undefined. The *pHighwater value is only\n** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^\n** </dl>\n**\n** New status parameters may be added from time to time.\n*/\n#define SQLITE_STATUS_MEMORY_USED 0\n#define SQLITE_STATUS_PAGECACHE_USED 1\n#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2\n#define SQLITE_STATUS_SCRATCH_USED 3 /* NOT USED */\n#define SQLITE_STATUS_SCRATCH_OVERFLOW 4 /* NOT USED */\n#define SQLITE_STATUS_MALLOC_SIZE 5\n#define SQLITE_STATUS_PARSER_STACK 6\n#define SQLITE_STATUS_PAGECACHE_SIZE 7\n#define SQLITE_STATUS_SCRATCH_SIZE 8 /* NOT USED */\n#define SQLITE_STATUS_MALLOC_COUNT 9\n\n/*\n** CAPI3REF: Database Connection Status\n** METHOD: sqlite3\n**\n** ^This interface is used to retrieve runtime status information\n** about a single [database connection]. ^The first argument is the\n** database connection object to be interrogated. ^The second argument\n** is an integer constant, taken from the set of\n** [SQLITE_DBSTATUS options], that\n** determines the parameter to interrogate. The set of\n** [SQLITE_DBSTATUS options] is likely\n** to grow in future releases of SQLite.\n**\n** ^The current value of the requested parameter is written into *pCur\n** and the highest instantaneous value is written into *pHiwtr. ^If\n** the resetFlg is true, then the highest instantaneous value is\n** reset back down to the current value.\n**\n** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a\n** non-zero [error code] on failure.\n**\n** See also: [sqlite3_status()] and [sqlite3_stmt_status()].\n*/\nSQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);\n\n/*\n** CAPI3REF: Status Parameters for database connections\n** KEYWORDS: {SQLITE_DBSTATUS options}\n**\n** These constants are the available integer \"verbs\" that can be passed as\n** the second argument to the [sqlite3_db_status()] interface.\n**\n** New verbs may be added in future releases of SQLite. Existing verbs\n** might be discontinued. Applications should check the return code from\n** [sqlite3_db_status()] to make sure that the call worked.\n** The [sqlite3_db_status()] interface will return a non-zero error code\n** if a discontinued or unsupported verb is invoked.\n**\n** <dl>\n** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt>\n** <dd>This parameter returns the number of lookaside memory slots currently\n** checked out.</dd>)^\n**\n** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt>\n** <dd>This parameter returns the number of malloc attempts that were\n** satisfied using lookaside memory. Only the high-water value is meaningful;\n** the current value is always zero.)^\n**\n** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]]\n** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt>\n** <dd>This parameter returns the number malloc attempts that might have\n** been satisfied using lookaside memory but failed due to the amount of\n** memory requested being larger than the lookaside slot size.\n** Only the high-water value is meaningful;\n** the current value is always zero.)^\n**\n** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]]\n** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt>\n** <dd>This parameter returns the number malloc attempts that might have\n** been satisfied using lookaside memory but failed due to all lookaside\n** memory already being in use.\n** Only the high-water value is meaningful;\n** the current value is always zero.)^\n**\n** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt>\n** <dd>This parameter returns the approximate number of bytes of heap\n** memory used by all pager caches associated with the database connection.)^\n** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0.\n**\n** [[SQLITE_DBSTATUS_CACHE_USED_SHARED]]\n** ^(<dt>SQLITE_DBSTATUS_CACHE_USED_SHARED</dt>\n** <dd>This parameter is similar to DBSTATUS_CACHE_USED, except that if a\n** pager cache is shared between two or more connections the bytes of heap\n** memory used by that pager cache is divided evenly between the attached\n** connections.)^ In other words, if none of the pager caches associated\n** with the database connection are shared, this request returns the same\n** value as DBSTATUS_CACHE_USED. Or, if one or more or the pager caches are\n** shared, the value returned by this call will be smaller than that returned\n** by DBSTATUS_CACHE_USED. ^The highwater mark associated with\n** SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0.\n**\n** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt>\n** <dd>This parameter returns the approximate number of bytes of heap\n** memory used to store the schema for all databases associated\n** with the connection - main, temp, and any [ATTACH]-ed databases.)^\n** ^The full amount of memory used by the schemas is reported, even if the\n** schema memory is shared with other database connections due to\n** [shared cache mode] being enabled.\n** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0.\n**\n** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt>\n** <dd>This parameter returns the approximate number of bytes of heap\n** and lookaside memory used by all prepared statements associated with\n** the database connection.)^\n** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0.\n** </dd>\n**\n** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt>\n** <dd>This parameter returns the number of pager cache hits that have\n** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT\n** is always 0.\n** </dd>\n**\n** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt>\n** <dd>This parameter returns the number of pager cache misses that have\n** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS\n** is always 0.\n** </dd>\n**\n** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt>\n** <dd>This parameter returns the number of dirty cache entries that have\n** been written to disk. Specifically, the number of pages written to the\n** wal file in wal mode databases, or the number of pages written to the\n** database file in rollback mode databases. Any pages written as part of\n** transaction rollback or database recovery operations are not included.\n** If an IO or other error occurs while writing a page to disk, the effect\n** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The\n** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0.\n** </dd>\n**\n** [[SQLITE_DBSTATUS_CACHE_SPILL]] ^(<dt>SQLITE_DBSTATUS_CACHE_SPILL</dt>\n** <dd>This parameter returns the number of dirty cache entries that have\n** been written to disk in the middle of a transaction due to the page\n** cache overflowing. Transactions are more efficient if they are written\n** to disk all at once. When pages spill mid-transaction, that introduces\n** additional overhead. This parameter can be used help identify\n** inefficiencies that can be resolved by increasing the cache size.\n** </dd>\n**\n** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(<dt>SQLITE_DBSTATUS_DEFERRED_FKS</dt>\n** <dd>This parameter returns zero for the current value if and only if\n** all foreign key constraints (deferred or immediate) have been\n** resolved.)^ ^The highwater mark is always 0.\n** </dd>\n** </dl>\n*/\n#define SQLITE_DBSTATUS_LOOKASIDE_USED 0\n#define SQLITE_DBSTATUS_CACHE_USED 1\n#define SQLITE_DBSTATUS_SCHEMA_USED 2\n#define SQLITE_DBSTATUS_STMT_USED 3\n#define SQLITE_DBSTATUS_LOOKASIDE_HIT 4\n#define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5\n#define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6\n#define SQLITE_DBSTATUS_CACHE_HIT 7\n#define SQLITE_DBSTATUS_CACHE_MISS 8\n#define SQLITE_DBSTATUS_CACHE_WRITE 9\n#define SQLITE_DBSTATUS_DEFERRED_FKS 10\n#define SQLITE_DBSTATUS_CACHE_USED_SHARED 11\n#define SQLITE_DBSTATUS_CACHE_SPILL 12\n#define SQLITE_DBSTATUS_MAX 12 /* Largest defined DBSTATUS */\n\n\n/*\n** CAPI3REF: Prepared Statement Status\n** METHOD: sqlite3_stmt\n**\n** ^(Each prepared statement maintains various\n** [SQLITE_STMTSTATUS counters] that measure the number\n** of times it has performed specific operations.)^ These counters can\n** be used to monitor the performance characteristics of the prepared\n** statements. For example, if the number of table steps greatly exceeds\n** the number of table searches or result rows, that would tend to indicate\n** that the prepared statement is using a full table scan rather than\n** an index.\n**\n** ^(This interface is used to retrieve and reset counter values from\n** a [prepared statement]. The first argument is the prepared statement\n** object to be interrogated. The second argument\n** is an integer code for a specific [SQLITE_STMTSTATUS counter]\n** to be interrogated.)^\n** ^The current value of the requested counter is returned.\n** ^If the resetFlg is true, then the counter is reset to zero after this\n** interface call returns.\n**\n** See also: [sqlite3_status()] and [sqlite3_db_status()].\n*/\nSQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);\n\n/*\n** CAPI3REF: Status Parameters for prepared statements\n** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters}\n**\n** These preprocessor macros define integer codes that name counter\n** values associated with the [sqlite3_stmt_status()] interface.\n** The meanings of the various counters are as follows:\n**\n** <dl>\n** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>\n** <dd>^This is the number of times that SQLite has stepped forward in\n** a table as part of a full table scan. Large numbers for this counter\n** may indicate opportunities for performance improvement through\n** careful use of indices.</dd>\n**\n** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt>\n** <dd>^This is the number of sort operations that have occurred.\n** A non-zero value in this counter may indicate an opportunity to\n** improvement performance through careful use of indices.</dd>\n**\n** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt>\n** <dd>^This is the number of rows inserted into transient indices that\n** were created automatically in order to help joins run faster.\n** A non-zero value in this counter may indicate an opportunity to\n** improvement performance by adding permanent indices that do not\n** need to be reinitialized each time the statement is run.</dd>\n**\n** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt>\n** <dd>^This is the number of virtual machine operations executed\n** by the prepared statement if that number is less than or equal\n** to 2147483647. The number of virtual machine operations can be\n** used as a proxy for the total work done by the prepared statement.\n** If the number of virtual machine operations exceeds 2147483647\n** then the value returned by this statement status code is undefined.\n**\n** [[SQLITE_STMTSTATUS_REPREPARE]] <dt>SQLITE_STMTSTATUS_REPREPARE</dt>\n** <dd>^This is the number of times that the prepare statement has been\n** automatically regenerated due to schema changes or changes to\n** [bound parameters] that might affect the query plan.\n**\n** [[SQLITE_STMTSTATUS_RUN]] <dt>SQLITE_STMTSTATUS_RUN</dt>\n** <dd>^This is the number of times that the prepared statement has\n** been run. A single \"run\" for the purposes of this counter is one\n** or more calls to [sqlite3_step()] followed by a call to [sqlite3_reset()].\n** The counter is incremented on the first [sqlite3_step()] call of each\n** cycle.\n**\n** [[SQLITE_STMTSTATUS_FILTER_MISS]]\n** [[SQLITE_STMTSTATUS_FILTER HIT]]\n** <dt>SQLITE_STMTSTATUS_FILTER_HIT<br>\n** SQLITE_STMTSTATUS_FILTER_MISS</dt>\n** <dd>^SQLITE_STMTSTATUS_FILTER_HIT is the number of times that a join\n** step was bypassed because a Bloom filter returned not-found. The\n** corresponding SQLITE_STMTSTATUS_FILTER_MISS value is the number of\n** times that the Bloom filter returned a find, and thus the join step\n** had to be processed as normal.\n**\n** [[SQLITE_STMTSTATUS_MEMUSED]] <dt>SQLITE_STMTSTATUS_MEMUSED</dt>\n** <dd>^This is the approximate number of bytes of heap memory\n** used to store the prepared statement. ^This value is not actually\n** a counter, and so the resetFlg parameter to sqlite3_stmt_status()\n** is ignored when the opcode is SQLITE_STMTSTATUS_MEMUSED.\n** </dd>\n** </dl>\n*/\n#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1\n#define SQLITE_STMTSTATUS_SORT 2\n#define SQLITE_STMTSTATUS_AUTOINDEX 3\n#define SQLITE_STMTSTATUS_VM_STEP 4\n#define SQLITE_STMTSTATUS_REPREPARE 5\n#define SQLITE_STMTSTATUS_RUN 6\n#define SQLITE_STMTSTATUS_FILTER_MISS 7\n#define SQLITE_STMTSTATUS_FILTER_HIT 8\n#define SQLITE_STMTSTATUS_MEMUSED 99\n\n/*\n** CAPI3REF: Custom Page Cache Object\n**\n** The sqlite3_pcache type is opaque. It is implemented by\n** the pluggable module. The SQLite core has no knowledge of\n** its size or internal structure and never deals with the\n** sqlite3_pcache object except by holding and passing pointers\n** to the object.\n**\n** See [sqlite3_pcache_methods2] for additional information.\n*/\ntypedef struct sqlite3_pcache sqlite3_pcache;\n\n/*\n** CAPI3REF: Custom Page Cache Object\n**\n** The sqlite3_pcache_page object represents a single page in the\n** page cache. The page cache will allocate instances of this\n** object. Various methods of the page cache use pointers to instances\n** of this object as parameters or as their return value.\n**\n** See [sqlite3_pcache_methods2] for additional information.\n*/\ntypedef struct sqlite3_pcache_page sqlite3_pcache_page;\nstruct sqlite3_pcache_page {\n void *pBuf; /* The content of the page */\n void *pExtra; /* Extra information associated with the page */\n};\n\n/*\n** CAPI3REF: Application Defined Page Cache.\n** KEYWORDS: {page cache}\n**\n** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can\n** register an alternative page cache implementation by passing in an\n** instance of the sqlite3_pcache_methods2 structure.)^\n** In many applications, most of the heap memory allocated by\n** SQLite is used for the page cache.\n** By implementing a\n** custom page cache using this API, an application can better control\n** the amount of memory consumed by SQLite, the way in which\n** that memory is allocated and released, and the policies used to\n** determine exactly which parts of a database file are cached and for\n** how long.\n**\n** The alternative page cache mechanism is an\n** extreme measure that is only needed by the most demanding applications.\n** The built-in page cache is recommended for most uses.\n**\n** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an\n** internal buffer by SQLite within the call to [sqlite3_config]. Hence\n** the application may discard the parameter after the call to\n** [sqlite3_config()] returns.)^\n**\n** [[the xInit() page cache method]]\n** ^(The xInit() method is called once for each effective\n** call to [sqlite3_initialize()])^\n** (usually only once during the lifetime of the process). ^(The xInit()\n** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^\n** The intent of the xInit() method is to set up global data structures\n** required by the custom page cache implementation.\n** ^(If the xInit() method is NULL, then the\n** built-in default page cache is used instead of the application defined\n** page cache.)^\n**\n** [[the xShutdown() page cache method]]\n** ^The xShutdown() method is called by [sqlite3_shutdown()].\n** It can be used to clean up\n** any outstanding resources before process shutdown, if required.\n** ^The xShutdown() method may be NULL.\n**\n** ^SQLite automatically serializes calls to the xInit method,\n** so the xInit method need not be threadsafe. ^The\n** xShutdown method is only called from [sqlite3_shutdown()] so it does\n** not need to be threadsafe either. All other methods must be threadsafe\n** in multithreaded applications.\n**\n** ^SQLite will never invoke xInit() more than once without an intervening\n** call to xShutdown().\n**\n** [[the xCreate() page cache methods]]\n** ^SQLite invokes the xCreate() method to construct a new cache instance.\n** SQLite will typically create one cache instance for each open database file,\n** though this is not guaranteed. ^The\n** first parameter, szPage, is the size in bytes of the pages that must\n** be allocated by the cache. ^szPage will always a power of two. ^The\n** second parameter szExtra is a number of bytes of extra storage\n** associated with each page cache entry. ^The szExtra parameter will\n** a number less than 250. SQLite will use the\n** extra szExtra bytes on each page to store metadata about the underlying\n** database page on disk. The value passed into szExtra depends\n** on the SQLite version, the target platform, and how SQLite was compiled.\n** ^The third argument to xCreate(), bPurgeable, is true if the cache being\n** created will be used to cache database pages of a file stored on disk, or\n** false if it is used for an in-memory database. The cache implementation\n** does not have to do anything special based with the value of bPurgeable;\n** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will\n** never invoke xUnpin() except to deliberately delete a page.\n** ^In other words, calls to xUnpin() on a cache with bPurgeable set to\n** false will always have the \"discard\" flag set to true.\n** ^Hence, a cache created with bPurgeable false will\n** never contain any unpinned pages.\n**\n** [[the xCachesize() page cache method]]\n** ^(The xCachesize() method may be called at any time by SQLite to set the\n** suggested maximum cache-size (number of pages stored by) the cache\n** instance passed as the first argument. This is the value configured using\n** the SQLite \"[PRAGMA cache_size]\" command.)^ As with the bPurgeable\n** parameter, the implementation is not required to do anything with this\n** value; it is advisory only.\n**\n** [[the xPagecount() page cache methods]]\n** The xPagecount() method must return the number of pages currently\n** stored in the cache, both pinned and unpinned.\n**\n** [[the xFetch() page cache methods]]\n** The xFetch() method locates a page in the cache and returns a pointer to\n** an sqlite3_pcache_page object associated with that page, or a NULL pointer.\n** The pBuf element of the returned sqlite3_pcache_page object will be a\n** pointer to a buffer of szPage bytes used to store the content of a\n** single database page. The pExtra element of sqlite3_pcache_page will be\n** a pointer to the szExtra bytes of extra storage that SQLite has requested\n** for each entry in the page cache.\n**\n** The page to be fetched is determined by the key. ^The minimum key value\n** is 1. After it has been retrieved using xFetch, the page is considered\n** to be \"pinned\".\n**\n** If the requested page is already in the page cache, then the page cache\n** implementation must return a pointer to the page buffer with its content\n** intact. If the requested page is not already in the cache, then the\n** cache implementation should use the value of the createFlag\n** parameter to help it determined what action to take:\n**\n** <table border=1 width=85% align=center>\n** <tr><th> createFlag <th> Behavior when page is not already in cache\n** <tr><td> 0 <td> Do not allocate a new page. Return NULL.\n** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so.\n** Otherwise return NULL.\n** <tr><td> 2 <td> Make every effort to allocate a new page. Only return\n** NULL if allocating a new page is effectively impossible.\n** </table>\n**\n** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite\n** will only use a createFlag of 2 after a prior call with a createFlag of 1\n** failed.)^ In between the xFetch() calls, SQLite may\n** attempt to unpin one or more cache pages by spilling the content of\n** pinned pages to disk and synching the operating system disk cache.\n**\n** [[the xUnpin() page cache method]]\n** ^xUnpin() is called by SQLite with a pointer to a currently pinned page\n** as its second argument. If the third parameter, discard, is non-zero,\n** then the page must be evicted from the cache.\n** ^If the discard parameter is\n** zero, then the page may be discarded or retained at the discretion of\n** page cache implementation. ^The page cache implementation\n** may choose to evict unpinned pages at any time.\n**\n** The cache must not perform any reference counting. A single\n** call to xUnpin() unpins the page regardless of the number of prior calls\n** to xFetch().\n**\n** [[the xRekey() page cache methods]]\n** The xRekey() method is used to change the key value associated with the\n** page passed as the second argument. If the cache\n** previously contains an entry associated with newKey, it must be\n** discarded. ^Any prior cache entry associated with newKey is guaranteed not\n** to be pinned.\n**\n** When SQLite calls the xTruncate() method, the cache must discard all\n** existing cache entries with page numbers (keys) greater than or equal\n** to the value of the iLimit parameter passed to xTruncate(). If any\n** of these pages are pinned, they are implicitly unpinned, meaning that\n** they can be safely discarded.\n**\n** [[the xDestroy() page cache method]]\n** ^The xDestroy() method is used to delete a cache allocated by xCreate().\n** All resources associated with the specified cache should be freed. ^After\n** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*]\n** handle invalid, and will not use it with any other sqlite3_pcache_methods2\n** functions.\n**\n** [[the xShrink() page cache method]]\n** ^SQLite invokes the xShrink() method when it wants the page cache to\n** free up as much of heap memory as possible. The page cache implementation\n** is not obligated to free any memory, but well-behaved implementations should\n** do their best.\n*/\ntypedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2;\nstruct sqlite3_pcache_methods2 {\n int iVersion;\n void *pArg;\n int (*xInit)(void*);\n void (*xShutdown)(void*);\n sqlite3_pcache *(*xCreate)(int szPage, int szExtra, int bPurgeable);\n void (*xCachesize)(sqlite3_pcache*, int nCachesize);\n int (*xPagecount)(sqlite3_pcache*);\n sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);\n void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard);\n void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*,\n unsigned oldKey, unsigned newKey);\n void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);\n void (*xDestroy)(sqlite3_pcache*);\n void (*xShrink)(sqlite3_pcache*);\n};\n\n/*\n** This is the obsolete pcache_methods object that has now been replaced\n** by sqlite3_pcache_methods2. This object is not used by SQLite. It is\n** retained in the header file for backwards compatibility only.\n*/\ntypedef struct sqlite3_pcache_methods sqlite3_pcache_methods;\nstruct sqlite3_pcache_methods {\n void *pArg;\n int (*xInit)(void*);\n void (*xShutdown)(void*);\n sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable);\n void (*xCachesize)(sqlite3_pcache*, int nCachesize);\n int (*xPagecount)(sqlite3_pcache*);\n void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);\n void (*xUnpin)(sqlite3_pcache*, void*, int discard);\n void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey);\n void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);\n void (*xDestroy)(sqlite3_pcache*);\n};\n\n\n/*\n** CAPI3REF: Online Backup Object\n**\n** The sqlite3_backup object records state information about an ongoing\n** online backup operation. ^The sqlite3_backup object is created by\n** a call to [sqlite3_backup_init()] and is destroyed by a call to\n** [sqlite3_backup_finish()].\n**\n** See Also: [Using the SQLite Online Backup API]\n*/\ntypedef struct sqlite3_backup sqlite3_backup;\n\n/*\n** CAPI3REF: Online Backup API.\n**\n** The backup API copies the content of one database into another.\n** It is useful either for creating backups of databases or\n** for copying in-memory databases to or from persistent files.\n**\n** See Also: [Using the SQLite Online Backup API]\n**\n** ^SQLite holds a write transaction open on the destination database file\n** for the duration of the backup operation.\n** ^The source database is read-locked only while it is being read;\n** it is not locked continuously for the entire backup operation.\n** ^Thus, the backup may be performed on a live source database without\n** preventing other database connections from\n** reading or writing to the source database while the backup is underway.\n**\n** ^(To perform a backup operation:\n** <ol>\n** <li><b>sqlite3_backup_init()</b> is called once to initialize the\n** backup,\n** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer\n** the data between the two databases, and finally\n** <li><b>sqlite3_backup_finish()</b> is called to release all resources\n** associated with the backup operation.\n** </ol>)^\n** There should be exactly one call to sqlite3_backup_finish() for each\n** successful call to sqlite3_backup_init().\n**\n** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b>\n**\n** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the\n** [database connection] associated with the destination database\n** and the database name, respectively.\n** ^The database name is \"main\" for the main database, \"temp\" for the\n** temporary database, or the name specified after the AS keyword in\n** an [ATTACH] statement for an attached database.\n** ^The S and M arguments passed to\n** sqlite3_backup_init(D,N,S,M) identify the [database connection]\n** and database name of the source database, respectively.\n** ^The source and destination [database connections] (parameters S and D)\n** must be different or else sqlite3_backup_init(D,N,S,M) will fail with\n** an error.\n**\n** ^A call to sqlite3_backup_init() will fail, returning NULL, if\n** there is already a read or read-write transaction open on the\n** destination database.\n**\n** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is\n** returned and an error code and error message are stored in the\n** destination [database connection] D.\n** ^The error code and message for the failed call to sqlite3_backup_init()\n** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or\n** [sqlite3_errmsg16()] functions.\n** ^A successful call to sqlite3_backup_init() returns a pointer to an\n** [sqlite3_backup] object.\n** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and\n** sqlite3_backup_finish() functions to perform the specified backup\n** operation.\n**\n** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b>\n**\n** ^Function sqlite3_backup_step(B,N) will copy up to N pages between\n** the source and destination databases specified by [sqlite3_backup] object B.\n** ^If N is negative, all remaining source pages are copied.\n** ^If sqlite3_backup_step(B,N) successfully copies N pages and there\n** are still more pages to be copied, then the function returns [SQLITE_OK].\n** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages\n** from source to destination, then it returns [SQLITE_DONE].\n** ^If an error occurs while running sqlite3_backup_step(B,N),\n** then an [error code] is returned. ^As well as [SQLITE_OK] and\n** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY],\n** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an\n** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code.\n**\n** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if\n** <ol>\n** <li> the destination database was opened read-only, or\n** <li> the destination database is using write-ahead-log journaling\n** and the destination and source page sizes differ, or\n** <li> the destination database is an in-memory database and the\n** destination and source page sizes differ.\n** </ol>)^\n**\n** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then\n** the [sqlite3_busy_handler | busy-handler function]\n** is invoked (if one is specified). ^If the\n** busy-handler returns non-zero before the lock is available, then\n** [SQLITE_BUSY] is returned to the caller. ^In this case the call to\n** sqlite3_backup_step() can be retried later. ^If the source\n** [database connection]\n** is being used to write to the source database when sqlite3_backup_step()\n** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this\n** case the call to sqlite3_backup_step() can be retried later on. ^(If\n** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or\n** [SQLITE_READONLY] is returned, then\n** there is no point in retrying the call to sqlite3_backup_step(). These\n** errors are considered fatal.)^ The application must accept\n** that the backup operation has failed and pass the backup operation handle\n** to the sqlite3_backup_finish() to release associated resources.\n**\n** ^The first call to sqlite3_backup_step() obtains an exclusive lock\n** on the destination file. ^The exclusive lock is not released until either\n** sqlite3_backup_finish() is called or the backup operation is complete\n** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to\n** sqlite3_backup_step() obtains a [shared lock] on the source database that\n** lasts for the duration of the sqlite3_backup_step() call.\n** ^Because the source database is not locked between calls to\n** sqlite3_backup_step(), the source database may be modified mid-way\n** through the backup process. ^If the source database is modified by an\n** external process or via a database connection other than the one being\n** used by the backup operation, then the backup will be automatically\n** restarted by the next call to sqlite3_backup_step(). ^If the source\n** database is modified by the using the same database connection as is used\n** by the backup operation, then the backup database is automatically\n** updated at the same time.\n**\n** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b>\n**\n** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the\n** application wishes to abandon the backup operation, the application\n** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish().\n** ^The sqlite3_backup_finish() interfaces releases all\n** resources associated with the [sqlite3_backup] object.\n** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any\n** active write-transaction on the destination database is rolled back.\n** The [sqlite3_backup] object is invalid\n** and may not be used following a call to sqlite3_backup_finish().\n**\n** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no\n** sqlite3_backup_step() errors occurred, regardless or whether or not\n** sqlite3_backup_step() completed.\n** ^If an out-of-memory condition or IO error occurred during any prior\n** sqlite3_backup_step() call on the same [sqlite3_backup] object, then\n** sqlite3_backup_finish() returns the corresponding [error code].\n**\n** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step()\n** is not a permanent error and does not affect the return value of\n** sqlite3_backup_finish().\n**\n** [[sqlite3_backup_remaining()]] [[sqlite3_backup_pagecount()]]\n** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b>\n**\n** ^The sqlite3_backup_remaining() routine returns the number of pages still\n** to be backed up at the conclusion of the most recent sqlite3_backup_step().\n** ^The sqlite3_backup_pagecount() routine returns the total number of pages\n** in the source database at the conclusion of the most recent\n** sqlite3_backup_step().\n** ^(The values returned by these functions are only updated by\n** sqlite3_backup_step(). If the source database is modified in a way that\n** changes the size of the source database or the number of pages remaining,\n** those changes are not reflected in the output of sqlite3_backup_pagecount()\n** and sqlite3_backup_remaining() until after the next\n** sqlite3_backup_step().)^\n**\n** <b>Concurrent Usage of Database Handles</b>\n**\n** ^The source [database connection] may be used by the application for other\n** purposes while a backup operation is underway or being initialized.\n** ^If SQLite is compiled and configured to support threadsafe database\n** connections, then the source database connection may be used concurrently\n** from within other threads.\n**\n** However, the application must guarantee that the destination\n** [database connection] is not passed to any other API (by any thread) after\n** sqlite3_backup_init() is called and before the corresponding call to\n** sqlite3_backup_finish(). SQLite does not currently check to see\n** if the application incorrectly accesses the destination [database connection]\n** and so no error code is reported, but the operations may malfunction\n** nevertheless. Use of the destination database connection while a\n** backup is in progress might also cause a mutex deadlock.\n**\n** If running in [shared cache mode], the application must\n** guarantee that the shared cache used by the destination database\n** is not accessed while the backup is running. In practice this means\n** that the application must guarantee that the disk file being\n** backed up to is not accessed by any connection within the process,\n** not just the specific connection that was passed to sqlite3_backup_init().\n**\n** The [sqlite3_backup] object itself is partially threadsafe. Multiple\n** threads may safely make multiple concurrent calls to sqlite3_backup_step().\n** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount()\n** APIs are not strictly speaking threadsafe. If they are invoked at the\n** same time as another thread is invoking sqlite3_backup_step() it is\n** possible that they return invalid values.\n**\n** <b>Alternatives To Using The Backup API</b>\n**\n** Other techniques for safely creating a consistent backup of an SQLite\n** database include:\n**\n** <ul>\n** <li> The [VACUUM INTO] command.\n** <li> The [sqlite3_rsync] utility program.\n** </ul>\n*/\nSQLITE_API sqlite3_backup *sqlite3_backup_init(\n sqlite3 *pDest, /* Destination database handle */\n const char *zDestName, /* Destination database name */\n sqlite3 *pSource, /* Source database handle */\n const char *zSourceName /* Source database name */\n);\nSQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage);\nSQLITE_API int sqlite3_backup_finish(sqlite3_backup *p);\nSQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p);\nSQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p);\n\n/*\n** CAPI3REF: Unlock Notification\n** METHOD: sqlite3\n**\n** ^When running in shared-cache mode, a database operation may fail with\n** an [SQLITE_LOCKED] error if the required locks on the shared-cache or\n** individual tables within the shared-cache cannot be obtained. See\n** [SQLite Shared-Cache Mode] for a description of shared-cache locking.\n** ^This API may be used to register a callback that SQLite will invoke\n** when the connection currently holding the required lock relinquishes it.\n** ^This API is only available if the library was compiled with the\n** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined.\n**\n** See Also: [Using the SQLite Unlock Notification Feature].\n**\n** ^Shared-cache locks are released when a database connection concludes\n** its current transaction, either by committing it or rolling it back.\n**\n** ^When a connection (known as the blocked connection) fails to obtain a\n** shared-cache lock and SQLITE_LOCKED is returned to the caller, the\n** identity of the database connection (the blocking connection) that\n** has locked the required resource is stored internally. ^After an\n** application receives an SQLITE_LOCKED error, it may call the\n** sqlite3_unlock_notify() method with the blocked connection handle as\n** the first argument to register for a callback that will be invoked\n** when the blocking connections current transaction is concluded. ^The\n** callback is invoked from within the [sqlite3_step] or [sqlite3_close]\n** call that concludes the blocking connection's transaction.\n**\n** ^(If sqlite3_unlock_notify() is called in a multi-threaded application,\n** there is a chance that the blocking connection will have already\n** concluded its transaction by the time sqlite3_unlock_notify() is invoked.\n** If this happens, then the specified callback is invoked immediately,\n** from within the call to sqlite3_unlock_notify().)^\n**\n** ^If the blocked connection is attempting to obtain a write-lock on a\n** shared-cache table, and more than one other connection currently holds\n** a read-lock on the same table, then SQLite arbitrarily selects one of\n** the other connections to use as the blocking connection.\n**\n** ^(There may be at most one unlock-notify callback registered by a\n** blocked connection. If sqlite3_unlock_notify() is called when the\n** blocked connection already has a registered unlock-notify callback,\n** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is\n** called with a NULL pointer as its second argument, then any existing\n** unlock-notify callback is canceled. ^The blocked connections\n** unlock-notify callback may also be canceled by closing the blocked\n** connection using [sqlite3_close()].\n**\n** The unlock-notify callback is not reentrant. If an application invokes\n** any sqlite3_xxx API functions from within an unlock-notify callback, a\n** crash or deadlock may be the result.\n**\n** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always\n** returns SQLITE_OK.\n**\n** <b>Callback Invocation Details</b>\n**\n** When an unlock-notify callback is registered, the application provides a\n** single void* pointer that is passed to the callback when it is invoked.\n** However, the signature of the callback function allows SQLite to pass\n** it an array of void* context pointers. The first argument passed to\n** an unlock-notify callback is a pointer to an array of void* pointers,\n** and the second is the number of entries in the array.\n**\n** When a blocking connection's transaction is concluded, there may be\n** more than one blocked connection that has registered for an unlock-notify\n** callback. ^If two or more such blocked connections have specified the\n** same callback function, then instead of invoking the callback function\n** multiple times, it is invoked once with the set of void* context pointers\n** specified by the blocked connections bundled together into an array.\n** This gives the application an opportunity to prioritize any actions\n** related to the set of unblocked database connections.\n**\n** <b>Deadlock Detection</b>\n**\n** Assuming that after registering for an unlock-notify callback a\n** database waits for the callback to be issued before taking any further\n** action (a reasonable assumption), then using this API may cause the\n** application to deadlock. For example, if connection X is waiting for\n** connection Y's transaction to be concluded, and similarly connection\n** Y is waiting on connection X's transaction, then neither connection\n** will proceed and the system may remain deadlocked indefinitely.\n**\n** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock\n** detection. ^If a given call to sqlite3_unlock_notify() would put the\n** system in a deadlocked state, then SQLITE_LOCKED is returned and no\n** unlock-notify callback is registered. The system is said to be in\n** a deadlocked state if connection A has registered for an unlock-notify\n** callback on the conclusion of connection B's transaction, and connection\n** B has itself registered for an unlock-notify callback when connection\n** A's transaction is concluded. ^Indirect deadlock is also detected, so\n** the system is also considered to be deadlocked if connection B has\n** registered for an unlock-notify callback on the conclusion of connection\n** C's transaction, where connection C is waiting on connection A. ^Any\n** number of levels of indirection are allowed.\n**\n** <b>The \"DROP TABLE\" Exception</b>\n**\n** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost\n** always appropriate to call sqlite3_unlock_notify(). There is however,\n** one exception. When executing a \"DROP TABLE\" or \"DROP INDEX\" statement,\n** SQLite checks if there are any currently executing SELECT statements\n** that belong to the same connection. If there are, SQLITE_LOCKED is\n** returned. In this case there is no \"blocking connection\", so invoking\n** sqlite3_unlock_notify() results in the unlock-notify callback being\n** invoked immediately. If the application then re-attempts the \"DROP TABLE\"\n** or \"DROP INDEX\" query, an infinite loop might be the result.\n**\n** One way around this problem is to check the extended error code returned\n** by an sqlite3_step() call. ^(If there is a blocking connection, then the\n** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in\n** the special \"DROP TABLE/INDEX\" case, the extended error code is just\n** SQLITE_LOCKED.)^\n*/\nSQLITE_API int sqlite3_unlock_notify(\n sqlite3 *pBlocked, /* Waiting connection */\n void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */\n void *pNotifyArg /* Argument to pass to xNotify */\n);\n\n\n/*\n** CAPI3REF: String Comparison\n**\n** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications\n** and extensions to compare the contents of two buffers containing UTF-8\n** strings in a case-independent fashion, using the same definition of \"case\n** independence\" that SQLite uses internally when comparing identifiers.\n*/\nSQLITE_API int sqlite3_stricmp(const char *, const char *);\nSQLITE_API int sqlite3_strnicmp(const char *, const char *, int);\n\n/*\n** CAPI3REF: String Globbing\n*\n** ^The [sqlite3_strglob(P,X)] interface returns zero if and only if\n** string X matches the [GLOB] pattern P.\n** ^The definition of [GLOB] pattern matching used in\n** [sqlite3_strglob(P,X)] is the same as for the \"X GLOB P\" operator in the\n** SQL dialect understood by SQLite. ^The [sqlite3_strglob(P,X)] function\n** is case sensitive.\n**\n** Note that this routine returns zero on a match and non-zero if the strings\n** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()].\n**\n** See also: [sqlite3_strlike()].\n*/\nSQLITE_API int sqlite3_strglob(const char *zGlob, const char *zStr);\n\n/*\n** CAPI3REF: String LIKE Matching\n*\n** ^The [sqlite3_strlike(P,X,E)] interface returns zero if and only if\n** string X matches the [LIKE] pattern P with escape character E.\n** ^The definition of [LIKE] pattern matching used in\n** [sqlite3_strlike(P,X,E)] is the same as for the \"X LIKE P ESCAPE E\"\n** operator in the SQL dialect understood by SQLite. ^For \"X LIKE P\" without\n** the ESCAPE clause, set the E parameter of [sqlite3_strlike(P,X,E)] to 0.\n** ^As with the LIKE operator, the [sqlite3_strlike(P,X,E)] function is case\n** insensitive - equivalent upper and lower case ASCII characters match\n** one another.\n**\n** ^The [sqlite3_strlike(P,X,E)] function matches Unicode characters, though\n** only ASCII characters are case folded.\n**\n** Note that this routine returns zero on a match and non-zero if the strings\n** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()].\n**\n** See also: [sqlite3_strglob()].\n*/\nSQLITE_API int sqlite3_strlike(const char *zGlob, const char *zStr, unsigned int cEsc);\n\n/*\n** CAPI3REF: Error Logging Interface\n**\n** ^The [sqlite3_log()] interface writes a message into the [error log]\n** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()].\n** ^If logging is enabled, the zFormat string and subsequent arguments are\n** used with [sqlite3_snprintf()] to generate the final output string.\n**\n** The sqlite3_log() interface is intended for use by extensions such as\n** virtual tables, collating functions, and SQL functions. While there is\n** nothing to prevent an application from calling sqlite3_log(), doing so\n** is considered bad form.\n**\n** The zFormat string must not be NULL.\n**\n** To avoid deadlocks and other threading problems, the sqlite3_log() routine\n** will not use dynamically allocated memory. The log message is stored in\n** a fixed-length buffer on the stack. If the log message is longer than\n** a few hundred characters, it will be truncated to the length of the\n** buffer.\n*/\nSQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...);\n\n/*\n** CAPI3REF: Write-Ahead Log Commit Hook\n** METHOD: sqlite3\n**\n** ^The [sqlite3_wal_hook()] function is used to register a callback that\n** is invoked each time data is committed to a database in wal mode.\n**\n** ^(The callback is invoked by SQLite after the commit has taken place and\n** the associated write-lock on the database released)^, so the implementation\n** may read, write or [checkpoint] the database as required.\n**\n** ^The first parameter passed to the callback function when it is invoked\n** is a copy of the third parameter passed to sqlite3_wal_hook() when\n** registering the callback. ^The second is a copy of the database handle.\n** ^The third parameter is the name of the database that was written to -\n** either \"main\" or the name of an [ATTACH]-ed database. ^The fourth parameter\n** is the number of pages currently in the write-ahead log file,\n** including those that were just committed.\n**\n** The callback function should normally return [SQLITE_OK]. ^If an error\n** code is returned, that error will propagate back up through the\n** SQLite code base to cause the statement that provoked the callback\n** to report an error, though the commit will have still occurred. If the\n** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value\n** that does not correspond to any valid SQLite error code, the results\n** are undefined.\n**\n** A single database handle may have at most a single write-ahead log callback\n** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any\n** previously registered write-ahead log callback. ^The return value is\n** a copy of the third parameter from the previous call, if any, or 0.\n** ^Note that the [sqlite3_wal_autocheckpoint()] interface and the\n** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will\n** overwrite any prior [sqlite3_wal_hook()] settings.\n*/\nSQLITE_API void *sqlite3_wal_hook(\n sqlite3*,\n int(*)(void *,sqlite3*,const char*,int),\n void*\n);\n\n/*\n** CAPI3REF: Configure an auto-checkpoint\n** METHOD: sqlite3\n**\n** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around\n** [sqlite3_wal_hook()] that causes any database on [database connection] D\n** to automatically [checkpoint]\n** after committing a transaction if there are N or\n** more frames in the [write-ahead log] file. ^Passing zero or\n** a negative value as the nFrame parameter disables automatic\n** checkpoints entirely.\n**\n** ^The callback registered by this function replaces any existing callback\n** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback\n** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism\n** configured by this function.\n**\n** ^The [wal_autocheckpoint pragma] can be used to invoke this interface\n** from SQL.\n**\n** ^Checkpoints initiated by this mechanism are\n** [sqlite3_wal_checkpoint_v2|PASSIVE].\n**\n** ^Every new [database connection] defaults to having the auto-checkpoint\n** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT]\n** pages. The use of this interface\n** is only necessary if the default setting is found to be suboptimal\n** for a particular application.\n*/\nSQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N);\n\n/*\n** CAPI3REF: Checkpoint a database\n** METHOD: sqlite3\n**\n** ^(The sqlite3_wal_checkpoint(D,X) is equivalent to\n** [sqlite3_wal_checkpoint_v2](D,X,[SQLITE_CHECKPOINT_PASSIVE],0,0).)^\n**\n** In brief, sqlite3_wal_checkpoint(D,X) causes the content in the\n** [write-ahead log] for database X on [database connection] D to be\n** transferred into the database file and for the write-ahead log to\n** be reset. See the [checkpointing] documentation for addition\n** information.\n**\n** This interface used to be the only way to cause a checkpoint to\n** occur. But then the newer and more powerful [sqlite3_wal_checkpoint_v2()]\n** interface was added. This interface is retained for backwards\n** compatibility and as a convenience for applications that need to manually\n** start a callback but which do not need the full power (and corresponding\n** complication) of [sqlite3_wal_checkpoint_v2()].\n*/\nSQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb);\n\n/*\n** CAPI3REF: Checkpoint a database\n** METHOD: sqlite3\n**\n** ^(The sqlite3_wal_checkpoint_v2(D,X,M,L,C) interface runs a checkpoint\n** operation on database X of [database connection] D in mode M. Status\n** information is written back into integers pointed to by L and C.)^\n** ^(The M parameter must be a valid [checkpoint mode]:)^\n**\n** <dl>\n** <dt>SQLITE_CHECKPOINT_PASSIVE<dd>\n** ^Checkpoint as many frames as possible without waiting for any database\n** readers or writers to finish, then sync the database file if all frames\n** in the log were checkpointed. ^The [busy-handler callback]\n** is never invoked in the SQLITE_CHECKPOINT_PASSIVE mode.\n** ^On the other hand, passive mode might leave the checkpoint unfinished\n** if there are concurrent readers or writers.\n**\n** <dt>SQLITE_CHECKPOINT_FULL<dd>\n** ^This mode blocks (it invokes the\n** [sqlite3_busy_handler|busy-handler callback]) until there is no\n** database writer and all readers are reading from the most recent database\n** snapshot. ^It then checkpoints all frames in the log file and syncs the\n** database file. ^This mode blocks new database writers while it is pending,\n** but new database readers are allowed to continue unimpeded.\n**\n** <dt>SQLITE_CHECKPOINT_RESTART<dd>\n** ^This mode works the same way as SQLITE_CHECKPOINT_FULL with the addition\n** that after checkpointing the log file it blocks (calls the\n** [busy-handler callback])\n** until all readers are reading from the database file only. ^This ensures\n** that the next writer will restart the log file from the beginning.\n** ^Like SQLITE_CHECKPOINT_FULL, this mode blocks new\n** database writer attempts while it is pending, but does not impede readers.\n**\n** <dt>SQLITE_CHECKPOINT_TRUNCATE<dd>\n** ^This mode works the same way as SQLITE_CHECKPOINT_RESTART with the\n** addition that it also truncates the log file to zero bytes just prior\n** to a successful return.\n** </dl>\n**\n** ^If pnLog is not NULL, then *pnLog is set to the total number of frames in\n** the log file or to -1 if the checkpoint could not run because\n** of an error or because the database is not in [WAL mode]. ^If pnCkpt is not\n** NULL,then *pnCkpt is set to the total number of checkpointed frames in the\n** log file (including any that were already checkpointed before the function\n** was called) or to -1 if the checkpoint could not run due to an error or\n** because the database is not in WAL mode. ^Note that upon successful\n** completion of an SQLITE_CHECKPOINT_TRUNCATE, the log file will have been\n** truncated to zero bytes and so both *pnLog and *pnCkpt will be set to zero.\n**\n** ^All calls obtain an exclusive \"checkpoint\" lock on the database file. ^If\n** any other process is running a checkpoint operation at the same time, the\n** lock cannot be obtained and SQLITE_BUSY is returned. ^Even if there is a\n** busy-handler configured, it will not be invoked in this case.\n**\n** ^The SQLITE_CHECKPOINT_FULL, RESTART and TRUNCATE modes also obtain the\n** exclusive \"writer\" lock on the database file. ^If the writer lock cannot be\n** obtained immediately, and a busy-handler is configured, it is invoked and\n** the writer lock retried until either the busy-handler returns 0 or the lock\n** is successfully obtained. ^The busy-handler is also invoked while waiting for\n** database readers as described above. ^If the busy-handler returns 0 before\n** the writer lock is obtained or while waiting for database readers, the\n** checkpoint operation proceeds from that point in the same way as\n** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible\n** without blocking any further. ^SQLITE_BUSY is returned in this case.\n**\n** ^If parameter zDb is NULL or points to a zero length string, then the\n** specified operation is attempted on all WAL databases [attached] to\n** [database connection] db. In this case the\n** values written to output parameters *pnLog and *pnCkpt are undefined. ^If\n** an SQLITE_BUSY error is encountered when processing one or more of the\n** attached WAL databases, the operation is still attempted on any remaining\n** attached databases and SQLITE_BUSY is returned at the end. ^If any other\n** error occurs while processing an attached database, processing is abandoned\n** and the error code is returned to the caller immediately. ^If no error\n** (SQLITE_BUSY or otherwise) is encountered while processing the attached\n** databases, SQLITE_OK is returned.\n**\n** ^If database zDb is the name of an attached database that is not in WAL\n** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. ^If\n** zDb is not NULL (or a zero length string) and is not the name of any\n** attached database, SQLITE_ERROR is returned to the caller.\n**\n** ^Unless it returns SQLITE_MISUSE,\n** the sqlite3_wal_checkpoint_v2() interface\n** sets the error information that is queried by\n** [sqlite3_errcode()] and [sqlite3_errmsg()].\n**\n** ^The [PRAGMA wal_checkpoint] command can be used to invoke this interface\n** from SQL.\n*/\nSQLITE_API int sqlite3_wal_checkpoint_v2(\n sqlite3 *db, /* Database handle */\n const char *zDb, /* Name of attached database (or NULL) */\n int eMode, /* SQLITE_CHECKPOINT_* value */\n int *pnLog, /* OUT: Size of WAL log in frames */\n int *pnCkpt /* OUT: Total number of frames checkpointed */\n);\n\n/*\n** CAPI3REF: Checkpoint Mode Values\n** KEYWORDS: {checkpoint mode}\n**\n** These constants define all valid values for the \"checkpoint mode\" passed\n** as the third parameter to the [sqlite3_wal_checkpoint_v2()] interface.\n** See the [sqlite3_wal_checkpoint_v2()] documentation for details on the\n** meaning of each of these checkpoint modes.\n*/\n#define SQLITE_CHECKPOINT_PASSIVE 0 /* Do as much as possible w/o blocking */\n#define SQLITE_CHECKPOINT_FULL 1 /* Wait for writers, then checkpoint */\n#define SQLITE_CHECKPOINT_RESTART 2 /* Like FULL but wait for readers */\n#define SQLITE_CHECKPOINT_TRUNCATE 3 /* Like RESTART but also truncate WAL */\n\n/*\n** CAPI3REF: Virtual Table Interface Configuration\n**\n** This function may be called by either the [xConnect] or [xCreate] method\n** of a [virtual table] implementation to configure\n** various facets of the virtual table interface.\n**\n** If this interface is invoked outside the context of an xConnect or\n** xCreate virtual table method then the behavior is undefined.\n**\n** In the call sqlite3_vtab_config(D,C,...) the D parameter is the\n** [database connection] in which the virtual table is being created and\n** which is passed in as the first argument to the [xConnect] or [xCreate]\n** method that is invoking sqlite3_vtab_config(). The C parameter is one\n** of the [virtual table configuration options]. The presence and meaning\n** of parameters after C depend on which [virtual table configuration option]\n** is used.\n*/\nSQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...);\n\n/*\n** CAPI3REF: Virtual Table Configuration Options\n** KEYWORDS: {virtual table configuration options}\n** KEYWORDS: {virtual table configuration option}\n**\n** These macros define the various options to the\n** [sqlite3_vtab_config()] interface that [virtual table] implementations\n** can use to customize and optimize their behavior.\n**\n** <dl>\n** [[SQLITE_VTAB_CONSTRAINT_SUPPORT]]\n** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT</dt>\n** <dd>Calls of the form\n** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported,\n** where X is an integer. If X is zero, then the [virtual table] whose\n** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not\n** support constraints. In this configuration (which is the default) if\n** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire\n** statement is rolled back as if [ON CONFLICT | OR ABORT] had been\n** specified as part of the users SQL statement, regardless of the actual\n** ON CONFLICT mode specified.\n**\n** If X is non-zero, then the virtual table implementation guarantees\n** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before\n** any modifications to internal or persistent data structures have been made.\n** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite\n** is able to roll back a statement or database transaction, and abandon\n** or continue processing the current SQL statement as appropriate.\n** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns\n** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode\n** had been ABORT.\n**\n** Virtual table implementations that are required to handle OR REPLACE\n** must do so within the [xUpdate] method. If a call to the\n** [sqlite3_vtab_on_conflict()] function indicates that the current ON\n** CONFLICT policy is REPLACE, the virtual table implementation should\n** silently replace the appropriate rows within the xUpdate callback and\n** return SQLITE_OK. Or, if this is not possible, it may return\n** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT\n** constraint handling.\n** </dd>\n**\n** [[SQLITE_VTAB_DIRECTONLY]]<dt>SQLITE_VTAB_DIRECTONLY</dt>\n** <dd>Calls of the form\n** [sqlite3_vtab_config](db,SQLITE_VTAB_DIRECTONLY) from within the\n** the [xConnect] or [xCreate] methods of a [virtual table] implementation\n** prohibits that virtual table from being used from within triggers and\n** views.\n** </dd>\n**\n** [[SQLITE_VTAB_INNOCUOUS]]<dt>SQLITE_VTAB_INNOCUOUS</dt>\n** <dd>Calls of the form\n** [sqlite3_vtab_config](db,SQLITE_VTAB_INNOCUOUS) from within the\n** the [xConnect] or [xCreate] methods of a [virtual table] implementation\n** identify that virtual table as being safe to use from within triggers\n** and views. Conceptually, the SQLITE_VTAB_INNOCUOUS tag means that the\n** virtual table can do no serious harm even if it is controlled by a\n** malicious hacker. Developers should avoid setting the SQLITE_VTAB_INNOCUOUS\n** flag unless absolutely necessary.\n** </dd>\n**\n** [[SQLITE_VTAB_USES_ALL_SCHEMAS]]<dt>SQLITE_VTAB_USES_ALL_SCHEMAS</dt>\n** <dd>Calls of the form\n** [sqlite3_vtab_config](db,SQLITE_VTAB_USES_ALL_SCHEMA) from within the\n** the [xConnect] or [xCreate] methods of a [virtual table] implementation\n** instruct the query planner to begin at least a read transaction on\n** all schemas (\"main\", \"temp\", and any ATTACH-ed databases) whenever the\n** virtual table is used.\n** </dd>\n** </dl>\n*/\n#define SQLITE_VTAB_CONSTRAINT_SUPPORT 1\n#define SQLITE_VTAB_INNOCUOUS 2\n#define SQLITE_VTAB_DIRECTONLY 3\n#define SQLITE_VTAB_USES_ALL_SCHEMAS 4\n\n/*\n** CAPI3REF: Determine The Virtual Table Conflict Policy\n**\n** This function may only be called from within a call to the [xUpdate] method\n** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The\n** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL],\n** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode\n** of the SQL statement that triggered the call to the [xUpdate] method of the\n** [virtual table].\n*/\nSQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *);\n\n/*\n** CAPI3REF: Determine If Virtual Table Column Access Is For UPDATE\n**\n** If the sqlite3_vtab_nochange(X) routine is called within the [xColumn]\n** method of a [virtual table], then it might return true if the\n** column is being fetched as part of an UPDATE operation during which the\n** column value will not change. The virtual table implementation can use\n** this hint as permission to substitute a return value that is less\n** expensive to compute and that the corresponding\n** [xUpdate] method understands as a \"no-change\" value.\n**\n** If the [xColumn] method calls sqlite3_vtab_nochange() and finds that\n** the column is not changed by the UPDATE statement, then the xColumn\n** method can optionally return without setting a result, without calling\n** any of the [sqlite3_result_int|sqlite3_result_xxxxx() interfaces].\n** In that case, [sqlite3_value_nochange(X)] will return true for the\n** same column in the [xUpdate] method.\n**\n** The sqlite3_vtab_nochange() routine is an optimization. Virtual table\n** implementations should continue to give a correct answer even if the\n** sqlite3_vtab_nochange() interface were to always return false. In the\n** current implementation, the sqlite3_vtab_nochange() interface does always\n** returns false for the enhanced [UPDATE FROM] statement.\n*/\nSQLITE_API int sqlite3_vtab_nochange(sqlite3_context*);\n\n/*\n** CAPI3REF: Determine The Collation For a Virtual Table Constraint\n** METHOD: sqlite3_index_info\n**\n** This function may only be called from within a call to the [xBestIndex]\n** method of a [virtual table]. This function returns a pointer to a string\n** that is the name of the appropriate collation sequence to use for text\n** comparisons on the constraint identified by its arguments.\n**\n** The first argument must be the pointer to the [sqlite3_index_info] object\n** that is the first parameter to the xBestIndex() method. The second argument\n** must be an index into the aConstraint[] array belonging to the\n** sqlite3_index_info structure passed to xBestIndex.\n**\n** Important:\n** The first parameter must be the same pointer that is passed into the\n** xBestMethod() method. The first parameter may not be a pointer to a\n** different [sqlite3_index_info] object, even an exact copy.\n**\n** The return value is computed as follows:\n**\n** <ol>\n** <li><p> If the constraint comes from a WHERE clause expression that contains\n** a [COLLATE operator], then the name of the collation specified by\n** that COLLATE operator is returned.\n** <li><p> If there is no COLLATE operator, but the column that is the subject\n** of the constraint specifies an alternative collating sequence via\n** a [COLLATE clause] on the column definition within the CREATE TABLE\n** statement that was passed into [sqlite3_declare_vtab()], then the\n** name of that alternative collating sequence is returned.\n** <li><p> Otherwise, \"BINARY\" is returned.\n** </ol>\n*/\nSQLITE_API const char *sqlite3_vtab_collation(sqlite3_index_info*,int);\n\n/*\n** CAPI3REF: Determine if a virtual table query is DISTINCT\n** METHOD: sqlite3_index_info\n**\n** This API may only be used from within an [xBestIndex|xBestIndex method]\n** of a [virtual table] implementation. The result of calling this\n** interface from outside of xBestIndex() is undefined and probably harmful.\n**\n** ^The sqlite3_vtab_distinct() interface returns an integer between 0 and\n** 3. The integer returned by sqlite3_vtab_distinct()\n** gives the virtual table additional information about how the query\n** planner wants the output to be ordered. As long as the virtual table\n** can meet the ordering requirements of the query planner, it may set\n** the \"orderByConsumed\" flag.\n**\n** <ol><li value=\"0\"><p>\n** ^If the sqlite3_vtab_distinct() interface returns 0, that means\n** that the query planner needs the virtual table to return all rows in the\n** sort order defined by the \"nOrderBy\" and \"aOrderBy\" fields of the\n** [sqlite3_index_info] object. This is the default expectation. If the\n** virtual table outputs all rows in sorted order, then it is always safe for\n** the xBestIndex method to set the \"orderByConsumed\" flag, regardless of\n** the return value from sqlite3_vtab_distinct().\n** <li value=\"1\"><p>\n** ^(If the sqlite3_vtab_distinct() interface returns 1, that means\n** that the query planner does not need the rows to be returned in sorted order\n** as long as all rows with the same values in all columns identified by the\n** \"aOrderBy\" field are adjacent.)^ This mode is used when the query planner\n** is doing a GROUP BY.\n** <li value=\"2\"><p>\n** ^(If the sqlite3_vtab_distinct() interface returns 2, that means\n** that the query planner does not need the rows returned in any particular\n** order, as long as rows with the same values in all columns identified\n** by \"aOrderBy\" are adjacent.)^ ^(Furthermore, when two or more rows\n** contain the same values for all columns identified by \"colUsed\", all but\n** one such row may optionally be omitted from the result.)^\n** The virtual table is not required to omit rows that are duplicates\n** over the \"colUsed\" columns, but if the virtual table can do that without\n** too much extra effort, it could potentially help the query to run faster.\n** This mode is used for a DISTINCT query.\n** <li value=\"3\"><p>\n** ^(If the sqlite3_vtab_distinct() interface returns 3, that means the\n** virtual table must return rows in the order defined by \"aOrderBy\" as\n** if the sqlite3_vtab_distinct() interface had returned 0. However if\n** two or more rows in the result have the same values for all columns\n** identified by \"colUsed\", then all but one such row may optionally be\n** omitted.)^ Like when the return value is 2, the virtual table\n** is not required to omit rows that are duplicates over the \"colUsed\"\n** columns, but if the virtual table can do that without\n** too much extra effort, it could potentially help the query to run faster.\n** This mode is used for queries\n** that have both DISTINCT and ORDER BY clauses.\n** </ol>\n**\n** <p>The following table summarizes the conditions under which the\n** virtual table is allowed to set the \"orderByConsumed\" flag based on\n** the value returned by sqlite3_vtab_distinct(). This table is a\n** restatement of the previous four paragraphs:\n**\n** <table border=1 cellspacing=0 cellpadding=10 width=\"90%\">\n** <tr>\n** <td valign=\"top\">sqlite3_vtab_distinct() return value\n** <td valign=\"top\">Rows are returned in aOrderBy order\n** <td valign=\"top\">Rows with the same value in all aOrderBy columns are adjacent\n** <td valign=\"top\">Duplicates over all colUsed columns may be omitted\n** <tr><td>0<td>yes<td>yes<td>no\n** <tr><td>1<td>no<td>yes<td>no\n** <tr><td>2<td>no<td>yes<td>yes\n** <tr><td>3<td>yes<td>yes<td>yes\n** </table>\n**\n** ^For the purposes of comparing virtual table output values to see if the\n** values are same value for sorting purposes, two NULL values are considered\n** to be the same. In other words, the comparison operator is \"IS\"\n** (or \"IS NOT DISTINCT FROM\") and not \"==\".\n**\n** If a virtual table implementation is unable to meet the requirements\n** specified above, then it must not set the \"orderByConsumed\" flag in the\n** [sqlite3_index_info] object or an incorrect answer may result.\n**\n** ^A virtual table implementation is always free to return rows in any order\n** it wants, as long as the \"orderByConsumed\" flag is not set. ^When the\n** the \"orderByConsumed\" flag is unset, the query planner will add extra\n** [bytecode] to ensure that the final results returned by the SQL query are\n** ordered correctly. The use of the \"orderByConsumed\" flag and the\n** sqlite3_vtab_distinct() interface is merely an optimization. ^Careful\n** use of the sqlite3_vtab_distinct() interface and the \"orderByConsumed\"\n** flag might help queries against a virtual table to run faster. Being\n** overly aggressive and setting the \"orderByConsumed\" flag when it is not\n** valid to do so, on the other hand, might cause SQLite to return incorrect\n** results.\n*/\nSQLITE_API int sqlite3_vtab_distinct(sqlite3_index_info*);\n\n/*\n** CAPI3REF: Identify and handle IN constraints in xBestIndex\n**\n** This interface may only be used from within an\n** [xBestIndex|xBestIndex() method] of a [virtual table] implementation.\n** The result of invoking this interface from any other context is\n** undefined and probably harmful.\n**\n** ^(A constraint on a virtual table of the form\n** \"[IN operator|column IN (...)]\" is\n** communicated to the xBestIndex method as a\n** [SQLITE_INDEX_CONSTRAINT_EQ] constraint.)^ If xBestIndex wants to use\n** this constraint, it must set the corresponding\n** aConstraintUsage[].argvIndex to a positive integer. ^(Then, under\n** the usual mode of handling IN operators, SQLite generates [bytecode]\n** that invokes the [xFilter|xFilter() method] once for each value\n** on the right-hand side of the IN operator.)^ Thus the virtual table\n** only sees a single value from the right-hand side of the IN operator\n** at a time.\n**\n** In some cases, however, it would be advantageous for the virtual\n** table to see all values on the right-hand of the IN operator all at\n** once. The sqlite3_vtab_in() interfaces facilitates this in two ways:\n**\n** <ol>\n** <li><p>\n** ^A call to sqlite3_vtab_in(P,N,-1) will return true (non-zero)\n** if and only if the [sqlite3_index_info|P->aConstraint][N] constraint\n** is an [IN operator] that can be processed all at once. ^In other words,\n** sqlite3_vtab_in() with -1 in the third argument is a mechanism\n** by which the virtual table can ask SQLite if all-at-once processing\n** of the IN operator is even possible.\n**\n** <li><p>\n** ^A call to sqlite3_vtab_in(P,N,F) with F==1 or F==0 indicates\n** to SQLite that the virtual table does or does not want to process\n** the IN operator all-at-once, respectively. ^Thus when the third\n** parameter (F) is non-negative, this interface is the mechanism by\n** which the virtual table tells SQLite how it wants to process the\n** IN operator.\n** </ol>\n**\n** ^The sqlite3_vtab_in(P,N,F) interface can be invoked multiple times\n** within the same xBestIndex method call. ^For any given P,N pair,\n** the return value from sqlite3_vtab_in(P,N,F) will always be the same\n** within the same xBestIndex call. ^If the interface returns true\n** (non-zero), that means that the constraint is an IN operator\n** that can be processed all-at-once. ^If the constraint is not an IN\n** operator or cannot be processed all-at-once, then the interface returns\n** false.\n**\n** ^(All-at-once processing of the IN operator is selected if both of the\n** following conditions are met:\n**\n** <ol>\n** <li><p> The P->aConstraintUsage[N].argvIndex value is set to a positive\n** integer. This is how the virtual table tells SQLite that it wants to\n** use the N-th constraint.\n**\n** <li><p> The last call to sqlite3_vtab_in(P,N,F) for which F was\n** non-negative had F>=1.\n** </ol>)^\n**\n** ^If either or both of the conditions above are false, then SQLite uses\n** the traditional one-at-a-time processing strategy for the IN constraint.\n** ^If both conditions are true, then the argvIndex-th parameter to the\n** xFilter method will be an [sqlite3_value] that appears to be NULL,\n** but which can be passed to [sqlite3_vtab_in_first()] and\n** [sqlite3_vtab_in_next()] to find all values on the right-hand side\n** of the IN constraint.\n*/\nSQLITE_API int sqlite3_vtab_in(sqlite3_index_info*, int iCons, int bHandle);\n\n/*\n** CAPI3REF: Find all elements on the right-hand side of an IN constraint.\n**\n** These interfaces are only useful from within the\n** [xFilter|xFilter() method] of a [virtual table] implementation.\n** The result of invoking these interfaces from any other context\n** is undefined and probably harmful.\n**\n** The X parameter in a call to sqlite3_vtab_in_first(X,P) or\n** sqlite3_vtab_in_next(X,P) should be one of the parameters to the\n** xFilter method which invokes these routines, and specifically\n** a parameter that was previously selected for all-at-once IN constraint\n** processing use the [sqlite3_vtab_in()] interface in the\n** [xBestIndex|xBestIndex method]. ^(If the X parameter is not\n** an xFilter argument that was selected for all-at-once IN constraint\n** processing, then these routines return [SQLITE_ERROR].)^\n**\n** ^(Use these routines to access all values on the right-hand side\n** of the IN constraint using code like the following:\n**\n** <blockquote><pre>\n** for(rc=sqlite3_vtab_in_first(pList, &pVal);\n** rc==SQLITE_OK && pVal;\n** rc=sqlite3_vtab_in_next(pList, &pVal)\n** ){\n** // do something with pVal\n** }\n** if( rc!=SQLITE_OK ){\n** // an error has occurred\n** }\n** </pre></blockquote>)^\n**\n** ^On success, the sqlite3_vtab_in_first(X,P) and sqlite3_vtab_in_next(X,P)\n** routines return SQLITE_OK and set *P to point to the first or next value\n** on the RHS of the IN constraint. ^If there are no more values on the\n** right hand side of the IN constraint, then *P is set to NULL and these\n** routines return [SQLITE_DONE]. ^The return value might be\n** some other value, such as SQLITE_NOMEM, in the event of a malfunction.\n**\n** The *ppOut values returned by these routines are only valid until the\n** next call to either of these routines or until the end of the xFilter\n** method from which these routines were called. If the virtual table\n** implementation needs to retain the *ppOut values for longer, it must make\n** copies. The *ppOut values are [protected sqlite3_value|protected].\n*/\nSQLITE_API int sqlite3_vtab_in_first(sqlite3_value *pVal, sqlite3_value **ppOut);\nSQLITE_API int sqlite3_vtab_in_next(sqlite3_value *pVal, sqlite3_value **ppOut);\n\n/*\n** CAPI3REF: Constraint values in xBestIndex()\n** METHOD: sqlite3_index_info\n**\n** This API may only be used from within the [xBestIndex|xBestIndex method]\n** of a [virtual table] implementation. The result of calling this interface\n** from outside of an xBestIndex method are undefined and probably harmful.\n**\n** ^When the sqlite3_vtab_rhs_value(P,J,V) interface is invoked from within\n** the [xBestIndex] method of a [virtual table] implementation, with P being\n** a copy of the [sqlite3_index_info] object pointer passed into xBestIndex and\n** J being a 0-based index into P->aConstraint[], then this routine\n** attempts to set *V to the value of the right-hand operand of\n** that constraint if the right-hand operand is known. ^If the\n** right-hand operand is not known, then *V is set to a NULL pointer.\n** ^The sqlite3_vtab_rhs_value(P,J,V) interface returns SQLITE_OK if\n** and only if *V is set to a value. ^The sqlite3_vtab_rhs_value(P,J,V)\n** inteface returns SQLITE_NOTFOUND if the right-hand side of the J-th\n** constraint is not available. ^The sqlite3_vtab_rhs_value() interface\n** can return an result code other than SQLITE_OK or SQLITE_NOTFOUND if\n** something goes wrong.\n**\n** The sqlite3_vtab_rhs_value() interface is usually only successful if\n** the right-hand operand of a constraint is a literal value in the original\n** SQL statement. If the right-hand operand is an expression or a reference\n** to some other column or a [host parameter], then sqlite3_vtab_rhs_value()\n** will probably return [SQLITE_NOTFOUND].\n**\n** ^(Some constraints, such as [SQLITE_INDEX_CONSTRAINT_ISNULL] and\n** [SQLITE_INDEX_CONSTRAINT_ISNOTNULL], have no right-hand operand. For such\n** constraints, sqlite3_vtab_rhs_value() always returns SQLITE_NOTFOUND.)^\n**\n** ^The [sqlite3_value] object returned in *V is a protected sqlite3_value\n** and remains valid for the duration of the xBestIndex method call.\n** ^When xBestIndex returns, the sqlite3_value object returned by\n** sqlite3_vtab_rhs_value() is automatically deallocated.\n**\n** The \"_rhs_\" in the name of this routine is an abbreviation for\n** \"Right-Hand Side\".\n*/\nSQLITE_API int sqlite3_vtab_rhs_value(sqlite3_index_info*, int, sqlite3_value **ppVal);\n\n/*\n** CAPI3REF: Conflict resolution modes\n** KEYWORDS: {conflict resolution mode}\n**\n** These constants are returned by [sqlite3_vtab_on_conflict()] to\n** inform a [virtual table] implementation what the [ON CONFLICT] mode\n** is for the SQL statement being evaluated.\n**\n** Note that the [SQLITE_IGNORE] constant is also used as a potential\n** return value from the [sqlite3_set_authorizer()] callback and that\n** [SQLITE_ABORT] is also a [result code].\n*/\n#define SQLITE_ROLLBACK 1\n/* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */\n#define SQLITE_FAIL 3\n/* #define SQLITE_ABORT 4 // Also an error code */\n#define SQLITE_REPLACE 5\n\n/*\n** CAPI3REF: Prepared Statement Scan Status Opcodes\n** KEYWORDS: {scanstatus options}\n**\n** The following constants can be used for the T parameter to the\n** [sqlite3_stmt_scanstatus(S,X,T,V)] interface. Each constant designates a\n** different metric for sqlite3_stmt_scanstatus() to return.\n**\n** When the value returned to V is a string, space to hold that string is\n** managed by the prepared statement S and will be automatically freed when\n** S is finalized.\n**\n** Not all values are available for all query elements. When a value is\n** not available, the output variable is set to -1 if the value is numeric,\n** or to NULL if it is a string (SQLITE_SCANSTAT_NAME).\n**\n** <dl>\n** [[SQLITE_SCANSTAT_NLOOP]] <dt>SQLITE_SCANSTAT_NLOOP</dt>\n** <dd>^The [sqlite3_int64] variable pointed to by the V parameter will be\n** set to the total number of times that the X-th loop has run.</dd>\n**\n** [[SQLITE_SCANSTAT_NVISIT]] <dt>SQLITE_SCANSTAT_NVISIT</dt>\n** <dd>^The [sqlite3_int64] variable pointed to by the V parameter will be set\n** to the total number of rows examined by all iterations of the X-th loop.</dd>\n**\n** [[SQLITE_SCANSTAT_EST]] <dt>SQLITE_SCANSTAT_EST</dt>\n** <dd>^The \"double\" variable pointed to by the V parameter will be set to the\n** query planner's estimate for the average number of rows output from each\n** iteration of the X-th loop. If the query planner's estimates was accurate,\n** then this value will approximate the quotient NVISIT/NLOOP and the\n** product of this value for all prior loops with the same SELECTID will\n** be the NLOOP value for the current loop.\n**\n** [[SQLITE_SCANSTAT_NAME]] <dt>SQLITE_SCANSTAT_NAME</dt>\n** <dd>^The \"const char *\" variable pointed to by the V parameter will be set\n** to a zero-terminated UTF-8 string containing the name of the index or table\n** used for the X-th loop.\n**\n** [[SQLITE_SCANSTAT_EXPLAIN]] <dt>SQLITE_SCANSTAT_EXPLAIN</dt>\n** <dd>^The \"const char *\" variable pointed to by the V parameter will be set\n** to a zero-terminated UTF-8 string containing the [EXPLAIN QUERY PLAN]\n** description for the X-th loop.\n**\n** [[SQLITE_SCANSTAT_SELECTID]] <dt>SQLITE_SCANSTAT_SELECTID</dt>\n** <dd>^The \"int\" variable pointed to by the V parameter will be set to the\n** id for the X-th query plan element. The id value is unique within the\n** statement. The select-id is the same value as is output in the first\n** column of an [EXPLAIN QUERY PLAN] query.\n**\n** [[SQLITE_SCANSTAT_PARENTID]] <dt>SQLITE_SCANSTAT_PARENTID</dt>\n** <dd>The \"int\" variable pointed to by the V parameter will be set to the\n** the id of the parent of the current query element, if applicable, or\n** to zero if the query element has no parent. This is the same value as\n** returned in the second column of an [EXPLAIN QUERY PLAN] query.\n**\n** [[SQLITE_SCANSTAT_NCYCLE]] <dt>SQLITE_SCANSTAT_NCYCLE</dt>\n** <dd>The sqlite3_int64 output value is set to the number of cycles,\n** according to the processor time-stamp counter, that elapsed while the\n** query element was being processed. This value is not available for\n** all query elements - if it is unavailable the output variable is\n** set to -1.\n** </dl>\n*/\n#define SQLITE_SCANSTAT_NLOOP 0\n#define SQLITE_SCANSTAT_NVISIT 1\n#define SQLITE_SCANSTAT_EST 2\n#define SQLITE_SCANSTAT_NAME 3\n#define SQLITE_SCANSTAT_EXPLAIN 4\n#define SQLITE_SCANSTAT_SELECTID 5\n#define SQLITE_SCANSTAT_PARENTID 6\n#define SQLITE_SCANSTAT_NCYCLE 7\n\n/*\n** CAPI3REF: Prepared Statement Scan Status\n** METHOD: sqlite3_stmt\n**\n** These interfaces return information about the predicted and measured\n** performance for pStmt. Advanced applications can use this\n** interface to compare the predicted and the measured performance and\n** issue warnings and/or rerun [ANALYZE] if discrepancies are found.\n**\n** Since this interface is expected to be rarely used, it is only\n** available if SQLite is compiled using the [SQLITE_ENABLE_STMT_SCANSTATUS]\n** compile-time option.\n**\n** The \"iScanStatusOp\" parameter determines which status information to return.\n** The \"iScanStatusOp\" must be one of the [scanstatus options] or the behavior\n** of this interface is undefined. ^The requested measurement is written into\n** a variable pointed to by the \"pOut\" parameter.\n**\n** The \"flags\" parameter must be passed a mask of flags. At present only\n** one flag is defined - SQLITE_SCANSTAT_COMPLEX. If SQLITE_SCANSTAT_COMPLEX\n** is specified, then status information is available for all elements\n** of a query plan that are reported by \"EXPLAIN QUERY PLAN\" output. If\n** SQLITE_SCANSTAT_COMPLEX is not specified, then only query plan elements\n** that correspond to query loops (the \"SCAN...\" and \"SEARCH...\" elements of\n** the EXPLAIN QUERY PLAN output) are available. Invoking API\n** sqlite3_stmt_scanstatus() is equivalent to calling\n** sqlite3_stmt_scanstatus_v2() with a zeroed flags parameter.\n**\n** Parameter \"idx\" identifies the specific query element to retrieve statistics\n** for. Query elements are numbered starting from zero. A value of -1 may be\n** to query for statistics regarding the entire query. ^If idx is out of range\n** - less than -1 or greater than or equal to the total number of query\n** elements used to implement the statement - a non-zero value is returned and\n** the variable that pOut points to is unchanged.\n**\n** See also: [sqlite3_stmt_scanstatus_reset()]\n*/\nSQLITE_API int sqlite3_stmt_scanstatus(\n sqlite3_stmt *pStmt, /* Prepared statement for which info desired */\n int idx, /* Index of loop to report on */\n int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */\n void *pOut /* Result written here */\n);\nSQLITE_API int sqlite3_stmt_scanstatus_v2(\n sqlite3_stmt *pStmt, /* Prepared statement for which info desired */\n int idx, /* Index of loop to report on */\n int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */\n int flags, /* Mask of flags defined below */\n void *pOut /* Result written here */\n);\n\n/*\n** CAPI3REF: Prepared Statement Scan Status\n** KEYWORDS: {scan status flags}\n*/\n#define SQLITE_SCANSTAT_COMPLEX 0x0001\n\n/*\n** CAPI3REF: Zero Scan-Status Counters\n** METHOD: sqlite3_stmt\n**\n** ^Zero all [sqlite3_stmt_scanstatus()] related event counters.\n**\n** This API is only available if the library is built with pre-processor\n** symbol [SQLITE_ENABLE_STMT_SCANSTATUS] defined.\n*/\nSQLITE_API void sqlite3_stmt_scanstatus_reset(sqlite3_stmt*);\n\n/*\n** CAPI3REF: Flush caches to disk mid-transaction\n** METHOD: sqlite3\n**\n** ^If a write-transaction is open on [database connection] D when the\n** [sqlite3_db_cacheflush(D)] interface invoked, any dirty\n** pages in the pager-cache that are not currently in use are written out\n** to disk. A dirty page may be in use if a database cursor created by an\n** active SQL statement is reading from it, or if it is page 1 of a database\n** file (page 1 is always \"in use\"). ^The [sqlite3_db_cacheflush(D)]\n** interface flushes caches for all schemas - \"main\", \"temp\", and\n** any [attached] databases.\n**\n** ^If this function needs to obtain extra database locks before dirty pages\n** can be flushed to disk, it does so. ^If those locks cannot be obtained\n** immediately and there is a busy-handler callback configured, it is invoked\n** in the usual manner. ^If the required lock still cannot be obtained, then\n** the database is skipped and an attempt made to flush any dirty pages\n** belonging to the next (if any) database. ^If any databases are skipped\n** because locks cannot be obtained, but no other error occurs, this\n** function returns SQLITE_BUSY.\n**\n** ^If any other error occurs while flushing dirty pages to disk (for\n** example an IO error or out-of-memory condition), then processing is\n** abandoned and an SQLite [error code] is returned to the caller immediately.\n**\n** ^Otherwise, if no error occurs, [sqlite3_db_cacheflush()] returns SQLITE_OK.\n**\n** ^This function does not set the database handle error code or message\n** returned by the [sqlite3_errcode()] and [sqlite3_errmsg()] functions.\n*/\nSQLITE_API int sqlite3_db_cacheflush(sqlite3*);\n\n/*\n** CAPI3REF: The pre-update hook.\n** METHOD: sqlite3\n**\n** ^These interfaces are only available if SQLite is compiled using the\n** [SQLITE_ENABLE_PREUPDATE_HOOK] compile-time option.\n**\n** ^The [sqlite3_preupdate_hook()] interface registers a callback function\n** that is invoked prior to each [INSERT], [UPDATE], and [DELETE] operation\n** on a database table.\n** ^At most one preupdate hook may be registered at a time on a single\n** [database connection]; each call to [sqlite3_preupdate_hook()] overrides\n** the previous setting.\n** ^The preupdate hook is disabled by invoking [sqlite3_preupdate_hook()]\n** with a NULL pointer as the second parameter.\n** ^The third parameter to [sqlite3_preupdate_hook()] is passed through as\n** the first parameter to callbacks.\n**\n** ^The preupdate hook only fires for changes to real database tables; the\n** preupdate hook is not invoked for changes to [virtual tables] or to\n** system tables like sqlite_sequence or sqlite_stat1.\n**\n** ^The second parameter to the preupdate callback is a pointer to\n** the [database connection] that registered the preupdate hook.\n** ^The third parameter to the preupdate callback is one of the constants\n** [SQLITE_INSERT], [SQLITE_DELETE], or [SQLITE_UPDATE] to identify the\n** kind of update operation that is about to occur.\n** ^(The fourth parameter to the preupdate callback is the name of the\n** database within the database connection that is being modified. This\n** will be \"main\" for the main database or \"temp\" for TEMP tables or\n** the name given after the AS keyword in the [ATTACH] statement for attached\n** databases.)^\n** ^The fifth parameter to the preupdate callback is the name of the\n** table that is being modified.\n**\n** For an UPDATE or DELETE operation on a [rowid table], the sixth\n** parameter passed to the preupdate callback is the initial [rowid] of the\n** row being modified or deleted. For an INSERT operation on a rowid table,\n** or any operation on a WITHOUT ROWID table, the value of the sixth\n** parameter is undefined. For an INSERT or UPDATE on a rowid table the\n** seventh parameter is the final rowid value of the row being inserted\n** or updated. The value of the seventh parameter passed to the callback\n** function is not defined for operations on WITHOUT ROWID tables, or for\n** DELETE operations on rowid tables.\n**\n** ^The sqlite3_preupdate_hook(D,C,P) function returns the P argument from\n** the previous call on the same [database connection] D, or NULL for\n** the first call on D.\n**\n** The [sqlite3_preupdate_old()], [sqlite3_preupdate_new()],\n** [sqlite3_preupdate_count()], and [sqlite3_preupdate_depth()] interfaces\n** provide additional information about a preupdate event. These routines\n** may only be called from within a preupdate callback. Invoking any of\n** these routines from outside of a preupdate callback or with a\n** [database connection] pointer that is different from the one supplied\n** to the preupdate callback results in undefined and probably undesirable\n** behavior.\n**\n** ^The [sqlite3_preupdate_count(D)] interface returns the number of columns\n** in the row that is being inserted, updated, or deleted.\n**\n** ^The [sqlite3_preupdate_old(D,N,P)] interface writes into P a pointer to\n** a [protected sqlite3_value] that contains the value of the Nth column of\n** the table row before it is updated. The N parameter must be between 0\n** and one less than the number of columns or the behavior will be\n** undefined. This must only be used within SQLITE_UPDATE and SQLITE_DELETE\n** preupdate callbacks; if it is used by an SQLITE_INSERT callback then the\n** behavior is undefined. The [sqlite3_value] that P points to\n** will be destroyed when the preupdate callback returns.\n**\n** ^The [sqlite3_preupdate_new(D,N,P)] interface writes into P a pointer to\n** a [protected sqlite3_value] that contains the value of the Nth column of\n** the table row after it is updated. The N parameter must be between 0\n** and one less than the number of columns or the behavior will be\n** undefined. This must only be used within SQLITE_INSERT and SQLITE_UPDATE\n** preupdate callbacks; if it is used by an SQLITE_DELETE callback then the\n** behavior is undefined. The [sqlite3_value] that P points to\n** will be destroyed when the preupdate callback returns.\n**\n** ^The [sqlite3_preupdate_depth(D)] interface returns 0 if the preupdate\n** callback was invoked as a result of a direct insert, update, or delete\n** operation; or 1 for inserts, updates, or deletes invoked by top-level\n** triggers; or 2 for changes resulting from triggers called by top-level\n** triggers; and so forth.\n**\n** When the [sqlite3_blob_write()] API is used to update a blob column,\n** the pre-update hook is invoked with SQLITE_DELETE. This is because the\n** in this case the new values are not available. In this case, when a\n** callback made with op==SQLITE_DELETE is actually a write using the\n** sqlite3_blob_write() API, the [sqlite3_preupdate_blobwrite()] returns\n** the index of the column being written. In other cases, where the\n** pre-update hook is being invoked for some other reason, including a\n** regular DELETE, sqlite3_preupdate_blobwrite() returns -1.\n**\n** See also: [sqlite3_update_hook()]\n*/\n#if defined(SQLITE_ENABLE_PREUPDATE_HOOK)\nSQLITE_API void *sqlite3_preupdate_hook(\n sqlite3 *db,\n void(*xPreUpdate)(\n void *pCtx, /* Copy of third arg to preupdate_hook() */\n sqlite3 *db, /* Database handle */\n int op, /* SQLITE_UPDATE, DELETE or INSERT */\n char const *zDb, /* Database name */\n char const *zName, /* Table name */\n sqlite3_int64 iKey1, /* Rowid of row about to be deleted/updated */\n sqlite3_int64 iKey2 /* New rowid value (for a rowid UPDATE) */\n ),\n void*\n);\nSQLITE_API int sqlite3_preupdate_old(sqlite3 *, int, sqlite3_value **);\nSQLITE_API int sqlite3_preupdate_count(sqlite3 *);\nSQLITE_API int sqlite3_preupdate_depth(sqlite3 *);\nSQLITE_API int sqlite3_preupdate_new(sqlite3 *, int, sqlite3_value **);\nSQLITE_API int sqlite3_preupdate_blobwrite(sqlite3 *);\n#endif\n\n/*\n** CAPI3REF: Low-level system error code\n** METHOD: sqlite3\n**\n** ^Attempt to return the underlying operating system error code or error\n** number that caused the most recent I/O error or failure to open a file.\n** The return value is OS-dependent. For example, on unix systems, after\n** [sqlite3_open_v2()] returns [SQLITE_CANTOPEN], this interface could be\n** called to get back the underlying \"errno\" that caused the problem, such\n** as ENOSPC, EAUTH, EISDIR, and so forth.\n*/\nSQLITE_API int sqlite3_system_errno(sqlite3*);\n\n/*\n** CAPI3REF: Database Snapshot\n** KEYWORDS: {snapshot} {sqlite3_snapshot}\n**\n** An instance of the snapshot object records the state of a [WAL mode]\n** database for some specific point in history.\n**\n** In [WAL mode], multiple [database connections] that are open on the\n** same database file can each be reading a different historical version\n** of the database file. When a [database connection] begins a read\n** transaction, that connection sees an unchanging copy of the database\n** as it existed for the point in time when the transaction first started.\n** Subsequent changes to the database from other connections are not seen\n** by the reader until a new read transaction is started.\n**\n** The sqlite3_snapshot object records state information about an historical\n** version of the database file so that it is possible to later open a new read\n** transaction that sees that historical version of the database rather than\n** the most recent version.\n*/\ntypedef struct sqlite3_snapshot {\n unsigned char hidden[48];\n} sqlite3_snapshot;\n\n/*\n** CAPI3REF: Record A Database Snapshot\n** CONSTRUCTOR: sqlite3_snapshot\n**\n** ^The [sqlite3_snapshot_get(D,S,P)] interface attempts to make a\n** new [sqlite3_snapshot] object that records the current state of\n** schema S in database connection D. ^On success, the\n** [sqlite3_snapshot_get(D,S,P)] interface writes a pointer to the newly\n** created [sqlite3_snapshot] object into *P and returns SQLITE_OK.\n** If there is not already a read-transaction open on schema S when\n** this function is called, one is opened automatically.\n**\n** If a read-transaction is opened by this function, then it is guaranteed\n** that the returned snapshot object may not be invalidated by a database\n** writer or checkpointer until after the read-transaction is closed. This\n** is not guaranteed if a read-transaction is already open when this\n** function is called. In that case, any subsequent write or checkpoint\n** operation on the database may invalidate the returned snapshot handle,\n** even while the read-transaction remains open.\n**\n** The following must be true for this function to succeed. If any of\n** the following statements are false when sqlite3_snapshot_get() is\n** called, SQLITE_ERROR is returned. The final value of *P is undefined\n** in this case.\n**\n** <ul>\n** <li> The database handle must not be in [autocommit mode].\n**\n** <li> Schema S of [database connection] D must be a [WAL mode] database.\n**\n** <li> There must not be a write transaction open on schema S of database\n** connection D.\n**\n** <li> One or more transactions must have been written to the current wal\n** file since it was created on disk (by any connection). This means\n** that a snapshot cannot be taken on a wal mode database with no wal\n** file immediately after it is first opened. At least one transaction\n** must be written to it first.\n** </ul>\n**\n** This function may also return SQLITE_NOMEM. If it is called with the\n** database handle in autocommit mode but fails for some other reason,\n** whether or not a read transaction is opened on schema S is undefined.\n**\n** The [sqlite3_snapshot] object returned from a successful call to\n** [sqlite3_snapshot_get()] must be freed using [sqlite3_snapshot_free()]\n** to avoid a memory leak.\n**\n** The [sqlite3_snapshot_get()] interface is only available when the\n** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used.\n*/\nSQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_get(\n sqlite3 *db,\n const char *zSchema,\n sqlite3_snapshot **ppSnapshot\n);\n\n/*\n** CAPI3REF: Start a read transaction on an historical snapshot\n** METHOD: sqlite3_snapshot\n**\n** ^The [sqlite3_snapshot_open(D,S,P)] interface either starts a new read\n** transaction or upgrades an existing one for schema S of\n** [database connection] D such that the read transaction refers to\n** historical [snapshot] P, rather than the most recent change to the\n** database. ^The [sqlite3_snapshot_open()] interface returns SQLITE_OK\n** on success or an appropriate [error code] if it fails.\n**\n** ^In order to succeed, the database connection must not be in\n** [autocommit mode] when [sqlite3_snapshot_open(D,S,P)] is called. If there\n** is already a read transaction open on schema S, then the database handle\n** must have no active statements (SELECT statements that have been passed\n** to sqlite3_step() but not sqlite3_reset() or sqlite3_finalize()).\n** SQLITE_ERROR is returned if either of these conditions is violated, or\n** if schema S does not exist, or if the snapshot object is invalid.\n**\n** ^A call to sqlite3_snapshot_open() will fail to open if the specified\n** snapshot has been overwritten by a [checkpoint]. In this case\n** SQLITE_ERROR_SNAPSHOT is returned.\n**\n** If there is already a read transaction open when this function is\n** invoked, then the same read transaction remains open (on the same\n** database snapshot) if SQLITE_ERROR, SQLITE_BUSY or SQLITE_ERROR_SNAPSHOT\n** is returned. If another error code - for example SQLITE_PROTOCOL or an\n** SQLITE_IOERR error code - is returned, then the final state of the\n** read transaction is undefined. If SQLITE_OK is returned, then the\n** read transaction is now open on database snapshot P.\n**\n** ^(A call to [sqlite3_snapshot_open(D,S,P)] will fail if the\n** database connection D does not know that the database file for\n** schema S is in [WAL mode]. A database connection might not know\n** that the database file is in [WAL mode] if there has been no prior\n** I/O on that database connection, or if the database entered [WAL mode]\n** after the most recent I/O on the database connection.)^\n** (Hint: Run \"[PRAGMA application_id]\" against a newly opened\n** database connection in order to make it ready to use snapshots.)\n**\n** The [sqlite3_snapshot_open()] interface is only available when the\n** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used.\n*/\nSQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_open(\n sqlite3 *db,\n const char *zSchema,\n sqlite3_snapshot *pSnapshot\n);\n\n/*\n** CAPI3REF: Destroy a snapshot\n** DESTRUCTOR: sqlite3_snapshot\n**\n** ^The [sqlite3_snapshot_free(P)] interface destroys [sqlite3_snapshot] P.\n** The application must eventually free every [sqlite3_snapshot] object\n** using this routine to avoid a memory leak.\n**\n** The [sqlite3_snapshot_free()] interface is only available when the\n** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used.\n*/\nSQLITE_API SQLITE_EXPERIMENTAL void sqlite3_snapshot_free(sqlite3_snapshot*);\n\n/*\n** CAPI3REF: Compare the ages of two snapshot handles.\n** METHOD: sqlite3_snapshot\n**\n** The sqlite3_snapshot_cmp(P1, P2) interface is used to compare the ages\n** of two valid snapshot handles.\n**\n** If the two snapshot handles are not associated with the same database\n** file, the result of the comparison is undefined.\n**\n** Additionally, the result of the comparison is only valid if both of the\n** snapshot handles were obtained by calling sqlite3_snapshot_get() since the\n** last time the wal file was deleted. The wal file is deleted when the\n** database is changed back to rollback mode or when the number of database\n** clients drops to zero. If either snapshot handle was obtained before the\n** wal file was last deleted, the value returned by this function\n** is undefined.\n**\n** Otherwise, this API returns a negative value if P1 refers to an older\n** snapshot than P2, zero if the two handles refer to the same database\n** snapshot, and a positive value if P1 is a newer snapshot than P2.\n**\n** This interface is only available if SQLite is compiled with the\n** [SQLITE_ENABLE_SNAPSHOT] option.\n*/\nSQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_cmp(\n sqlite3_snapshot *p1,\n sqlite3_snapshot *p2\n);\n\n/*\n** CAPI3REF: Recover snapshots from a wal file\n** METHOD: sqlite3_snapshot\n**\n** If a [WAL file] remains on disk after all database connections close\n** (either through the use of the [SQLITE_FCNTL_PERSIST_WAL] [file control]\n** or because the last process to have the database opened exited without\n** calling [sqlite3_close()]) and a new connection is subsequently opened\n** on that database and [WAL file], the [sqlite3_snapshot_open()] interface\n** will only be able to open the last transaction added to the WAL file\n** even though the WAL file contains other valid transactions.\n**\n** This function attempts to scan the WAL file associated with database zDb\n** of database handle db and make all valid snapshots available to\n** sqlite3_snapshot_open(). It is an error if there is already a read\n** transaction open on the database, or if the database is not a WAL mode\n** database.\n**\n** SQLITE_OK is returned if successful, or an SQLite error code otherwise.\n**\n** This interface is only available if SQLite is compiled with the\n** [SQLITE_ENABLE_SNAPSHOT] option.\n*/\nSQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb);\n\n/*\n** CAPI3REF: Serialize a database\n**\n** The sqlite3_serialize(D,S,P,F) interface returns a pointer to\n** memory that is a serialization of the S database on\n** [database connection] D. If S is a NULL pointer, the main database is used.\n** If P is not a NULL pointer, then the size of the database in bytes\n** is written into *P.\n**\n** For an ordinary on-disk database file, the serialization is just a\n** copy of the disk file. For an in-memory database or a \"TEMP\" database,\n** the serialization is the same sequence of bytes which would be written\n** to disk if that database where backed up to disk.\n**\n** The usual case is that sqlite3_serialize() copies the serialization of\n** the database into memory obtained from [sqlite3_malloc64()] and returns\n** a pointer to that memory. The caller is responsible for freeing the\n** returned value to avoid a memory leak. However, if the F argument\n** contains the SQLITE_SERIALIZE_NOCOPY bit, then no memory allocations\n** are made, and the sqlite3_serialize() function will return a pointer\n** to the contiguous memory representation of the database that SQLite\n** is currently using for that database, or NULL if the no such contiguous\n** memory representation of the database exists. A contiguous memory\n** representation of the database will usually only exist if there has\n** been a prior call to [sqlite3_deserialize(D,S,...)] with the same\n** values of D and S.\n** The size of the database is written into *P even if the\n** SQLITE_SERIALIZE_NOCOPY bit is set but no contiguous copy\n** of the database exists.\n**\n** After the call, if the SQLITE_SERIALIZE_NOCOPY bit had been set,\n** the returned buffer content will remain accessible and unchanged\n** until either the next write operation on the connection or when\n** the connection is closed, and applications must not modify the\n** buffer. If the bit had been clear, the returned buffer will not\n** be accessed by SQLite after the call.\n**\n** A call to sqlite3_serialize(D,S,P,F) might return NULL even if the\n** SQLITE_SERIALIZE_NOCOPY bit is omitted from argument F if a memory\n** allocation error occurs.\n**\n** This interface is omitted if SQLite is compiled with the\n** [SQLITE_OMIT_DESERIALIZE] option.\n*/\nSQLITE_API unsigned char *sqlite3_serialize(\n sqlite3 *db, /* The database connection */\n const char *zSchema, /* Which DB to serialize. ex: \"main\", \"temp\", ... */\n sqlite3_int64 *piSize, /* Write size of the DB here, if not NULL */\n unsigned int mFlags /* Zero or more SQLITE_SERIALIZE_* flags */\n);\n\n/*\n** CAPI3REF: Flags for sqlite3_serialize\n**\n** Zero or more of the following constants can be OR-ed together for\n** the F argument to [sqlite3_serialize(D,S,P,F)].\n**\n** SQLITE_SERIALIZE_NOCOPY means that [sqlite3_serialize()] will return\n** a pointer to contiguous in-memory database that it is currently using,\n** without making a copy of the database. If SQLite is not currently using\n** a contiguous in-memory database, then this option causes\n** [sqlite3_serialize()] to return a NULL pointer. SQLite will only be\n** using a contiguous in-memory database if it has been initialized by a\n** prior call to [sqlite3_deserialize()].\n*/\n#define SQLITE_SERIALIZE_NOCOPY 0x001 /* Do no memory allocations */\n\n/*\n** CAPI3REF: Deserialize a database\n**\n** The sqlite3_deserialize(D,S,P,N,M,F) interface causes the\n** [database connection] D to disconnect from database S and then\n** reopen S as an in-memory database based on the serialization contained\n** in P. The serialized database P is N bytes in size. M is the size of\n** the buffer P, which might be larger than N. If M is larger than N, and\n** the SQLITE_DESERIALIZE_READONLY bit is not set in F, then SQLite is\n** permitted to add content to the in-memory database as long as the total\n** size does not exceed M bytes.\n**\n** If the SQLITE_DESERIALIZE_FREEONCLOSE bit is set in F, then SQLite will\n** invoke sqlite3_free() on the serialization buffer when the database\n** connection closes. If the SQLITE_DESERIALIZE_RESIZEABLE bit is set, then\n** SQLite will try to increase the buffer size using sqlite3_realloc64()\n** if writes on the database cause it to grow larger than M bytes.\n**\n** Applications must not modify the buffer P or invalidate it before\n** the database connection D is closed.\n**\n** The sqlite3_deserialize() interface will fail with SQLITE_BUSY if the\n** database is currently in a read transaction or is involved in a backup\n** operation.\n**\n** It is not possible to deserialized into the TEMP database. If the\n** S argument to sqlite3_deserialize(D,S,P,N,M,F) is \"temp\" then the\n** function returns SQLITE_ERROR.\n**\n** The deserialized database should not be in [WAL mode]. If the database\n** is in WAL mode, then any attempt to use the database file will result\n** in an [SQLITE_CANTOPEN] error. The application can set the\n** [file format version numbers] (bytes 18 and 19) of the input database P\n** to 0x01 prior to invoking sqlite3_deserialize(D,S,P,N,M,F) to force the\n** database file into rollback mode and work around this limitation.\n**\n** If sqlite3_deserialize(D,S,P,N,M,F) fails for any reason and if the\n** SQLITE_DESERIALIZE_FREEONCLOSE bit is set in argument F, then\n** [sqlite3_free()] is invoked on argument P prior to returning.\n**\n** This interface is omitted if SQLite is compiled with the\n** [SQLITE_OMIT_DESERIALIZE] option.\n*/\nSQLITE_API int sqlite3_deserialize(\n sqlite3 *db, /* The database connection */\n const char *zSchema, /* Which DB to reopen with the deserialization */\n unsigned char *pData, /* The serialized database content */\n sqlite3_int64 szDb, /* Number bytes in the deserialization */\n sqlite3_int64 szBuf, /* Total size of buffer pData[] */\n unsigned mFlags /* Zero or more SQLITE_DESERIALIZE_* flags */\n);\n\n/*\n** CAPI3REF: Flags for sqlite3_deserialize()\n**\n** The following are allowed values for 6th argument (the F argument) to\n** the [sqlite3_deserialize(D,S,P,N,M,F)] interface.\n**\n** The SQLITE_DESERIALIZE_FREEONCLOSE means that the database serialization\n** in the P argument is held in memory obtained from [sqlite3_malloc64()]\n** and that SQLite should take ownership of this memory and automatically\n** free it when it has finished using it. Without this flag, the caller\n** is responsible for freeing any dynamically allocated memory.\n**\n** The SQLITE_DESERIALIZE_RESIZEABLE flag means that SQLite is allowed to\n** grow the size of the database using calls to [sqlite3_realloc64()]. This\n** flag should only be used if SQLITE_DESERIALIZE_FREEONCLOSE is also used.\n** Without this flag, the deserialized database cannot increase in size beyond\n** the number of bytes specified by the M parameter.\n**\n** The SQLITE_DESERIALIZE_READONLY flag means that the deserialized database\n** should be treated as read-only.\n*/\n#define SQLITE_DESERIALIZE_FREEONCLOSE 1 /* Call sqlite3_free() on close */\n#define SQLITE_DESERIALIZE_RESIZEABLE 2 /* Resize using sqlite3_realloc64() */\n#define SQLITE_DESERIALIZE_READONLY 4 /* Database is read-only */\n\n/*\n** Undo the hack that converts floating point types to integer for\n** builds on processors without floating point support.\n*/\n#ifdef SQLITE_OMIT_FLOATING_POINT\n# undef double\n#endif\n\n#if defined(__wasi__)\n# undef SQLITE_WASI\n# define SQLITE_WASI 1\n# ifndef SQLITE_OMIT_LOAD_EXTENSION\n# define SQLITE_OMIT_LOAD_EXTENSION\n# endif\n# ifndef SQLITE_THREADSAFE\n# define SQLITE_THREADSAFE 0\n# endif\n#endif\n\n#ifdef __cplusplus\n} /* End of the 'extern \"C\"' block */\n#endif\n/* #endif for SQLITE3_H will be added by mksqlite3.tcl */\n\n/******** Begin file sqlite3rtree.h *********/\n/*\n** 2010 August 30\n**\n** The author disclaims copyright to this source code. In place of\n** a legal notice, here is a blessing:\n**\n** May you do good and not evil.\n** May you find forgiveness for yourself and forgive others.\n** May you share freely, never taking more than you give.\n**\n*************************************************************************\n*/\n\n#ifndef _SQLITE3RTREE_H_\n#define _SQLITE3RTREE_H_\n\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\ntypedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry;\ntypedef struct sqlite3_rtree_query_info sqlite3_rtree_query_info;\n\n/* The double-precision datatype used by RTree depends on the\n** SQLITE_RTREE_INT_ONLY compile-time option.\n*/\n#ifdef SQLITE_RTREE_INT_ONLY\n typedef sqlite3_int64 sqlite3_rtree_dbl;\n#else\n typedef double sqlite3_rtree_dbl;\n#endif\n\n/*\n** Register a geometry callback named zGeom that can be used as part of an\n** R-Tree geometry query as follows:\n**\n** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zGeom(... params ...)\n*/\nSQLITE_API int sqlite3_rtree_geometry_callback(\n sqlite3 *db,\n const char *zGeom,\n int (*xGeom)(sqlite3_rtree_geometry*, int, sqlite3_rtree_dbl*,int*),\n void *pContext\n);\n\n\n/*\n** A pointer to a structure of the following type is passed as the first\n** argument to callbacks registered using rtree_geometry_callback().\n*/\nstruct sqlite3_rtree_geometry {\n void *pContext; /* Copy of pContext passed to s_r_g_c() */\n int nParam; /* Size of array aParam[] */\n sqlite3_rtree_dbl *aParam; /* Parameters passed to SQL geom function */\n void *pUser; /* Callback implementation user data */\n void (*xDelUser)(void *); /* Called by SQLite to clean up pUser */\n};\n\n/*\n** Register a 2nd-generation geometry callback named zScore that can be\n** used as part of an R-Tree geometry query as follows:\n**\n** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zQueryFunc(... params ...)\n*/\nSQLITE_API int sqlite3_rtree_query_callback(\n sqlite3 *db,\n const char *zQueryFunc,\n int (*xQueryFunc)(sqlite3_rtree_query_info*),\n void *pContext,\n void (*xDestructor)(void*)\n);\n\n\n/*\n** A pointer to a structure of the following type is passed as the\n** argument to scored geometry callback registered using\n** sqlite3_rtree_query_callback().\n**\n** Note that the first 5 fields of this structure are identical to\n** sqlite3_rtree_geometry. This structure is a subclass of\n** sqlite3_rtree_geometry.\n*/\nstruct sqlite3_rtree_query_info {\n void *pContext; /* pContext from when function registered */\n int nParam; /* Number of function parameters */\n sqlite3_rtree_dbl *aParam; /* value of function parameters */\n void *pUser; /* callback can use this, if desired */\n void (*xDelUser)(void*); /* function to free pUser */\n sqlite3_rtree_dbl *aCoord; /* Coordinates of node or entry to check */\n unsigned int *anQueue; /* Number of pending entries in the queue */\n int nCoord; /* Number of coordinates */\n int iLevel; /* Level of current node or entry */\n int mxLevel; /* The largest iLevel value in the tree */\n sqlite3_int64 iRowid; /* Rowid for current entry */\n sqlite3_rtree_dbl rParentScore; /* Score of parent node */\n int eParentWithin; /* Visibility of parent node */\n int eWithin; /* OUT: Visibility */\n sqlite3_rtree_dbl rScore; /* OUT: Write the score here */\n /* The following fields are only available in 3.8.11 and later */\n sqlite3_value **apSqlParam; /* Original SQL values of parameters */\n};\n\n/*\n** Allowed values for sqlite3_rtree_query.eWithin and .eParentWithin.\n*/\n#define NOT_WITHIN 0 /* Object completely outside of query region */\n#define PARTLY_WITHIN 1 /* Object partially overlaps query region */\n#define FULLY_WITHIN 2 /* Object fully contained within query region */\n\n\n#ifdef __cplusplus\n} /* end of the 'extern \"C\"' block */\n#endif\n\n#endif /* ifndef _SQLITE3RTREE_H_ */\n\n/******** End of sqlite3rtree.h *********/\n/******** Begin file sqlite3session.h *********/\n\n#if !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION)\n#define __SQLITESESSION_H_ 1\n\n/*\n** Make sure we can call this stuff from C++.\n*/\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n\n/*\n** CAPI3REF: Session Object Handle\n**\n** An instance of this object is a [session] that can be used to\n** record changes to a database.\n*/\ntypedef struct sqlite3_session sqlite3_session;\n\n/*\n** CAPI3REF: Changeset Iterator Handle\n**\n** An instance of this object acts as a cursor for iterating\n** over the elements of a [changeset] or [patchset].\n*/\ntypedef struct sqlite3_changeset_iter sqlite3_changeset_iter;\n\n/*\n** CAPI3REF: Create A New Session Object\n** CONSTRUCTOR: sqlite3_session\n**\n** Create a new session object attached to database handle db. If successful,\n** a pointer to the new object is written to *ppSession and SQLITE_OK is\n** returned. If an error occurs, *ppSession is set to NULL and an SQLite\n** error code (e.g. SQLITE_NOMEM) is returned.\n**\n** It is possible to create multiple session objects attached to a single\n** database handle.\n**\n** Session objects created using this function should be deleted using the\n** [sqlite3session_delete()] function before the database handle that they\n** are attached to is itself closed. If the database handle is closed before\n** the session object is deleted, then the results of calling any session\n** module function, including [sqlite3session_delete()] on the session object\n** are undefined.\n**\n** Because the session module uses the [sqlite3_preupdate_hook()] API, it\n** is not possible for an application to register a pre-update hook on a\n** database handle that has one or more session objects attached. Nor is\n** it possible to create a session object attached to a database handle for\n** which a pre-update hook is already defined. The results of attempting\n** either of these things are undefined.\n**\n** The session object will be used to create changesets for tables in\n** database zDb, where zDb is either \"main\", or \"temp\", or the name of an\n** attached database. It is not an error if database zDb is not attached\n** to the database when the session object is created.\n*/\nSQLITE_API int sqlite3session_create(\n sqlite3 *db, /* Database handle */\n const char *zDb, /* Name of db (e.g. \"main\") */\n sqlite3_session **ppSession /* OUT: New session object */\n);\n\n/*\n** CAPI3REF: Delete A Session Object\n** DESTRUCTOR: sqlite3_session\n**\n** Delete a session object previously allocated using\n** [sqlite3session_create()]. Once a session object has been deleted, the\n** results of attempting to use pSession with any other session module\n** function are undefined.\n**\n** Session objects must be deleted before the database handle to which they\n** are attached is closed. Refer to the documentation for\n** [sqlite3session_create()] for details.\n*/\nSQLITE_API void sqlite3session_delete(sqlite3_session *pSession);\n\n/*\n** CAPI3REF: Configure a Session Object\n** METHOD: sqlite3_session\n**\n** This method is used to configure a session object after it has been\n** created. At present the only valid values for the second parameter are\n** [SQLITE_SESSION_OBJCONFIG_SIZE] and [SQLITE_SESSION_OBJCONFIG_ROWID].\n**\n*/\nSQLITE_API int sqlite3session_object_config(sqlite3_session*, int op, void *pArg);\n\n/*\n** CAPI3REF: Options for sqlite3session_object_config\n**\n** The following values may passed as the the 2nd parameter to\n** sqlite3session_object_config().\n**\n** <dt>SQLITE_SESSION_OBJCONFIG_SIZE <dd>\n** This option is used to set, clear or query the flag that enables\n** the [sqlite3session_changeset_size()] API. Because it imposes some\n** computational overhead, this API is disabled by default. Argument\n** pArg must point to a value of type (int). If the value is initially\n** 0, then the sqlite3session_changeset_size() API is disabled. If it\n** is greater than 0, then the same API is enabled. Or, if the initial\n** value is less than zero, no change is made. In all cases the (int)\n** variable is set to 1 if the sqlite3session_changeset_size() API is\n** enabled following the current call, or 0 otherwise.\n**\n** It is an error (SQLITE_MISUSE) to attempt to modify this setting after\n** the first table has been attached to the session object.\n**\n** <dt>SQLITE_SESSION_OBJCONFIG_ROWID <dd>\n** This option is used to set, clear or query the flag that enables\n** collection of data for tables with no explicit PRIMARY KEY.\n**\n** Normally, tables with no explicit PRIMARY KEY are simply ignored\n** by the sessions module. However, if this flag is set, it behaves\n** as if such tables have a column \"_rowid_ INTEGER PRIMARY KEY\" inserted\n** as their leftmost columns.\n**\n** It is an error (SQLITE_MISUSE) to attempt to modify this setting after\n** the first table has been attached to the session object.\n*/\n#define SQLITE_SESSION_OBJCONFIG_SIZE 1\n#define SQLITE_SESSION_OBJCONFIG_ROWID 2\n\n/*\n** CAPI3REF: Enable Or Disable A Session Object\n** METHOD: sqlite3_session\n**\n** Enable or disable the recording of changes by a session object. When\n** enabled, a session object records changes made to the database. When\n** disabled - it does not. A newly created session object is enabled.\n** Refer to the documentation for [sqlite3session_changeset()] for further\n** details regarding how enabling and disabling a session object affects\n** the eventual changesets.\n**\n** Passing zero to this function disables the session. Passing a value\n** greater than zero enables it. Passing a value less than zero is a\n** no-op, and may be used to query the current state of the session.\n**\n** The return value indicates the final state of the session object: 0 if\n** the session is disabled, or 1 if it is enabled.\n*/\nSQLITE_API int sqlite3session_enable(sqlite3_session *pSession, int bEnable);\n\n/*\n** CAPI3REF: Set Or Clear the Indirect Change Flag\n** METHOD: sqlite3_session\n**\n** Each change recorded by a session object is marked as either direct or\n** indirect. A change is marked as indirect if either:\n**\n** <ul>\n** <li> The session object \"indirect\" flag is set when the change is\n** made, or\n** <li> The change is made by an SQL trigger or foreign key action\n** instead of directly as a result of a users SQL statement.\n** </ul>\n**\n** If a single row is affected by more than one operation within a session,\n** then the change is considered indirect if all operations meet the criteria\n** for an indirect change above, or direct otherwise.\n**\n** This function is used to set, clear or query the session object indirect\n** flag. If the second argument passed to this function is zero, then the\n** indirect flag is cleared. If it is greater than zero, the indirect flag\n** is set. Passing a value less than zero does not modify the current value\n** of the indirect flag, and may be used to query the current state of the\n** indirect flag for the specified session object.\n**\n** The return value indicates the final state of the indirect flag: 0 if\n** it is clear, or 1 if it is set.\n*/\nSQLITE_API int sqlite3session_indirect(sqlite3_session *pSession, int bIndirect);\n\n/*\n** CAPI3REF: Attach A Table To A Session Object\n** METHOD: sqlite3_session\n**\n** If argument zTab is not NULL, then it is the name of a table to attach\n** to the session object passed as the first argument. All subsequent changes\n** made to the table while the session object is enabled will be recorded. See\n** documentation for [sqlite3session_changeset()] for further details.\n**\n** Or, if argument zTab is NULL, then changes are recorded for all tables\n** in the database. If additional tables are added to the database (by\n** executing \"CREATE TABLE\" statements) after this call is made, changes for\n** the new tables are also recorded.\n**\n** Changes can only be recorded for tables that have a PRIMARY KEY explicitly\n** defined as part of their CREATE TABLE statement. It does not matter if the\n** PRIMARY KEY is an \"INTEGER PRIMARY KEY\" (rowid alias) or not. The PRIMARY\n** KEY may consist of a single column, or may be a composite key.\n**\n** It is not an error if the named table does not exist in the database. Nor\n** is it an error if the named table does not have a PRIMARY KEY. However,\n** no changes will be recorded in either of these scenarios.\n**\n** Changes are not recorded for individual rows that have NULL values stored\n** in one or more of their PRIMARY KEY columns.\n**\n** SQLITE_OK is returned if the call completes without error. Or, if an error\n** occurs, an SQLite error code (e.g. SQLITE_NOMEM) is returned.\n**\n** <h3>Special sqlite_stat1 Handling</h3>\n**\n** As of SQLite version 3.22.0, the \"sqlite_stat1\" table is an exception to\n** some of the rules above. In SQLite, the schema of sqlite_stat1 is:\n** <pre>\n** CREATE TABLE sqlite_stat1(tbl,idx,stat)\n** </pre>\n**\n** Even though sqlite_stat1 does not have a PRIMARY KEY, changes are\n** recorded for it as if the PRIMARY KEY is (tbl,idx). Additionally, changes\n** are recorded for rows for which (idx IS NULL) is true. However, for such\n** rows a zero-length blob (SQL value X'') is stored in the changeset or\n** patchset instead of a NULL value. This allows such changesets to be\n** manipulated by legacy implementations of sqlite3changeset_invert(),\n** concat() and similar.\n**\n** The sqlite3changeset_apply() function automatically converts the\n** zero-length blob back to a NULL value when updating the sqlite_stat1\n** table. However, if the application calls sqlite3changeset_new(),\n** sqlite3changeset_old() or sqlite3changeset_conflict on a changeset\n** iterator directly (including on a changeset iterator passed to a\n** conflict-handler callback) then the X'' value is returned. The application\n** must translate X'' to NULL itself if required.\n**\n** Legacy (older than 3.22.0) versions of the sessions module cannot capture\n** changes made to the sqlite_stat1 table. Legacy versions of the\n** sqlite3changeset_apply() function silently ignore any modifications to the\n** sqlite_stat1 table that are part of a changeset or patchset.\n*/\nSQLITE_API int sqlite3session_attach(\n sqlite3_session *pSession, /* Session object */\n const char *zTab /* Table name */\n);\n\n/*\n** CAPI3REF: Set a table filter on a Session Object.\n** METHOD: sqlite3_session\n**\n** The second argument (xFilter) is the \"filter callback\". For changes to rows\n** in tables that are not attached to the Session object, the filter is called\n** to determine whether changes to the table's rows should be tracked or not.\n** If xFilter returns 0, changes are not tracked. Note that once a table is\n** attached, xFilter will not be called again.\n*/\nSQLITE_API void sqlite3session_table_filter(\n sqlite3_session *pSession, /* Session object */\n int(*xFilter)(\n void *pCtx, /* Copy of third arg to _filter_table() */\n const char *zTab /* Table name */\n ),\n void *pCtx /* First argument passed to xFilter */\n);\n\n/*\n** CAPI3REF: Generate A Changeset From A Session Object\n** METHOD: sqlite3_session\n**\n** Obtain a changeset containing changes to the tables attached to the\n** session object passed as the first argument. If successful,\n** set *ppChangeset to point to a buffer containing the changeset\n** and *pnChangeset to the size of the changeset in bytes before returning\n** SQLITE_OK. If an error occurs, set both *ppChangeset and *pnChangeset to\n** zero and return an SQLite error code.\n**\n** A changeset consists of zero or more INSERT, UPDATE and/or DELETE changes,\n** each representing a change to a single row of an attached table. An INSERT\n** change contains the values of each field of a new database row. A DELETE\n** contains the original values of each field of a deleted database row. An\n** UPDATE change contains the original values of each field of an updated\n** database row along with the updated values for each updated non-primary-key\n** column. It is not possible for an UPDATE change to represent a change that\n** modifies the values of primary key columns. If such a change is made, it\n** is represented in a changeset as a DELETE followed by an INSERT.\n**\n** Changes are not recorded for rows that have NULL values stored in one or\n** more of their PRIMARY KEY columns. If such a row is inserted or deleted,\n** no corresponding change is present in the changesets returned by this\n** function. If an existing row with one or more NULL values stored in\n** PRIMARY KEY columns is updated so that all PRIMARY KEY columns are non-NULL,\n** only an INSERT is appears in the changeset. Similarly, if an existing row\n** with non-NULL PRIMARY KEY values is updated so that one or more of its\n** PRIMARY KEY columns are set to NULL, the resulting changeset contains a\n** DELETE change only.\n**\n** The contents of a changeset may be traversed using an iterator created\n** using the [sqlite3changeset_start()] API. A changeset may be applied to\n** a database with a compatible schema using the [sqlite3changeset_apply()]\n** API.\n**\n** Within a changeset generated by this function, all changes related to a\n** single table are grouped together. In other words, when iterating through\n** a changeset or when applying a changeset to a database, all changes related\n** to a single table are processed before moving on to the next table. Tables\n** are sorted in the same order in which they were attached (or auto-attached)\n** to the sqlite3_session object. The order in which the changes related to\n** a single table are stored is undefined.\n**\n** Following a successful call to this function, it is the responsibility of\n** the caller to eventually free the buffer that *ppChangeset points to using\n** [sqlite3_free()].\n**\n** <h3>Changeset Generation</h3>\n**\n** Once a table has been attached to a session object, the session object\n** records the primary key values of all new rows inserted into the table.\n** It also records the original primary key and other column values of any\n** deleted or updated rows. For each unique primary key value, data is only\n** recorded once - the first time a row with said primary key is inserted,\n** updated or deleted in the lifetime of the session.\n**\n** There is one exception to the previous paragraph: when a row is inserted,\n** updated or deleted, if one or more of its primary key columns contain a\n** NULL value, no record of the change is made.\n**\n** The session object therefore accumulates two types of records - those\n** that consist of primary key values only (created when the user inserts\n** a new record) and those that consist of the primary key values and the\n** original values of other table columns (created when the users deletes\n** or updates a record).\n**\n** When this function is called, the requested changeset is created using\n** both the accumulated records and the current contents of the database\n** file. Specifically:\n**\n** <ul>\n** <li> For each record generated by an insert, the database is queried\n** for a row with a matching primary key. If one is found, an INSERT\n** change is added to the changeset. If no such row is found, no change\n** is added to the changeset.\n**\n** <li> For each record generated by an update or delete, the database is\n** queried for a row with a matching primary key. If such a row is\n** found and one or more of the non-primary key fields have been\n** modified from their original values, an UPDATE change is added to\n** the changeset. Or, if no such row is found in the table, a DELETE\n** change is added to the changeset. If there is a row with a matching\n** primary key in the database, but all fields contain their original\n** values, no change is added to the changeset.\n** </ul>\n**\n** This means, amongst other things, that if a row is inserted and then later\n** deleted while a session object is active, neither the insert nor the delete\n** will be present in the changeset. Or if a row is deleted and then later a\n** row with the same primary key values inserted while a session object is\n** active, the resulting changeset will contain an UPDATE change instead of\n** a DELETE and an INSERT.\n**\n** When a session object is disabled (see the [sqlite3session_enable()] API),\n** it does not accumulate records when rows are inserted, updated or deleted.\n** This may appear to have some counter-intuitive effects if a single row\n** is written to more than once during a session. For example, if a row\n** is inserted while a session object is enabled, then later deleted while\n** the same session object is disabled, no INSERT record will appear in the\n** changeset, even though the delete took place while the session was disabled.\n** Or, if one field of a row is updated while a session is disabled, and\n** another field of the same row is updated while the session is enabled, the\n** resulting changeset will contain an UPDATE change that updates both fields.\n*/\nSQLITE_API int sqlite3session_changeset(\n sqlite3_session *pSession, /* Session object */\n int *pnChangeset, /* OUT: Size of buffer at *ppChangeset */\n void **ppChangeset /* OUT: Buffer containing changeset */\n);\n\n/*\n** CAPI3REF: Return An Upper-limit For The Size Of The Changeset\n** METHOD: sqlite3_session\n**\n** By default, this function always returns 0. For it to return\n** a useful result, the sqlite3_session object must have been configured\n** to enable this API using sqlite3session_object_config() with the\n** SQLITE_SESSION_OBJCONFIG_SIZE verb.\n**\n** When enabled, this function returns an upper limit, in bytes, for the size\n** of the changeset that might be produced if sqlite3session_changeset() were\n** called. The final changeset size might be equal to or smaller than the\n** size in bytes returned by this function.\n*/\nSQLITE_API sqlite3_int64 sqlite3session_changeset_size(sqlite3_session *pSession);\n\n/*\n** CAPI3REF: Load The Difference Between Tables Into A Session\n** METHOD: sqlite3_session\n**\n** If it is not already attached to the session object passed as the first\n** argument, this function attaches table zTbl in the same manner as the\n** [sqlite3session_attach()] function. If zTbl does not exist, or if it\n** does not have a primary key, this function is a no-op (but does not return\n** an error).\n**\n** Argument zFromDb must be the name of a database (\"main\", \"temp\" etc.)\n** attached to the same database handle as the session object that contains\n** a table compatible with the table attached to the session by this function.\n** A table is considered compatible if it:\n**\n** <ul>\n** <li> Has the same name,\n** <li> Has the same set of columns declared in the same order, and\n** <li> Has the same PRIMARY KEY definition.\n** </ul>\n**\n** If the tables are not compatible, SQLITE_SCHEMA is returned. If the tables\n** are compatible but do not have any PRIMARY KEY columns, it is not an error\n** but no changes are added to the session object. As with other session\n** APIs, tables without PRIMARY KEYs are simply ignored.\n**\n** This function adds a set of changes to the session object that could be\n** used to update the table in database zFrom (call this the \"from-table\")\n** so that its content is the same as the table attached to the session\n** object (call this the \"to-table\"). Specifically:\n**\n** <ul>\n** <li> For each row (primary key) that exists in the to-table but not in\n** the from-table, an INSERT record is added to the session object.\n**\n** <li> For each row (primary key) that exists in the to-table but not in\n** the from-table, a DELETE record is added to the session object.\n**\n** <li> For each row (primary key) that exists in both tables, but features\n** different non-PK values in each, an UPDATE record is added to the\n** session.\n** </ul>\n**\n** To clarify, if this function is called and then a changeset constructed\n** using [sqlite3session_changeset()], then after applying that changeset to\n** database zFrom the contents of the two compatible tables would be\n** identical.\n**\n** It an error if database zFrom does not exist or does not contain the\n** required compatible table.\n**\n** If the operation is successful, SQLITE_OK is returned. Otherwise, an SQLite\n** error code. In this case, if argument pzErrMsg is not NULL, *pzErrMsg\n** may be set to point to a buffer containing an English language error\n** message. It is the responsibility of the caller to free this buffer using\n** sqlite3_free().\n*/\nSQLITE_API int sqlite3session_diff(\n sqlite3_session *pSession,\n const char *zFromDb,\n const char *zTbl,\n char **pzErrMsg\n);\n\n\n/*\n** CAPI3REF: Generate A Patchset From A Session Object\n** METHOD: sqlite3_session\n**\n** The differences between a patchset and a changeset are that:\n**\n** <ul>\n** <li> DELETE records consist of the primary key fields only. The\n** original values of other fields are omitted.\n** <li> The original values of any modified fields are omitted from\n** UPDATE records.\n** </ul>\n**\n** A patchset blob may be used with up to date versions of all\n** sqlite3changeset_xxx API functions except for sqlite3changeset_invert(),\n** which returns SQLITE_CORRUPT if it is passed a patchset. Similarly,\n** attempting to use a patchset blob with old versions of the\n** sqlite3changeset_xxx APIs also provokes an SQLITE_CORRUPT error.\n**\n** Because the non-primary key \"old.*\" fields are omitted, no\n** SQLITE_CHANGESET_DATA conflicts can be detected or reported if a patchset\n** is passed to the sqlite3changeset_apply() API. Other conflict types work\n** in the same way as for changesets.\n**\n** Changes within a patchset are ordered in the same way as for changesets\n** generated by the sqlite3session_changeset() function (i.e. all changes for\n** a single table are grouped together, tables appear in the order in which\n** they were attached to the session object).\n*/\nSQLITE_API int sqlite3session_patchset(\n sqlite3_session *pSession, /* Session object */\n int *pnPatchset, /* OUT: Size of buffer at *ppPatchset */\n void **ppPatchset /* OUT: Buffer containing patchset */\n);\n\n/*\n** CAPI3REF: Test if a changeset has recorded any changes.\n**\n** Return non-zero if no changes to attached tables have been recorded by\n** the session object passed as the first argument. Otherwise, if one or\n** more changes have been recorded, return zero.\n**\n** Even if this function returns zero, it is possible that calling\n** [sqlite3session_changeset()] on the session handle may still return a\n** changeset that contains no changes. This can happen when a row in\n** an attached table is modified and then later on the original values\n** are restored. However, if this function returns non-zero, then it is\n** guaranteed that a call to sqlite3session_changeset() will return a\n** changeset containing zero changes.\n*/\nSQLITE_API int sqlite3session_isempty(sqlite3_session *pSession);\n\n/*\n** CAPI3REF: Query for the amount of heap memory used by a session object.\n**\n** This API returns the total amount of heap memory in bytes currently\n** used by the session object passed as the only argument.\n*/\nSQLITE_API sqlite3_int64 sqlite3session_memory_used(sqlite3_session *pSession);\n\n/*\n** CAPI3REF: Create An Iterator To Traverse A Changeset\n** CONSTRUCTOR: sqlite3_changeset_iter\n**\n** Create an iterator used to iterate through the contents of a changeset.\n** If successful, *pp is set to point to the iterator handle and SQLITE_OK\n** is returned. Otherwise, if an error occurs, *pp is set to zero and an\n** SQLite error code is returned.\n**\n** The following functions can be used to advance and query a changeset\n** iterator created by this function:\n**\n** <ul>\n** <li> [sqlite3changeset_next()]\n** <li> [sqlite3changeset_op()]\n** <li> [sqlite3changeset_new()]\n** <li> [sqlite3changeset_old()]\n** </ul>\n**\n** It is the responsibility of the caller to eventually destroy the iterator\n** by passing it to [sqlite3changeset_finalize()]. The buffer containing the\n** changeset (pChangeset) must remain valid until after the iterator is\n** destroyed.\n**\n** Assuming the changeset blob was created by one of the\n** [sqlite3session_changeset()], [sqlite3changeset_concat()] or\n** [sqlite3changeset_invert()] functions, all changes within the changeset\n** that apply to a single table are grouped together. This means that when\n** an application iterates through a changeset using an iterator created by\n** this function, all changes that relate to a single table are visited\n** consecutively. There is no chance that the iterator will visit a change\n** the applies to table X, then one for table Y, and then later on visit\n** another change for table X.\n**\n** The behavior of sqlite3changeset_start_v2() and its streaming equivalent\n** may be modified by passing a combination of\n** [SQLITE_CHANGESETSTART_INVERT | supported flags] as the 4th parameter.\n**\n** Note that the sqlite3changeset_start_v2() API is still <b>experimental</b>\n** and therefore subject to change.\n*/\nSQLITE_API int sqlite3changeset_start(\n sqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */\n int nChangeset, /* Size of changeset blob in bytes */\n void *pChangeset /* Pointer to blob containing changeset */\n);\nSQLITE_API int sqlite3changeset_start_v2(\n sqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */\n int nChangeset, /* Size of changeset blob in bytes */\n void *pChangeset, /* Pointer to blob containing changeset */\n int flags /* SESSION_CHANGESETSTART_* flags */\n);\n\n/*\n** CAPI3REF: Flags for sqlite3changeset_start_v2\n**\n** The following flags may passed via the 4th parameter to\n** [sqlite3changeset_start_v2] and [sqlite3changeset_start_v2_strm]:\n**\n** <dt>SQLITE_CHANGESETAPPLY_INVERT <dd>\n** Invert the changeset while iterating through it. This is equivalent to\n** inverting a changeset using sqlite3changeset_invert() before applying it.\n** It is an error to specify this flag with a patchset.\n*/\n#define SQLITE_CHANGESETSTART_INVERT 0x0002\n\n\n/*\n** CAPI3REF: Advance A Changeset Iterator\n** METHOD: sqlite3_changeset_iter\n**\n** This function may only be used with iterators created by the function\n** [sqlite3changeset_start()]. If it is called on an iterator passed to\n** a conflict-handler callback by [sqlite3changeset_apply()], SQLITE_MISUSE\n** is returned and the call has no effect.\n**\n** Immediately after an iterator is created by sqlite3changeset_start(), it\n** does not point to any change in the changeset. Assuming the changeset\n** is not empty, the first call to this function advances the iterator to\n** point to the first change in the changeset. Each subsequent call advances\n** the iterator to point to the next change in the changeset (if any). If\n** no error occurs and the iterator points to a valid change after a call\n** to sqlite3changeset_next() has advanced it, SQLITE_ROW is returned.\n** Otherwise, if all changes in the changeset have already been visited,\n** SQLITE_DONE is returned.\n**\n** If an error occurs, an SQLite error code is returned. Possible error\n** codes include SQLITE_CORRUPT (if the changeset buffer is corrupt) or\n** SQLITE_NOMEM.\n*/\nSQLITE_API int sqlite3changeset_next(sqlite3_changeset_iter *pIter);\n\n/*\n** CAPI3REF: Obtain The Current Operation From A Changeset Iterator\n** METHOD: sqlite3_changeset_iter\n**\n** The pIter argument passed to this function may either be an iterator\n** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator\n** created by [sqlite3changeset_start()]. In the latter case, the most recent\n** call to [sqlite3changeset_next()] must have returned [SQLITE_ROW]. If this\n** is not the case, this function returns [SQLITE_MISUSE].\n**\n** Arguments pOp, pnCol and pzTab may not be NULL. Upon return, three\n** outputs are set through these pointers:\n**\n** *pOp is set to one of [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE],\n** depending on the type of change that the iterator currently points to;\n**\n** *pnCol is set to the number of columns in the table affected by the change; and\n**\n** *pzTab is set to point to a nul-terminated utf-8 encoded string containing\n** the name of the table affected by the current change. The buffer remains\n** valid until either sqlite3changeset_next() is called on the iterator\n** or until the conflict-handler function returns.\n**\n** If pbIndirect is not NULL, then *pbIndirect is set to true (1) if the change\n** is an indirect change, or false (0) otherwise. See the documentation for\n** [sqlite3session_indirect()] for a description of direct and indirect\n** changes.\n**\n** If no error occurs, SQLITE_OK is returned. If an error does occur, an\n** SQLite error code is returned. The values of the output variables may not\n** be trusted in this case.\n*/\nSQLITE_API int sqlite3changeset_op(\n sqlite3_changeset_iter *pIter, /* Iterator object */\n const char **pzTab, /* OUT: Pointer to table name */\n int *pnCol, /* OUT: Number of columns in table */\n int *pOp, /* OUT: SQLITE_INSERT, DELETE or UPDATE */\n int *pbIndirect /* OUT: True for an 'indirect' change */\n);\n\n/*\n** CAPI3REF: Obtain The Primary Key Definition Of A Table\n** METHOD: sqlite3_changeset_iter\n**\n** For each modified table, a changeset includes the following:\n**\n** <ul>\n** <li> The number of columns in the table, and\n** <li> Which of those columns make up the tables PRIMARY KEY.\n** </ul>\n**\n** This function is used to find which columns comprise the PRIMARY KEY of\n** the table modified by the change that iterator pIter currently points to.\n** If successful, *pabPK is set to point to an array of nCol entries, where\n** nCol is the number of columns in the table. Elements of *pabPK are set to\n** 0x01 if the corresponding column is part of the tables primary key, or\n** 0x00 if it is not.\n**\n** If argument pnCol is not NULL, then *pnCol is set to the number of columns\n** in the table.\n**\n** If this function is called when the iterator does not point to a valid\n** entry, SQLITE_MISUSE is returned and the output variables zeroed. Otherwise,\n** SQLITE_OK is returned and the output variables populated as described\n** above.\n*/\nSQLITE_API int sqlite3changeset_pk(\n sqlite3_changeset_iter *pIter, /* Iterator object */\n unsigned char **pabPK, /* OUT: Array of boolean - true for PK cols */\n int *pnCol /* OUT: Number of entries in output array */\n);\n\n/*\n** CAPI3REF: Obtain old.* Values From A Changeset Iterator\n** METHOD: sqlite3_changeset_iter\n**\n** The pIter argument passed to this function may either be an iterator\n** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator\n** created by [sqlite3changeset_start()]. In the latter case, the most recent\n** call to [sqlite3changeset_next()] must have returned SQLITE_ROW.\n** Furthermore, it may only be called if the type of change that the iterator\n** currently points to is either [SQLITE_DELETE] or [SQLITE_UPDATE]. Otherwise,\n** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL.\n**\n** Argument iVal must be greater than or equal to 0, and less than the number\n** of columns in the table affected by the current change. Otherwise,\n** [SQLITE_RANGE] is returned and *ppValue is set to NULL.\n**\n** If successful, this function sets *ppValue to point to a protected\n** sqlite3_value object containing the iVal'th value from the vector of\n** original row values stored as part of the UPDATE or DELETE change and\n** returns SQLITE_OK. The name of the function comes from the fact that this\n** is similar to the \"old.*\" columns available to update or delete triggers.\n**\n** If some other error occurs (e.g. an OOM condition), an SQLite error code\n** is returned and *ppValue is set to NULL.\n*/\nSQLITE_API int sqlite3changeset_old(\n sqlite3_changeset_iter *pIter, /* Changeset iterator */\n int iVal, /* Column number */\n sqlite3_value **ppValue /* OUT: Old value (or NULL pointer) */\n);\n\n/*\n** CAPI3REF: Obtain new.* Values From A Changeset Iterator\n** METHOD: sqlite3_changeset_iter\n**\n** The pIter argument passed to this function may either be an iterator\n** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator\n** created by [sqlite3changeset_start()]. In the latter case, the most recent\n** call to [sqlite3changeset_next()] must have returned SQLITE_ROW.\n** Furthermore, it may only be called if the type of change that the iterator\n** currently points to is either [SQLITE_UPDATE] or [SQLITE_INSERT]. Otherwise,\n** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL.\n**\n** Argument iVal must be greater than or equal to 0, and less than the number\n** of columns in the table affected by the current change. Otherwise,\n** [SQLITE_RANGE] is returned and *ppValue is set to NULL.\n**\n** If successful, this function sets *ppValue to point to a protected\n** sqlite3_value object containing the iVal'th value from the vector of\n** new row values stored as part of the UPDATE or INSERT change and\n** returns SQLITE_OK. If the change is an UPDATE and does not include\n** a new value for the requested column, *ppValue is set to NULL and\n** SQLITE_OK returned. The name of the function comes from the fact that\n** this is similar to the \"new.*\" columns available to update or delete\n** triggers.\n**\n** If some other error occurs (e.g. an OOM condition), an SQLite error code\n** is returned and *ppValue is set to NULL.\n*/\nSQLITE_API int sqlite3changeset_new(\n sqlite3_changeset_iter *pIter, /* Changeset iterator */\n int iVal, /* Column number */\n sqlite3_value **ppValue /* OUT: New value (or NULL pointer) */\n);\n\n/*\n** CAPI3REF: Obtain Conflicting Row Values From A Changeset Iterator\n** METHOD: sqlite3_changeset_iter\n**\n** This function should only be used with iterator objects passed to a\n** conflict-handler callback by [sqlite3changeset_apply()] with either\n** [SQLITE_CHANGESET_DATA] or [SQLITE_CHANGESET_CONFLICT]. If this function\n** is called on any other iterator, [SQLITE_MISUSE] is returned and *ppValue\n** is set to NULL.\n**\n** Argument iVal must be greater than or equal to 0, and less than the number\n** of columns in the table affected by the current change. Otherwise,\n** [SQLITE_RANGE] is returned and *ppValue is set to NULL.\n**\n** If successful, this function sets *ppValue to point to a protected\n** sqlite3_value object containing the iVal'th value from the\n** \"conflicting row\" associated with the current conflict-handler callback\n** and returns SQLITE_OK.\n**\n** If some other error occurs (e.g. an OOM condition), an SQLite error code\n** is returned and *ppValue is set to NULL.\n*/\nSQLITE_API int sqlite3changeset_conflict(\n sqlite3_changeset_iter *pIter, /* Changeset iterator */\n int iVal, /* Column number */\n sqlite3_value **ppValue /* OUT: Value from conflicting row */\n);\n\n/*\n** CAPI3REF: Determine The Number Of Foreign Key Constraint Violations\n** METHOD: sqlite3_changeset_iter\n**\n** This function may only be called with an iterator passed to an\n** SQLITE_CHANGESET_FOREIGN_KEY conflict handler callback. In this case\n** it sets the output variable to the total number of known foreign key\n** violations in the destination database and returns SQLITE_OK.\n**\n** In all other cases this function returns SQLITE_MISUSE.\n*/\nSQLITE_API int sqlite3changeset_fk_conflicts(\n sqlite3_changeset_iter *pIter, /* Changeset iterator */\n int *pnOut /* OUT: Number of FK violations */\n);\n\n\n/*\n** CAPI3REF: Finalize A Changeset Iterator\n** METHOD: sqlite3_changeset_iter\n**\n** This function is used to finalize an iterator allocated with\n** [sqlite3changeset_start()].\n**\n** This function should only be called on iterators created using the\n** [sqlite3changeset_start()] function. If an application calls this\n** function with an iterator passed to a conflict-handler by\n** [sqlite3changeset_apply()], [SQLITE_MISUSE] is immediately returned and the\n** call has no effect.\n**\n** If an error was encountered within a call to an sqlite3changeset_xxx()\n** function (for example an [SQLITE_CORRUPT] in [sqlite3changeset_next()] or an\n** [SQLITE_NOMEM] in [sqlite3changeset_new()]) then an error code corresponding\n** to that error is returned by this function. Otherwise, SQLITE_OK is\n** returned. This is to allow the following pattern (pseudo-code):\n**\n** <pre>\n** sqlite3changeset_start();\n** while( SQLITE_ROW==sqlite3changeset_next() ){\n** // Do something with change.\n** }\n** rc = sqlite3changeset_finalize();\n** if( rc!=SQLITE_OK ){\n** // An error has occurred\n** }\n** </pre>\n*/\nSQLITE_API int sqlite3changeset_finalize(sqlite3_changeset_iter *pIter);\n\n/*\n** CAPI3REF: Invert A Changeset\n**\n** This function is used to \"invert\" a changeset object. Applying an inverted\n** changeset to a database reverses the effects of applying the uninverted\n** changeset. Specifically:\n**\n** <ul>\n** <li> Each DELETE change is changed to an INSERT, and\n** <li> Each INSERT change is changed to a DELETE, and\n** <li> For each UPDATE change, the old.* and new.* values are exchanged.\n** </ul>\n**\n** This function does not change the order in which changes appear within\n** the changeset. It merely reverses the sense of each individual change.\n**\n** If successful, a pointer to a buffer containing the inverted changeset\n** is stored in *ppOut, the size of the same buffer is stored in *pnOut, and\n** SQLITE_OK is returned. If an error occurs, both *pnOut and *ppOut are\n** zeroed and an SQLite error code returned.\n**\n** It is the responsibility of the caller to eventually call sqlite3_free()\n** on the *ppOut pointer to free the buffer allocation following a successful\n** call to this function.\n**\n** WARNING/TODO: This function currently assumes that the input is a valid\n** changeset. If it is not, the results are undefined.\n*/\nSQLITE_API int sqlite3changeset_invert(\n int nIn, const void *pIn, /* Input changeset */\n int *pnOut, void **ppOut /* OUT: Inverse of input */\n);\n\n/*\n** CAPI3REF: Concatenate Two Changeset Objects\n**\n** This function is used to concatenate two changesets, A and B, into a\n** single changeset. The result is a changeset equivalent to applying\n** changeset A followed by changeset B.\n**\n** This function combines the two input changesets using an\n** sqlite3_changegroup object. Calling it produces similar results as the\n** following code fragment:\n**\n** <pre>\n** sqlite3_changegroup *pGrp;\n** rc = sqlite3_changegroup_new(&pGrp);\n** if( rc==SQLITE_OK ) rc = sqlite3changegroup_add(pGrp, nA, pA);\n** if( rc==SQLITE_OK ) rc = sqlite3changegroup_add(pGrp, nB, pB);\n** if( rc==SQLITE_OK ){\n** rc = sqlite3changegroup_output(pGrp, pnOut, ppOut);\n** }else{\n** *ppOut = 0;\n** *pnOut = 0;\n** }\n** </pre>\n**\n** Refer to the sqlite3_changegroup documentation below for details.\n*/\nSQLITE_API int sqlite3changeset_concat(\n int nA, /* Number of bytes in buffer pA */\n void *pA, /* Pointer to buffer containing changeset A */\n int nB, /* Number of bytes in buffer pB */\n void *pB, /* Pointer to buffer containing changeset B */\n int *pnOut, /* OUT: Number of bytes in output changeset */\n void **ppOut /* OUT: Buffer containing output changeset */\n);\n\n\n/*\n** CAPI3REF: Upgrade the Schema of a Changeset/Patchset\n*/\nSQLITE_API int sqlite3changeset_upgrade(\n sqlite3 *db,\n const char *zDb,\n int nIn, const void *pIn, /* Input changeset */\n int *pnOut, void **ppOut /* OUT: Inverse of input */\n);\n\n\n\n/*\n** CAPI3REF: Changegroup Handle\n**\n** A changegroup is an object used to combine two or more\n** [changesets] or [patchsets]\n*/\ntypedef struct sqlite3_changegroup sqlite3_changegroup;\n\n/*\n** CAPI3REF: Create A New Changegroup Object\n** CONSTRUCTOR: sqlite3_changegroup\n**\n** An sqlite3_changegroup object is used to combine two or more changesets\n** (or patchsets) into a single changeset (or patchset). A single changegroup\n** object may combine changesets or patchsets, but not both. The output is\n** always in the same format as the input.\n**\n** If successful, this function returns SQLITE_OK and populates (*pp) with\n** a pointer to a new sqlite3_changegroup object before returning. The caller\n** should eventually free the returned object using a call to\n** sqlite3changegroup_delete(). If an error occurs, an SQLite error code\n** (i.e. SQLITE_NOMEM) is returned and *pp is set to NULL.\n**\n** The usual usage pattern for an sqlite3_changegroup object is as follows:\n**\n** <ul>\n** <li> It is created using a call to sqlite3changegroup_new().\n**\n** <li> Zero or more changesets (or patchsets) are added to the object\n** by calling sqlite3changegroup_add().\n**\n** <li> The result of combining all input changesets together is obtained\n** by the application via a call to sqlite3changegroup_output().\n**\n** <li> The object is deleted using a call to sqlite3changegroup_delete().\n** </ul>\n**\n** Any number of calls to add() and output() may be made between the calls to\n** new() and delete(), and in any order.\n**\n** As well as the regular sqlite3changegroup_add() and\n** sqlite3changegroup_output() functions, also available are the streaming\n** versions sqlite3changegroup_add_strm() and sqlite3changegroup_output_strm().\n*/\nSQLITE_API int sqlite3changegroup_new(sqlite3_changegroup **pp);\n\n/*\n** CAPI3REF: Add a Schema to a Changegroup\n** METHOD: sqlite3_changegroup_schema\n**\n** This method may be used to optionally enforce the rule that the changesets\n** added to the changegroup handle must match the schema of database zDb\n** (\"main\", \"temp\", or the name of an attached database). If\n** sqlite3changegroup_add() is called to add a changeset that is not compatible\n** with the configured schema, SQLITE_SCHEMA is returned and the changegroup\n** object is left in an undefined state.\n**\n** A changeset schema is considered compatible with the database schema in\n** the same way as for sqlite3changeset_apply(). Specifically, for each\n** table in the changeset, there exists a database table with:\n**\n** <ul>\n** <li> The name identified by the changeset, and\n** <li> at least as many columns as recorded in the changeset, and\n** <li> the primary key columns in the same position as recorded in\n** the changeset.\n** </ul>\n**\n** The output of the changegroup object always has the same schema as the\n** database nominated using this function. In cases where changesets passed\n** to sqlite3changegroup_add() have fewer columns than the corresponding table\n** in the database schema, these are filled in using the default column\n** values from the database schema. This makes it possible to combined\n** changesets that have different numbers of columns for a single table\n** within a changegroup, provided that they are otherwise compatible.\n*/\nSQLITE_API int sqlite3changegroup_schema(sqlite3_changegroup*, sqlite3*, const char *zDb);\n\n/*\n** CAPI3REF: Add A Changeset To A Changegroup\n** METHOD: sqlite3_changegroup\n**\n** Add all changes within the changeset (or patchset) in buffer pData (size\n** nData bytes) to the changegroup.\n**\n** If the buffer contains a patchset, then all prior calls to this function\n** on the same changegroup object must also have specified patchsets. Or, if\n** the buffer contains a changeset, so must have the earlier calls to this\n** function. Otherwise, SQLITE_ERROR is returned and no changes are added\n** to the changegroup.\n**\n** Rows within the changeset and changegroup are identified by the values in\n** their PRIMARY KEY columns. A change in the changeset is considered to\n** apply to the same row as a change already present in the changegroup if\n** the two rows have the same primary key.\n**\n** Changes to rows that do not already appear in the changegroup are\n** simply copied into it. Or, if both the new changeset and the changegroup\n** contain changes that apply to a single row, the final contents of the\n** changegroup depends on the type of each change, as follows:\n**\n** <table border=1 style=\"margin-left:8ex;margin-right:8ex\">\n** <tr><th style=\"white-space:pre\">Existing Change </th>\n** <th style=\"white-space:pre\">New Change </th>\n** <th>Output Change\n** <tr><td>INSERT <td>INSERT <td>\n** The new change is ignored. This case does not occur if the new\n** changeset was recorded immediately after the changesets already\n** added to the changegroup.\n** <tr><td>INSERT <td>UPDATE <td>\n** The INSERT change remains in the changegroup. The values in the\n** INSERT change are modified as if the row was inserted by the\n** existing change and then updated according to the new change.\n** <tr><td>INSERT <td>DELETE <td>\n** The existing INSERT is removed from the changegroup. The DELETE is\n** not added.\n** <tr><td>UPDATE <td>INSERT <td>\n** The new change is ignored. This case does not occur if the new\n** changeset was recorded immediately after the changesets already\n** added to the changegroup.\n** <tr><td>UPDATE <td>UPDATE <td>\n** The existing UPDATE remains within the changegroup. It is amended\n** so that the accompanying values are as if the row was updated once\n** by the existing change and then again by the new change.\n** <tr><td>UPDATE <td>DELETE <td>\n** The existing UPDATE is replaced by the new DELETE within the\n** changegroup.\n** <tr><td>DELETE <td>INSERT <td>\n** If one or more of the column values in the row inserted by the\n** new change differ from those in the row deleted by the existing\n** change, the existing DELETE is replaced by an UPDATE within the\n** changegroup. Otherwise, if the inserted row is exactly the same\n** as the deleted row, the existing DELETE is simply discarded.\n** <tr><td>DELETE <td>UPDATE <td>\n** The new change is ignored. This case does not occur if the new\n** changeset was recorded immediately after the changesets already\n** added to the changegroup.\n** <tr><td>DELETE <td>DELETE <td>\n** The new change is ignored. This case does not occur if the new\n** changeset was recorded immediately after the changesets already\n** added to the changegroup.\n** </table>\n**\n** If the new changeset contains changes to a table that is already present\n** in the changegroup, then the number of columns and the position of the\n** primary key columns for the table must be consistent. If this is not the\n** case, this function fails with SQLITE_SCHEMA. Except, if the changegroup\n** object has been configured with a database schema using the\n** sqlite3changegroup_schema() API, then it is possible to combine changesets\n** with different numbers of columns for a single table, provided that\n** they are otherwise compatible.\n**\n** If the input changeset appears to be corrupt and the corruption is\n** detected, SQLITE_CORRUPT is returned. Or, if an out-of-memory condition\n** occurs during processing, this function returns SQLITE_NOMEM.\n**\n** In all cases, if an error occurs the state of the final contents of the\n** changegroup is undefined. If no error occurs, SQLITE_OK is returned.\n*/\nSQLITE_API int sqlite3changegroup_add(sqlite3_changegroup*, int nData, void *pData);\n\n/*\n** CAPI3REF: Add A Single Change To A Changegroup\n** METHOD: sqlite3_changegroup\n**\n** This function adds the single change currently indicated by the iterator\n** passed as the second argument to the changegroup object. The rules for\n** adding the change are just as described for [sqlite3changegroup_add()].\n**\n** If the change is successfully added to the changegroup, SQLITE_OK is\n** returned. Otherwise, an SQLite error code is returned.\n**\n** The iterator must point to a valid entry when this function is called.\n** If it does not, SQLITE_ERROR is returned and no change is added to the\n** changegroup. Additionally, the iterator must not have been opened with\n** the SQLITE_CHANGESETAPPLY_INVERT flag. In this case SQLITE_ERROR is also\n** returned.\n*/\nSQLITE_API int sqlite3changegroup_add_change(\n sqlite3_changegroup*,\n sqlite3_changeset_iter*\n);\n\n\n\n/*\n** CAPI3REF: Obtain A Composite Changeset From A Changegroup\n** METHOD: sqlite3_changegroup\n**\n** Obtain a buffer containing a changeset (or patchset) representing the\n** current contents of the changegroup. If the inputs to the changegroup\n** were themselves changesets, the output is a changeset. Or, if the\n** inputs were patchsets, the output is also a patchset.\n**\n** As with the output of the sqlite3session_changeset() and\n** sqlite3session_patchset() functions, all changes related to a single\n** table are grouped together in the output of this function. Tables appear\n** in the same order as for the very first changeset added to the changegroup.\n** If the second or subsequent changesets added to the changegroup contain\n** changes for tables that do not appear in the first changeset, they are\n** appended onto the end of the output changeset, again in the order in\n** which they are first encountered.\n**\n** If an error occurs, an SQLite error code is returned and the output\n** variables (*pnData) and (*ppData) are set to 0. Otherwise, SQLITE_OK\n** is returned and the output variables are set to the size of and a\n** pointer to the output buffer, respectively. In this case it is the\n** responsibility of the caller to eventually free the buffer using a\n** call to sqlite3_free().\n*/\nSQLITE_API int sqlite3changegroup_output(\n sqlite3_changegroup*,\n int *pnData, /* OUT: Size of output buffer in bytes */\n void **ppData /* OUT: Pointer to output buffer */\n);\n\n/*\n** CAPI3REF: Delete A Changegroup Object\n** DESTRUCTOR: sqlite3_changegroup\n*/\nSQLITE_API void sqlite3changegroup_delete(sqlite3_changegroup*);\n\n/*\n** CAPI3REF: Apply A Changeset To A Database\n**\n** Apply a changeset or patchset to a database. These functions attempt to\n** update the \"main\" database attached to handle db with the changes found in\n** the changeset passed via the second and third arguments.\n**\n** The fourth argument (xFilter) passed to these functions is the \"filter\n** callback\". If it is not NULL, then for each table affected by at least one\n** change in the changeset, the filter callback is invoked with\n** the table name as the second argument, and a copy of the context pointer\n** passed as the sixth argument as the first. If the \"filter callback\"\n** returns zero, then no attempt is made to apply any changes to the table.\n** Otherwise, if the return value is non-zero or the xFilter argument to\n** is NULL, all changes related to the table are attempted.\n**\n** For each table that is not excluded by the filter callback, this function\n** tests that the target database contains a compatible table. A table is\n** considered compatible if all of the following are true:\n**\n** <ul>\n** <li> The table has the same name as the name recorded in the\n** changeset, and\n** <li> The table has at least as many columns as recorded in the\n** changeset, and\n** <li> The table has primary key columns in the same position as\n** recorded in the changeset.\n** </ul>\n**\n** If there is no compatible table, it is not an error, but none of the\n** changes associated with the table are applied. A warning message is issued\n** via the sqlite3_log() mechanism with the error code SQLITE_SCHEMA. At most\n** one such warning is issued for each table in the changeset.\n**\n** For each change for which there is a compatible table, an attempt is made\n** to modify the table contents according to the UPDATE, INSERT or DELETE\n** change. If a change cannot be applied cleanly, the conflict handler\n** function passed as the fifth argument to sqlite3changeset_apply() may be\n** invoked. A description of exactly when the conflict handler is invoked for\n** each type of change is below.\n**\n** Unlike the xFilter argument, xConflict may not be passed NULL. The results\n** of passing anything other than a valid function pointer as the xConflict\n** argument are undefined.\n**\n** Each time the conflict handler function is invoked, it must return one\n** of [SQLITE_CHANGESET_OMIT], [SQLITE_CHANGESET_ABORT] or\n** [SQLITE_CHANGESET_REPLACE]. SQLITE_CHANGESET_REPLACE may only be returned\n** if the second argument passed to the conflict handler is either\n** SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If the conflict-handler\n** returns an illegal value, any changes already made are rolled back and\n** the call to sqlite3changeset_apply() returns SQLITE_MISUSE. Different\n** actions are taken by sqlite3changeset_apply() depending on the value\n** returned by each invocation of the conflict-handler function. Refer to\n** the documentation for the three\n** [SQLITE_CHANGESET_OMIT|available return values] for details.\n**\n** <dl>\n** <dt>DELETE Changes<dd>\n** For each DELETE change, the function checks if the target database\n** contains a row with the same primary key value (or values) as the\n** original row values stored in the changeset. If it does, and the values\n** stored in all non-primary key columns also match the values stored in\n** the changeset the row is deleted from the target database.\n**\n** If a row with matching primary key values is found, but one or more of\n** the non-primary key fields contains a value different from the original\n** row value stored in the changeset, the conflict-handler function is\n** invoked with [SQLITE_CHANGESET_DATA] as the second argument. If the\n** database table has more columns than are recorded in the changeset,\n** only the values of those non-primary key fields are compared against\n** the current database contents - any trailing database table columns\n** are ignored.\n**\n** If no row with matching primary key values is found in the database,\n** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND]\n** passed as the second argument.\n**\n** If the DELETE operation is attempted, but SQLite returns SQLITE_CONSTRAINT\n** (which can only happen if a foreign key constraint is violated), the\n** conflict-handler function is invoked with [SQLITE_CHANGESET_CONSTRAINT]\n** passed as the second argument. This includes the case where the DELETE\n** operation is attempted because an earlier call to the conflict handler\n** function returned [SQLITE_CHANGESET_REPLACE].\n**\n** <dt>INSERT Changes<dd>\n** For each INSERT change, an attempt is made to insert the new row into\n** the database. If the changeset row contains fewer fields than the\n** database table, the trailing fields are populated with their default\n** values.\n**\n** If the attempt to insert the row fails because the database already\n** contains a row with the same primary key values, the conflict handler\n** function is invoked with the second argument set to\n** [SQLITE_CHANGESET_CONFLICT].\n**\n** If the attempt to insert the row fails because of some other constraint\n** violation (e.g. NOT NULL or UNIQUE), the conflict handler function is\n** invoked with the second argument set to [SQLITE_CHANGESET_CONSTRAINT].\n** This includes the case where the INSERT operation is re-attempted because\n** an earlier call to the conflict handler function returned\n** [SQLITE_CHANGESET_REPLACE].\n**\n** <dt>UPDATE Changes<dd>\n** For each UPDATE change, the function checks if the target database\n** contains a row with the same primary key value (or values) as the\n** original row values stored in the changeset. If it does, and the values\n** stored in all modified non-primary key columns also match the values\n** stored in the changeset the row is updated within the target database.\n**\n** If a row with matching primary key values is found, but one or more of\n** the modified non-primary key fields contains a value different from an\n** original row value stored in the changeset, the conflict-handler function\n** is invoked with [SQLITE_CHANGESET_DATA] as the second argument. Since\n** UPDATE changes only contain values for non-primary key fields that are\n** to be modified, only those fields need to match the original values to\n** avoid the SQLITE_CHANGESET_DATA conflict-handler callback.\n**\n** If no row with matching primary key values is found in the database,\n** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND]\n** passed as the second argument.\n**\n** If the UPDATE operation is attempted, but SQLite returns\n** SQLITE_CONSTRAINT, the conflict-handler function is invoked with\n** [SQLITE_CHANGESET_CONSTRAINT] passed as the second argument.\n** This includes the case where the UPDATE operation is attempted after\n** an earlier call to the conflict handler function returned\n** [SQLITE_CHANGESET_REPLACE].\n** </dl>\n**\n** It is safe to execute SQL statements, including those that write to the\n** table that the callback related to, from within the xConflict callback.\n** This can be used to further customize the application's conflict\n** resolution strategy.\n**\n** All changes made by these functions are enclosed in a savepoint transaction.\n** If any other error (aside from a constraint failure when attempting to\n** write to the target database) occurs, then the savepoint transaction is\n** rolled back, restoring the target database to its original state, and an\n** SQLite error code returned.\n**\n** If the output parameters (ppRebase) and (pnRebase) are non-NULL and\n** the input is a changeset (not a patchset), then sqlite3changeset_apply_v2()\n** may set (*ppRebase) to point to a \"rebase\" that may be used with the\n** sqlite3_rebaser APIs buffer before returning. In this case (*pnRebase)\n** is set to the size of the buffer in bytes. It is the responsibility of the\n** caller to eventually free any such buffer using sqlite3_free(). The buffer\n** is only allocated and populated if one or more conflicts were encountered\n** while applying the patchset. See comments surrounding the sqlite3_rebaser\n** APIs for further details.\n**\n** The behavior of sqlite3changeset_apply_v2() and its streaming equivalent\n** may be modified by passing a combination of\n** [SQLITE_CHANGESETAPPLY_NOSAVEPOINT | supported flags] as the 9th parameter.\n**\n** Note that the sqlite3changeset_apply_v2() API is still <b>experimental</b>\n** and therefore subject to change.\n*/\nSQLITE_API int sqlite3changeset_apply(\n sqlite3 *db, /* Apply change to \"main\" db of this handle */\n int nChangeset, /* Size of changeset in bytes */\n void *pChangeset, /* Changeset blob */\n int(*xFilter)(\n void *pCtx, /* Copy of sixth arg to _apply() */\n const char *zTab /* Table name */\n ),\n int(*xConflict)(\n void *pCtx, /* Copy of sixth arg to _apply() */\n int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */\n sqlite3_changeset_iter *p /* Handle describing change and conflict */\n ),\n void *pCtx /* First argument passed to xConflict */\n);\nSQLITE_API int sqlite3changeset_apply_v2(\n sqlite3 *db, /* Apply change to \"main\" db of this handle */\n int nChangeset, /* Size of changeset in bytes */\n void *pChangeset, /* Changeset blob */\n int(*xFilter)(\n void *pCtx, /* Copy of sixth arg to _apply() */\n const char *zTab /* Table name */\n ),\n int(*xConflict)(\n void *pCtx, /* Copy of sixth arg to _apply() */\n int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */\n sqlite3_changeset_iter *p /* Handle describing change and conflict */\n ),\n void *pCtx, /* First argument passed to xConflict */\n void **ppRebase, int *pnRebase, /* OUT: Rebase data */\n int flags /* SESSION_CHANGESETAPPLY_* flags */\n);\n\n/*\n** CAPI3REF: Flags for sqlite3changeset_apply_v2\n**\n** The following flags may passed via the 9th parameter to\n** [sqlite3changeset_apply_v2] and [sqlite3changeset_apply_v2_strm]:\n**\n** <dl>\n** <dt>SQLITE_CHANGESETAPPLY_NOSAVEPOINT <dd>\n** Usually, the sessions module encloses all operations performed by\n** a single call to apply_v2() or apply_v2_strm() in a [SAVEPOINT]. The\n** SAVEPOINT is committed if the changeset or patchset is successfully\n** applied, or rolled back if an error occurs. Specifying this flag\n** causes the sessions module to omit this savepoint. In this case, if the\n** caller has an open transaction or savepoint when apply_v2() is called,\n** it may revert the partially applied changeset by rolling it back.\n**\n** <dt>SQLITE_CHANGESETAPPLY_INVERT <dd>\n** Invert the changeset before applying it. This is equivalent to inverting\n** a changeset using sqlite3changeset_invert() before applying it. It is\n** an error to specify this flag with a patchset.\n**\n** <dt>SQLITE_CHANGESETAPPLY_IGNORENOOP <dd>\n** Do not invoke the conflict handler callback for any changes that\n** would not actually modify the database even if they were applied.\n** Specifically, this means that the conflict handler is not invoked\n** for:\n** <ul>\n** <li>a delete change if the row being deleted cannot be found,\n** <li>an update change if the modified fields are already set to\n** their new values in the conflicting row, or\n** <li>an insert change if all fields of the conflicting row match\n** the row being inserted.\n** </ul>\n**\n** <dt>SQLITE_CHANGESETAPPLY_FKNOACTION <dd>\n** If this flag it set, then all foreign key constraints in the target\n** database behave as if they were declared with \"ON UPDATE NO ACTION ON\n** DELETE NO ACTION\", even if they are actually CASCADE, RESTRICT, SET NULL\n** or SET DEFAULT.\n*/\n#define SQLITE_CHANGESETAPPLY_NOSAVEPOINT 0x0001\n#define SQLITE_CHANGESETAPPLY_INVERT 0x0002\n#define SQLITE_CHANGESETAPPLY_IGNORENOOP 0x0004\n#define SQLITE_CHANGESETAPPLY_FKNOACTION 0x0008\n\n/*\n** CAPI3REF: Constants Passed To The Conflict Handler\n**\n** Values that may be passed as the second argument to a conflict-handler.\n**\n** <dl>\n** <dt>SQLITE_CHANGESET_DATA<dd>\n** The conflict handler is invoked with CHANGESET_DATA as the second argument\n** when processing a DELETE or UPDATE change if a row with the required\n** PRIMARY KEY fields is present in the database, but one or more other\n** (non primary-key) fields modified by the update do not contain the\n** expected \"before\" values.\n**\n** The conflicting row, in this case, is the database row with the matching\n** primary key.\n**\n** <dt>SQLITE_CHANGESET_NOTFOUND<dd>\n** The conflict handler is invoked with CHANGESET_NOTFOUND as the second\n** argument when processing a DELETE or UPDATE change if a row with the\n** required PRIMARY KEY fields is not present in the database.\n**\n** There is no conflicting row in this case. The results of invoking the\n** sqlite3changeset_conflict() API are undefined.\n**\n** <dt>SQLITE_CHANGESET_CONFLICT<dd>\n** CHANGESET_CONFLICT is passed as the second argument to the conflict\n** handler while processing an INSERT change if the operation would result\n** in duplicate primary key values.\n**\n** The conflicting row in this case is the database row with the matching\n** primary key.\n**\n** <dt>SQLITE_CHANGESET_FOREIGN_KEY<dd>\n** If foreign key handling is enabled, and applying a changeset leaves the\n** database in a state containing foreign key violations, the conflict\n** handler is invoked with CHANGESET_FOREIGN_KEY as the second argument\n** exactly once before the changeset is committed. If the conflict handler\n** returns CHANGESET_OMIT, the changes, including those that caused the\n** foreign key constraint violation, are committed. Or, if it returns\n** CHANGESET_ABORT, the changeset is rolled back.\n**\n** No current or conflicting row information is provided. The only function\n** it is possible to call on the supplied sqlite3_changeset_iter handle\n** is sqlite3changeset_fk_conflicts().\n**\n** <dt>SQLITE_CHANGESET_CONSTRAINT<dd>\n** If any other constraint violation occurs while applying a change (i.e.\n** a UNIQUE, CHECK or NOT NULL constraint), the conflict handler is\n** invoked with CHANGESET_CONSTRAINT as the second argument.\n**\n** There is no conflicting row in this case. The results of invoking the\n** sqlite3changeset_conflict() API are undefined.\n**\n** </dl>\n*/\n#define SQLITE_CHANGESET_DATA 1\n#define SQLITE_CHANGESET_NOTFOUND 2\n#define SQLITE_CHANGESET_CONFLICT 3\n#define SQLITE_CHANGESET_CONSTRAINT 4\n#define SQLITE_CHANGESET_FOREIGN_KEY 5\n\n/*\n** CAPI3REF: Constants Returned By The Conflict Handler\n**\n** A conflict handler callback must return one of the following three values.\n**\n** <dl>\n** <dt>SQLITE_CHANGESET_OMIT<dd>\n** If a conflict handler returns this value no special action is taken. The\n** change that caused the conflict is not applied. The session module\n** continues to the next change in the changeset.\n**\n** <dt>SQLITE_CHANGESET_REPLACE<dd>\n** This value may only be returned if the second argument to the conflict\n** handler was SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If this\n** is not the case, any changes applied so far are rolled back and the\n** call to sqlite3changeset_apply() returns SQLITE_MISUSE.\n**\n** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_DATA conflict\n** handler, then the conflicting row is either updated or deleted, depending\n** on the type of change.\n**\n** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_CONFLICT conflict\n** handler, then the conflicting row is removed from the database and a\n** second attempt to apply the change is made. If this second attempt fails,\n** the original row is restored to the database before continuing.\n**\n** <dt>SQLITE_CHANGESET_ABORT<dd>\n** If this value is returned, any changes applied so far are rolled back\n** and the call to sqlite3changeset_apply() returns SQLITE_ABORT.\n** </dl>\n*/\n#define SQLITE_CHANGESET_OMIT 0\n#define SQLITE_CHANGESET_REPLACE 1\n#define SQLITE_CHANGESET_ABORT 2\n\n/*\n** CAPI3REF: Rebasing changesets\n** EXPERIMENTAL\n**\n** Suppose there is a site hosting a database in state S0. And that\n** modifications are made that move that database to state S1 and a\n** changeset recorded (the \"local\" changeset). Then, a changeset based\n** on S0 is received from another site (the \"remote\" changeset) and\n** applied to the database. The database is then in state\n** (S1+\"remote\"), where the exact state depends on any conflict\n** resolution decisions (OMIT or REPLACE) made while applying \"remote\".\n** Rebasing a changeset is to update it to take those conflict\n** resolution decisions into account, so that the same conflicts\n** do not have to be resolved elsewhere in the network.\n**\n** For example, if both the local and remote changesets contain an\n** INSERT of the same key on \"CREATE TABLE t1(a PRIMARY KEY, b)\":\n**\n** local: INSERT INTO t1 VALUES(1, 'v1');\n** remote: INSERT INTO t1 VALUES(1, 'v2');\n**\n** and the conflict resolution is REPLACE, then the INSERT change is\n** removed from the local changeset (it was overridden). Or, if the\n** conflict resolution was \"OMIT\", then the local changeset is modified\n** to instead contain:\n**\n** UPDATE t1 SET b = 'v2' WHERE a=1;\n**\n** Changes within the local changeset are rebased as follows:\n**\n** <dl>\n** <dt>Local INSERT<dd>\n** This may only conflict with a remote INSERT. If the conflict\n** resolution was OMIT, then add an UPDATE change to the rebased\n** changeset. Or, if the conflict resolution was REPLACE, add\n** nothing to the rebased changeset.\n**\n** <dt>Local DELETE<dd>\n** This may conflict with a remote UPDATE or DELETE. In both cases the\n** only possible resolution is OMIT. If the remote operation was a\n** DELETE, then add no change to the rebased changeset. If the remote\n** operation was an UPDATE, then the old.* fields of change are updated\n** to reflect the new.* values in the UPDATE.\n**\n** <dt>Local UPDATE<dd>\n** This may conflict with a remote UPDATE or DELETE. If it conflicts\n** with a DELETE, and the conflict resolution was OMIT, then the update\n** is changed into an INSERT. Any undefined values in the new.* record\n** from the update change are filled in using the old.* values from\n** the conflicting DELETE. Or, if the conflict resolution was REPLACE,\n** the UPDATE change is simply omitted from the rebased changeset.\n**\n** If conflict is with a remote UPDATE and the resolution is OMIT, then\n** the old.* values are rebased using the new.* values in the remote\n** change. Or, if the resolution is REPLACE, then the change is copied\n** into the rebased changeset with updates to columns also updated by\n** the conflicting remote UPDATE removed. If this means no columns would\n** be updated, the change is omitted.\n** </dl>\n**\n** A local change may be rebased against multiple remote changes\n** simultaneously. If a single key is modified by multiple remote\n** changesets, they are combined as follows before the local changeset\n** is rebased:\n**\n** <ul>\n** <li> If there has been one or more REPLACE resolutions on a\n** key, it is rebased according to a REPLACE.\n**\n** <li> If there have been no REPLACE resolutions on a key, then\n** the local changeset is rebased according to the most recent\n** of the OMIT resolutions.\n** </ul>\n**\n** Note that conflict resolutions from multiple remote changesets are\n** combined on a per-field basis, not per-row. This means that in the\n** case of multiple remote UPDATE operations, some fields of a single\n** local change may be rebased for REPLACE while others are rebased for\n** OMIT.\n**\n** In order to rebase a local changeset, the remote changeset must first\n** be applied to the local database using sqlite3changeset_apply_v2() and\n** the buffer of rebase information captured. Then:\n**\n** <ol>\n** <li> An sqlite3_rebaser object is created by calling\n** sqlite3rebaser_create().\n** <li> The new object is configured with the rebase buffer obtained from\n** sqlite3changeset_apply_v2() by calling sqlite3rebaser_configure().\n** If the local changeset is to be rebased against multiple remote\n** changesets, then sqlite3rebaser_configure() should be called\n** multiple times, in the same order that the multiple\n** sqlite3changeset_apply_v2() calls were made.\n** <li> Each local changeset is rebased by calling sqlite3rebaser_rebase().\n** <li> The sqlite3_rebaser object is deleted by calling\n** sqlite3rebaser_delete().\n** </ol>\n*/\ntypedef struct sqlite3_rebaser sqlite3_rebaser;\n\n/*\n** CAPI3REF: Create a changeset rebaser object.\n** EXPERIMENTAL\n**\n** Allocate a new changeset rebaser object. If successful, set (*ppNew) to\n** point to the new object and return SQLITE_OK. Otherwise, if an error\n** occurs, return an SQLite error code (e.g. SQLITE_NOMEM) and set (*ppNew)\n** to NULL.\n*/\nSQLITE_API int sqlite3rebaser_create(sqlite3_rebaser **ppNew);\n\n/*\n** CAPI3REF: Configure a changeset rebaser object.\n** EXPERIMENTAL\n**\n** Configure the changeset rebaser object to rebase changesets according\n** to the conflict resolutions described by buffer pRebase (size nRebase\n** bytes), which must have been obtained from a previous call to\n** sqlite3changeset_apply_v2().\n*/\nSQLITE_API int sqlite3rebaser_configure(\n sqlite3_rebaser*,\n int nRebase, const void *pRebase\n);\n\n/*\n** CAPI3REF: Rebase a changeset\n** EXPERIMENTAL\n**\n** Argument pIn must point to a buffer containing a changeset nIn bytes\n** in size. This function allocates and populates a buffer with a copy\n** of the changeset rebased according to the configuration of the\n** rebaser object passed as the first argument. If successful, (*ppOut)\n** is set to point to the new buffer containing the rebased changeset and\n** (*pnOut) to its size in bytes and SQLITE_OK returned. It is the\n** responsibility of the caller to eventually free the new buffer using\n** sqlite3_free(). Otherwise, if an error occurs, (*ppOut) and (*pnOut)\n** are set to zero and an SQLite error code returned.\n*/\nSQLITE_API int sqlite3rebaser_rebase(\n sqlite3_rebaser*,\n int nIn, const void *pIn,\n int *pnOut, void **ppOut\n);\n\n/*\n** CAPI3REF: Delete a changeset rebaser object.\n** EXPERIMENTAL\n**\n** Delete the changeset rebaser object and all associated resources. There\n** should be one call to this function for each successful invocation\n** of sqlite3rebaser_create().\n*/\nSQLITE_API void sqlite3rebaser_delete(sqlite3_rebaser *p);\n\n/*\n** CAPI3REF: Streaming Versions of API functions.\n**\n** The six streaming API xxx_strm() functions serve similar purposes to the\n** corresponding non-streaming API functions:\n**\n** <table border=1 style=\"margin-left:8ex;margin-right:8ex\">\n** <tr><th>Streaming function<th>Non-streaming equivalent</th>\n** <tr><td>sqlite3changeset_apply_strm<td>[sqlite3changeset_apply]\n** <tr><td>sqlite3changeset_apply_strm_v2<td>[sqlite3changeset_apply_v2]\n** <tr><td>sqlite3changeset_concat_strm<td>[sqlite3changeset_concat]\n** <tr><td>sqlite3changeset_invert_strm<td>[sqlite3changeset_invert]\n** <tr><td>sqlite3changeset_start_strm<td>[sqlite3changeset_start]\n** <tr><td>sqlite3session_changeset_strm<td>[sqlite3session_changeset]\n** <tr><td>sqlite3session_patchset_strm<td>[sqlite3session_patchset]\n** </table>\n**\n** Non-streaming functions that accept changesets (or patchsets) as input\n** require that the entire changeset be stored in a single buffer in memory.\n** Similarly, those that return a changeset or patchset do so by returning\n** a pointer to a single large buffer allocated using sqlite3_malloc().\n** Normally this is convenient. However, if an application running in a\n** low-memory environment is required to handle very large changesets, the\n** large contiguous memory allocations required can become onerous.\n**\n** In order to avoid this problem, instead of a single large buffer, input\n** is passed to a streaming API functions by way of a callback function that\n** the sessions module invokes to incrementally request input data as it is\n** required. In all cases, a pair of API function parameters such as\n**\n** <pre>\n** int nChangeset,\n** void *pChangeset,\n** </pre>\n**\n** Is replaced by:\n**\n** <pre>\n** int (*xInput)(void *pIn, void *pData, int *pnData),\n** void *pIn,\n** </pre>\n**\n** Each time the xInput callback is invoked by the sessions module, the first\n** argument passed is a copy of the supplied pIn context pointer. The second\n** argument, pData, points to a buffer (*pnData) bytes in size. Assuming no\n** error occurs the xInput method should copy up to (*pnData) bytes of data\n** into the buffer and set (*pnData) to the actual number of bytes copied\n** before returning SQLITE_OK. If the input is completely exhausted, (*pnData)\n** should be set to zero to indicate this. Or, if an error occurs, an SQLite\n** error code should be returned. In all cases, if an xInput callback returns\n** an error, all processing is abandoned and the streaming API function\n** returns a copy of the error code to the caller.\n**\n** In the case of sqlite3changeset_start_strm(), the xInput callback may be\n** invoked by the sessions module at any point during the lifetime of the\n** iterator. If such an xInput callback returns an error, the iterator enters\n** an error state, whereby all subsequent calls to iterator functions\n** immediately fail with the same error code as returned by xInput.\n**\n** Similarly, streaming API functions that return changesets (or patchsets)\n** return them in chunks by way of a callback function instead of via a\n** pointer to a single large buffer. In this case, a pair of parameters such\n** as:\n**\n** <pre>\n** int *pnChangeset,\n** void **ppChangeset,\n** </pre>\n**\n** Is replaced by:\n**\n** <pre>\n** int (*xOutput)(void *pOut, const void *pData, int nData),\n** void *pOut\n** </pre>\n**\n** The xOutput callback is invoked zero or more times to return data to\n** the application. The first parameter passed to each call is a copy of the\n** pOut pointer supplied by the application. The second parameter, pData,\n** points to a buffer nData bytes in size containing the chunk of output\n** data being returned. If the xOutput callback successfully processes the\n** supplied data, it should return SQLITE_OK to indicate success. Otherwise,\n** it should return some other SQLite error code. In this case processing\n** is immediately abandoned and the streaming API function returns a copy\n** of the xOutput error code to the application.\n**\n** The sessions module never invokes an xOutput callback with the third\n** parameter set to a value less than or equal to zero. Other than this,\n** no guarantees are made as to the size of the chunks of data returned.\n*/\nSQLITE_API int sqlite3changeset_apply_strm(\n sqlite3 *db, /* Apply change to \"main\" db of this handle */\n int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */\n void *pIn, /* First arg for xInput */\n int(*xFilter)(\n void *pCtx, /* Copy of sixth arg to _apply() */\n const char *zTab /* Table name */\n ),\n int(*xConflict)(\n void *pCtx, /* Copy of sixth arg to _apply() */\n int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */\n sqlite3_changeset_iter *p /* Handle describing change and conflict */\n ),\n void *pCtx /* First argument passed to xConflict */\n);\nSQLITE_API int sqlite3changeset_apply_v2_strm(\n sqlite3 *db, /* Apply change to \"main\" db of this handle */\n int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */\n void *pIn, /* First arg for xInput */\n int(*xFilter)(\n void *pCtx, /* Copy of sixth arg to _apply() */\n const char *zTab /* Table name */\n ),\n int(*xConflict)(\n void *pCtx, /* Copy of sixth arg to _apply() */\n int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */\n sqlite3_changeset_iter *p /* Handle describing change and conflict */\n ),\n void *pCtx, /* First argument passed to xConflict */\n void **ppRebase, int *pnRebase,\n int flags\n);\nSQLITE_API int sqlite3changeset_concat_strm(\n int (*xInputA)(void *pIn, void *pData, int *pnData),\n void *pInA,\n int (*xInputB)(void *pIn, void *pData, int *pnData),\n void *pInB,\n int (*xOutput)(void *pOut, const void *pData, int nData),\n void *pOut\n);\nSQLITE_API int sqlite3changeset_invert_strm(\n int (*xInput)(void *pIn, void *pData, int *pnData),\n void *pIn,\n int (*xOutput)(void *pOut, const void *pData, int nData),\n void *pOut\n);\nSQLITE_API int sqlite3changeset_start_strm(\n sqlite3_changeset_iter **pp,\n int (*xInput)(void *pIn, void *pData, int *pnData),\n void *pIn\n);\nSQLITE_API int sqlite3changeset_start_v2_strm(\n sqlite3_changeset_iter **pp,\n int (*xInput)(void *pIn, void *pData, int *pnData),\n void *pIn,\n int flags\n);\nSQLITE_API int sqlite3session_changeset_strm(\n sqlite3_session *pSession,\n int (*xOutput)(void *pOut, const void *pData, int nData),\n void *pOut\n);\nSQLITE_API int sqlite3session_patchset_strm(\n sqlite3_session *pSession,\n int (*xOutput)(void *pOut, const void *pData, int nData),\n void *pOut\n);\nSQLITE_API int sqlite3changegroup_add_strm(sqlite3_changegroup*,\n int (*xInput)(void *pIn, void *pData, int *pnData),\n void *pIn\n);\nSQLITE_API int sqlite3changegroup_output_strm(sqlite3_changegroup*,\n int (*xOutput)(void *pOut, const void *pData, int nData),\n void *pOut\n);\nSQLITE_API int sqlite3rebaser_rebase_strm(\n sqlite3_rebaser *pRebaser,\n int (*xInput)(void *pIn, void *pData, int *pnData),\n void *pIn,\n int (*xOutput)(void *pOut, const void *pData, int nData),\n void *pOut\n);\n\n/*\n** CAPI3REF: Configure global parameters\n**\n** The sqlite3session_config() interface is used to make global configuration\n** changes to the sessions module in order to tune it to the specific needs\n** of the application.\n**\n** The sqlite3session_config() interface is not threadsafe. If it is invoked\n** while any other thread is inside any other sessions method then the\n** results are undefined. Furthermore, if it is invoked after any sessions\n** related objects have been created, the results are also undefined.\n**\n** The first argument to the sqlite3session_config() function must be one\n** of the SQLITE_SESSION_CONFIG_XXX constants defined below. The\n** interpretation of the (void*) value passed as the second parameter and\n** the effect of calling this function depends on the value of the first\n** parameter.\n**\n** <dl>\n** <dt>SQLITE_SESSION_CONFIG_STRMSIZE<dd>\n** By default, the sessions module streaming interfaces attempt to input\n** and output data in approximately 1 KiB chunks. This operand may be used\n** to set and query the value of this configuration setting. The pointer\n** passed as the second argument must point to a value of type (int).\n** If this value is greater than 0, it is used as the new streaming data\n** chunk size for both input and output. Before returning, the (int) value\n** pointed to by pArg is set to the final value of the streaming interface\n** chunk size.\n** </dl>\n**\n** This function returns SQLITE_OK if successful, or an SQLite error code\n** otherwise.\n*/\nSQLITE_API int sqlite3session_config(int op, void *pArg);\n\n/*\n** CAPI3REF: Values for sqlite3session_config().\n*/\n#define SQLITE_SESSION_CONFIG_STRMSIZE 1\n\n/*\n** Make sure we can call this stuff from C++.\n*/\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION) */\n\n/******** End of sqlite3session.h *********/\n/******** Begin file fts5.h *********/\n/*\n** 2014 May 31\n**\n** The author disclaims copyright to this source code. In place of\n** a legal notice, here is a blessing:\n**\n** May you do good and not evil.\n** May you find forgiveness for yourself and forgive others.\n** May you share freely, never taking more than you give.\n**\n******************************************************************************\n**\n** Interfaces to extend FTS5. Using the interfaces defined in this file,\n** FTS5 may be extended with:\n**\n** * custom tokenizers, and\n** * custom auxiliary functions.\n*/\n\n\n#ifndef _FTS5_H\n#define _FTS5_H\n\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/*************************************************************************\n** CUSTOM AUXILIARY FUNCTIONS\n**\n** Virtual table implementations may overload SQL functions by implementing\n** the sqlite3_module.xFindFunction() method.\n*/\n\ntypedef struct Fts5ExtensionApi Fts5ExtensionApi;\ntypedef struct Fts5Context Fts5Context;\ntypedef struct Fts5PhraseIter Fts5PhraseIter;\n\ntypedef void (*fts5_extension_function)(\n const Fts5ExtensionApi *pApi, /* API offered by current FTS version */\n Fts5Context *pFts, /* First arg to pass to pApi functions */\n sqlite3_context *pCtx, /* Context for returning result/error */\n int nVal, /* Number of values in apVal[] array */\n sqlite3_value **apVal /* Array of trailing arguments */\n);\n\nstruct Fts5PhraseIter {\n const unsigned char *a;\n const unsigned char *b;\n};\n\n/*\n** EXTENSION API FUNCTIONS\n**\n** xUserData(pFts):\n** Return a copy of the pUserData pointer passed to the xCreateFunction()\n** API when the extension function was registered.\n**\n** xColumnTotalSize(pFts, iCol, pnToken):\n** If parameter iCol is less than zero, set output variable *pnToken\n** to the total number of tokens in the FTS5 table. Or, if iCol is\n** non-negative but less than the number of columns in the table, return\n** the total number of tokens in column iCol, considering all rows in\n** the FTS5 table.\n**\n** If parameter iCol is greater than or equal to the number of columns\n** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g.\n** an OOM condition or IO error), an appropriate SQLite error code is\n** returned.\n**\n** xColumnCount(pFts):\n** Return the number of columns in the table.\n**\n** xColumnSize(pFts, iCol, pnToken):\n** If parameter iCol is less than zero, set output variable *pnToken\n** to the total number of tokens in the current row. Or, if iCol is\n** non-negative but less than the number of columns in the table, set\n** *pnToken to the number of tokens in column iCol of the current row.\n**\n** If parameter iCol is greater than or equal to the number of columns\n** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g.\n** an OOM condition or IO error), an appropriate SQLite error code is\n** returned.\n**\n** This function may be quite inefficient if used with an FTS5 table\n** created with the \"columnsize=0\" option.\n**\n** xColumnText:\n** If parameter iCol is less than zero, or greater than or equal to the\n** number of columns in the table, SQLITE_RANGE is returned.\n**\n** Otherwise, this function attempts to retrieve the text of column iCol of\n** the current document. If successful, (*pz) is set to point to a buffer\n** containing the text in utf-8 encoding, (*pn) is set to the size in bytes\n** (not characters) of the buffer and SQLITE_OK is returned. Otherwise,\n** if an error occurs, an SQLite error code is returned and the final values\n** of (*pz) and (*pn) are undefined.\n**\n** xPhraseCount:\n** Returns the number of phrases in the current query expression.\n**\n** xPhraseSize:\n** If parameter iCol is less than zero, or greater than or equal to the\n** number of phrases in the current query, as returned by xPhraseCount,\n** 0 is returned. Otherwise, this function returns the number of tokens in\n** phrase iPhrase of the query. Phrases are numbered starting from zero.\n**\n** xInstCount:\n** Set *pnInst to the total number of occurrences of all phrases within\n** the query within the current row. Return SQLITE_OK if successful, or\n** an error code (i.e. SQLITE_NOMEM) if an error occurs.\n**\n** This API can be quite slow if used with an FTS5 table created with the\n** \"detail=none\" or \"detail=column\" option. If the FTS5 table is created\n** with either \"detail=none\" or \"detail=column\" and \"content=\" option\n** (i.e. if it is a contentless table), then this API always returns 0.\n**\n** xInst:\n** Query for the details of phrase match iIdx within the current row.\n** Phrase matches are numbered starting from zero, so the iIdx argument\n** should be greater than or equal to zero and smaller than the value\n** output by xInstCount(). If iIdx is less than zero or greater than\n** or equal to the value returned by xInstCount(), SQLITE_RANGE is returned.\n**\n** Otherwise, output parameter *piPhrase is set to the phrase number, *piCol\n** to the column in which it occurs and *piOff the token offset of the\n** first token of the phrase. SQLITE_OK is returned if successful, or an\n** error code (i.e. SQLITE_NOMEM) if an error occurs.\n**\n** This API can be quite slow if used with an FTS5 table created with the\n** \"detail=none\" or \"detail=column\" option.\n**\n** xRowid:\n** Returns the rowid of the current row.\n**\n** xTokenize:\n** Tokenize text using the tokenizer belonging to the FTS5 table.\n**\n** xQueryPhrase(pFts5, iPhrase, pUserData, xCallback):\n** This API function is used to query the FTS table for phrase iPhrase\n** of the current query. Specifically, a query equivalent to:\n**\n** ... FROM ftstable WHERE ftstable MATCH $p ORDER BY rowid\n**\n** with $p set to a phrase equivalent to the phrase iPhrase of the\n** current query is executed. Any column filter that applies to\n** phrase iPhrase of the current query is included in $p. For each\n** row visited, the callback function passed as the fourth argument\n** is invoked. The context and API objects passed to the callback\n** function may be used to access the properties of each matched row.\n** Invoking Api.xUserData() returns a copy of the pointer passed as\n** the third argument to pUserData.\n**\n** If parameter iPhrase is less than zero, or greater than or equal to\n** the number of phrases in the query, as returned by xPhraseCount(),\n** this function returns SQLITE_RANGE.\n**\n** If the callback function returns any value other than SQLITE_OK, the\n** query is abandoned and the xQueryPhrase function returns immediately.\n** If the returned value is SQLITE_DONE, xQueryPhrase returns SQLITE_OK.\n** Otherwise, the error code is propagated upwards.\n**\n** If the query runs to completion without incident, SQLITE_OK is returned.\n** Or, if some error occurs before the query completes or is aborted by\n** the callback, an SQLite error code is returned.\n**\n**\n** xSetAuxdata(pFts5, pAux, xDelete)\n**\n** Save the pointer passed as the second argument as the extension function's\n** \"auxiliary data\". The pointer may then be retrieved by the current or any\n** future invocation of the same fts5 extension function made as part of\n** the same MATCH query using the xGetAuxdata() API.\n**\n** Each extension function is allocated a single auxiliary data slot for\n** each FTS query (MATCH expression). If the extension function is invoked\n** more than once for a single FTS query, then all invocations share a\n** single auxiliary data context.\n**\n** If there is already an auxiliary data pointer when this function is\n** invoked, then it is replaced by the new pointer. If an xDelete callback\n** was specified along with the original pointer, it is invoked at this\n** point.\n**\n** The xDelete callback, if one is specified, is also invoked on the\n** auxiliary data pointer after the FTS5 query has finished.\n**\n** If an error (e.g. an OOM condition) occurs within this function,\n** the auxiliary data is set to NULL and an error code returned. If the\n** xDelete parameter was not NULL, it is invoked on the auxiliary data\n** pointer before returning.\n**\n**\n** xGetAuxdata(pFts5, bClear)\n**\n** Returns the current auxiliary data pointer for the fts5 extension\n** function. See the xSetAuxdata() method for details.\n**\n** If the bClear argument is non-zero, then the auxiliary data is cleared\n** (set to NULL) before this function returns. In this case the xDelete,\n** if any, is not invoked.\n**\n**\n** xRowCount(pFts5, pnRow)\n**\n** This function is used to retrieve the total number of rows in the table.\n** In other words, the same value that would be returned by:\n**\n** SELECT count(*) FROM ftstable;\n**\n** xPhraseFirst()\n** This function is used, along with type Fts5PhraseIter and the xPhraseNext\n** method, to iterate through all instances of a single query phrase within\n** the current row. This is the same information as is accessible via the\n** xInstCount/xInst APIs. While the xInstCount/xInst APIs are more convenient\n** to use, this API may be faster under some circumstances. To iterate\n** through instances of phrase iPhrase, use the following code:\n**\n** Fts5PhraseIter iter;\n** int iCol, iOff;\n** for(pApi->xPhraseFirst(pFts, iPhrase, &iter, &iCol, &iOff);\n** iCol>=0;\n** pApi->xPhraseNext(pFts, &iter, &iCol, &iOff)\n** ){\n** // An instance of phrase iPhrase at offset iOff of column iCol\n** }\n**\n** The Fts5PhraseIter structure is defined above. Applications should not\n** modify this structure directly - it should only be used as shown above\n** with the xPhraseFirst() and xPhraseNext() API methods (and by\n** xPhraseFirstColumn() and xPhraseNextColumn() as illustrated below).\n**\n** This API can be quite slow if used with an FTS5 table created with the\n** \"detail=none\" or \"detail=column\" option. If the FTS5 table is created\n** with either \"detail=none\" or \"detail=column\" and \"content=\" option\n** (i.e. if it is a contentless table), then this API always iterates\n** through an empty set (all calls to xPhraseFirst() set iCol to -1).\n**\n** In all cases, matches are visited in (column ASC, offset ASC) order.\n** i.e. all those in column 0, sorted by offset, followed by those in\n** column 1, etc.\n**\n** xPhraseNext()\n** See xPhraseFirst above.\n**\n** xPhraseFirstColumn()\n** This function and xPhraseNextColumn() are similar to the xPhraseFirst()\n** and xPhraseNext() APIs described above. The difference is that instead\n** of iterating through all instances of a phrase in the current row, these\n** APIs are used to iterate through the set of columns in the current row\n** that contain one or more instances of a specified phrase. For example:\n**\n** Fts5PhraseIter iter;\n** int iCol;\n** for(pApi->xPhraseFirstColumn(pFts, iPhrase, &iter, &iCol);\n** iCol>=0;\n** pApi->xPhraseNextColumn(pFts, &iter, &iCol)\n** ){\n** // Column iCol contains at least one instance of phrase iPhrase\n** }\n**\n** This API can be quite slow if used with an FTS5 table created with the\n** \"detail=none\" option. If the FTS5 table is created with either\n** \"detail=none\" \"content=\" option (i.e. if it is a contentless table),\n** then this API always iterates through an empty set (all calls to\n** xPhraseFirstColumn() set iCol to -1).\n**\n** The information accessed using this API and its companion\n** xPhraseFirstColumn() may also be obtained using xPhraseFirst/xPhraseNext\n** (or xInst/xInstCount). The chief advantage of this API is that it is\n** significantly more efficient than those alternatives when used with\n** \"detail=column\" tables.\n**\n** xPhraseNextColumn()\n** See xPhraseFirstColumn above.\n**\n** xQueryToken(pFts5, iPhrase, iToken, ppToken, pnToken)\n** This is used to access token iToken of phrase iPhrase of the current\n** query. Before returning, output parameter *ppToken is set to point\n** to a buffer containing the requested token, and *pnToken to the\n** size of this buffer in bytes.\n**\n** If iPhrase or iToken are less than zero, or if iPhrase is greater than\n** or equal to the number of phrases in the query as reported by\n** xPhraseCount(), or if iToken is equal to or greater than the number of\n** tokens in the phrase, SQLITE_RANGE is returned and *ppToken and *pnToken\n are both zeroed.\n**\n** The output text is not a copy of the query text that specified the\n** token. It is the output of the tokenizer module. For tokendata=1\n** tables, this includes any embedded 0x00 and trailing data.\n**\n** xInstToken(pFts5, iIdx, iToken, ppToken, pnToken)\n** This is used to access token iToken of phrase hit iIdx within the\n** current row. If iIdx is less than zero or greater than or equal to the\n** value returned by xInstCount(), SQLITE_RANGE is returned. Otherwise,\n** output variable (*ppToken) is set to point to a buffer containing the\n** matching document token, and (*pnToken) to the size of that buffer in\n** bytes.\n**\n** The output text is not a copy of the document text that was tokenized.\n** It is the output of the tokenizer module. For tokendata=1 tables, this\n** includes any embedded 0x00 and trailing data.\n**\n** This API may be slow in some cases if the token identified by parameters\n** iIdx and iToken matched a prefix token in the query. In most cases, the\n** first call to this API for each prefix token in the query is forced\n** to scan the portion of the full-text index that matches the prefix\n** token to collect the extra data required by this API. If the prefix\n** token matches a large number of token instances in the document set,\n** this may be a performance problem.\n**\n** If the user knows in advance that a query may use this API for a\n** prefix token, FTS5 may be configured to collect all required data as part\n** of the initial querying of the full-text index, avoiding the second scan\n** entirely. This also causes prefix queries that do not use this API to\n** run more slowly and use more memory. FTS5 may be configured in this way\n** either on a per-table basis using the [FTS5 insttoken | 'insttoken']\n** option, or on a per-query basis using the\n** [fts5_insttoken | fts5_insttoken()] user function.\n**\n** This API can be quite slow if used with an FTS5 table created with the\n** \"detail=none\" or \"detail=column\" option.\n**\n** xColumnLocale(pFts5, iIdx, pzLocale, pnLocale)\n** If parameter iCol is less than zero, or greater than or equal to the\n** number of columns in the table, SQLITE_RANGE is returned.\n**\n** Otherwise, this function attempts to retrieve the locale associated\n** with column iCol of the current row. Usually, there is no associated\n** locale, and output parameters (*pzLocale) and (*pnLocale) are set\n** to NULL and 0, respectively. However, if the fts5_locale() function\n** was used to associate a locale with the value when it was inserted\n** into the fts5 table, then (*pzLocale) is set to point to a nul-terminated\n** buffer containing the name of the locale in utf-8 encoding. (*pnLocale)\n** is set to the size in bytes of the buffer, not including the\n** nul-terminator.\n**\n** If successful, SQLITE_OK is returned. Or, if an error occurs, an\n** SQLite error code is returned. The final value of the output parameters\n** is undefined in this case.\n**\n** xTokenize_v2:\n** Tokenize text using the tokenizer belonging to the FTS5 table. This\n** API is the same as the xTokenize() API, except that it allows a tokenizer\n** locale to be specified.\n*/\nstruct Fts5ExtensionApi {\n int iVersion; /* Currently always set to 4 */\n\n void *(*xUserData)(Fts5Context*);\n\n int (*xColumnCount)(Fts5Context*);\n int (*xRowCount)(Fts5Context*, sqlite3_int64 *pnRow);\n int (*xColumnTotalSize)(Fts5Context*, int iCol, sqlite3_int64 *pnToken);\n\n int (*xTokenize)(Fts5Context*,\n const char *pText, int nText, /* Text to tokenize */\n void *pCtx, /* Context passed to xToken() */\n int (*xToken)(void*, int, const char*, int, int, int) /* Callback */\n );\n\n int (*xPhraseCount)(Fts5Context*);\n int (*xPhraseSize)(Fts5Context*, int iPhrase);\n\n int (*xInstCount)(Fts5Context*, int *pnInst);\n int (*xInst)(Fts5Context*, int iIdx, int *piPhrase, int *piCol, int *piOff);\n\n sqlite3_int64 (*xRowid)(Fts5Context*);\n int (*xColumnText)(Fts5Context*, int iCol, const char **pz, int *pn);\n int (*xColumnSize)(Fts5Context*, int iCol, int *pnToken);\n\n int (*xQueryPhrase)(Fts5Context*, int iPhrase, void *pUserData,\n int(*)(const Fts5ExtensionApi*,Fts5Context*,void*)\n );\n int (*xSetAuxdata)(Fts5Context*, void *pAux, void(*xDelete)(void*));\n void *(*xGetAuxdata)(Fts5Context*, int bClear);\n\n int (*xPhraseFirst)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*, int*);\n void (*xPhraseNext)(Fts5Context*, Fts5PhraseIter*, int *piCol, int *piOff);\n\n int (*xPhraseFirstColumn)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*);\n void (*xPhraseNextColumn)(Fts5Context*, Fts5PhraseIter*, int *piCol);\n\n /* Below this point are iVersion>=3 only */\n int (*xQueryToken)(Fts5Context*,\n int iPhrase, int iToken,\n const char **ppToken, int *pnToken\n );\n int (*xInstToken)(Fts5Context*, int iIdx, int iToken, const char**, int*);\n\n /* Below this point are iVersion>=4 only */\n int (*xColumnLocale)(Fts5Context*, int iCol, const char **pz, int *pn);\n int (*xTokenize_v2)(Fts5Context*,\n const char *pText, int nText, /* Text to tokenize */\n const char *pLocale, int nLocale, /* Locale to pass to tokenizer */\n void *pCtx, /* Context passed to xToken() */\n int (*xToken)(void*, int, const char*, int, int, int) /* Callback */\n );\n};\n\n/*\n** CUSTOM AUXILIARY FUNCTIONS\n*************************************************************************/\n\n/*************************************************************************\n** CUSTOM TOKENIZERS\n**\n** Applications may also register custom tokenizer types. A tokenizer\n** is registered by providing fts5 with a populated instance of the\n** following structure. All structure methods must be defined, setting\n** any member of the fts5_tokenizer struct to NULL leads to undefined\n** behaviour. The structure methods are expected to function as follows:\n**\n** xCreate:\n** This function is used to allocate and initialize a tokenizer instance.\n** A tokenizer instance is required to actually tokenize text.\n**\n** The first argument passed to this function is a copy of the (void*)\n** pointer provided by the application when the fts5_tokenizer_v2 object\n** was registered with FTS5 (the third argument to xCreateTokenizer()).\n** The second and third arguments are an array of nul-terminated strings\n** containing the tokenizer arguments, if any, specified following the\n** tokenizer name as part of the CREATE VIRTUAL TABLE statement used\n** to create the FTS5 table.\n**\n** The final argument is an output variable. If successful, (*ppOut)\n** should be set to point to the new tokenizer handle and SQLITE_OK\n** returned. If an error occurs, some value other than SQLITE_OK should\n** be returned. In this case, fts5 assumes that the final value of *ppOut\n** is undefined.\n**\n** xDelete:\n** This function is invoked to delete a tokenizer handle previously\n** allocated using xCreate(). Fts5 guarantees that this function will\n** be invoked exactly once for each successful call to xCreate().\n**\n** xTokenize:\n** This function is expected to tokenize the nText byte string indicated\n** by argument pText. pText may or may not be nul-terminated. The first\n** argument passed to this function is a pointer to an Fts5Tokenizer object\n** returned by an earlier call to xCreate().\n**\n** The third argument indicates the reason that FTS5 is requesting\n** tokenization of the supplied text. This is always one of the following\n** four values:\n**\n** <ul><li> <b>FTS5_TOKENIZE_DOCUMENT</b> - A document is being inserted into\n** or removed from the FTS table. The tokenizer is being invoked to\n** determine the set of tokens to add to (or delete from) the\n** FTS index.\n**\n** <li> <b>FTS5_TOKENIZE_QUERY</b> - A MATCH query is being executed\n** against the FTS index. The tokenizer is being called to tokenize\n** a bareword or quoted string specified as part of the query.\n**\n** <li> <b>(FTS5_TOKENIZE_QUERY | FTS5_TOKENIZE_PREFIX)</b> - Same as\n** FTS5_TOKENIZE_QUERY, except that the bareword or quoted string is\n** followed by a \"*\" character, indicating that the last token\n** returned by the tokenizer will be treated as a token prefix.\n**\n** <li> <b>FTS5_TOKENIZE_AUX</b> - The tokenizer is being invoked to\n** satisfy an fts5_api.xTokenize() request made by an auxiliary\n** function. Or an fts5_api.xColumnSize() request made by the same\n** on a columnsize=0 database.\n** </ul>\n**\n** The sixth and seventh arguments passed to xTokenize() - pLocale and\n** nLocale - are a pointer to a buffer containing the locale to use for\n** tokenization (e.g. \"en_US\") and its size in bytes, respectively. The\n** pLocale buffer is not nul-terminated. pLocale may be passed NULL (in\n** which case nLocale is always 0) to indicate that the tokenizer should\n** use its default locale.\n**\n** For each token in the input string, the supplied callback xToken() must\n** be invoked. The first argument to it should be a copy of the pointer\n** passed as the second argument to xTokenize(). The third and fourth\n** arguments are a pointer to a buffer containing the token text, and the\n** size of the token in bytes. The 4th and 5th arguments are the byte offsets\n** of the first byte of and first byte immediately following the text from\n** which the token is derived within the input.\n**\n** The second argument passed to the xToken() callback (\"tflags\") should\n** normally be set to 0. The exception is if the tokenizer supports\n** synonyms. In this case see the discussion below for details.\n**\n** FTS5 assumes the xToken() callback is invoked for each token in the\n** order that they occur within the input text.\n**\n** If an xToken() callback returns any value other than SQLITE_OK, then\n** the tokenization should be abandoned and the xTokenize() method should\n** immediately return a copy of the xToken() return value. Or, if the\n** input buffer is exhausted, xTokenize() should return SQLITE_OK. Finally,\n** if an error occurs with the xTokenize() implementation itself, it\n** may abandon the tokenization and return any error code other than\n** SQLITE_OK or SQLITE_DONE.\n**\n** If the tokenizer is registered using an fts5_tokenizer_v2 object,\n** then the xTokenize() method has two additional arguments - pLocale\n** and nLocale. These specify the locale that the tokenizer should use\n** for the current request. If pLocale and nLocale are both 0, then the\n** tokenizer should use its default locale. Otherwise, pLocale points to\n** an nLocale byte buffer containing the name of the locale to use as utf-8\n** text. pLocale is not nul-terminated.\n**\n** FTS5_TOKENIZER\n**\n** There is also an fts5_tokenizer object. This is an older, deprecated,\n** version of fts5_tokenizer_v2. It is similar except that:\n**\n** <ul>\n** <li> There is no \"iVersion\" field, and\n** <li> The xTokenize() method does not take a locale argument.\n** </ul>\n**\n** Legacy fts5_tokenizer tokenizers must be registered using the\n** legacy xCreateTokenizer() function, instead of xCreateTokenizer_v2().\n**\n** Tokenizer implementations registered using either API may be retrieved\n** using both xFindTokenizer() and xFindTokenizer_v2().\n**\n** SYNONYM SUPPORT\n**\n** Custom tokenizers may also support synonyms. Consider a case in which a\n** user wishes to query for a phrase such as \"first place\". Using the\n** built-in tokenizers, the FTS5 query 'first + place' will match instances\n** of \"first place\" within the document set, but not alternative forms\n** such as \"1st place\". In some applications, it would be better to match\n** all instances of \"first place\" or \"1st place\" regardless of which form\n** the user specified in the MATCH query text.\n**\n** There are several ways to approach this in FTS5:\n**\n** <ol><li> By mapping all synonyms to a single token. In this case, using\n** the above example, this means that the tokenizer returns the\n** same token for inputs \"first\" and \"1st\". Say that token is in\n** fact \"first\", so that when the user inserts the document \"I won\n** 1st place\" entries are added to the index for tokens \"i\", \"won\",\n** \"first\" and \"place\". If the user then queries for '1st + place',\n** the tokenizer substitutes \"first\" for \"1st\" and the query works\n** as expected.\n**\n** <li> By querying the index for all synonyms of each query term\n** separately. In this case, when tokenizing query text, the\n** tokenizer may provide multiple synonyms for a single term\n** within the document. FTS5 then queries the index for each\n** synonym individually. For example, faced with the query:\n**\n** <codeblock>\n** ... MATCH 'first place'</codeblock>\n**\n** the tokenizer offers both \"1st\" and \"first\" as synonyms for the\n** first token in the MATCH query and FTS5 effectively runs a query\n** similar to:\n**\n** <codeblock>\n** ... MATCH '(first OR 1st) place'</codeblock>\n**\n** except that, for the purposes of auxiliary functions, the query\n** still appears to contain just two phrases - \"(first OR 1st)\"\n** being treated as a single phrase.\n**\n** <li> By adding multiple synonyms for a single term to the FTS index.\n** Using this method, when tokenizing document text, the tokenizer\n** provides multiple synonyms for each token. So that when a\n** document such as \"I won first place\" is tokenized, entries are\n** added to the FTS index for \"i\", \"won\", \"first\", \"1st\" and\n** \"place\".\n**\n** This way, even if the tokenizer does not provide synonyms\n** when tokenizing query text (it should not - to do so would be\n** inefficient), it doesn't matter if the user queries for\n** 'first + place' or '1st + place', as there are entries in the\n** FTS index corresponding to both forms of the first token.\n** </ol>\n**\n** Whether it is parsing document or query text, any call to xToken that\n** specifies a <i>tflags</i> argument with the FTS5_TOKEN_COLOCATED bit\n** is considered to supply a synonym for the previous token. For example,\n** when parsing the document \"I won first place\", a tokenizer that supports\n** synonyms would call xToken() 5 times, as follows:\n**\n** <codeblock>\n** xToken(pCtx, 0, \"i\", 1, 0, 1);\n** xToken(pCtx, 0, \"won\", 3, 2, 5);\n** xToken(pCtx, 0, \"first\", 5, 6, 11);\n** xToken(pCtx, FTS5_TOKEN_COLOCATED, \"1st\", 3, 6, 11);\n** xToken(pCtx, 0, \"place\", 5, 12, 17);\n**</codeblock>\n**\n** It is an error to specify the FTS5_TOKEN_COLOCATED flag the first time\n** xToken() is called. Multiple synonyms may be specified for a single token\n** by making multiple calls to xToken(FTS5_TOKEN_COLOCATED) in sequence.\n** There is no limit to the number of synonyms that may be provided for a\n** single token.\n**\n** In many cases, method (1) above is the best approach. It does not add\n** extra data to the FTS index or require FTS5 to query for multiple terms,\n** so it is efficient in terms of disk space and query speed. However, it\n** does not support prefix queries very well. If, as suggested above, the\n** token \"first\" is substituted for \"1st\" by the tokenizer, then the query:\n**\n** <codeblock>\n** ... MATCH '1s*'</codeblock>\n**\n** will not match documents that contain the token \"1st\" (as the tokenizer\n** will probably not map \"1s\" to any prefix of \"first\").\n**\n** For full prefix support, method (3) may be preferred. In this case,\n** because the index contains entries for both \"first\" and \"1st\", prefix\n** queries such as 'fi*' or '1s*' will match correctly. However, because\n** extra entries are added to the FTS index, this method uses more space\n** within the database.\n**\n** Method (2) offers a midpoint between (1) and (3). Using this method,\n** a query such as '1s*' will match documents that contain the literal\n** token \"1st\", but not \"first\" (assuming the tokenizer is not able to\n** provide synonyms for prefixes). However, a non-prefix query like '1st'\n** will match against \"1st\" and \"first\". This method does not require\n** extra disk space, as no extra entries are added to the FTS index.\n** On the other hand, it may require more CPU cycles to run MATCH queries,\n** as separate queries of the FTS index are required for each synonym.\n**\n** When using methods (2) or (3), it is important that the tokenizer only\n** provide synonyms when tokenizing document text (method (3)) or query\n** text (method (2)), not both. Doing so will not cause any errors, but is\n** inefficient.\n*/\ntypedef struct Fts5Tokenizer Fts5Tokenizer;\ntypedef struct fts5_tokenizer_v2 fts5_tokenizer_v2;\nstruct fts5_tokenizer_v2 {\n int iVersion; /* Currently always 2 */\n\n int (*xCreate)(void*, const char **azArg, int nArg, Fts5Tokenizer **ppOut);\n void (*xDelete)(Fts5Tokenizer*);\n int (*xTokenize)(Fts5Tokenizer*,\n void *pCtx,\n int flags, /* Mask of FTS5_TOKENIZE_* flags */\n const char *pText, int nText,\n const char *pLocale, int nLocale,\n int (*xToken)(\n void *pCtx, /* Copy of 2nd argument to xTokenize() */\n int tflags, /* Mask of FTS5_TOKEN_* flags */\n const char *pToken, /* Pointer to buffer containing token */\n int nToken, /* Size of token in bytes */\n int iStart, /* Byte offset of token within input text */\n int iEnd /* Byte offset of end of token within input text */\n )\n );\n};\n\n/*\n** New code should use the fts5_tokenizer_v2 type to define tokenizer\n** implementations. The following type is included for legacy applications\n** that still use it.\n*/\ntypedef struct fts5_tokenizer fts5_tokenizer;\nstruct fts5_tokenizer {\n int (*xCreate)(void*, const char **azArg, int nArg, Fts5Tokenizer **ppOut);\n void (*xDelete)(Fts5Tokenizer*);\n int (*xTokenize)(Fts5Tokenizer*,\n void *pCtx,\n int flags, /* Mask of FTS5_TOKENIZE_* flags */\n const char *pText, int nText,\n int (*xToken)(\n void *pCtx, /* Copy of 2nd argument to xTokenize() */\n int tflags, /* Mask of FTS5_TOKEN_* flags */\n const char *pToken, /* Pointer to buffer containing token */\n int nToken, /* Size of token in bytes */\n int iStart, /* Byte offset of token within input text */\n int iEnd /* Byte offset of end of token within input text */\n )\n );\n};\n\n\n/* Flags that may be passed as the third argument to xTokenize() */\n#define FTS5_TOKENIZE_QUERY 0x0001\n#define FTS5_TOKENIZE_PREFIX 0x0002\n#define FTS5_TOKENIZE_DOCUMENT 0x0004\n#define FTS5_TOKENIZE_AUX 0x0008\n\n/* Flags that may be passed by the tokenizer implementation back to FTS5\n** as the third argument to the supplied xToken callback. */\n#define FTS5_TOKEN_COLOCATED 0x0001 /* Same position as prev. token */\n\n/*\n** END OF CUSTOM TOKENIZERS\n*************************************************************************/\n\n/*************************************************************************\n** FTS5 EXTENSION REGISTRATION API\n*/\ntypedef struct fts5_api fts5_api;\nstruct fts5_api {\n int iVersion; /* Currently always set to 3 */\n\n /* Create a new tokenizer */\n int (*xCreateTokenizer)(\n fts5_api *pApi,\n const char *zName,\n void *pUserData,\n fts5_tokenizer *pTokenizer,\n void (*xDestroy)(void*)\n );\n\n /* Find an existing tokenizer */\n int (*xFindTokenizer)(\n fts5_api *pApi,\n const char *zName,\n void **ppUserData,\n fts5_tokenizer *pTokenizer\n );\n\n /* Create a new auxiliary function */\n int (*xCreateFunction)(\n fts5_api *pApi,\n const char *zName,\n void *pUserData,\n fts5_extension_function xFunction,\n void (*xDestroy)(void*)\n );\n\n /* APIs below this point are only available if iVersion>=3 */\n\n /* Create a new tokenizer */\n int (*xCreateTokenizer_v2)(\n fts5_api *pApi,\n const char *zName,\n void *pUserData,\n fts5_tokenizer_v2 *pTokenizer,\n void (*xDestroy)(void*)\n );\n\n /* Find an existing tokenizer */\n int (*xFindTokenizer_v2)(\n fts5_api *pApi,\n const char *zName,\n void **ppUserData,\n fts5_tokenizer_v2 **ppTokenizer\n );\n};\n\n/*\n** END OF REGISTRATION API\n*************************************************************************/\n\n#ifdef __cplusplus\n} /* end of the 'extern \"C\"' block */\n#endif\n\n#endif /* _FTS5_H */\n\n/******** End of fts5.h *********/\n#endif /* SQLITE3_H */\n"},"language":{"kind":"string","value":"Unknown"}}},{"rowIdx":9332,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/SQLiteCpp/examples/example1/main.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":22649,"string":"22,649"},"line_count":{"kind":"number","value":508,"string":"508"},"content":{"kind":"string","value":"/**\n * @file main.cpp\n * @brief A few short examples in a row.\n *\n * Demonstrates how-to use the SQLite++ wrapper\n *\n * Copyright (c) 2012-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)\n *\n * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt\n * or copy at http://opensource.org/licenses/MIT)\n */\n\n#include <iostream>\n#include <cstdio>\n#include <cstdlib>\n#include <string>\n\n#include <SQLiteCpp/SQLiteCpp.h>\n#include <SQLiteCpp/VariadicBind.h>\n\n\n#ifdef SQLITECPP_ENABLE_ASSERT_HANDLER\nnamespace SQLite\n{\n/// definition of the assertion handler enabled when SQLITECPP_ENABLE_ASSERT_HANDLER is defined in the project (CMakeList.txt)\nvoid assertion_failed(const char* apFile, const long apLine, const char* apFunc, const char* apExpr, const char* apMsg)\n{\n // Print a message to the standard error output stream, and abort the program.\n std::cerr << apFile << \":\" << apLine << \":\" << \" error: assertion failed (\" << apExpr << \") in \" << apFunc << \"() with message \\\"\" << apMsg << \"\\\"\\n\";\n std::abort();\n}\n}\n#endif\n\n/// Get path to this example's directory (including the final separator '/' or '\\')\nstatic inline std::string getExamplePath()\n{\n std::string filePath(__FILE__);\n return filePath.substr( 0, filePath.length() - std::string(\"main.cpp\").length());\n}\n\n/// Example Database\nstatic const std::string filename_example_db3 = getExamplePath() + \"example.db3\";\n/// Image (SQLite logo as a 12581 bytes PNG file)\nstatic const int sizeof_logo_png = 12581;\nstatic const std::string filename_logo_png = getExamplePath() + \"logo.png\";\n\n\n/// Object Oriented Basic example\nclass Example\n{\npublic:\n // Constructor\n Example() :\n mDb(filename_example_db3), // Open a database file in read-only mode\n mQuery(mDb, \"SELECT * FROM test WHERE weight > :min_weight\")// Compile a SQL query, containing one parameter (index 1)\n {\n }\n virtual ~Example()\n {\n }\n\n /// List the rows where the \"weight\" column is greater than the provided aParamValue\n void ListGreaterThan(const int aParamValue)\n {\n std::cout << \"ListGreaterThan(\" << aParamValue << \")\\n\";\n\n // Bind the integer value provided to the first parameter of the SQL query\n mQuery.bind(\":min_weight\", aParamValue); // same as mQuery.bind(1, aParamValue);\n\n // Loop to execute the query step by step, to get one a row of results at a time\n while (mQuery.executeStep())\n {\n std::cout << \"row (\" << mQuery.getColumn(0) << \", \\\"\" << mQuery.getColumn(1) << \"\\\", \" << mQuery.getColumn(2) << \")\\n\";\n }\n\n // Reset the query to be able to use it again later\n mQuery.reset();\n }\n\nprivate:\n SQLite::Database mDb; ///< Database connection\n SQLite::Statement mQuery; ///< Database prepared SQL query\n};\n\nint main()\n{\n // Using SQLITE_VERSION would require #include <sqlite3.h> which we want to avoid: use SQLite::VERSION if possible.\n// std::cout << \"SQlite3 version \" << SQLITE_VERSION << std::endl;\n std::cout << \"SQlite3 compile time header version \" << SQLite::VERSION << \" (vs dynamic lib version \" << SQLite::getLibVersion() << \")\" << std::endl;\n std::cout << \"SQliteC++ version \" << SQLITECPP_VERSION << std::endl;\n\n ////////////////////////////////////////////////////////////////////////////\n // Inspect a database via SQLite header information\n try\n {\n const SQLite::Header header = SQLite::Database::getHeaderInfo(filename_example_db3);\n\n // Print values for all header fields\n // Official documentation for fields can be found here: https://www.sqlite.org/fileformat.html#the_database_header\n std::cout << \"Magic header string: \" << header.headerStr << std::endl;\n std::cout << \"Page size bytes: \" << header.pageSizeBytes << std::endl;\n std::cout << \"File format write version: \" << (int)header.fileFormatWriteVersion << std::endl;\n std::cout << \"File format read version: \" << (int)header.fileFormatReadVersion << std::endl;\n std::cout << \"Reserved space bytes: \" << (int)header.reservedSpaceBytes << std::endl;\n std::cout << \"Max embedded payload fraction \" << (int)header.maxEmbeddedPayloadFrac << std::endl;\n std::cout << \"Min embedded payload fraction: \" << (int)header.minEmbeddedPayloadFrac << std::endl;\n std::cout << \"Leaf payload fraction: \" << (int)header.leafPayloadFrac << std::endl;\n std::cout << \"File change counter: \" << header.fileChangeCounter << std::endl;\n std::cout << \"Database size pages: \" << header.databaseSizePages << std::endl;\n std::cout << \"First freelist trunk page: \" << header.firstFreelistTrunkPage << std::endl;\n std::cout << \"Total freelist trunk pages: \" << header.totalFreelistPages << std::endl;\n std::cout << \"Schema cookie: \" << header.schemaCookie << std::endl;\n std::cout << \"Schema format number: \" << header.schemaFormatNumber << std::endl;\n std::cout << \"Default page cache size bytes: \" << header.defaultPageCacheSizeBytes << std::endl;\n std::cout << \"Largest B tree page number: \" << header.largestBTreePageNumber << std::endl;\n std::cout << \"Database text encoding: \" << header.databaseTextEncoding << std::endl;\n std::cout << \"User version: \" << header.userVersion << std::endl;\n std::cout << \"Incremental vaccum mode: \" << header.incrementalVaccumMode << std::endl;\n std::cout << \"Application ID: \" << header.applicationId << std::endl;\n std::cout << \"Version valid for: \" << header.versionValidFor << std::endl;\n std::cout << \"SQLite version: \" << header.sqliteVersion << std::endl;\n }\n catch (std::exception& e)\n {\n std::cout << \"SQLite exception: \" << e.what() << std::endl;\n return EXIT_FAILURE; // unexpected error : exit the example program\n }\n\n ////////////////////////////////////////////////////////////////////////////\n // Very basic first example (1/7) :\n try\n {\n // Open a database file in read-only mode\n SQLite::Database db(filename_example_db3); // SQLite::OPEN_READONLY\n std::cout << \"SQLite database file '\" << db.getFilename().c_str() << \"' opened successfully\\n\";\n\n // Test if the 'test' table exists\n const bool bExists = db.tableExists(\"test\");\n std::cout << \"SQLite table 'test' exists=\" << bExists << \"\\n\";\n\n // Get a single value result with an easy to use shortcut\n const std::string value = db.execAndGet(\"SELECT value FROM test WHERE id=2\");\n std::cout << \"execAndGet=\" << value.c_str() << std::endl;\n }\n catch (std::exception& e)\n {\n std::cout << \"SQLite exception: \" << e.what() << std::endl;\n return EXIT_FAILURE; // unexpected error : exit the example program\n }\n\n ////////////////////////////////////////////////////////////////////////////\n // Simple select query - few variations (2/7) :\n try\n {\n // Open a database file in read-only mode\n SQLite::Database db(filename_example_db3); // SQLite::OPEN_READONLY\n std::cout << \"SQLite database file '\" << db.getFilename().c_str() << \"' opened successfully\\n\";\n\n ///// a) Loop to get values of column by index, using auto cast to variable type\n\n // Compile a SQL query, containing one parameter (index 1)\n SQLite::Statement query(db, \"SELECT id as test_id, value as test_val, weight as test_weight FROM test WHERE weight > ?\");\n std::cout << \"SQLite statement '\" << query.getQuery().c_str() << \"' compiled (\" << query.getColumnCount() << \" columns in the result)\\n\";\n // Bind the integer value 2 to the first parameter of the SQL query\n query.bind(1, 2);\n std::cout << \"binded with integer value '2' :\\n\";\n\n // Loop to execute the query step by step, to get one a row of results at a time\n while (query.executeStep())\n {\n // Demonstrates how to get some typed column value (and the equivalent explicit call)\n const int id = query.getColumn(0); // = query.getColumn(0).getInt();\n //const char* pvalue = query.getColumn(1); // = query.getColumn(1).getText();\n const std::string value = query.getColumn(1); // = query.getColumn(1).getText();\n const int bytes = query.getColumn(1).size(); // .getColumn(1).getBytes();\n const double weight = query.getColumn(2); // = query.getColumn(2).getInt();\n std::cout << \"row (\" << id << \", \\\"\" << value.c_str() << \"\\\"(\" << bytes << \") \" << weight << \")\\n\";\n }\n\n ///// b) Get aliased column names (and original column names if possible)\n\n // Reset the query to use it again\n query.reset();\n std::cout << \"SQLite statement '\" << query.getQuery().c_str() << \"' reseted (\" << query.getColumnCount() << \" columns in the result)\\n\";\n\n // Show how to get the aliased names of the result columns.\n const std::string name0 = query.getColumnName(0);\n const std::string name1 = query.getColumnName(1);\n const std::string name2 = query.getColumnName(2);\n std::cout << \"aliased result [\\\"\" << name0.c_str() << \"\\\", \\\"\" << name1.c_str() << \"\\\", \\\"\" << name2.c_str() << \"\\\"]\\n\";\n\n#ifdef SQLITE_ENABLE_COLUMN_METADATA\n // Show how to get origin names of the table columns from which theses result columns come from.\n // Requires the SQLITE_ENABLE_COLUMN_METADATA preprocessor macro to be\n // also defined at compile times of the SQLite library itself.\n const std::string oname0 = query.getColumnOriginName(0);\n const std::string oname1 = query.getColumnOriginName(1);\n const std::string oname2 = query.getColumnOriginName(2);\n std::cout << \"origin table 'test' [\\\"\" << oname0.c_str() << \"\\\", \\\"\" << oname1.c_str() << \"\\\", \\\"\" << oname2.c_str() << \"\\\"]\\n\";\n#endif\n // Loop to execute the query step by step, to get one a row of results at a time\n while (query.executeStep())\n {\n // Demonstrates that inserting column value in a std:ostream is natural\n std::cout << \"row (\" << query.getColumn(0) << \", \\\"\" << query.getColumn(1) << \"\\\", \" << query.getColumn(2) << \")\\n\";\n }\n\n ///// c) Get columns by name\n\n // Reset the query to use it again\n query.reset();\n std::cout << \"SQLite statement '\" << query.getQuery().c_str() << \"' reseted (\" << query.getColumnCount() << \" columns in the result)\\n\";\n\n // Loop to execute the query step by step, to get one a row of results at a time\n while (query.executeStep())\n {\n // Demonstrates how to get column value by aliased name (not the original table names, see above)\n const int id = query.getColumn(\"test_id\");\n const std::string value = query.getColumn(\"test_val\");\n const double weight = query.getColumn(\"test_weight\");\n std::cout << \"row (\" << id << \", \\\"\" << value.c_str() << \"\\\" \" << weight << \")\\n\";\n }\n\n ///// d) Uses explicit typed getters instead of auto cast operators\n\n // Reset the query to use it again\n query.reset();\n std::cout << \"SQLite statement '\" << query.getQuery().c_str() << \"' reseted (\" << query.getColumnCount () << \" columns in the result)\\n\";\n // Bind the string value \"6\" to the first parameter of the SQL query\n query.bind(1, \"6\");\n std::cout << \"binded with string value \\\"6\\\" :\\n\";\n // Reuses variables: uses assignment operator in the loop instead of constructor with initialization\n int id = 0;\n std::string value;\n double weight = 0.0;\n while (query.executeStep())\n {\n id = query.getColumn(0).getInt();\n value = query.getColumn(1).getText();\n weight = query.getColumn(2).getInt();\n std::cout << \"row (\" << id << \", \\\"\" << value << \"\\\", \" << weight << \")\\n\";\n }\n }\n catch (std::exception& e)\n {\n std::cout << \"SQLite exception: \" << e.what() << std::endl;\n return EXIT_FAILURE; // unexpected error : exit the example program\n }\n\n ////////////////////////////////////////////////////////////////////////////\n // Object Oriented Basic example (3/7) :\n try\n {\n // Open the database and compile the query\n Example example;\n\n // Demonstrates the way to use the same query with different parameter values\n example.ListGreaterThan(8);\n example.ListGreaterThan(6);\n example.ListGreaterThan(2);\n }\n catch (std::exception& e)\n {\n std::cout << \"SQLite exception: \" << e.what() << std::endl;\n return EXIT_FAILURE; // unexpected error : exit the example program\n }\n\n // The execAndGet wrapper example (4/7) :\n try\n {\n // Open a database file in read-only mode\n SQLite::Database db(filename_example_db3); // SQLite::OPEN_READONLY\n std::cout << \"SQLite database file '\" << db.getFilename().c_str() << \"' opened successfully\\n\";\n\n // WARNING: Be very careful with this dangerous method: you have to\n // make a COPY OF THE result, else it will be destroy before the next line\n // (when the underlying temporary Statement and Column objects are destroyed)\n std::string value = db.execAndGet(\"SELECT value FROM test WHERE id=2\");\n std::cout << \"execAndGet=\" << value.c_str() << std::endl;\n }\n catch (std::exception& e)\n {\n std::cout << \"SQLite exception: \" << e.what() << std::endl;\n return EXIT_FAILURE; // unexpected error : exit the example program\n }\n\n ////////////////////////////////////////////////////////////////////////////\n // Simple batch queries example (5/7) :\n try\n {\n // Open a database file in create/write mode\n SQLite::Database db(\"test.db3\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n std::cout << \"SQLite database file '\" << db.getFilename().c_str() << \"' opened successfully\\n\";\n\n // Create a new table with an explicit \"id\" column aliasing the underlying rowid\n db.exec(\"DROP TABLE IF EXISTS test\");\n db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\");\n\n // first row\n int nb = db.exec(\"INSERT INTO test VALUES (NULL, 'test')\");\n std::cout << \"INSERT INTO test VALUES (NULL, 'test')\\\", returned \" << nb << std::endl;\n\n // second row\n nb = db.exec(\"INSERT INTO test VALUES (NULL, 'second')\");\n std::cout << \"INSERT INTO test VALUES (NULL, 'second')\\\", returned \" << nb << std::endl;\n\n // update the second row\n nb = db.exec(\"UPDATE test SET value='second-updated' WHERE id='2'\");\n std::cout << \"UPDATE test SET value='second-updated' WHERE id='2', returned \" << nb << std::endl;\n\n nb = db.getTotalChanges();\n std::cout << \"Nb of total changes since connection: \" << nb << std::endl;\n\n // Check the results : expect two row of result\n SQLite::Statement query(db, \"SELECT * FROM test\");\n std::cout << \"SELECT * FROM test :\\n\";\n while (query.executeStep())\n {\n std::cout << \"row (\" << query.getColumn(0) << \", \\\"\" << query.getColumn(1) << \"\\\")\\n\";\n }\n\n db.exec(\"DROP TABLE test\");\n }\n catch (std::exception& e)\n {\n std::cout << \"SQLite exception: \" << e.what() << std::endl;\n return EXIT_FAILURE; // unexpected error : exit the example program\n }\n remove(\"test.db3\");\n\n ////////////////////////////////////////////////////////////////////////////\n // RAII transaction example (6/7) :\n try\n {\n // Open a database file in create/write mode\n SQLite::Database db(\"transaction.db3\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n std::cout << \"SQLite database file '\" << db.getFilename().c_str() << \"' opened successfully\\n\";\n\n db.exec(\"DROP TABLE IF EXISTS test\");\n\n // Exemple of a successful transaction :\n try\n {\n // Begin transaction\n SQLite::Transaction transaction(db);\n\n db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\");\n\n int nb = db.exec(\"INSERT INTO test VALUES (NULL, 'test')\");\n std::cout << \"INSERT INTO test VALUES (NULL, 'test')\\\", returned \" << nb << std::endl;\n\n // Commit transaction\n transaction.commit();\n }\n catch (std::exception& e)\n {\n std::cout << \"SQLite exception: \" << e.what() << std::endl;\n return EXIT_FAILURE; // unexpected error : exit the example program\n }\n\n // Exemple of a rollbacked transaction :\n try\n {\n // Begin transaction\n SQLite::Transaction transaction(db);\n\n int nb = db.exec(\"INSERT INTO test VALUES (NULL, 'second')\");\n std::cout << \"INSERT INTO test VALUES (NULL, 'second')\\\", returned \" << nb << std::endl;\n\n nb = db.exec(\"INSERT INTO test ObviousError\");\n std::cout << \"INSERT INTO test \\\"error\\\", returned \" << nb << std::endl;\n\n return EXIT_FAILURE; // we should never get there : exit the example program\n\n // Commit transaction\n transaction.commit();\n }\n catch (std::exception& e)\n {\n std::cout << \"SQLite exception: \" << e.what() << std::endl;\n // expected error, see above\n }\n\n // Check the results (expect only one row of result, as the second one has been rollbacked by the error)\n SQLite::Statement query(db, \"SELECT * FROM test\");\n std::cout << \"SELECT * FROM test :\\n\";\n while (query.executeStep())\n {\n std::cout << \"row (\" << query.getColumn(0) << \", \\\"\" << query.getColumn(1) << \"\\\")\\n\";\n }\n }\n catch (std::exception& e)\n {\n std::cout << \"SQLite exception: \" << e.what() << std::endl;\n return EXIT_FAILURE; // unexpected error : exit the example program\n }\n remove(\"transaction.db3\");\n\n ////////////////////////////////////////////////////////////////////////////\n // Binary blob and in-memory database example (7/7) :\n try\n {\n // Open a database file in create/write mode\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n std::cout << \"SQLite database file '\" << db.getFilename().c_str() << \"' opened successfully\\n\";\n\n db.exec(\"DROP TABLE IF EXISTS test\");\n db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value BLOB)\");\n\n // A) insert the logo.png image into the db as a blob\n FILE* fp = fopen(filename_logo_png.c_str(), \"rb\");\n if (NULL != fp)\n {\n char buffer[16*1024];\n static_assert(sizeof(buffer) > sizeof_logo_png, \"Buffer is smaller than the size of the file to read\");\n void* blob = &buffer;\n const int size = static_cast<int>(fread(blob, 1, 16*1024, fp));\n buffer[size] = '\\0';\n SQLITECPP_ASSERT(size == sizeof_logo_png, \"unexpected fread return value\"); // See SQLITECPP_ENABLE_ASSERT_HANDLER\n fclose(fp);\n std::cout << filename_logo_png << \" file size=\" << size << \" bytes\\n\";\n\n // Insert query\n SQLite::Statement query(db, \"INSERT INTO test VALUES (NULL, ?)\");\n // Bind the blob value to the first parameter of the SQL query\n query.bind(1, blob, size);\n std::cout << \"blob binded successfully\\n\";\n\n // Execute the one-step query to insert the blob\n int nb = query.exec();\n std::cout << \"INSERT INTO test VALUES (NULL, ?)\\\", returned \" << nb << std::endl;\n }\n else\n {\n std::cout << \"file \" << filename_logo_png << \" not found !\\n\";\n return EXIT_FAILURE; // unexpected error : exit the example program\n }\n\n // B) select the blob from the db and write it to disk into a \"out.png\" image file\n fp = fopen(\"out.png\", \"wb\");\n if (NULL != fp)\n {\n SQLite::Statement query(db, \"SELECT * FROM test\");\n std::cout << \"SELECT * FROM test :\\n\";\n if (query.executeStep())\n {\n SQLite::Column colBlob = query.getColumn(1);\n const void* const blob = colBlob.getBlob();\n const size_t size = colBlob.getBytes();\n std::cout << \"row (\" << query.getColumn(0) << \", size=\" << size << \" bytes)\\n\";\n size_t sizew = fwrite(blob, 1, size, fp);\n SQLITECPP_ASSERT(sizew == size, \"fwrite failed\"); // See SQLITECPP_ENABLE_ASSERT_HANDLER\n fclose(fp);\n }\n // NOTE: here the blob is still held in memory, until the Statement is finalized at the end of the scope\n }\n else\n {\n std::cout << \"file out.png not created !\\n\";\n return EXIT_FAILURE; // unexpected error : exit the example program\n }\n }\n catch (std::exception& e)\n {\n std::cout << \"SQLite exception: \" << e.what() << std::endl;\n return EXIT_FAILURE; // unexpected error : exit the example program\n }\n remove(\"out.png\");\n\n#if (__cplusplus >= 201402L) || ( defined(_MSC_VER) && (_MSC_VER >= 1900) ) // c++14: Visual Studio 2015\n // example with C++14 variadic bind\n try\n {\n // Open a database file in create/write mode\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n\n db.exec(\"DROP TABLE IF EXISTS test\");\n db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\");\n\n {\n SQLite::Statement query(db, \"INSERT INTO test VALUES (?, ?)\");\n\n SQLite::bind(query, 42, \"fortytwo\");\n // Execute the one-step query to insert the blob\n int nb = query.exec();\n std::cout << \"INSERT INTO test VALUES (NULL, ?)\\\", returned \" << nb << std::endl;\n }\n\n SQLite::Statement query(db, \"SELECT * FROM test\");\n std::cout << \"SELECT * FROM test :\\n\";\n if (query.executeStep())\n {\n std::cout << query.getColumn(0).getInt() << \"\\t\\\"\" << query.getColumn(1).getText() << \"\\\"\\n\";\n }\n }\n catch (std::exception& e)\n {\n std::cout << \"SQLite exception: \" << e.what() << std::endl;\n return EXIT_FAILURE; // unexpected error : exit the example program\n }\n#endif\n\n std::cout << \"everything ok, quitting\\n\";\n\n return EXIT_SUCCESS;\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9333,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/SQLiteCpp/examples/example2/build.sh"},"file_extension":{"kind":"string","value":".sh"},"file_size":{"kind":"number","value":412,"string":"412"},"line_count":{"kind":"number","value":19,"string":"19"},"content":{"kind":"string","value":"#!/bin/sh\n# Copyright (c) 2012-2023 Sébastien Rombauts (sebastien.rombauts@gmail.com)\n#\n# Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt\n# or copy at http://opensource.org/licenses/MIT)\n\n# exit on first error\nset -e\n\nmkdir -p build\ncd build\n\n# Generate a Makefile for GCC (or Clang, depanding on CC/CXX envvar)\ncmake -DCMAKE_BUILD_TYPE=Debug ..\n\n# Build (ie 'make')\ncmake --build .\n\n"},"language":{"kind":"string","value":"Shell"}}},{"rowIdx":9334,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/SQLiteCpp/examples/example2/src/main.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":3224,"string":"3,224"},"line_count":{"kind":"number","value":85,"string":"85"},"content":{"kind":"string","value":"/**\n * @file main.cpp\n * @brief A few short examples in a row.\n *\n * Demonstrates how-to use the SQLite++ wrapper\n *\n * Copyright (c) 2012-2023 Sebastien Rombauts (sebastien.rombauts@gmail.com)\n *\n * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt\n * or copy at http://opensource.org/licenses/MIT)\n */\n\n#include <iostream>\n#include <cstdio>\n#include <cstdlib>\n\n#include <SQLiteCpp/SQLiteCpp.h>\n\n\n#ifdef SQLITECPP_ENABLE_ASSERT_HANDLER\nnamespace SQLite\n{\n/// definition of the assertion handler enabled when SQLITECPP_ENABLE_ASSERT_HANDLER is defined in the project (CMakeList.txt)\nvoid assertion_failed(const char* apFile, const long apLine, const char* apFunc, const char* apExpr, const char* apMsg)\n{\n // Print a message to the standard error output stream, and abort the program.\n std::cerr << apFile << \":\" << apLine << \":\" << \" error: assertion failed (\" << apExpr << \") in \" << apFunc << \"() with message \\\"\" << apMsg << \"\\\"\\n\";\n std::abort();\n}\n}\n#endif\n\nint main ()\n{\n // Using SQLITE_VERSION would require #include <sqlite3.h> which we want to avoid: use SQLite::VERSION if possible.\n// std::cout << \"SQlite3 version \" << SQLITE_VERSION << std::endl;\n std::cout << \"SQlite3 version \" << SQLite::VERSION << \" (\" << SQLite::getLibVersion() << \")\" << std::endl;\n std::cout << \"SQliteC++ version \" << SQLITECPP_VERSION << std::endl;\n\n ////////////////////////////////////////////////////////////////////////////\n // Simple batch queries example :\n try\n {\n // Open a database file in create/write mode\n SQLite::Database db(\"test.db3\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n std::cout << \"SQLite database file '\" << db.getFilename().c_str() << \"' opened successfully\\n\";\n\n // Create a new table with an explicit \"id\" column aliasing the underlying rowid\n db.exec(\"DROP TABLE IF EXISTS test\");\n db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\");\n\n // first row\n int nb = db.exec(\"INSERT INTO test VALUES (NULL, \\\"test\\\")\");\n std::cout << \"INSERT INTO test VALUES (NULL, \\\"test\\\")\\\", returned \" << nb << std::endl;\n\n // second row\n nb = db.exec(\"INSERT INTO test VALUES (NULL, \\\"second\\\")\");\n std::cout << \"INSERT INTO test VALUES (NULL, \\\"second\\\")\\\", returned \" << nb << std::endl;\n\n // update the second row\n nb = db.exec(\"UPDATE test SET value=\\\"second-updated\\\" WHERE id='2'\");\n std::cout << \"UPDATE test SET value=\\\"second-updated\\\" WHERE id='2', returned \" << nb << std::endl;\n\n // Check the results : expect two row of result\n SQLite::Statement query(db, \"SELECT * FROM test\");\n std::cout << \"SELECT * FROM test :\\n\";\n while (query.executeStep())\n {\n std::cout << \"row (\" << query.getColumn(0) << \", \\\"\" << query.getColumn(1) << \"\\\")\\n\";\n }\n\n db.exec(\"DROP TABLE test\");\n }\n catch (std::exception& e)\n {\n std::cout << \"SQLite exception: \" << e.what() << std::endl;\n return EXIT_FAILURE; // unexpected error : exit the example program\n }\n remove(\"test.db3\");\n\n std::cout << \"everything ok, quitting\\n\";\n\n return EXIT_SUCCESS;\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9335,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/SQLiteCpp/tests/Exception_test.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":2537,"string":"2,537"},"line_count":{"kind":"number","value":90,"string":"90"},"content":{"kind":"string","value":"/**\n * @file Transaction_test.cpp\n * @ingroup tests\n * @brief Test of a SQLite Transaction.\n *\n * Copyright (c) 2012-2020 Sebastien Rombauts (sebastien.rombauts@gmail.com)\n *\n * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt\n * or copy at http://opensource.org/licenses/MIT)\n */\n\n#include <SQLiteCpp/Exception.h>\n\n#include <gtest/gtest.h>\n\n#include <string>\n\nTEST(Exception, copy)\n{\n const SQLite::Exception ex1(\"some error\", 2);\n const SQLite::Exception ex2 = ex1;\n EXPECT_STREQ(ex1.what(), ex2.what());\n EXPECT_EQ(ex1.getErrorCode(), ex2.getErrorCode());\n EXPECT_EQ(ex1.getExtendedErrorCode(), ex2.getExtendedErrorCode());\n}\n\n// see http://eel.is/c++draft/exception#2 or http://www.cplusplus.com/reference/exception/exception/operator=/\n// an assignment operator is expected to be avaiable\nTEST(Exception, assignment)\n{\n const char message[] = \"some error\";\n const SQLite::Exception ex1(message, 1);\n SQLite::Exception ex2(\"another error\", 2);\n\n ex2 = ex1;\n\n EXPECT_STREQ(ex2.what(), message);\n EXPECT_EQ(ex2.getErrorCode(), 1);\n EXPECT_EQ(ex2.getExtendedErrorCode(), -1);\n EXPECT_STREQ(ex2.getErrorStr(), \"SQL logic error\");\n}\n\nTEST(Exception, throw_catch)\n{\n const char message[] = \"some error\";\n try\n {\n throw SQLite::Exception(message);\n }\n catch (const std::runtime_error& ex)\n {\n EXPECT_STREQ(ex.what(), message);\n }\n}\n\n\nTEST(Exception, constructor)\n{\n const char msg1[] = \"some error\";\n std::string msg2 = \"another error\";\n {\n const SQLite::Exception ex(msg1);\n EXPECT_STREQ(ex.what(), msg1);\n EXPECT_EQ(ex.getErrorCode(), -1);\n EXPECT_EQ(ex.getExtendedErrorCode(), -1);\n EXPECT_STREQ(\"unknown error\", ex.getErrorStr());\n }\n {\n const SQLite::Exception ex(msg2);\n EXPECT_STREQ(ex.what(), msg2.c_str());\n EXPECT_EQ(ex.getErrorCode(), -1);\n EXPECT_EQ(ex.getExtendedErrorCode(), -1);\n EXPECT_STREQ(\"unknown error\", ex.getErrorStr());\n }\n {\n const SQLite::Exception ex(msg1, 1);\n EXPECT_STREQ(ex.what(), msg1);\n EXPECT_EQ(ex.getErrorCode(), 1);\n EXPECT_EQ(ex.getExtendedErrorCode(), -1);\n EXPECT_STREQ(ex.getErrorStr(), \"SQL logic error\");\n }\n {\n const SQLite::Exception ex(msg2, 2);\n EXPECT_STREQ(ex.what(), msg2.c_str());\n EXPECT_EQ(ex.getErrorCode(), 2);\n EXPECT_EQ(ex.getExtendedErrorCode(), -1);\n EXPECT_STREQ(ex.getErrorStr(), \"unknown error\");\n }\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9336,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/SQLiteCpp/tests/Column_test.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":13220,"string":"13,220"},"line_count":{"kind":"number","value":300,"string":"300"},"content":{"kind":"string","value":"/**\n * @file Column_test.cpp\n * @ingroup tests\n * @brief Test of a SQLiteCpp Column.\n *\n * Copyright (c) 2012-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)\n *\n * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt\n * or copy at http://opensource.org/licenses/MIT)\n */\n\n#include <SQLiteCpp/Database.h>\n#include <SQLiteCpp/Statement.h>\n#include <SQLiteCpp/Column.h>\n\n#include <gtest/gtest.h>\n\n#include <cstdio>\n#include <stdint.h>\n\n\nstatic void test_column_basis(bool utf16)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n EXPECT_EQ(SQLite::OK, db.getExtendedErrorCode());\n\n if (utf16)\n {\n EXPECT_EQ(0, db.exec(\"PRAGMA encoding = 'UTF-16';\"));\n }\n\n // Create a new table\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, msg TEXT, int INTEGER, double REAL, binary BLOB, empty TEXT)\"));\n EXPECT_TRUE(db.tableExists(\"test\"));\n EXPECT_TRUE(db.tableExists(std::string(\"test\")));\n EXPECT_EQ(0, db.getLastInsertRowid());\n\n // Create a first row (autoid: 1) with all kind of data and a null value\n SQLite::Statement insert(db, \"INSERT INTO test VALUES (NULL, 'first', -123, 0.123, ?, NULL)\");\n // Bind the blob value to the first parameter of the SQL query\n const char buffer[] = {'b', 'l', '\\0', 'b'}; // \"bl\\0b\" : 4 char, with a null byte inside\n const int size = sizeof(buffer); // size = 4\n const void* blob = &buffer;\n insert.bind(1, blob, size);\n // Execute the one-step query to insert the row\n EXPECT_EQ(1, insert.exec());\n EXPECT_EQ(1, db.getLastInsertRowid());\n EXPECT_EQ(1, db.getChanges());\n EXPECT_EQ(1, db.getTotalChanges());\n\n EXPECT_THROW(insert.exec(), SQLite::Exception); // exec() shall throw as it needs to be reseted\n\n // Compile a SQL query\n SQLite::Statement query(db, \"SELECT * FROM test\");\n EXPECT_STREQ(\"SELECT * FROM test\", query.getQuery().c_str());\n EXPECT_EQ(6, query.getColumnCount ());\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n\n // validates every variant of cast operators, and conversions of types\n {\n const int64_t id1 = query.getColumn(0); // operator int64_t()\n const int32_t id2 = query.getColumn(0); // operator int32_t()\n const int id3 = query.getColumn(0); // operator int32_t()\n const int16_t id4 = query.getColumn(0); // operator int32_t()\n const short id5 = query.getColumn(0); // operator int32_t()\n const int8_t id6 = query.getColumn(0); // operator int32_t()\n const char id7 = query.getColumn(0); // operator int32_t()\n const unsigned int uint1 = query.getColumn(0); // operator unsigned int()\n const uint32_t uint2 = query.getColumn(0); // operator unsigned int()\n const unsigned char uint3 = query.getColumn(0); // operator unsigned char()\n const unsigned short uint4 = query.getColumn(0); // operator unsigned short()\n const char* ptxt = query.getColumn(1); // operator const char*()\n const std::string msg = query.getColumn(1); // operator std::string() (or const char* with MSVC)\n const int integer = query.getColumn(2); // operator int()\n const double real = query.getColumn(3); // operator double()\n const void* pblob = query.getColumn(4); // operator void*()\n#if !defined(_MSC_VER) || _MSC_VER >= 1900\n // This implicit cast should use operator std::string()\n // but would fallback to const char* with MSVC 2010-2013 (witch does not work with the NULL char in the middle)\n const std::string sblob = query.getColumn(4); // operator std::string()\n#endif\n const void* pempty = query.getColumn(5); // operator void*()\n EXPECT_EQ(1, id1);\n EXPECT_EQ(1, id2);\n EXPECT_EQ(1, id3);\n EXPECT_EQ(1, id4);\n EXPECT_EQ(1, id5);\n EXPECT_EQ(1, id6);\n EXPECT_EQ(1, id7);\n EXPECT_EQ(1U, uint1);\n EXPECT_EQ(1U, uint2);\n EXPECT_EQ(1U, uint3);\n EXPECT_EQ(1U, uint4);\n EXPECT_STREQ(\"first\", ptxt);\n EXPECT_EQ(\"first\", msg);\n EXPECT_EQ(-123, integer);\n EXPECT_DOUBLE_EQ(0.123, real);\n EXPECT_EQ(0, memcmp(\"bl\\0b\", pblob, size));\n#if !defined(_MSC_VER) || _MSC_VER >= 1900\n EXPECT_EQ((size_t)size, sblob.size());\n EXPECT_EQ(0, memcmp(\"bl\\0b\", &sblob[0], size));\n#endif\n EXPECT_EQ(NULL, pempty);\n }\n\n query.reset();\n query.executeStep();\n\n // validates every variant of explicit getters\n {\n int64_t id = query.getColumn(0).getInt64();\n const unsigned int uint1 = query.getColumn(0).getUInt();\n const uint32_t uint2 = query.getColumn(0).getUInt();\n const std::string msg1 = query.getColumn(1).getString();\n const char* ptxt = query.getColumn(1).getText();\n const std::string msg2 = query.getColumn(1).getText();\n const int integer = query.getColumn(2).getInt();\n const double real = query.getColumn(3).getDouble();\n const void* pblob = query.getColumn(4).getBlob();\n const std::string sblob = query.getColumn(4).getString();\n EXPECT_EQ(1, id);\n EXPECT_EQ(1U, uint1);\n EXPECT_EQ(1U, uint2);\n EXPECT_STREQ(\"first\", ptxt);\n EXPECT_EQ(\"first\", msg1);\n EXPECT_EQ(\"first\", msg2);\n EXPECT_EQ(-123, integer);\n EXPECT_DOUBLE_EQ(0.123, real);\n EXPECT_EQ(0, memcmp(\"bl\\0b\", pblob, 4));\n EXPECT_EQ(0, memcmp(\"bl\\0b\", &sblob[0], 4));\n }\n\n // Validate getBytes(), getType(), isInteger(), isNull()...\n EXPECT_EQ(SQLite::INTEGER, query.getColumn(0).getType());\n EXPECT_EQ(true, query.getColumn(0).isInteger());\n EXPECT_EQ(false, query.getColumn(0).isFloat());\n EXPECT_EQ(false, query.getColumn(0).isText());\n EXPECT_EQ(false, query.getColumn(0).isBlob());\n EXPECT_EQ(false, query.getColumn(0).isNull());\n EXPECT_STREQ(\"1\", query.getColumn(0).getText()); // convert to TEXT via text func\n EXPECT_EQ(1, query.getColumn(0).getBytes()); // size of the string \"1\" without the null terminator\n EXPECT_EQ(SQLite::TEXT, query.getColumn(1).getType());\n EXPECT_EQ(false, query.getColumn(1).isInteger());\n EXPECT_EQ(false, query.getColumn(1).isFloat());\n EXPECT_EQ(true, query.getColumn(1).isText());\n EXPECT_EQ(false, query.getColumn(1).isBlob());\n EXPECT_EQ(false, query.getColumn(1).isNull());\n EXPECT_STREQ(\"first\", query.getColumn(1).getString().c_str()); // convert to TEXT via string func\n EXPECT_EQ(5, query.getColumn(1).getBytes()); // size of the string \"first\"\n EXPECT_EQ(SQLite::INTEGER, query.getColumn(2).getType());\n EXPECT_EQ(true, query.getColumn(2).isInteger());\n EXPECT_EQ(false, query.getColumn(2).isFloat());\n EXPECT_EQ(false, query.getColumn(2).isText());\n EXPECT_EQ(false, query.getColumn(2).isBlob());\n EXPECT_EQ(false, query.getColumn(2).isNull());\n EXPECT_STREQ(\"-123\", query.getColumn(2).getText()); // convert to string\n EXPECT_EQ(4, query.getColumn(2).getBytes()); // size of the string \"-123\"\n EXPECT_EQ(SQLite::FLOAT, query.getColumn(3).getType());\n EXPECT_EQ(false, query.getColumn(3).isInteger());\n EXPECT_EQ(true, query.getColumn(3).isFloat());\n EXPECT_EQ(false, query.getColumn(3).isText());\n EXPECT_EQ(false, query.getColumn(3).isBlob());\n EXPECT_EQ(false, query.getColumn(3).isNull());\n EXPECT_STREQ(\"0.123\", query.getColumn(3).getText()); // convert to string\n EXPECT_EQ(5, query.getColumn(3).getBytes()); // size of the string \"0.123\"\n EXPECT_EQ(SQLite::BLOB, query.getColumn(4).getType());\n EXPECT_EQ(false, query.getColumn(4).isInteger());\n EXPECT_EQ(false, query.getColumn(4).isFloat());\n EXPECT_EQ(false, query.getColumn(4).isText());\n EXPECT_EQ(true, query.getColumn(4).isBlob());\n EXPECT_EQ(false, query.getColumn(4).isNull());\n EXPECT_EQ(4, query.getColumn(4).getBytes()); // size of the blob \"bl\\0b\" with the null char\n EXPECT_EQ(SQLite::Null, query.getColumn(5).getType());\n EXPECT_EQ(false, query.getColumn(5).isInteger());\n EXPECT_EQ(false, query.getColumn(5).isFloat());\n EXPECT_EQ(false, query.getColumn(5).isText());\n EXPECT_EQ(false, query.getColumn(5).isBlob());\n EXPECT_EQ(true, query.getColumn(5).isNull());\n EXPECT_STREQ(\"\", query.getColumn(5).getText()); // convert to string\n EXPECT_EQ(0, query.getColumn(5).getBytes()); // size of the string \"\" without the null terminator\n\n query.reset();\n query.executeStep();\n\n // Use intermediate Column objects (this is not the recommended way to use the API)\n {\n const SQLite::Column id = query.getColumn(0);\n EXPECT_EQ(1, id.getInt64());\n const SQLite::Column msg = query.getColumn(1);\n EXPECT_EQ(\"first\", msg.getString());\n const SQLite::Column integer = query.getColumn(2);\n EXPECT_EQ(-123, integer.getInt());\n const SQLite::Column dbl = query.getColumn(3);\n EXPECT_DOUBLE_EQ(0.123, dbl.getDouble());\n }\n}\n\nTEST(Column, basis)\n{\n test_column_basis(false);\n}\n\nTEST(Column, basis16)\n{\n test_column_basis(true);\n}\n\nTEST(Column, getName)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, msg TEXT)\"));\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'first')\"));\n\n // Compile a SQL query, using the \"id\" column name as-is, but aliasing the \"msg\" column with new name \"value\"\n SQLite::Statement query(db, \"SELECT id, msg as value FROM test\");\n query.executeStep();\n\n // Show how to get the aliased names of the result columns.\n const std::string name0 = query.getColumn(0).getName();\n const std::string name1 = query.getColumn(1).getName();\n EXPECT_EQ(\"id\", name0);\n EXPECT_EQ(\"value\", name1);\n\n#ifdef SQLITE_ENABLE_COLUMN_METADATA\n // Show how to get origin names of the table columns from which theses result columns come from.\n // Requires the SQLITE_ENABLE_COLUMN_METADATA preprocessor macro to be\n // also defined at compile times of the SQLite library itself.\n const std::string oname0 = query.getColumn(0).getOriginName();\n const std::string oname1 = query.getColumn(1).getOriginName();\n EXPECT_EQ(\"id\", oname0);\n EXPECT_EQ(\"msg\", oname1);\n#endif\n}\n\nTEST(Column, stream)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (msg TEXT)\"));\n SQLite::Statement insert(db, \"INSERT INTO test VALUES (?)\");\n\n // content to test\n const char str_[] = \"stringwith\\0embedded\";\n std::string str(str_, sizeof(str_)-1);\n\n insert.bind(1, str);\n // Execute the one-step query to insert the row\n EXPECT_EQ(1, insert.exec());\n EXPECT_EQ(1, db.getChanges());\n EXPECT_EQ(1, db.getTotalChanges());\n\n SQLite::Statement query(db, \"SELECT * FROM test\");\n query.executeStep();\n std::stringstream ss;\n ss << query.getColumn(0);\n std::string content = ss.str();\n EXPECT_EQ(content, str);\n}\n\nTEST(Column, shared_ptr)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, msg TEXT)\"));\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (42, 'fortytwo')\"));\n const char* query_str = \"SELECT id, msg FROM test\";\n\n std::unique_ptr<SQLite::Statement> query{ new SQLite::Statement(db, query_str) };\n query->executeStep();\n \n auto column0 = query->getColumn(0);\n auto column1 = query->getColumn(1);\n query.reset();\n\n EXPECT_EQ(42, column0.getInt());\n EXPECT_STREQ(\"fortytwo\", column1.getText());\n\n query.reset(new SQLite::Statement(db, query_str));\n query->executeStep();\n column0 = query->getColumn(0);\n EXPECT_EQ(true, column0.isInteger());\n query->executeStep(); // query is done\n \n // Undefined behavior\n // auto x = column0.getInt();\n\n query.reset();\n\n // Undefined behavior\n // auto x = column0.getInt();\n // bool isInt = column0.isInteger();\n\n EXPECT_STREQ(\"id\", column0.getName());\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9337,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/SQLiteCpp/tests/VariadicBind_test.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":4076,"string":"4,076"},"line_count":{"kind":"number","value":110,"string":"110"},"content":{"kind":"string","value":"/**\n * @file VariadicBind_test.cpp\n * @ingroup tests\n * @brief Test of variadic bind\n *\n * Copyright (c) 2016 Paul Dreik (github@pauldreik.se)\n * Copyright (c) 2016-2020 Sebastien Rombauts (sebastien.rombauts@gmail.com)\n * Copyright (c) 2019 Maximilian Bachmann (github@maxbachmann)\n *\n * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt\n * or copy at http://opensource.org/licenses/MIT)\n */\n\n#include <SQLiteCpp/Database.h>\n#include <SQLiteCpp/Statement.h>\n#include <SQLiteCpp/VariadicBind.h>\n\n#include <gtest/gtest.h>\n\n#include <cstdio>\n\n#if (__cplusplus >= 201103L) || ( defined(_MSC_VER) && (_MSC_VER >= 1800) ) // c++11: Visual Studio 2013\nTEST(VariadicBind, invalid)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n\n EXPECT_EQ(0, db.exec(\"DROP TABLE IF EXISTS test\"));\n EXPECT_EQ(0,\n db.exec(\n \"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT DEFAULT 'default') \"));\n EXPECT_EQ(0,\n db.exec(\n \"CREATE TABLE test2 (id INTEGER PRIMARY KEY, value TEXT DEFAULT 'default') \"));\n EXPECT_TRUE(db.tableExists(\"test\"));\n EXPECT_TRUE(db.tableExists(\"test2\"));\n\n {\n SQLite::Statement query(db, \"INSERT INTO test VALUES (?, ?)\");\n\n // bind one argument less than expected - should be fine.\n // the unspecified argument should be set to null, not the default.\n SQLite::bind(query, 1);\n EXPECT_EQ(1, query.exec());\n query.reset();\n\n // bind all arguments - should work just fine\n SQLite::bind(query, 2, \"two\");\n EXPECT_EQ(1, query.exec());\n query.reset();\n\n // bind too many arguments - should throw.\n EXPECT_THROW(SQLite::bind(query, 3, \"three\", 0), SQLite::Exception);\n EXPECT_EQ(1, query.exec());\n }\n // make sure the content is as expected\n {\n SQLite::Statement query(db, std::string{\"SELECT id, value FROM test ORDER BY id\"});\n std::vector<std::pair<int, std::string> > results;\n while (query.executeStep())\n {\n const int id = query.getColumn(0);\n std::string value = query.getColumn(1);\n results.emplace_back( id, std::move(value) );\n }\n EXPECT_EQ(std::size_t(3), results.size());\n\n EXPECT_EQ(std::make_pair(1,std::string{\"\"}), results.at(0));\n EXPECT_EQ(std::make_pair(2,std::string{\"two\"}), results.at(1));\n EXPECT_EQ(std::make_pair(3,std::string{\"three\"}), results.at(2));\n }\n #if (__cplusplus >= 201402L) || ( defined(_MSC_VER) && (_MSC_VER >= 1900) ) // c++14: Visual Studio 2015\n {\n SQLite::Statement query(db, \"INSERT INTO test2 VALUES (?, ?)\");\n\n // bind one argument less than expected - should be fine.\n // the unspecified argument should be set to null, not the default.\n SQLite::bind(query, std::make_tuple(1));\n EXPECT_EQ(1, query.exec());\n query.reset();\n\n // bind all arguments - should work just fine\n SQLite::bind(query, std::make_tuple(2, \"two\"));\n EXPECT_EQ(1, query.exec());\n query.reset();\n\n // bind too many arguments - should throw.\n EXPECT_THROW(SQLite::bind(query, std::make_tuple(3, \"three\", 0)), SQLite::Exception);\n EXPECT_EQ(1, query.exec());\n }\n // make sure the content is as expected\n {\n SQLite::Statement query(db, std::string{\"SELECT id, value FROM test2 ORDER BY id\"});\n std::vector<std::pair<int, std::string> > results;\n while (query.executeStep())\n {\n const int id = query.getColumn(0);\n std::string value = query.getColumn(1);\n results.emplace_back( id, std::move(value) );\n }\n EXPECT_EQ(std::size_t(3), results.size());\n\n EXPECT_EQ(std::make_pair(1,std::string{\"\"}), results.at(0));\n EXPECT_EQ(std::make_pair(2,std::string{\"two\"}), results.at(1));\n EXPECT_EQ(std::make_pair(3,std::string{\"three\"}), results.at(2));\n }\n #endif // c++14\n}\n#endif // c++11\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9338,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/SQLiteCpp/tests/Database_test.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":26240,"string":"26,240"},"line_count":{"kind":"number","value":645,"string":"645"},"content":{"kind":"string","value":"/**\n * @file Database_test.cpp\n * @ingroup tests\n * @brief Test of a SQLiteCpp Database.\n *\n * Copyright (c) 2012-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)\n *\n * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt\n * or copy at http://opensource.org/licenses/MIT)\n */\n\n#include <SQLiteCpp/Database.h>\n\n#include <sqlite3.h> // for SQLITE_ERROR and SQLITE_VERSION_NUMBER\n\n#include <gtest/gtest.h>\n\n#ifdef SQLITECPP_HAVE_STD_FILESYSTEM\n#include <filesystem>\n#endif // c++17\n\n#include <cstdio>\n#include <fstream>\n\n#ifdef SQLITECPP_ENABLE_ASSERT_HANDLER\nnamespace SQLite\n{\n/// definition of the assertion handler enabled when SQLITECPP_ENABLE_ASSERT_HANDLER is defined in the project (CMakeList.txt)\nvoid assertion_failed(const char* apFile, const long apLine, const char* apFunc, const char* apExpr, const char* apMsg)\n{\n // TODO: unit test that this assertion callback get called (already tested manually)\n std::cout << \"assertion_failed(\" << apFile << \", \" << apLine << \", \" << apFunc << \", \" << apExpr << \", \" << apMsg << \")\\n\";\n}\n}\n#endif\n\n// NOTE on macOS FindSQLite3 find an unrelated sqlite3.h from Mono.framework that doesn't match the actual package version!\n#if defined(SQLITECPP_INTERNAL_SQLITE) || !defined(__APPLE__)\nTEST(SQLiteCpp, version)\n{\n EXPECT_STREQ(SQLITE_VERSION, SQLite::VERSION);\n EXPECT_EQ (SQLITE_VERSION_NUMBER, SQLite::VERSION_NUMBER);\n EXPECT_STREQ(SQLITE_VERSION, SQLite::getLibVersion());\n EXPECT_EQ (SQLITE_VERSION_NUMBER, SQLite::getLibVersionNumber());\n}\n#endif\n\nTEST(Database, ctorExecCreateDropExist)\n{\n remove(\"test.db3\");\n {\n // Try to open a non-existing database\n std::string filename = \"test.db3\";\n EXPECT_THROW(SQLite::Database not_found(filename), SQLite::Exception);\n\n // Create a new database using a string or a std::filesystem::path if using c++17 and a\n // compatible compiler\n #ifdef SQLITECPP_HAVE_STD_FILESYSTEM\n SQLite::Database db(std::filesystem::path(\"test.db3\"), SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n #else\n SQLite::Database db(\"test.db3\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n #endif // have std::filesystem\n\n EXPECT_STREQ(\"test.db3\", db.getFilename().c_str());\n EXPECT_FALSE(db.tableExists(\"test\"));\n EXPECT_FALSE(db.tableExists(std::string(\"test\")));\n EXPECT_EQ(0, db.getLastInsertRowid());\n\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\"));\n EXPECT_TRUE(db.tableExists(\"test\"));\n EXPECT_TRUE(db.tableExists(std::string(\"test\")));\n EXPECT_EQ(0, db.getLastInsertRowid());\n\n EXPECT_EQ(0, db.exec(\"DROP TABLE IF EXISTS test\"));\n EXPECT_FALSE(db.tableExists(\"test\"));\n EXPECT_FALSE(db.tableExists(std::string(\"test\")));\n EXPECT_EQ(0, db.getLastInsertRowid());\n } // Close DB test.db3\n remove(\"test.db3\");\n}\n\n#if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1600)\n\nSQLite::Database DatabaseBuilder(const char* apName)\n{\n return SQLite::Database(apName, SQLite::OPEN_READWRITE | SQLite::OPEN_CREATE);\n}\n\nTEST(Database, moveConstructor)\n{\n remove(\"test.db3\");\n {\n // Create a new database, using the move constructor\n SQLite::Database db = DatabaseBuilder(\"test.db3\");\n EXPECT_FALSE(db.tableExists(\"test\"));\n EXPECT_TRUE(db.getHandle() != NULL);\n SQLite::Database moved = std::move(db);\n EXPECT_TRUE(db.getHandle() == NULL);\n EXPECT_TRUE(moved.getHandle() != NULL);\n EXPECT_FALSE(moved.tableExists(\"test\"));\n } // Close DB test.db3\n remove(\"test.db3\");\n}\n\n#endif\n\nTEST(Database, createCloseReopen)\n{\n remove(\"test.db3\");\n {\n // Try to open the non-existing database\n EXPECT_THROW(SQLite::Database not_found(\"test.db3\"), SQLite::Exception);\n\n // Create a new database\n SQLite::Database db(\"test.db3\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n EXPECT_FALSE(db.tableExists(\"test\"));\n db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\");\n EXPECT_TRUE(db.tableExists(\"test\"));\n } // Close DB test.db3\n {\n // Reopen the database file\n SQLite::Database db(\"test.db3\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n EXPECT_TRUE(db.tableExists(\"test\"));\n } // Close DB test.db3\n remove(\"test.db3\");\n}\n\nTEST(Database, inMemory)\n{\n {\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE);\n EXPECT_FALSE(db.tableExists(\"test\"));\n db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\");\n EXPECT_TRUE(db.tableExists(\"test\"));\n // Create a new database: not shared with the above db\n SQLite::Database db2(\":memory:\");\n EXPECT_FALSE(db2.tableExists(\"test\"));\n } // Close an destroy DBs\n {\n // Create a new database: no more \"test\" table\n SQLite::Database db(\":memory:\");\n EXPECT_FALSE(db.tableExists(\"test\"));\n } // Close an destroy DB\n}\n\nTEST(Database, backup)\n{\n // Create a new in-memory database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE);\n EXPECT_FALSE(db.tableExists(\"test\"));\n db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\");\n EXPECT_TRUE(db.tableExists(\"test\"));\n\n // Export the data into a file\n remove(\"backup.db3\");\n EXPECT_NO_THROW(db.backup(\"backup.db3\", SQLite::Database::Save));\n\n // Trash the table\n db.exec(\"DROP TABLE test;\");\n EXPECT_FALSE(db.tableExists(\"test\"));\n\n // Import the data back from the file\n EXPECT_NO_THROW(db.backup(\"backup.db3\", SQLite::Database::Load));\n remove(\"backup.db3\");\n\n EXPECT_TRUE(db.tableExists(\"test\"));\n}\n\n#if SQLITE_VERSION_NUMBER >= 3007015 // SQLite v3.7.15 is first version with PRAGMA busy_timeout\nTEST(Database, busyTimeout)\n{\n {\n // Create a new database with default timeout of 0ms\n SQLite::Database db(\":memory:\");\n // Busy timeout default to 0ms: any contention between threads or process leads to SQLITE_BUSY error\n EXPECT_EQ(0, db.execAndGet(\"PRAGMA busy_timeout\").getInt());\n\n // Set a non null busy timeout: any contention between threads will leads to as much retry as possible during the time\n db.setBusyTimeout(5000);\n EXPECT_EQ(5000, db.execAndGet(\"PRAGMA busy_timeout\").getInt());\n\n // Reset timeout to 0\n db.setBusyTimeout(0);\n EXPECT_EQ(0, db.execAndGet(\"PRAGMA busy_timeout\").getInt());\n }\n {\n // Create a new database with a non null busy timeout\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE, 5000);\n EXPECT_EQ(5000, db.execAndGet(\"PRAGMA busy_timeout\").getInt());\n\n // Reset timeout to null\n db.setBusyTimeout(0);\n EXPECT_EQ(0, db.execAndGet(\"PRAGMA busy_timeout\").getInt());\n }\n {\n // Create a new database with a non null busy timeout\n const std::string memory = \":memory:\";\n SQLite::Database db(memory, SQLite::OPEN_READWRITE, 5000);\n EXPECT_EQ(5000, db.execAndGet(\"PRAGMA busy_timeout\").getInt());\n\n // Reset timeout to null\n db.setBusyTimeout(0);\n EXPECT_EQ(0, db.execAndGet(\"PRAGMA busy_timeout\").getInt());\n }\n}\n#endif // SQLITE_VERSION_NUMBER >= 3007015\n\nTEST(Database, exec)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE);\n\n // Create a new table with an explicit \"id\" column aliasing the underlying rowid\n // NOTE: here exec() returns 0 only because it is the first statements since database connexion,\n // but its return is an undefined value for \"CREATE TABLE\" statements.\n db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\");\n EXPECT_EQ(0, db.getChanges());\n EXPECT_EQ(0, db.getLastInsertRowid());\n EXPECT_EQ(0, db.getTotalChanges());\n\n // first row : insert the \"first\" text value into new row of id 1\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'first')\"));\n EXPECT_EQ(1, db.getChanges());\n EXPECT_EQ(1, db.getLastInsertRowid());\n EXPECT_EQ(1, db.getTotalChanges());\n\n // second row : insert the \"second\" text value into new row of id 2\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'second')\"));\n EXPECT_EQ(1, db.getChanges());\n EXPECT_EQ(2, db.getLastInsertRowid());\n EXPECT_EQ(2, db.getTotalChanges());\n\n // third row : insert the \"third\" text value into new row of id 3\n const std::string insert(\"INSERT INTO test VALUES (NULL, 'third')\");\n EXPECT_EQ(1, db.exec(insert));\n EXPECT_EQ(1, db.getChanges());\n EXPECT_EQ(3, db.getLastInsertRowid());\n EXPECT_EQ(3, db.getTotalChanges());\n\n // update the second row : update text value to \"second_updated\"\n EXPECT_EQ(1, db.exec(\"UPDATE test SET value='second-updated' WHERE id='2'\"));\n EXPECT_EQ(1, db.getChanges());\n EXPECT_EQ(3, db.getLastInsertRowid()); // last inserted row ID is still 3\n EXPECT_EQ(4, db.getTotalChanges());\n\n // delete the third row\n EXPECT_EQ(1, db.exec(\"DELETE FROM test WHERE id='3'\"));\n EXPECT_EQ(1, db.getChanges());\n EXPECT_EQ(3, db.getLastInsertRowid());\n EXPECT_EQ(5, db.getTotalChanges());\n\n // drop the whole table, ie the two remaining columns\n // NOTE: here exec() returns 1, like the last time, as it is an undefined value for \"DROP TABLE\" statements\n db.exec(\"DROP TABLE IF EXISTS test\");\n EXPECT_FALSE(db.tableExists(\"test\"));\n EXPECT_EQ(5, db.getTotalChanges());\n\n // Re-Create the same table\n // NOTE: here exec() returns 1, like the last time, as it is an undefined value for \"CREATE TABLE\" statements\n db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\");\n EXPECT_EQ(5, db.getTotalChanges());\n\n // insert two rows with two *different* statements => returns only 1, ie. for the second INSERT statement\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'first');INSERT INTO test VALUES (NULL, 'second');\"));\n EXPECT_EQ(1, db.getChanges());\n EXPECT_EQ(2, db.getLastInsertRowid());\n EXPECT_EQ(7, db.getTotalChanges());\n\n#if (SQLITE_VERSION_NUMBER >= 3007011)\n // insert two rows with only one statement (starting with SQLite 3.7.11) => returns 2\n EXPECT_EQ(2, db.exec(\"INSERT INTO test VALUES (NULL, 'third'), (NULL, 'fourth');\"));\n EXPECT_EQ(2, db.getChanges());\n EXPECT_EQ(4, db.getLastInsertRowid());\n EXPECT_EQ(9, db.getTotalChanges());\n#endif\n}\n\nTEST(Database, tryExec)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE);\n\n // Create a new table with an explicit \"id\" column aliasing the underlying rowid\n EXPECT_EQ(SQLite::OK, db.tryExec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\"));\n EXPECT_EQ(0, db.getChanges());\n EXPECT_EQ(0, db.getLastInsertRowid());\n EXPECT_EQ(0, db.getTotalChanges());\n\n // first row : insert the \"first\" text value into new row of id 1\n EXPECT_EQ(SQLite::OK, db.tryExec(\"INSERT INTO test VALUES (NULL, 'first')\"));\n EXPECT_EQ(1, db.getChanges());\n EXPECT_EQ(1, db.getLastInsertRowid());\n EXPECT_EQ(1, db.getTotalChanges());\n\n // second row : insert the \"second\" text value into new row of id 2\n EXPECT_EQ(SQLite::OK, db.tryExec(\"INSERT INTO test VALUES (NULL, 'second')\"));\n EXPECT_EQ(1, db.getChanges());\n EXPECT_EQ(2, db.getLastInsertRowid());\n EXPECT_EQ(2, db.getTotalChanges());\n\n // third row : insert the \"third\" text value into new row of id 3\n const std::string insert(\"INSERT INTO test VALUES (NULL, 'third')\");\n EXPECT_EQ(SQLite::OK, db.tryExec(insert));\n EXPECT_EQ(1, db.getChanges());\n EXPECT_EQ(3, db.getLastInsertRowid());\n EXPECT_EQ(3, db.getTotalChanges());\n\n // update the second row : update text value to \"second_updated\"\n EXPECT_EQ(SQLite::OK, db.tryExec(\"UPDATE test SET value='second-updated' WHERE id='2'\"));\n EXPECT_EQ(1, db.getChanges());\n EXPECT_EQ(3, db.getLastInsertRowid()); // last inserted row ID is still 3\n EXPECT_EQ(4, db.getTotalChanges());\n\n // delete the third row\n EXPECT_EQ(SQLite::OK, db.tryExec(\"DELETE FROM test WHERE id='3'\"));\n EXPECT_EQ(1, db.getChanges());\n EXPECT_EQ(3, db.getLastInsertRowid());\n EXPECT_EQ(5, db.getTotalChanges());\n\n // drop the whole table, ie the two remaining columns\n EXPECT_EQ(SQLite::OK, db.tryExec(\"DROP TABLE IF EXISTS test\"));\n EXPECT_FALSE(db.tableExists(\"test\"));\n EXPECT_EQ(5, db.getTotalChanges());\n\n // Re-Create the same table\n EXPECT_EQ(SQLite::OK, db.tryExec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\"));\n EXPECT_EQ(5, db.getTotalChanges());\n\n // insert two rows with two *different* statements => only 1 change, ie. for the second INSERT statement\n EXPECT_EQ(SQLite::OK, db.tryExec(\"INSERT INTO test VALUES (NULL, 'first');INSERT INTO test VALUES (NULL, 'second');\"));\n EXPECT_EQ(1, db.getChanges());\n EXPECT_EQ(2, db.getLastInsertRowid());\n EXPECT_EQ(7, db.getTotalChanges());\n\n#if (SQLITE_VERSION_NUMBER >= 3007011)\n // insert two rows with only one statement (starting with SQLite 3.7.11)\n EXPECT_EQ(SQLite::OK, db.tryExec(\"INSERT INTO test VALUES (NULL, 'third'), (NULL, 'fourth');\"));\n EXPECT_EQ(2, db.getChanges());\n EXPECT_EQ(4, db.getLastInsertRowid());\n EXPECT_EQ(9, db.getTotalChanges());\n#endif\n}\n\nTEST(Database, execAndGet)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE);\n\n // Create a new table with an explicit \"id\" column aliasing the underlying rowid\n db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT, weight INTEGER)\");\n\n // insert a few rows\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'first', 3)\"));\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'second', 5)\"));\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'third', 7)\"));\n\n // Get a single value result with an easy to use shortcut\n EXPECT_STREQ(\"second\", db.execAndGet(\"SELECT value FROM test WHERE id=2\"));\n EXPECT_STREQ(\"third\", db.execAndGet(\"SELECT value FROM test WHERE weight=7\"));\n const std::string query(\"SELECT weight FROM test WHERE value='first'\");\n EXPECT_EQ(3, db.execAndGet(query).getInt());\n}\n\nTEST(Database, execException)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE);\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n EXPECT_EQ(SQLite::OK, db.getExtendedErrorCode());\n\n // exception with SQL error: \"no such table\"\n EXPECT_THROW(db.exec(\"INSERT INTO test VALUES (NULL, 'first', 3)\"), SQLite::Exception);\n EXPECT_EQ(SQLITE_ERROR, db.getErrorCode());\n EXPECT_EQ(SQLITE_ERROR, db.getExtendedErrorCode());\n EXPECT_STREQ(\"no such table: test\", db.getErrorMsg());\n\n // Create a new table\n db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT, weight INTEGER)\");\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n EXPECT_EQ(SQLite::OK, db.getExtendedErrorCode());\n EXPECT_STREQ(\"not an error\", db.getErrorMsg());\n\n // exception with SQL error: \"table test has 3 columns but 2 values were supplied\"\n EXPECT_THROW(db.exec(\"INSERT INTO test VALUES (NULL, 3)\"), SQLite::Exception);\n EXPECT_EQ(SQLITE_ERROR, db.getErrorCode());\n EXPECT_EQ(SQLITE_ERROR, db.getExtendedErrorCode());\n EXPECT_STREQ(\"table test has 3 columns but 2 values were supplied\", db.getErrorMsg());\n\n // exception with SQL error: \"No row to get a column from\"\n EXPECT_THROW(db.execAndGet(\"SELECT weight FROM test WHERE value='first'\"), SQLite::Exception);\n\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'first', 3)\"));\n // exception with SQL error: \"No row to get a column from\"\n EXPECT_THROW(db.execAndGet(\"SELECT weight FROM test WHERE value='second'\"), SQLite::Exception);\n\n // Add a row with more values than columns in the table: \"table test has 3 columns but 4 values were supplied\"\n EXPECT_THROW(db.exec(\"INSERT INTO test VALUES (NULL, 'first', 123, 0.123)\"), SQLite::Exception);\n EXPECT_EQ(SQLITE_ERROR, db.getErrorCode());\n EXPECT_EQ(SQLITE_ERROR, db.getExtendedErrorCode());\n EXPECT_STREQ(\"table test has 3 columns but 4 values were supplied\", db.getErrorMsg());\n}\n\nTEST(Database, tryExecError)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE);\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n EXPECT_EQ(SQLite::OK, db.getExtendedErrorCode());\n\n // Insert into nonexistent table: \"no such table\"\n EXPECT_EQ(SQLITE_ERROR, db.tryExec(\"INSERT INTO test VALUES (NULL, 'first', 3)\"));\n EXPECT_EQ(SQLITE_ERROR, db.getErrorCode());\n EXPECT_EQ(SQLITE_ERROR, db.getExtendedErrorCode());\n EXPECT_STREQ(\"no such table: test\", db.getErrorMsg());\n\n // Create a new table\n EXPECT_EQ(SQLite::OK, db.tryExec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT, weight INTEGER)\"));\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n EXPECT_EQ(SQLite::OK, db.getExtendedErrorCode());\n EXPECT_STREQ(\"not an error\", db.getErrorMsg());\n\n // Add a row with fewer values than columns in the table: \"table test has 3 columns but 2 values were supplied\"\n EXPECT_EQ(SQLITE_ERROR, db.tryExec(\"INSERT INTO test VALUES (NULL, 3)\"));\n EXPECT_EQ(SQLITE_ERROR, db.getErrorCode());\n EXPECT_EQ(SQLITE_ERROR, db.getExtendedErrorCode());\n EXPECT_STREQ(\"table test has 3 columns but 2 values were supplied\", db.getErrorMsg());\n\n // Add a row with more values than columns in the table: \"table test has 3 columns but 4 values were supplied\"\n EXPECT_EQ(SQLITE_ERROR, db.tryExec(\"INSERT INTO test VALUES (NULL, 'first', 123, 0.123)\"));\n EXPECT_EQ(SQLITE_ERROR, db.getErrorCode());\n EXPECT_EQ(SQLITE_ERROR, db.getExtendedErrorCode());\n EXPECT_STREQ(\"table test has 3 columns but 4 values were supplied\", db.getErrorMsg());\n\n // Create a first row\n EXPECT_EQ(SQLite::OK, db.tryExec(\"INSERT INTO test VALUES (NULL, 'first', 3)\"));\n EXPECT_EQ(1, db.getLastInsertRowid());\n\n // Try to insert a new row with the same PRIMARY KEY: \"UNIQUE constraint failed: test.id\"\n EXPECT_EQ(SQLITE_CONSTRAINT, db.tryExec(\"INSERT INTO test VALUES (1, 'impossible', 456)\"));\n EXPECT_EQ(SQLITE_CONSTRAINT, db.getErrorCode());\n EXPECT_EQ(SQLITE_CONSTRAINT_PRIMARYKEY, db.getExtendedErrorCode());\n EXPECT_STREQ(\"UNIQUE constraint failed: test.id\", db.getErrorMsg());\n}\n\n// From https://stackoverflow.com/a/8283265/1163698 How can I create a user-defined function in SQLite?\nstatic void firstchar(sqlite3_context *context, int argc, sqlite3_value **argv)\n{\n if (argc == 1)\n {\n const unsigned char *text = sqlite3_value_text(argv[0]);\n if (text && text[0])\n {\n char result[2];\n result[0] = text[0]; result[1] = '\\0';\n sqlite3_result_text(context, result, -1, SQLITE_TRANSIENT);\n return;\n }\n }\n sqlite3_result_null(context);\n}\n\nTEST(Database, createFunction)\n{\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE);\n db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\");\n\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'first')\"));\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'second')\"));\n\n // exception with SQL error: \"no such function: firstchar\"\n EXPECT_THROW(db.exec(\"SELECT firstchar(value) FROM test WHERE id=1\"), SQLite::Exception);\n\n db.createFunction(\"firstchar\", 1, true, nullptr, &firstchar, nullptr, nullptr, nullptr);\n \n EXPECT_EQ(1, db.exec(\"SELECT firstchar(value) FROM test WHERE id=1\"));\n}\n\nTEST(Database, loadExtension)\n{\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE);\n\n // Try to load a non-existing extension (no dynamic library found)\n EXPECT_THROW(db.loadExtension(\"non-existing-extension\", \"entry-point\"), SQLite::Exception);\n\n // TODO: test a proper extension\n}\n\nTEST(Database, getHeaderInfo)\n{\n remove(\"test.db3\");\n {\n // Call without passing a database file name\n EXPECT_THROW(SQLite::Database::getHeaderInfo(\"\"),SQLite::Exception);\n\n // Call with a non-existent database\n EXPECT_THROW(SQLite::Database::getHeaderInfo(\"test.db3\"), SQLite::Exception);\n\n // Simulate an incomplete header by writing garbage to a file\n {\n const unsigned char badData[] = \"garbage...\";\n const char* pBadData = reinterpret_cast<const char*>(&badData[0]);\n\n remove(\"short.db3\");\n std::ofstream corruptDb;\n corruptDb.open(\"short.db3\", std::ios::app | std::ios::binary);\n corruptDb.write(pBadData, sizeof(badData));\n corruptDb.close();\n\n EXPECT_THROW(SQLite::Database::getHeaderInfo(\"short.db3\"), SQLite::Exception);\n remove(\"short.db3\");\n }\n\n // Simulate a corrupt header by writing garbage to a file\n {\n const unsigned char badData[100] = \"garbage...\";\n const char* pBadData = reinterpret_cast<const char*>(&badData[0]);\n\n remove(\"corrupt.db3\");\n std::ofstream corruptDb;\n corruptDb.open(\"corrupt.db3\", std::ios::app | std::ios::binary);\n corruptDb.write(pBadData, sizeof(badData));\n corruptDb.close();\n\n EXPECT_THROW(SQLite::Database::getHeaderInfo(\"corrupt.db3\"), SQLite::Exception);\n remove(\"corrupt.db3\");\n }\n\n // Create a new database\n SQLite::Database db(\"test.db3\", SQLite::OPEN_READWRITE | SQLite::OPEN_CREATE);\n db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\");\n\n // Set assorted SQLite header values using associated PRAGMA\n db.exec(\"PRAGMA main.user_version = 12345\");\n db.exec(\"PRAGMA main.application_id = 2468\");\n\n // Parse header fields from test database\n const SQLite::Header h = db.getHeaderInfo();\n\n //Test header values explicitly set via PRAGMA statements\n EXPECT_EQ(h.userVersion, 12345);\n EXPECT_EQ(h.applicationId, 2468);\n\n //Test header values with expected default values\n EXPECT_EQ(h.pageSizeBytes, 4096);\n EXPECT_EQ(h.fileFormatWriteVersion,1);\n EXPECT_EQ(h.fileFormatReadVersion,1);\n EXPECT_EQ(h.reservedSpaceBytes,0);\n EXPECT_EQ(h.maxEmbeddedPayloadFrac, 64);\n EXPECT_EQ(h.minEmbeddedPayloadFrac, 32);\n EXPECT_EQ(h.leafPayloadFrac, 32);\n EXPECT_EQ(h.fileChangeCounter, 3);\n EXPECT_EQ(h.databaseSizePages, 2);\n EXPECT_EQ(h.firstFreelistTrunkPage, 0);\n EXPECT_EQ(h.totalFreelistPages, 0);\n EXPECT_EQ(h.schemaCookie, 1);\n EXPECT_EQ(h.schemaFormatNumber, 4);\n EXPECT_EQ(h.defaultPageCacheSizeBytes, 0);\n EXPECT_EQ(h.largestBTreePageNumber, 0);\n EXPECT_EQ(h.databaseTextEncoding, 1);\n EXPECT_EQ(h.incrementalVaccumMode, 0);\n EXPECT_EQ(h.versionValidFor, 3);\n// NOTE on macOS FindSQLite3 find an unrelated sqlite3.h from Mono.framework that doesn't match the actual package version!\n#if defined(SQLITECPP_INTERNAL_SQLITE) || !defined(__APPLE__)\n EXPECT_EQ(h.sqliteVersion, SQLITE_VERSION_NUMBER);\n#endif\n }\n remove(\"test.db3\");\n}\n\n#ifdef SQLITE_HAS_CODEC\nTEST(Database, encryptAndDecrypt)\n{\n remove(\"test.db3\");\n {\n // Try to open the non-existing database\n EXPECT_THROW(SQLite::Database not_found(\"test.db3\"), SQLite::Exception);\n EXPECT_THROW(SQLite::Database::isUnencrypted(\"test.db3\"), SQLite::Exception);\n EXPECT_THROW(SQLite::Database::isUnencrypted(\"\"), SQLite::Exception);\n\n // Create a new database\n SQLite::Database db(\"test.db3\", SQLite::OPEN_READWRITE | SQLite::OPEN_CREATE);\n EXPECT_FALSE(db.tableExists(\"test\"));\n db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\");\n EXPECT_TRUE(db.tableExists(\"test\"));\n } // Close DB test.db3\n {\n // Reopen the database file and encrypt it\n EXPECT_TRUE(SQLite::Database::isUnencrypted(\"test.db3\"));\n SQLite::Database db(\"test.db3\", SQLite::OPEN_READWRITE);\n // Encrypt the database\n db.rekey(\"123secret\");\n } // Close DB test.db3\n {\n // Reopen the database file and try to use it\n EXPECT_FALSE(SQLite::Database::isUnencrypted(\"test.db3\"));\n SQLite::Database db(\"test.db3\", SQLite::OPEN_READONLY);\n EXPECT_THROW(db.tableExists(\"test\"), SQLite::Exception);\n db.key(\"123secret\");\n EXPECT_TRUE(db.tableExists(\"test\"));\n } // Close DB test.db3\n {\n // Reopen the database file and decrypt it\n EXPECT_FALSE(SQLite::Database::isUnencrypted(\"test.db3\"));\n SQLite::Database db(\"test.db3\", SQLite::OPEN_READWRITE);\n // Decrypt the database\n db.key(\"123secret\");\n db.rekey(\"\");\n } // Close DB test.db3\n {\n // Reopen the database file and use it\n EXPECT_TRUE(SQLite::Database::isUnencrypted(\"test.db3\"));\n SQLite::Database db(\"test.db3\", SQLite::OPEN_READWRITE);\n EXPECT_TRUE(db.tableExists(\"test\"));\n } // Close DB test.db3\n remove(\"test.db3\");\n}\n#else // SQLITE_HAS_CODEC\nTEST(Database, encryptAndDecrypt)\n{\n remove(\"test.db3\");\n {\n // Try to open the non-existing database\n EXPECT_THROW(SQLite::Database not_found(\"test.db3\"), SQLite::Exception);\n EXPECT_THROW(SQLite::Database::isUnencrypted(\"test.db3\"), SQLite::Exception);\n EXPECT_THROW(SQLite::Database::isUnencrypted(\"\"), SQLite::Exception);\n\n // Create a new database\n SQLite::Database db(\"test.db3\", SQLite::OPEN_READWRITE | SQLite::OPEN_CREATE);\n EXPECT_FALSE(db.tableExists(\"test\"));\n db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\");\n EXPECT_TRUE(db.tableExists(\"test\"));\n } // Close DB test.db3\n {\n // Reopen the database file and encrypt it\n EXPECT_TRUE(SQLite::Database::isUnencrypted(\"test.db3\"));\n SQLite::Database db(\"test.db3\", SQLite::OPEN_READWRITE);\n // Encrypt the database\n EXPECT_THROW(db.key(\"123secret\"), SQLite::Exception);\n EXPECT_THROW(db.rekey(\"123secret\"), SQLite::Exception);\n } // Close DB test.db3\n remove(\"test.db3\");\n}\n#endif // SQLITE_HAS_CODEC\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9339,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/SQLiteCpp/tests/Savepoint_test.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":3331,"string":"3,331"},"line_count":{"kind":"number","value":107,"string":"107"},"content":{"kind":"string","value":"/**\n * @file Savepoint_test.cpp\n * @ingroup tests\n * @brief Test of a SQLite Savepoint.\n *\n * Copyright (c) 2020 Kelvin Hammond (hammond.kelvin@gmail.com)\n *\n * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt or\n * copy at http://opensource.org/licenses/MIT)\n */\n\n#include <SQLiteCpp/Database.h>\n#include <SQLiteCpp/Exception.h>\n#include <SQLiteCpp/Savepoint.h>\n#include <SQLiteCpp/Statement.h>\n#include <SQLiteCpp/Transaction.h>\n#include <gtest/gtest.h>\n\n#include <cstdio>\n\nTEST(Savepoint, commitRollback)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE | SQLite::OPEN_CREATE);\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n \n {\n // Begin savepoint\n SQLite::Savepoint savepoint(db, \"sp1\");\n\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\"));\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n\n // Insert a first value\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'first')\"));\n EXPECT_EQ(1, db.getLastInsertRowid());\n\n // release savepoint\n savepoint.release();\n\n // Commit again throw an exception\n EXPECT_THROW(savepoint.release(), SQLite::Exception);\n EXPECT_THROW(savepoint.rollback(), SQLite::Exception);\n }\n\n // Auto rollback if no release() before the end of scope\n {\n // Begin savepoint\n SQLite::Savepoint savepoint(db, \"sp2\");\n\n // Insert a second value (that will be rollbacked)\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'third')\"));\n EXPECT_EQ(2, db.getLastInsertRowid());\n\n // end of scope: automatic rollback\n }\n\n // Auto rollback of a transaction on error / exception\n try\n {\n // Begin savepoint\n SQLite::Savepoint savepoint(db, \"sp3\");\n\n // Insert a second value (that will be rollbacked)\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'second')\"));\n EXPECT_EQ(2, db.getLastInsertRowid());\n\n // Execute with an error => exception with auto-rollback\n db.exec(\"DesiredSyntaxError to raise an exception to rollback the transaction\");\n\n GTEST_FATAL_FAILURE_(\"we should never get there\");\n savepoint.release(); // We should never get there\n }\n catch (std::exception& e)\n {\n std::cout << \"SQLite exception: \" << e.what() << std::endl;\n // expected error, see above\n }\n\n // Double rollback with a manual command before the end of scope\n {\n // Begin savepoint\n SQLite::Savepoint savepoint(db, \"sp4\");\n\n // Insert a second value (that will be rollbacked)\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'third')\"));\n EXPECT_EQ(2, db.getLastInsertRowid());\n\n // Execute a manual rollback\n savepoint.rollback();\n\n // end of scope: the automatic rollback should not raise an error because it is harmless\n }\n\n // Check the results (expect only one row of result, as all other one have\n // been rollbacked)\n SQLite::Statement query(db, \"SELECT * FROM test\");\n int nbRows = 0;\n while (query.executeStep())\n {\n nbRows++;\n EXPECT_EQ(1, query.getColumn(0).getInt());\n EXPECT_STREQ(\"first\", query.getColumn(1).getText());\n }\n EXPECT_EQ(1, nbRows);\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9340,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/SQLiteCpp/tests/Backup_test.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":5191,"string":"5,191"},"line_count":{"kind":"number","value":128,"string":"128"},"content":{"kind":"string","value":"/**\n * @file Backup_test.cpp\n * @ingroup tests\n * @brief Test of a SQLite Backup.\n *\n * Copyright (c) 2015 Shibao HONG (shibaohong@outlook.com)\n * Copyright (c) 2015-2020 Sebastien Rombauts (sebastien.rombauts@gmail.com)\n *\n * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt\n * or copy at http://opensource.org/licenses/MIT)\n */\n\n#include <SQLiteCpp/Backup.h>\n#include <SQLiteCpp/Database.h>\n#include <SQLiteCpp/Statement.h>\n#include <SQLiteCpp/Exception.h>\n\n#include <sqlite3.h> // for SQLITE_ERROR, SQLITE_RANGE and SQLITE_DONE\n\n#include <gtest/gtest.h>\n\n#include <cstdio>\n\nTEST(Backup, initException)\n{\n remove(\"backup_test.db3\");\n {\n SQLite::Database srcDB(\"backup_test.db3\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n srcDB.exec(\"CREATE TABLE backup_test (id INTEGER PRIMARY KEY, value TEXT)\");\n ASSERT_EQ(1, srcDB.exec(\"INSERT INTO backup_test VALUES (1, 'first')\"));\n ASSERT_EQ(1, srcDB.exec(\"INSERT INTO backup_test VALUES (2, 'second')\"));\n EXPECT_THROW(SQLite::Backup backup(srcDB, srcDB), SQLite::Exception);\n EXPECT_THROW(SQLite::Backup backup(srcDB, \"main\", srcDB, \"main\"), SQLite::Exception);\n const std::string name(\"main\");\n EXPECT_THROW(SQLite::Backup backup(srcDB, name, srcDB, name), SQLite::Exception);\n }\n remove(\"backup_test.db3\");\n}\n\nTEST(Backup, executeStepOne)\n{\n remove(\"backup_test.db3\");\n remove(\"backup_test.db3.backup\");\n {\n SQLite::Database srcDB(\"backup_test.db3\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n srcDB.exec(\"CREATE TABLE backup_test (id INTEGER PRIMARY KEY, value TEXT)\");\n ASSERT_EQ(1, srcDB.exec(\"INSERT INTO backup_test VALUES (1, 'first')\"));\n ASSERT_EQ(1, srcDB.exec(\"INSERT INTO backup_test VALUES (2, 'second')\"));\n\n SQLite::Database destDB(\"backup_test.db3.backup\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n SQLite::Backup backup(destDB, \"main\", srcDB, \"main\");\n int res = backup.executeStep(1); // backup only one page at a time\n ASSERT_EQ(SQLite::OK, res);\n const int total = backup.getTotalPageCount();\n ASSERT_EQ(2, total);\n int remaining = backup.getRemainingPageCount();\n ASSERT_EQ(1, remaining);\n res = backup.executeStep(1); // backup the second and last page\n ASSERT_EQ(SQLITE_DONE, res);\n remaining = backup.getRemainingPageCount();\n ASSERT_EQ(0, remaining);\n\n SQLite::Statement query(destDB, \"SELECT * FROM backup_test ORDER BY id ASC\");\n ASSERT_TRUE(query.executeStep());\n EXPECT_EQ(1, query.getColumn(0).getInt());\n EXPECT_STREQ(\"first\", query.getColumn(1));\n ASSERT_TRUE(query.executeStep());\n EXPECT_EQ(2, query.getColumn(0).getInt());\n EXPECT_STREQ(\"second\", query.getColumn(1));\n }\n remove(\"backup_test.db3\");\n remove(\"backup_test.db3.backup\");\n}\n\nTEST(Backup, executeStepAll)\n{\n remove(\"backup_test.db3\");\n remove(\"backup_test.db3.backup\");\n {\n SQLite::Database srcDB(\"backup_test.db3\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n srcDB.exec(\"CREATE TABLE backup_test (id INTEGER PRIMARY KEY, value TEXT)\");\n ASSERT_EQ(1, srcDB.exec(\"INSERT INTO backup_test VALUES (1, 'first')\"));\n ASSERT_EQ(1, srcDB.exec(\"INSERT INTO backup_test VALUES (2, 'second')\"));\n\n SQLite::Database destDB(\"backup_test.db3.backup\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n SQLite::Backup backup(destDB, srcDB);\n const int res = backup.executeStep(); // uses default argument \"-1\" => execute all steps at once\n ASSERT_EQ(res, SQLITE_DONE);\n const int total = backup.getTotalPageCount();\n ASSERT_EQ(2, total);\n const int remaining = backup.getRemainingPageCount();\n ASSERT_EQ(0, remaining);\n\n SQLite::Statement query(destDB, \"SELECT * FROM backup_test ORDER BY id ASC\");\n ASSERT_TRUE(query.executeStep());\n EXPECT_EQ(1, query.getColumn(0).getInt());\n EXPECT_STREQ(\"first\", query.getColumn(1));\n ASSERT_TRUE(query.executeStep());\n EXPECT_EQ(2, query.getColumn(0).getInt());\n EXPECT_STREQ(\"second\", query.getColumn(1));\n }\n remove(\"backup_test.db3\");\n remove(\"backup_test.db3.backup\");\n}\n\nTEST(Backup, executeStepException)\n{\n remove(\"backup_test.db3\");\n remove(\"backup_test.db3.backup\");\n {\n SQLite::Database srcDB(\"backup_test.db3\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n srcDB.exec(\"CREATE TABLE backup_test (id INTEGER PRIMARY KEY, value TEXT)\");\n ASSERT_EQ(1, srcDB.exec(\"INSERT INTO backup_test VALUES (1, 'first')\"));\n ASSERT_EQ(1, srcDB.exec(\"INSERT INTO backup_test VALUES (2, 'second')\"));\n {\n SQLite::Database destDB(\"backup_test.db3.backup\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n (void)destDB;\n }\n {\n SQLite::Database destDB(\"backup_test.db3.backup\", SQLite::OPEN_READONLY);\n SQLite::Backup backup(destDB, srcDB);\n EXPECT_THROW(backup.executeStep(), SQLite::Exception);\n }\n }\n remove(\"backup_test.db3\");\n remove(\"backup_test.db3.backup\");\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9341,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/SQLiteCpp/tests/Statement_test.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":38576,"string":"38,576"},"line_count":{"kind":"number","value":1029,"string":"1,029"},"content":{"kind":"string","value":"/**\n * @file Statement_test.cpp\n * @ingroup tests\n * @brief Test of a SQLiteCpp Statement.\n *\n * Copyright (c) 2012-2020 Sebastien Rombauts (sebastien.rombauts@gmail.com)\n *\n * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt\n * or copy at http://opensource.org/licenses/MIT)\n */\n\n#include <SQLiteCpp/Database.h>\n#include <SQLiteCpp/Statement.h>\n\n#include <cstdint> // for int64_t\n#include <sqlite3.h> // for SQLITE_DONE\n\n#include <gtest/gtest.h>\n\n#include <cstdio>\n#include <stdint.h>\n\n#include <climits> // For INT_MAX\n\nTEST(Statement, invalid)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n EXPECT_EQ(SQLite::OK, db.getExtendedErrorCode());\n\n // Compile a SQL query, but without any table in the database\n EXPECT_THROW(SQLite::Statement query(db, \"SELECT * FROM test\"), SQLite::Exception);\n EXPECT_EQ(SQLITE_ERROR, db.getErrorCode());\n EXPECT_EQ(SQLITE_ERROR, db.getExtendedErrorCode());\n\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\"));\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n EXPECT_EQ(SQLite::OK, db.getExtendedErrorCode());\n\n // Compile a SQL query with no parameter\n SQLite::Statement query(db, \"SELECT * FROM test\");\n EXPECT_STREQ(\"SELECT * FROM test\", query.getQuery().c_str());\n EXPECT_EQ(2, query.getColumnCount ());\n EXPECT_FALSE(query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ(SQLite::OK, query.getErrorCode());\n EXPECT_EQ(SQLite::OK, query.getExtendedErrorCode());\n EXPECT_THROW(query.isColumnNull(-1), SQLite::Exception);\n EXPECT_THROW(query.isColumnNull(0), SQLite::Exception);\n EXPECT_THROW(query.isColumnNull(1), SQLite::Exception);\n EXPECT_THROW(query.isColumnNull(2), SQLite::Exception);\n EXPECT_THROW(query.getColumn(-1), SQLite::Exception);\n EXPECT_THROW(query.getColumn(0), SQLite::Exception);\n EXPECT_THROW(query.getColumn(1), SQLite::Exception);\n EXPECT_THROW(query.getColumn(2), SQLite::Exception);\n\n query.reset();\n EXPECT_FALSE(query.hasRow());\n EXPECT_FALSE(query.isDone());\n\n query.executeStep();\n EXPECT_FALSE(query.hasRow());\n EXPECT_TRUE( query.isDone());\n query.reset();\n EXPECT_FALSE(query.hasRow());\n EXPECT_FALSE(query.isDone());\n\n query.reset();\n EXPECT_THROW(query.bind(-1, 123), SQLite::Exception);\n EXPECT_THROW(query.bind(0, 123), SQLite::Exception);\n EXPECT_THROW(query.bind(1, 123), SQLite::Exception);\n EXPECT_THROW(query.bind(2, 123), SQLite::Exception);\n EXPECT_THROW(query.bind(0, \"abc\"), SQLite::Exception);\n EXPECT_THROW(query.bind(0), SQLite::Exception);\n EXPECT_EQ(SQLITE_RANGE, db.getErrorCode());\n EXPECT_EQ(SQLITE_RANGE, db.getExtendedErrorCode());\n EXPECT_STREQ(\"column index out of range\", db.getErrorMsg());\n EXPECT_EQ(SQLITE_RANGE, query.getErrorCode());\n EXPECT_EQ(SQLITE_RANGE, query.getExtendedErrorCode());\n EXPECT_STREQ(\"column index out of range\", query.getErrorMsg());\n\n query.exec(); // exec() instead of executeStep() as there is no result\n EXPECT_THROW(query.isColumnNull(0), SQLite::Exception);\n EXPECT_THROW(query.getColumn(0), SQLite::Exception);\n\n EXPECT_THROW(query.exec(), SQLite::Exception); // exec() shall throw as it needs to be reseted\n\n // Add a first row\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'first')\"));\n EXPECT_EQ(1, db.getLastInsertRowid());\n EXPECT_EQ(1, db.getTotalChanges());\n\n query.reset();\n EXPECT_FALSE(query.hasRow());\n EXPECT_FALSE(query.isDone());\n\n EXPECT_THROW(query.exec(), SQLite::Exception); // exec() shall throw as it does not expect a result\n}\n\n#if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1600)\n\nSQLite::Statement StatementBuilder(SQLite::Database& aDb, const char* apQuery)\n{\n return SQLite::Statement(aDb, apQuery);\n}\n\nTEST(Statement, moveConstructor)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE | SQLite::OPEN_CREATE);\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\"));\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'first')\"));\n EXPECT_EQ(1, db.getLastInsertRowid());\n\n SQLite::Statement query = StatementBuilder(db, \"SELECT * FROM test\");\n EXPECT_FALSE(query.getQuery().empty());\n EXPECT_FALSE(query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ(2, query.getColumnCount());\n SQLite::Statement moved = std::move(query);\n EXPECT_TRUE(query.getQuery().empty());\n EXPECT_FALSE(moved.getQuery().empty());\n EXPECT_EQ(2, moved.getColumnCount());\n // Execute\n moved.executeStep();\n EXPECT_TRUE(moved.hasRow());\n EXPECT_FALSE(moved.isDone());\n EXPECT_FALSE(query.hasRow());\n EXPECT_FALSE(query.isDone());\n\n // Const statement lookup\n const auto const_query = std::move(moved);\n auto index = const_query.getColumnIndex(\"value\");\n EXPECT_EQ(1, index);\n EXPECT_NO_THROW(const_query.getColumn(index));\n\n // Moved statements should throw\n EXPECT_THROW(query.getColumnIndex(\"value\"), SQLite::Exception);\n EXPECT_THROW(query.getColumn(index), SQLite::Exception);\n}\n\n#endif\n\nTEST(Statement, executeStep)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n\n // Create a new table\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, msg TEXT, int INTEGER, double REAL)\"));\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n\n // Create a first row\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'first', 123, 0.123)\"));\n EXPECT_EQ(1, db.getLastInsertRowid());\n\n // Compile a SQL query\n SQLite::Statement query(db, \"SELECT * FROM test\");\n EXPECT_STREQ(\"SELECT * FROM test\", query.getQuery().c_str());\n EXPECT_EQ(4, query.getColumnCount());\n\n // Get the first row\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n const int64_t id = query.getColumn(0);\n const std::string msg = query.getColumn(1);\n const int integer = query.getColumn(2);\n const int64_t integer2= query.getColumn(2);\n const double real = query.getColumn(3);\n EXPECT_EQ(1, id);\n EXPECT_EQ(\"first\", msg);\n EXPECT_EQ(123, integer);\n EXPECT_EQ(123, integer2);\n EXPECT_DOUBLE_EQ(0.123, real);\n\n // Step one more time to discover there is nothing more\n query.executeStep();\n EXPECT_FALSE(query.hasRow());\n EXPECT_TRUE (query.isDone()); // \"done\" is \"the end\"\n\n // Step after \"the end\" throw an exception\n EXPECT_THROW(query.executeStep(), SQLite::Exception);\n\n // Try to insert a new row with the same PRIMARY KEY: \"UNIQUE constraint failed: test.id\"\n SQLite::Statement insert(db, \"INSERT INTO test VALUES (1, 'impossible', 456, 0.456)\");\n EXPECT_THROW(insert.executeStep(), SQLite::Exception);\n // in this case, reset() do throw again the same error\n EXPECT_THROW(insert.reset(), SQLite::Exception);\n\n // Try again to insert a new row with the same PRIMARY KEY (with an alternative method): \"UNIQUE constraint failed: test.id\"\n SQLite::Statement insert2(db, \"INSERT INTO test VALUES (1, 'impossible', 456, 0.456)\");\n EXPECT_THROW(insert2.exec(), SQLite::Exception);\n}\n\nTEST(Statement, tryExecuteStep)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n\n // Create a new table\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, msg TEXT, int INTEGER, double REAL)\"));\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n\n // Create a first row\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'first', 123, 0.123)\"));\n EXPECT_EQ(1, db.getLastInsertRowid());\n\n // Compile a SQL query\n SQLite::Statement query(db, \"SELECT * FROM test\");\n EXPECT_STREQ(\"SELECT * FROM test\", query.getQuery().c_str());\n EXPECT_EQ(4, query.getColumnCount());\n\n // Get the first row\n EXPECT_EQ(query.tryExecuteStep(), SQLITE_ROW);\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n const int64_t id = query.getColumn(0);\n const std::string msg = query.getColumn(1);\n const int integer = query.getColumn(2);\n const int64_t integer2= query.getColumn(2);\n const double real = query.getColumn(3);\n EXPECT_EQ(1, id);\n EXPECT_EQ(\"first\", msg);\n EXPECT_EQ(123, integer);\n EXPECT_EQ(123, integer2);\n EXPECT_DOUBLE_EQ(0.123, real);\n\n // Step one more time to discover there is nothing more\n EXPECT_EQ(query.tryExecuteStep(), SQLITE_DONE);\n EXPECT_FALSE(query.hasRow());\n EXPECT_TRUE (query.isDone()); // \"done\" is \"the end\"\n\n // Try to insert a new row with the same PRIMARY KEY: \"UNIQUE constraint failed: test.id\"\n SQLite::Statement insert(db, \"INSERT INTO test VALUES (1, 'impossible', 456, 0.456)\");\n EXPECT_EQ(insert.tryExecuteStep(), SQLITE_CONSTRAINT);\n // in this case, reset() do throw again the same error\n EXPECT_EQ(insert.tryReset(), SQLITE_CONSTRAINT);\n}\n\nTEST(Statement, bindings)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n\n // Create a new table\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, msg TEXT, int INTEGER, double REAL)\"));\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n\n // Insertion with bindable parameters\n SQLite::Statement insert(db, \"INSERT INTO test VALUES (NULL, ?, ?, ?)\");\n\n // Compile a SQL query to check the results\n SQLite::Statement query(db, \"SELECT * FROM test\");\n EXPECT_STREQ(\"SELECT * FROM test\", query.getQuery().c_str());\n EXPECT_EQ(4, query.getColumnCount());\n\n // First row with text/int/double\n {\n const char* text = \"first\";\n const int integer = -123;\n const double dbl = 0.123;\n insert.bind(1, text);\n insert.bind(2, integer);\n insert.bind(3, dbl);\n EXPECT_EQ(insert.getExpandedSQL(), \"INSERT INTO test VALUES (NULL, 'first', -123, 0.123)\");\n EXPECT_EQ(1, insert.exec());\n EXPECT_EQ(SQLITE_DONE, db.getErrorCode());\n\n // Check the result\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ (1, query.getColumn(0).getInt64());\n EXPECT_STREQ(\"first\", query.getColumn(1).getText());\n EXPECT_EQ (-123, query.getColumn(2).getInt());\n EXPECT_EQ (0.123, query.getColumn(3).getDouble());\n }\n\n // reset() without clearbindings()\n insert.reset();\n\n // Second row with the same exact values because clearbindings() was not called\n {\n EXPECT_EQ(1, insert.exec());\n EXPECT_EQ(SQLITE_DONE, db.getErrorCode());\n\n // Check the result\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ (2, query.getColumn(0).getInt64());\n EXPECT_STREQ(\"first\", query.getColumn(1).getText());\n EXPECT_EQ (-123, query.getColumn(2).getInt());\n EXPECT_EQ (0.123, query.getColumn(3).getDouble());\n }\n\n // reset() with clearbindings() and no more bindings\n insert.reset();\n insert.clearBindings();\n\n // Third row with the all null values because clearbindings() was called\n {\n EXPECT_EQ(1, insert.exec());\n EXPECT_EQ(SQLITE_DONE, db.getErrorCode());\n\n // Check the resultw\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ (3, query.getColumn(0).getInt64());\n EXPECT_TRUE (query.isColumnNull(1));\n EXPECT_STREQ(\"\", query.getColumn(1).getText());\n EXPECT_TRUE (query.isColumnNull(2));\n EXPECT_EQ (0, query.getColumn(2).getInt());\n EXPECT_TRUE (query.isColumnNull(3));\n EXPECT_EQ (0.0, query.getColumn(3).getDouble());\n }\n\n // reset() with clearbindings() and new bindings\n insert.reset();\n insert.clearBindings();\n\n // Fourth row with string/int64/float\n {\n const std::string fourth(\"fourth\");\n const int64_t int64 = 12345678900000LL;\n const float float32 = 0.234f;\n insert.bind(1, fourth);\n insert.bind(2, int64);\n insert.bind(3, float32);\n EXPECT_EQ(1, insert.exec());\n EXPECT_EQ(SQLITE_DONE, db.getErrorCode());\n\n // Check the result\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ(4, query.getColumn(0).getInt64());\n EXPECT_EQ(fourth, query.getColumn(1).getText());\n EXPECT_EQ(12345678900000LL, query.getColumn(2).getInt64());\n EXPECT_FLOAT_EQ(0.234f, (float)query.getColumn(3).getDouble());\n }\n\n // reset() without clearbindings()\n insert.reset();\n\n // Fifth row with binary buffer and a null parameter\n {\n const char buffer[] = \"binary\";\n insert.bind(1, buffer, sizeof(buffer));\n insert.bind(2); // bind a NULL value\n EXPECT_EQ(1, insert.exec());\n\n // Check the result\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ(5, query.getColumn(0).getInt64());\n EXPECT_STREQ(buffer, query.getColumn(1).getText());\n EXPECT_TRUE (query.isColumnNull(2));\n EXPECT_EQ(0, query.getColumn(2).getInt());\n EXPECT_FLOAT_EQ(0.234f, (float)query.getColumn(3).getDouble());\n }\n\n\n // reset() without clearbindings()\n insert.reset();\n\n // Sixth row with uint32_t unsigned value and a long value (which is either a 32b int or a 64b int64_t)\n {\n const uint32_t uint32 = 4294967295U;\n const int64_t integer = -123;\n insert.bind(2, uint32);\n insert.bind(3, integer);\n EXPECT_EQ(1, insert.exec());\n EXPECT_EQ(SQLITE_DONE, db.getErrorCode());\n\n // Check the result\n query.executeStep();\n EXPECT_TRUE(query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ(6, query.getColumn(0).getInt64());\n EXPECT_EQ(4294967295U, query.getColumn(2).getUInt());\n EXPECT_EQ(-123, query.getColumn(3).getInt());\n }\n\n\n // reset() without clearbindings()\n insert.reset();\n\n // Seventh row using another variant of int64 type\n {\n const int64_t int64 = 12345678900000LL;\n insert.bind(2, int64);\n EXPECT_EQ(1, insert.exec());\n EXPECT_EQ(SQLITE_DONE, db.getErrorCode());\n\n // Check the result\n query.executeStep();\n EXPECT_TRUE(query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ(7, query.getColumn(0).getInt64());\n EXPECT_EQ(12345678900000LL, query.getColumn(2).getInt64());\n }\n}\n\nTEST(Statement, bindNoCopy)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n\n // Create a new table\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, txt1 TEXT, txt2 TEXT, binary BLOB)\"));\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n\n // Insertion with bindable parameters\n SQLite::Statement insert(db, \"INSERT INTO test VALUES (NULL, ?, ?, ?)\");\n\n // Compile a SQL query to check the results\n SQLite::Statement query(db, \"SELECT * FROM test\");\n EXPECT_STREQ(\"SELECT * FROM test\", query.getQuery().c_str());\n EXPECT_EQ(4, query.getColumnCount());\n\n // Insert one row with all variants of bindNoCopy()\n {\n const char* txt1 = \"first\";\n const std::string txt2 = \"sec\\0nd\";\n const char blob[] = {'b','l','\\0','b'};\n insert.bindNoCopy(1, txt1);\n insert.bindNoCopy(2, txt2);\n insert.bindNoCopy(3, blob, sizeof(blob));\n EXPECT_EQ(1, insert.exec());\n EXPECT_EQ(SQLITE_DONE, db.getErrorCode());\n\n // Check the result\n query.executeStep();\n EXPECT_TRUE(query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ(1, query.getColumn(0).getInt64());\n EXPECT_STREQ(txt1, query.getColumn(1).getText());\n EXPECT_EQ(0, memcmp(&txt2[0], &query.getColumn(2).getString()[0], txt2.size()));\n EXPECT_EQ(0, memcmp(blob, &query.getColumn(3).getString()[0], sizeof(blob)));\n }\n}\n\nTEST(Statement, bindByName)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n\n // Create a new table\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, msg TEXT, int INTEGER, long INTEGER, double REAL)\"));\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n\n // Insertion with bindable parameters\n SQLite::Statement insert(db, \"INSERT INTO test VALUES (NULL, @msg, @int, @long, @double)\");\n\n // First row with text/int/double\n insert.bind(\"@msg\", \"first\");\n insert.bind(\"@int\", 123);\n insert.bind(\"@long\", -123);\n insert.bind(\"@double\", 0.123);\n EXPECT_EQ(1, insert.exec());\n EXPECT_EQ(SQLITE_DONE, db.getErrorCode());\n\n // Compile a SQL query to check the result\n SQLite::Statement query(db, \"SELECT * FROM test\");\n EXPECT_STREQ(\"SELECT * FROM test\", query.getQuery().c_str());\n EXPECT_EQ(5, query.getColumnCount());\n\n // Check the result\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ (1, query.getColumn(0).getInt64());\n EXPECT_STREQ(\"first\", query.getColumn(1).getText());\n EXPECT_EQ (123, query.getColumn(2).getInt());\n EXPECT_EQ (-123, query.getColumn(3).getInt());\n EXPECT_EQ (0.123, query.getColumn(4).getDouble());\n\n // reset() with clearbindings() and new bindings\n insert.reset();\n insert.clearBindings();\n\n // Second row with string/int64/float\n {\n const std::string second(\"second\");\n const int32_t int32 = -123;\n const int64_t int64 = 12345678900000LL;\n const float float32 = 0.234f;\n insert.bind(\"@msg\", second);\n insert.bind(\"@int\", int32);\n insert.bind(\"@long\", int64);\n insert.bind(\"@double\", float32);\n EXPECT_EQ(1, insert.exec());\n EXPECT_EQ(SQLITE_DONE, db.getErrorCode());\n\n // Check the result\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ(2, query.getColumn(0).getInt64());\n EXPECT_EQ(second, query.getColumn(1).getText());\n EXPECT_EQ(-123, query.getColumn(2).getInt());\n EXPECT_EQ(12345678900000LL, query.getColumn(3).getInt64());\n EXPECT_FLOAT_EQ(0.234f, (float)query.getColumn(4).getDouble());\n }\n\n // reset() without clearbindings()\n insert.reset();\n\n // Third row with binary buffer and a null parameter\n {\n const char buffer[] = \"binary\";\n insert.bind(\"@msg\", buffer, sizeof(buffer));\n insert.bind(\"@int\"); // bind a NULL value\n EXPECT_EQ(1, insert.exec());\n\n // Check the result\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ(3, query.getColumn(0).getInt64());\n EXPECT_STREQ(buffer, query.getColumn(1).getText());\n EXPECT_TRUE (query.isColumnNull(2));\n EXPECT_EQ(0, query.getColumn(2).getInt());\n EXPECT_FLOAT_EQ(0.234f, (float)query.getColumn(4).getDouble());\n }\n\n // reset() without clearbindings()\n insert.reset();\n\n // Fourth row with uint32_t unsigned value and int64_t 64bits value\n {\n const uint32_t uint32 = 4294967295U;\n const int64_t int64 = 12345678900000LL;\n insert.bind(\"@int\", uint32);\n insert.bind(\"@long\", int64);\n EXPECT_EQ(1, insert.exec());\n EXPECT_EQ(SQLITE_DONE, db.getErrorCode());\n\n // Check the result\n query.executeStep();\n EXPECT_TRUE(query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ(4, query.getColumn(0).getInt64());\n EXPECT_EQ(4294967295U, query.getColumn(2).getUInt());\n EXPECT_EQ(12345678900000LL, query.getColumn(3).getInt64());\n }\n}\n\n\nTEST(Statement, bindByNameString)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE | SQLite::OPEN_CREATE);\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n\n // Create a new table\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, msg TEXT, int INTEGER, double REAL, long INTEGER)\"));\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n\n // Insertion with bindable parameters\n SQLite::Statement insert(db, \"INSERT INTO test VALUES (NULL, @msg, @int, @double, @long)\");\n\n const std::string amsg = \"@msg\";\n const std::string aint = \"@int\";\n const std::string along = \"@long\";\n const std::string adouble = \"@double\";\n\n // First row with text/int/double\n insert.bind(amsg, \"first\");\n insert.bind(aint, 123);\n insert.bind(along, -123);\n insert.bind(adouble, 0.123);\n EXPECT_EQ(1, insert.exec());\n EXPECT_EQ(SQLITE_DONE, db.getErrorCode());\n\n // Compile a SQL query to check the result\n SQLite::Statement query(db, \"SELECT * FROM test\");\n EXPECT_STREQ(\"SELECT * FROM test\", query.getQuery().c_str());\n EXPECT_EQ(5, query.getColumnCount());\n\n // Check the result\n query.executeStep();\n EXPECT_TRUE(query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ(1, query.getColumn(0).getInt64());\n EXPECT_STREQ(\"first\", query.getColumn(1).getText());\n EXPECT_EQ(123, query.getColumn(2).getInt());\n EXPECT_DOUBLE_EQ(0.123, query.getColumn(3).getDouble());\n EXPECT_EQ(-123, query.getColumn(4).getInt());\n\n // reset() with clearbindings() and new bindings\n insert.reset();\n insert.clearBindings();\n\n // Second row with string/int64/float\n {\n const std::string second(\"second\");\n const int64_t int64 = 12345678900000LL;\n const int64_t integer = -123;\n const float float32 = 0.234f;\n insert.bind(amsg, second);\n insert.bind(aint, int64);\n insert.bind(adouble, float32);\n insert.bind(along, integer);\n EXPECT_EQ(1, insert.exec());\n EXPECT_EQ(SQLITE_DONE, db.getErrorCode());\n\n // Check the result\n query.executeStep();\n EXPECT_TRUE(query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ(2, query.getColumn(0).getInt64());\n EXPECT_EQ(second, query.getColumn(1).getText());\n EXPECT_EQ(12345678900000LL, query.getColumn(2).getInt64());\n EXPECT_FLOAT_EQ(0.234f, (float)query.getColumn(3).getDouble());\n EXPECT_EQ(-123, query.getColumn(4).getInt());\n }\n\n // reset() without clearbindings()\n insert.reset();\n\n // Third row with binary buffer and a null parameter\n {\n const char buffer[] = \"binary\";\n insert.bind(amsg, buffer, sizeof(buffer));\n insert.bind(aint); // bind a NULL value\n EXPECT_EQ(1, insert.exec());\n\n // Check the result\n query.executeStep();\n EXPECT_TRUE(query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ(3, query.getColumn(0).getInt64());\n EXPECT_STREQ(buffer, query.getColumn(1).getText());\n EXPECT_TRUE(query.isColumnNull(2));\n EXPECT_EQ(0, query.getColumn(2).getInt());\n EXPECT_FLOAT_EQ(0.234f, (float)query.getColumn(3).getDouble());\n }\n\n // reset() without clearbindings()\n insert.reset();\n\n // Fourth row with uint32_t unsigned value and int64_t 64bits value\n {\n const uint32_t uint32 = 4294967295U;\n const int64_t int64 = 12345678900000LL;\n insert.bind(aint, uint32);\n insert.bind(along, int64);\n EXPECT_EQ(1, insert.exec());\n EXPECT_EQ(SQLITE_DONE, db.getErrorCode());\n\n // Check the result\n query.executeStep();\n EXPECT_TRUE(query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ(4, query.getColumn(0).getInt64());\n EXPECT_EQ(4294967295U, query.getColumn(2).getUInt());\n EXPECT_EQ(12345678900000LL, query.getColumn(4).getInt64());\n }\n}\n\nTEST(Statement, bindNoCopyByName)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n\n // Create a new table\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, txt1 TEXT, txt2 TEXT, binary BLOB)\"));\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n\n // Insertion with bindable parameters\n SQLite::Statement insert(db, \"INSERT INTO test VALUES (NULL, @txt1, @txt2, @blob)\");\n\n // Compile a SQL query to check the results\n SQLite::Statement query(db, \"SELECT * FROM test\");\n EXPECT_STREQ(\"SELECT * FROM test\", query.getQuery().c_str());\n EXPECT_EQ(4, query.getColumnCount());\n\n // Insert one row with all variants of bindNoCopy()\n {\n const char* txt1 = \"first\";\n const std::string txt2 = \"sec\\0nd\";\n const char blob[] = { 'b','l','\\0','b' };\n insert.bindNoCopy(\"@txt1\", txt1);\n insert.bindNoCopy(\"@txt2\", txt2);\n insert.bindNoCopy(\"@blob\", blob, sizeof(blob));\n EXPECT_EQ(1, insert.exec());\n EXPECT_EQ(1, db.getLastInsertRowid());\n EXPECT_EQ(SQLITE_DONE, db.getErrorCode());\n\n // Check the result\n query.executeStep();\n EXPECT_TRUE(query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ(1, query.getColumn(0).getInt64());\n EXPECT_STREQ(txt1, query.getColumn(1).getText());\n EXPECT_EQ(0, memcmp(&txt2[0], &query.getColumn(2).getString()[0], txt2.size()));\n EXPECT_EQ(0, memcmp(blob, &query.getColumn(3).getString()[0], sizeof(blob)));\n }\n\n insert.reset();\n query.reset();\n\n // Insert a second row with all variants of bindNoCopy() using std::string names\n {\n const std::string atxt1 = \"@txt1\";\n const std::string atxt2 = \"@txt2\";\n const std::string ablob = \"@blob\";\n const char* txt1 = \"first2\";\n const std::string txt2 = \"sec\\0nd2\";\n const char blob[] = { 'b','l','\\0','b','2' };\n insert.bindNoCopy(atxt1, txt1);\n insert.bindNoCopy(atxt2, txt2);\n insert.bindNoCopy(ablob, blob, sizeof(blob));\n EXPECT_EQ(1, insert.exec());\n EXPECT_EQ(2, db.getLastInsertRowid());\n EXPECT_EQ(SQLITE_DONE, db.getErrorCode());\n\n // Check the result\n query.executeStep(); // pass on the first row\n query.executeStep();\n EXPECT_TRUE(query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_EQ(2, query.getColumn(0).getInt64());\n EXPECT_STREQ(txt1, query.getColumn(1).getText());\n EXPECT_EQ(0, memcmp(&txt2[0], &query.getColumn(2).getString()[0], txt2.size()));\n EXPECT_EQ(0, memcmp(blob, &query.getColumn(3).getString()[0], sizeof(blob)));\n }\n}\n\nTEST(Statement, isColumnNull)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n ASSERT_EQ(SQLite::OK, db.getErrorCode());\n\n // Create a new table\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (msg TEXT, int INTEGER, double REAL)\"));\n ASSERT_EQ(SQLite::OK, db.getErrorCode());\n\n // Create a first row with no null values, then other rows with each time a NULL value\n ASSERT_EQ(1, db.exec(\"INSERT INTO test VALUES ('first', 123, 0.123)\"));\n ASSERT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 123, 0.123)\"));\n ASSERT_EQ(1, db.exec(\"INSERT INTO test VALUES ('first', NULL, 0.123)\"));\n ASSERT_EQ(1, db.exec(\"INSERT INTO test VALUES ('first', 123, NULL)\"));\n\n // Compile a SQL query\n const std::string select(\"SELECT * FROM test\");\n SQLite::Statement query(db, select);\n EXPECT_EQ(select, query.getQuery());\n EXPECT_EQ(3, query.getColumnCount());\n\n // Get the first non-null row\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_THROW(query.isColumnNull(-1), SQLite::Exception);\n EXPECT_EQ(false, query.isColumnNull(0));\n EXPECT_EQ(false, query.isColumnNull(1));\n EXPECT_EQ(false, query.isColumnNull(2));\n EXPECT_THROW(query.isColumnNull(3), SQLite::Exception);\n\n // Get the second row with null text\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_THROW(query.isColumnNull(-1), SQLite::Exception);\n EXPECT_EQ(true, query.isColumnNull(0));\n EXPECT_EQ(false, query.isColumnNull(1));\n EXPECT_EQ(false, query.isColumnNull(2));\n EXPECT_THROW(query.isColumnNull(3), SQLite::Exception);\n\n // Get the second row with null integer\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_THROW(query.isColumnNull(-1), SQLite::Exception);\n EXPECT_EQ(false, query.isColumnNull(0));\n EXPECT_EQ(true, query.isColumnNull(1));\n EXPECT_EQ(false, query.isColumnNull(2));\n EXPECT_THROW(query.isColumnNull(3), SQLite::Exception);\n\n // Get the third row with null float\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_THROW(query.isColumnNull(-1), SQLite::Exception);\n EXPECT_EQ(false, query.isColumnNull(0));\n EXPECT_EQ(false, query.isColumnNull(1));\n EXPECT_EQ(true, query.isColumnNull(2));\n EXPECT_THROW(query.isColumnNull(3), SQLite::Exception);\n}\n\nTEST(Statement, isColumnNullByName)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE);\n ASSERT_EQ(SQLITE_OK, db.getErrorCode());\n\n // Create a new table\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (msg TEXT, int INTEGER, double REAL)\"));\n ASSERT_EQ(SQLITE_OK, db.getErrorCode());\n\n // Create a first row with no null values, then other rows with each time a NULL value\n ASSERT_EQ(1, db.exec(\"INSERT INTO test VALUES ('first', 123, 0.123)\"));\n ASSERT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 123, 0.123)\"));\n ASSERT_EQ(1, db.exec(\"INSERT INTO test VALUES ('first', NULL, 0.123)\"));\n ASSERT_EQ(1, db.exec(\"INSERT INTO test VALUES ('first', 123, NULL)\"));\n\n // Compile a SQL query\n const std::string select(\"SELECT * FROM test\");\n SQLite::Statement query(db, select);\n EXPECT_EQ(select, query.getQuery());\n EXPECT_EQ(3, query.getColumnCount());\n\n // Get the first non-null row\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_THROW(query.isColumnNull(\"\"), SQLite::Exception);\n EXPECT_EQ(false, query.isColumnNull(\"msg\"));\n EXPECT_EQ(false, query.isColumnNull(\"int\"));\n EXPECT_EQ(false, query.isColumnNull(\"double\"));\n EXPECT_THROW(query.isColumnNull(3), SQLite::Exception);\n\n // Get the second row with null text\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_THROW(query.isColumnNull(\"\"), SQLite::Exception);\n EXPECT_EQ(true, query.isColumnNull(\"msg\"));\n EXPECT_EQ(false, query.isColumnNull(1));\n EXPECT_EQ(false, query.isColumnNull(\"double\"));\n EXPECT_THROW(query.isColumnNull(3), SQLite::Exception);\n\n // Get the second row with null integer\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_THROW(query.isColumnNull(\"\"), SQLite::Exception);\n EXPECT_EQ(false, query.isColumnNull(\"msg\"));\n EXPECT_EQ(true, query.isColumnNull(\"int\"));\n EXPECT_EQ(false, query.isColumnNull(\"double\"));\n EXPECT_THROW(query.isColumnNull(3), SQLite::Exception);\n\n // Get the third row with null float\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n EXPECT_THROW(query.isColumnNull(\"\"), SQLite::Exception);\n EXPECT_EQ(false, query.isColumnNull(\"msg\"));\n EXPECT_EQ(false, query.isColumnNull(\"int\"));\n EXPECT_EQ(true, query.isColumnNull(\"double\"));\n EXPECT_THROW(query.isColumnNull(3), SQLite::Exception);\n}\n\nTEST(Statement, getColumnByName)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n EXPECT_EQ(SQLite::OK, db.getExtendedErrorCode());\n\n // Create a new table\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, msg TEXT, int INTEGER, double REAL)\"));\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n EXPECT_EQ(SQLite::OK, db.getExtendedErrorCode());\n\n // Create a first row\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'first', 123, 0.123)\"));\n EXPECT_EQ(1, db.getLastInsertRowid());\n EXPECT_EQ(1, db.getTotalChanges());\n\n // Compile a SQL query\n SQLite::Statement query(db, \"SELECT * FROM test\");\n EXPECT_STREQ(\"SELECT * FROM test\", query.getQuery().c_str());\n EXPECT_EQ(4, query.getColumnCount());\n query.executeStep();\n EXPECT_TRUE (query.hasRow());\n EXPECT_FALSE(query.isDone());\n\n // Look for non-existing columns\n EXPECT_THROW(query.getColumn(\"unknown\"), SQLite::Exception);\n EXPECT_THROW(query.getColumn(\"\"), SQLite::Exception);\n\n const std::string msg = query.getColumn(\"msg\");\n const int integer = query.getColumn(\"int\");\n const double real = query.getColumn(\"double\");\n EXPECT_EQ(\"first\", msg);\n EXPECT_EQ(123, integer);\n EXPECT_DOUBLE_EQ(0.123, real);\n}\n\nTEST(Statement, getName)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, msg TEXT)\"));\n\n // Compile a SQL query, using the \"id\" column name as-is, but aliasing the \"msg\" column with new name \"value\"\n SQLite::Statement query(db, \"SELECT id, msg as value FROM test\");\n query.executeStep();\n\n const std::string name0 = query.getColumnName(0);\n const std::string name1 = query.getColumnName(1);\n EXPECT_EQ(\"id\", name0);\n EXPECT_EQ(\"value\", name1);\n\n#ifdef SQLITE_ENABLE_COLUMN_METADATA\n // Show how to get origin names of the table columns from which theses result columns come from.\n // Requires the SQLITE_ENABLE_COLUMN_METADATA preprocessor macro to be\n // also defined at compile times of the SQLite library itself.\n const std::string oname0 = query.getColumnOriginName(0);\n const std::string oname1 = query.getColumnOriginName(1);\n EXPECT_EQ(\"id\", oname0);\n EXPECT_EQ(\"msg\", oname1);\n#endif\n}\n\nTEST(Statement, getColumnDeclaredType)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE | SQLite::OPEN_CREATE);\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, msg TEXT, value DOUBLE)\"));\n\n SQLite::Statement query(db, \"SELECT *, 1 FROM test\");\n\n const std::string decltype0 = query.getColumnDeclaredType(0);\n const std::string decltype1 = query.getColumnDeclaredType(1);\n const std::string decltype2 = query.getColumnDeclaredType(2);\n EXPECT_EQ(\"INTEGER\", decltype0);\n EXPECT_EQ(\"TEXT\", decltype1);\n EXPECT_EQ(\"DOUBLE\", decltype2);\n\n // The column at index 3 is not a table column.\n EXPECT_THROW(query.getColumnDeclaredType(3), SQLite::Exception);\n\n // Index out of bounds.\n EXPECT_THROW(query.getColumnDeclaredType(4), SQLite::Exception);\n\n // Not a select statement.\n SQLite::Statement pragma(db,\"PRAGMA compile_options\");\n EXPECT_THROW(pragma.getColumnDeclaredType(0), SQLite::Exception);\n}\n\n#if __cplusplus >= 201402L || (defined(_MSC_VER) && _MSC_VER >= 1900)\nTEST(Statement, getColumns)\n{\n struct GetRowTestStruct\n {\n int id;\n std::string msg;\n int integer;\n double real;\n GetRowTestStruct(int _id, std::string _msg, int _integer, double _real)\n : id(_id), msg(_msg), integer(_integer), real(_real)\n {}\n\n GetRowTestStruct(int _id, const std::string& _msg)\n : id(_id), msg(_msg), integer(-1), real(0.0)\n {}\n };\n\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE | SQLite::OPEN_CREATE);\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n EXPECT_EQ(SQLite::OK, db.getExtendedErrorCode());\n\n // Create a new table\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, msg TEXT, int INTEGER, double REAL)\"));\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n EXPECT_EQ(SQLite::OK, db.getExtendedErrorCode());\n\n // Create a first row\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'first', 123, 0.123)\"));\n EXPECT_EQ(1, db.getLastInsertRowid());\n EXPECT_EQ(1, db.getTotalChanges());\n\n // Compile a SQL query\n SQLite::Statement query(db, \"SELECT * FROM test\");\n EXPECT_STREQ(\"SELECT * FROM test\", query.getQuery().c_str());\n EXPECT_EQ(4, query.getColumnCount());\n query.executeStep();\n EXPECT_TRUE(query.hasRow());\n EXPECT_FALSE(query.isDone());\n\n // Get all columns\n auto testStruct = query.getColumns<GetRowTestStruct, 4>();\n EXPECT_EQ(1, testStruct.id);\n EXPECT_EQ(\"first\", testStruct.msg);\n EXPECT_EQ(123, testStruct.integer);\n EXPECT_DOUBLE_EQ(0.123, testStruct.real);\n\n // Get only the first 2 columns\n auto testStruct2 = query.getColumns<GetRowTestStruct, 2>();\n EXPECT_EQ(1, testStruct2.id);\n EXPECT_EQ(\"first\", testStruct2.msg);\n EXPECT_EQ(-1, testStruct2.integer);\n EXPECT_DOUBLE_EQ(0.0, testStruct2.real);\n}\n#endif\n\nTEST(Statement, getBindParameterCount)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE | SQLite::OPEN_CREATE);\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, msg TEXT)\"));\n\n SQLite::Statement query(db, \"SELECT id, msg FROM test where id = ?\");\n EXPECT_EQ(1, query.getBindParameterCount());\n\n SQLite::Statement query2(db, \"SELECT id, msg FROM test where id = ? and msg = ?\");\n EXPECT_EQ(2, query2.getBindParameterCount());\n\n SQLite::Statement query3(db, \"SELECT id, msg FROM test\");\n EXPECT_EQ(0, query3.getBindParameterCount());\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9342,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/SQLiteCpp/tests/Transaction_test.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":3731,"string":"3,731"},"line_count":{"kind":"number","value":119,"string":"119"},"content":{"kind":"string","value":"/**\n * @file Transaction_test.cpp\n * @ingroup tests\n * @brief Test of a SQLite Transaction.\n *\n * Copyright (c) 2012-2020 Sebastien Rombauts (sebastien.rombauts@gmail.com)\n *\n * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt\n * or copy at http://opensource.org/licenses/MIT)\n */\n\n#include <SQLiteCpp/Transaction.h>\n#include <SQLiteCpp/Database.h>\n#include <SQLiteCpp/Statement.h>\n#include <SQLiteCpp/Exception.h>\n\n#include <gtest/gtest.h>\n\n#include <cstdio>\n\nTEST(Transaction, commitRollback)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n\n {\n // Begin transaction\n SQLite::Transaction transaction(db);\n\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT)\"));\n EXPECT_EQ(SQLite::OK, db.getErrorCode());\n\n // Insert a first value\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'first')\"));\n EXPECT_EQ(1, db.getLastInsertRowid());\n\n // Commit transaction\n transaction.commit();\n\n // Commit again throw an exception\n EXPECT_THROW(transaction.commit(), SQLite::Exception);\n }\n\n // ensure transactions with different types are well-formed\n {\n for (auto behavior : {\n SQLite::TransactionBehavior::DEFERRED,\n SQLite::TransactionBehavior::IMMEDIATE,\n SQLite::TransactionBehavior::EXCLUSIVE })\n {\n SQLite::Transaction transaction(db, behavior);\n transaction.commit();\n }\n\n EXPECT_THROW(SQLite::Transaction(db, static_cast<SQLite::TransactionBehavior>(-1)), SQLite::Exception);\n }\n\n // Auto rollback if no commit() before the end of scope\n {\n // Begin transaction\n SQLite::Transaction transaction(db);\n\n // Insert a second value (that will be rollbacked)\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'third')\"));\n EXPECT_EQ(2, db.getLastInsertRowid());\n\n // end of scope: automatic rollback\n }\n\n // Auto rollback of a transaction on error/exception\n try\n {\n // Begin transaction\n SQLite::Transaction transaction(db);\n\n // Insert a second value (that will be rollbacked)\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'second')\"));\n EXPECT_EQ(2, db.getLastInsertRowid());\n\n // Execute with an error => exception with auto-rollback\n db.exec(\"DesiredSyntaxError to raise an exception to rollback the transaction\");\n\n GTEST_FATAL_FAILURE_(\"we should never get there\");\n transaction.commit(); // We should never get there\n }\n catch (std::exception& e)\n {\n std::cout << \"SQLite exception: \" << e.what() << std::endl;\n // expected error, see above\n }\n\n // Double rollback with a manual command before the end of scope\n {\n // Begin transaction\n SQLite::Transaction transaction(db);\n\n // Insert a second value (that will be rollbacked)\n EXPECT_EQ(1, db.exec(\"INSERT INTO test VALUES (NULL, 'third')\"));\n EXPECT_EQ(2, db.getLastInsertRowid());\n\n // Execute a manual rollback\n transaction.rollback();\n\n // end of scope: the automatic rollback should not raise an error because it is harmless\n }\n\n // Check the results (expect only one row of result, as all other one have been rollbacked)\n SQLite::Statement query(db, \"SELECT * FROM test\");\n int nbRows = 0;\n while (query.executeStep())\n {\n nbRows++;\n EXPECT_EQ(1, query.getColumn(0).getInt());\n EXPECT_STREQ(\"first\", query.getColumn(1).getText());\n }\n EXPECT_EQ(1, nbRows);\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9343,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/SQLiteCpp/tests/ExecuteMany_test.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":1835,"string":"1,835"},"line_count":{"kind":"number","value":55,"string":"55"},"content":{"kind":"string","value":"/**\n * @file VariadicBind_test.cpp\n * @ingroup tests\n * @brief Test of variadic bind\n *\n * Copyright (c) 2019 Maximilian Bachmann (contact@maxbachmann.de)\n * Copyright (c) 2019-2020 Sebastien Rombauts (sebastien.rombauts@gmail.com)\n *\n * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt\n * or copy at http://opensource.org/licenses/MIT)\n */\n\n#include <SQLiteCpp/Database.h>\n#include <SQLiteCpp/Statement.h>\n#include <SQLiteCpp/ExecuteMany.h>\n\n#include <gtest/gtest.h>\n\n#include <cstdio>\n\n#if (__cplusplus >= 201402L) || ( defined(_MSC_VER) && (_MSC_VER >= 1900) ) // c++14: Visual Studio 2015\nTEST(ExecuteMany, invalid)\n{\n // Create a new database\n SQLite::Database db(\":memory:\", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);\n\n EXPECT_EQ(0, db.exec(\"DROP TABLE IF EXISTS test\"));\n EXPECT_EQ(0, db.exec(\"CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT DEFAULT 'default')\"));\n EXPECT_TRUE(db.tableExists(\"test\"));\n {\n execute_many(db, \"INSERT INTO test VALUES (?, ?)\",\n 1,\n std::make_tuple(2),\n std::make_tuple(3, \"three\")\n );\n }\n // make sure the content is as expected\n {\n SQLite::Statement query(db, std::string{\"SELECT id, value FROM test ORDER BY id\"});\n std::vector<std::pair<int, std::string> > results;\n while (query.executeStep())\n {\n const int id = query.getColumn(0);\n std::string value = query.getColumn(1);\n results.emplace_back( id, std::move(value) );\n }\n EXPECT_EQ(std::size_t(3), results.size());\n\n EXPECT_EQ(std::make_pair(1,std::string{\"\"}), results.at(0));\n EXPECT_EQ(std::make_pair(2,std::string{\"\"}), results.at(1));\n EXPECT_EQ(std::make_pair(3,std::string{\"three\"}), results.at(2));\n }\n}\n#endif // c++14\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9344,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/tool_description_lib/Example00.cpp.md"},"file_extension":{"kind":"string","value":".md"},"file_size":{"kind":"number","value":2851,"string":"2,851"},"line_count":{"kind":"number","value":60,"string":"60"},"content":{"kind":"string","value":"<!-- SPDX-FileCopyrightText: 2006-2023, Knut Reinert & Freie Universität Berlin -->\n<!-- SPDX-FileCopyrightText: 2016-2023, Knut Reinert & MPI für molekulare Genetik -->\n<!-- SPDX-License-Identifier: CC0-1.0 -->\n```\n#include <tdl/tdl.h>\n\nint main(int argc, char** argv) {\n\n auto toolInfo = tdl::ToolInfo {\n .meta = {\n .version = \"7.6.5\", // version of your tool\n .name = \"testApp\", // name of your tool\n .docurl = \"example.com\", // url to the documentation of your tool\n .category = \"sequence analysis\", //!TODO what are good categories?\n .description = \"awesome tool! does everything\", // a description of your tool\n .executableName = argv[0], // executable name of your tool, we advise to fill it with what ever is given in argv[0]\n\n // A list of citations you would like people to look at when they use your tool for research\n .citations = {{\"doi:123\", \"https://en.wikipedia.org/wiki/Meaning_of_life\"},\n {\"doi:456\", \"https://en.wikipedia.org/wiki/Turing_completeness\"}},\n }\n .params = {\n // allow a call like `./myTool build --input <file1> <file2>`\n tdl::Node {\n .name = \"build\",\n .description = \"builds some index for search\",\n .tags = {}, // no tags\n .value = tdl::Node::Children { tdl::Node {\n .name = \"input\", // This must be the same as the referenceName of CLIMapping\n .description = \"input file\",\n .value = tdl::StringValueList{}, // indicates that we are accepting a list of strings as values\n }}\n },\n\n // allow a call like `./myTool search --index myindex.db --queries <file1> <file2>`\n tdl::Node {\n .name = \"search\",\n .description = \"using index to search\",\n .value = tdl::Node::Children {\n tdl::Node {\n .name = \"queries\", // This must be the same as the referenceName of CLIMapping\n .description = \"files with search queries\",\n .value = tdl::StringValueList{}, // indicates that we are accepting a list of strings as values\n }, tdl::Node {\n .name = \"index\", // This must be the same as the referenceName of CLIMapping\n .description = \"path to an index file\",\n .value = tdl::StringValue{}, // indicates that we are accepting a single string value\n }\n }\n }\n },\n .cliMapping = {\n tdl::CLIMapping {.optionIdentifier = \"--input\", .referenceName = \"input\"},\n tdl::CLIMapping {.optionIdentifier = \"--index\", .referenceName = \"index\"},\n tdl::CLIMapping {.optionIdentifier = \"--queries\", .referenceName = \"queries\"},\n });\n};\n```\n\n"},"language":{"kind":"string","value":"Markdown"}}},{"rowIdx":9345,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/tool_description_lib/Example01.cpp.md"},"file_extension":{"kind":"string","value":".md"},"file_size":{"kind":"number","value":2264,"string":"2,264"},"line_count":{"kind":"number","value":57,"string":"57"},"content":{"kind":"string","value":"<!-- SPDX-FileCopyrightText: 2006-2023, Knut Reinert & Freie Universität Berlin -->\n<!-- SPDX-FileCopyrightText: 2016-2023, Knut Reinert & MPI für molekulare Genetik -->\n<!-- SPDX-License-Identifier: CC0-1.0 -->\n##### Include library\nYou will need to include `tdl/tdl.h` to use this library:\n```\n#include <tdl/tdl.h>\n```\n\n##### Define Meta info\nAs a second step you define meta info about your app\n```\nauto toolInfo = tdl::ToolInfo {\n .meta = {\n .version = \"7.6.5\", // version of your tool\n .name = \"testApp\", // name of your tool\n .docurl = \"example.com\", // url to the documentation of your tool\n .category = \"sequence analysis\", //!TODO what are good categories?\n .description = \"some description\", // a description of your tool\n .executableName = argv[0], // executable name of your tool, we advise to fill it with what ever is given in argv[0]\n\n // A list of citations you would like people to look at when they use your tool for research\n .citations = {{\"doi:123\", \"https://en.wikipedia.org/wiki/Meaning_of_life\"},\n {\"doi:456\", \"https://en.wikipedia.org/wiki/Turing_completeness\"}},\n }\n};\n\n```\n##### Define parameters\nThe third step is to define which parameter your program will be interessted in:\n```\n// allow a call like `./myTool build --input <file1> <file2>`\nauto node = tdl::Node {\n .name = \"build\",\n .description = \"builds some index for search\",\n .tags = {}, // no tags\n .value = tdl::Node::Children { tdl::Node {\n .name = \"input\", // This must be the same as the referenceName of CLIMapping\n .description = \"input file\",\n .value = tdl::StringValueList{}, // indicates that we are accepting a list of strings as values\n }}\n};\ntoolInfo.params.push_back(node);\n```\n\n##### Map CLI options\nAs a fourth step you have to define how your register option `input` has to be called on the command line:\n```\ntoolInfo.cliMapping = {\n tdl::CLIMapping {.optionIdentifier = \"--input\", .referenceName = \"input\"},\n tdl::CLIMapping {.optionIdentifier = \"--index\", .referenceName = \"index\"},\n tdl::CLIMapping {.optionIdentifier = \"--queries\", .referenceName = \"queries\"},\n });\n};\n```\n\n"},"language":{"kind":"string","value":"Markdown"}}},{"rowIdx":9346,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/tool_description_lib/src/tdl/convertToCWL.h"},"file_extension":{"kind":"string","value":".h"},"file_size":{"kind":"number","value":14798,"string":"14,798"},"line_count":{"kind":"number","value":382,"string":"382"},"content":{"kind":"string","value":"// SPDX-FileCopyrightText: 2006-2023, Knut Reinert & Freie Universität Berlin\n// SPDX-FileCopyrightText: 2016-2023, Knut Reinert & MPI für molekulare Genetik\n// SPDX-License-Identifier: BSD-3-Clause\n#pragma once\n\n#include \"ToolInfo.h\"\n#include \"cwl_v1_2.h\"\n\n#include <cassert>\n#include <filesystem>\n#include <functional>\n#include <iomanip>\n#include <limits>\n#include <map>\n#include <sstream>\n\n\n#if (defined(_WIN32) || defined(WIN32)) && !defined(__GNUG__)\n# // Maybe visual studio will get there one day to support the c++ standard...\n# // Until then we have to live with this:\n# define and &&\n# define or ||\n# define not !\n#endif\n\n\nnamespace tdl {\n\n//!\\brief overload structure allowing fancy 'std::visit` syntax\ntemplate<class... Ts> struct overloaded : Ts... { using Ts::operator()...; };\n\n//!\\brief required deduction guide for c++17 (not required for c++20)\ntemplate<class... Ts> overloaded(Ts...) -> overloaded<Ts...>;\n\nnamespace cwl = https___w3id_org_cwl_cwl;\n\n/**!\\brief a global callback function to adjust the exporting for cwl\n *\n * This callback allows to adjust the exported yaml file to add/change/remove\n * cwl entries, which currently aren't controllable via tdl itself.\n */\ninline std::function<void(YAML::Node&)> post_process_cwl;\n\n\n\nnamespace detail {\n\ninline auto simplifyType(YAML::Node type) -> YAML::Node {\n // 1. Collapsing optional scalar types into one option\n if (type.IsSequence() and type.size() == 2) {\n if (type[0].IsScalar()\n and type[0].as<std::string>() == \"null\"\n and type[1].IsScalar()) {\n type = type[1].as<std::string>() + \"?\";\n }\n }\n\n // 2. Collapsing array types into one option\n if (type.IsMap()\n and type[\"type\"].as<std::string>(\"\") == \"array\"\n and type[\"items\"].IsScalar()) {\n type = type[\"items\"].as<std::string>() + \"[]\";\n }\n\n // 3. Collapsing optional array types into one option\n if (type.IsSequence() and type.size() == 2) {\n if (type[0].IsScalar()\n and type[0].as<std::string>() == \"null\"\n and type[1].IsMap()\n and type[1][\"type\"].as<std::string>() == \"array\"\n and type[1][\"items\"].IsScalar()) {\n type = type[1][\"items\"].as<std::string>() + \"[]?\";\n }\n }\n return type;\n}\n\ninline auto findCLIMapping(std::string const& referenceName, ToolInfo const& doc) -> CLIMapping const* {\n for (auto const& mapping : doc.cliMapping) {\n if (mapping.referenceName == referenceName) {\n return &mapping;\n }\n }\n return nullptr;\n};\n\ntemplate <typename InputType>\nvoid setIdOrName(InputType& input, std::string name) {\n if constexpr (std::is_same_v<InputType, cwl::CommandInputRecordField>\n || std::is_same_v<InputType, cwl::CommandOutputRecordField>) {\n input.name = name;\n } else {\n input.id = name;\n }\n}\ntemplate<typename InputType = cwl::CommandInputParameter, typename OutputType = cwl::CommandOutputParameter, size_t deep = 5, typename InputCB, typename OutputCB, typename BaseCommandCB>\ninline void f(Node::Children const& children, ToolInfo const& doc, InputCB const& inputCB, OutputCB const& outputCB, BaseCommandCB const& baseCommandCB) {\n //!WORKAROUND MSVC warns about unused variables\n (void)inputCB;\n (void)outputCB;\n (void)baseCommandCB;\n (void)doc;\n (void)children;\n if constexpr (deep > 0) {\n for (auto child : children) {\n // find CLIMapping\n auto cliMapping = findCLIMapping(child.name, doc);\n\n auto addInput = [&](auto type) {\n auto input = InputType{};\n setIdOrName(input, child.name);\n if (child.tags.count(\"required\")) {\n input.type = type;\n } else {\n using namespace https___w3id_org_cwl_cwl;\n input.type = std::vector<std::variant<CWLType, CommandInputRecordSchema, CommandInputEnumSchema, CommandInputArraySchema, std::string>>{cwl::CWLType::null, type};\n }\n input.doc = child.description;\n if (cliMapping) {\n auto binding = cwl::CommandLineBinding{};\n binding.prefix = cliMapping->optionIdentifier;\n input.inputBinding = binding;\n }\n inputCB(std::move(input));\n };\n auto addInputArray = [&](auto type) {\n auto input = InputType{};\n setIdOrName(input, child.name);\n auto arrayType = cwl::CommandInputArraySchema{};\n arrayType.items = type;\n if (child.tags.count(\"required\")) {\n input.type = arrayType;\n } else {\n using namespace https___w3id_org_cwl_cwl;\n input.type = std::vector<std::variant<CWLType, CommandInputRecordSchema, CommandInputEnumSchema, CommandInputArraySchema, std::string>>{cwl::CWLType::null, arrayType};\n }\n input.doc = child.description;\n\n if (cliMapping) {\n auto binding = cwl::CommandLineBinding{};\n binding.prefix = cliMapping->optionIdentifier;\n input.inputBinding = binding;\n }\n inputCB(std::move(input));\n };\n auto addOutput = [&](auto type) {\n auto input = InputType{};\n setIdOrName(input, child.name);\n if (child.tags.count(\"required\")) {\n input.type = cwl::CWLType::string;\n } else {\n using namespace https___w3id_org_cwl_cwl;\n input.type = std::vector<std::variant<CWLType, CommandInputRecordSchema, CommandInputEnumSchema, CommandInputArraySchema, std::string>>{cwl::CWLType::null, cwl::CWLType::string};\n }\n input.doc = child.description;\n\n if (cliMapping) {\n auto binding = cwl::CommandLineBinding{};\n binding.prefix = cliMapping->optionIdentifier;\n input.inputBinding = binding;\n }\n inputCB(std::move(input));\n\n auto output = OutputType{};\n setIdOrName(output, child.name);\n if (child.tags.count(\"required\")) {\n output.type = type;\n } else {\n using namespace https___w3id_org_cwl_cwl;\n output.type = std::vector<std::variant<CWLType, CommandOutputRecordSchema, CommandOutputEnumSchema, CommandOutputArraySchema, std::string>>{cwl::CWLType::null, type};\n }\n auto binding = cwl::CommandOutputBinding{};\n binding.glob = \"$(inputs.\" + child.name + \")\";\n output.outputBinding = binding;\n\n outputCB(std::move(output));\n };\n auto addOutputPrefixed = [&](auto type, bool multipleFiles) {\n auto input = InputType{};\n setIdOrName(input, child.name);\n if (child.tags.count(\"required\")) {\n input.type = cwl::CWLType::string;\n } else {\n using namespace https___w3id_org_cwl_cwl;\n input.type = std::vector<std::variant<CWLType, CommandInputRecordSchema, CommandInputEnumSchema, CommandInputArraySchema, std::string>>{cwl::CWLType::null, cwl::CWLType::string};\n }\n input.doc = child.description;\n\n if (cliMapping) {\n auto binding = cwl::CommandLineBinding{};\n binding.prefix = cliMapping->optionIdentifier;\n input.inputBinding = binding;\n }\n inputCB(std::move(input));\n\n auto output = OutputType{};\n setIdOrName(output, child.name);\n\n // Setting the correct value type\n output.type = type;\n using namespace https___w3id_org_cwl_cwl;\n // Add an array, if a list of files\n if (multipleFiles) {\n auto arrayType = cwl::CommandOutputArraySchema{};\n arrayType.items = type;\n output.type = arrayType;\n }\n\n // Add a null, if not required and an array, if a list of files\n if (!child.tags.count(\"required\")) {\n output.type = std::vector<std::variant<CWLType, CommandOutputRecordSchema, CommandOutputEnumSchema, CommandOutputArraySchema, std::string>>{cwl::CWLType::null, type };\n\n if (multipleFiles) {\n auto arrayType = cwl::CommandOutputArraySchema{};\n arrayType.items = type;\n output.type = std::vector<std::variant<CWLType, CommandOutputRecordSchema, CommandOutputEnumSchema, CommandOutputArraySchema, std::string>>{cwl::CWLType::null, arrayType };\n }\n }\n auto binding = cwl::CommandOutputBinding{};\n binding.glob = \"$(inputs.\" + child.name + \")*\";\n output.outputBinding = binding;\n outputCB(std::move(output));\n };\n\n std::visit(overloaded{\n [&](BoolValue const&) {\n addInput(cwl::CWLType::boolean);\n },\n [&](IntValue const&) {\n addInput(cwl::CWLType::long_);\n },\n [&](DoubleValue const&) {\n addInput(cwl::CWLType::double_);\n },\n [&](StringValue const&) {\n if (child.tags.count(\"output\")) {\n if (child.tags.count(\"file\")) {\n addOutput(cwl::CWLType::File);\n } else if (child.tags.count(\"directory\")) {\n addOutput(cwl::CWLType::Directory);\n } else if (child.tags.count(\"prefixed\")) {\n addOutputPrefixed(cwl::CWLType::File, /*.mutliplieFiles = */ false);\n }\n } else if (child.tags.count(\"file\")) {\n addInput(cwl::CWLType::File);\n } else if (child.tags.count(\"directory\")) {\n addInput(cwl::CWLType::Directory);\n } else {\n addInput(cwl::CWLType::string);\n }\n },\n [&](IntValueList const&) {\n addInputArray(cwl::CWLType::long_);\n },\n [&](DoubleValueList const&) {\n addInputArray(cwl::CWLType::double_);\n },\n [&](StringValueList const&) {\n if (child.tags.count(\"output\")) {\n if (child.tags.count(\"prefixed\")) {\n addOutputPrefixed(cwl::CWLType::File, /*.multipleFiles =*/ true);\n } else {\n //!TODO not implemented\n }\n } else if (child.tags.count(\"file\")) {\n addInputArray(cwl::CWLType::File);\n } else if (child.tags.count(\"directory\")) {\n addInputArray(cwl::CWLType::Directory);\n } else {\n addInputArray(cwl::CWLType::string);\n }\n },\n [&](Node::Children const& v) {\n if (child.tags.count(\"basecommand\")) {\n baseCommandCB(child.name);\n\n f<InputType, OutputType, deep-1>(v, doc, inputCB, outputCB, baseCommandCB);\n return;\n }\n\n auto inputs = std::vector<cwl::CommandInputRecordField>{};\n auto outputs = std::vector<cwl::CommandOutputRecordField>{};\n f<cwl::CommandInputRecordField, cwl::CommandOutputRecordField, (deep-1)>(v, doc, [&](auto input) {\n inputs.push_back(input);\n } , [&](auto output) {\n outputs.push_back(output);\n }, baseCommandCB);\n\n auto inputType = cwl::CommandInputRecordSchema{};\n auto outputType = cwl::CommandOutputRecordSchema{};\n\n inputType.fields = inputs;\n outputType.fields = outputs;\n// child.tags.insert(\"required\"); //!TODO, is this required?\n addInput(inputType);\n },\n }, child.value);\n }\n }\n}\n}\n\n/*!\\brief converts a ToolInfo into a string that\n * holds the CWL representation of the given tool\n */\ninline auto convertToCWL(ToolInfo const& doc) -> std::string {\n auto& tool_info = doc.metaInfo;\n auto const schema_location = std::string{\"/SCHEMAS/Param_1_7_0.xsd\"};\n auto const schema_version = std::string{\"1.7.0\"};\n\n\n auto tool = cwl::CommandLineTool{};\n tool.cwlVersion = cwl::CWLVersion::v1_2;\n tool.label = tool_info.name;\n tool.doc = tool_info.description;\n // = tool_info.category; //!TODO\n // = tool_info.docurl; //!TODO\n // = tool_info.version; //!TODO\n\n\n //!TODO Add citation information\n // for (auto& [doi, url] : tool_info.citations) {\n // citationNode.children.push_back({/*.tag = */\"citation\",\n // /*.attr = */{{\"doi\", doi}, {\"url\", url}}});\n // }\n // toolNode.children.push_back(citationNode);\n auto baseCommand = std::vector<std::string>{};\n baseCommand.push_back(std::filesystem::path{tool_info.executableName}.filename().string());\n\n detail::f(doc.params, doc, [&](auto input) {\n tool.inputs->push_back(std::move(input));\n }, [&](auto output) {\n tool.outputs->push_back(std::move(output));\n }, [&](auto command) {\n baseCommand.push_back(command);\n });\n\n tool.baseCommand = baseCommand;\n\n auto y = toYaml(tool);\n\n // function to traverse yaml tree and executes 'simplifyType' on all nodes with name 'type'\n auto traverseTree = std::function<void(YAML::Node)>{};\n traverseTree = [&traverseTree](YAML::Node node) {\n if (node.IsMap()) {\n for (auto n : node) {\n if (n.first.as<std::string>(\"\") == \"type\") {\n n.second = detail::simplifyType(n.second);\n traverseTree(n.second);\n } else {\n traverseTree(n.second);\n }\n }\n } else if (node.IsSequence()) {\n for (auto n : node) {\n traverseTree(n);\n }\n }\n };\n // Post procssing inputs and outputs of the yaml object\n for (auto param : {\"inputs\", \"outputs\"}) {\n traverseTree(y[param]);\n }\n\n // post process generated cwl yaml file\n if (post_process_cwl) {\n post_process_cwl(y);\n }\n\n YAML::Emitter out;\n out << y;\n return out.c_str();\n}\n\n}\n\n#if (defined(_WIN32) || defined(WIN32)) && !defined(__GNUG__)\n#undef and\n#undef or\n#undef not\n#endif\n"},"language":{"kind":"string","value":"Unknown"}}},{"rowIdx":9347,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/tool_description_lib/src/tdl/convertToCTD.h"},"file_extension":{"kind":"string","value":".h"},"file_size":{"kind":"number","value":13490,"string":"13,490"},"line_count":{"kind":"number","value":360,"string":"360"},"content":{"kind":"string","value":"// SPDX-FileCopyrightText: 2006-2023, Knut Reinert & Freie Universität Berlin\n// SPDX-FileCopyrightText: 2016-2023, Knut Reinert & MPI für molekulare Genetik\n// SPDX-License-Identifier: BSD-3-Clause\n#pragma once\n\n#include \"ToolInfo.h\"\n\n#include <cassert>\n#include <iomanip>\n#include <limits>\n#include <map>\n#include <sstream>\n\n\n#if (defined(_WIN32) || defined(WIN32)) && !defined(__GNUG__)\n# // Maybe visual studio will get there one day to support the c++ standard...\n# // Until then we have to live with this:\n# define and &&\n# define or ||\n# define not !\n#endif\n\n\nnamespace tdl {\n\nnamespace detail {\n\n//!\\brief overload structure allowing fancy 'std::visit` syntax\ntemplate<class... Ts> struct overloaded : Ts... { using Ts::operator()...; };\n\n//!\\brief required deduction guide for c++17 (not required for c++20)\ntemplate<class... Ts> overloaded(Ts...) -> overloaded<Ts...>;\n\n\n//!\\brief replaces all occurrences of a character with a string\ninline auto replace(std::string replace_in, char to_replace, std::string const& replace_with) {\n auto out = std::string{};\n out.reserve(replace_in.size());\n for (auto c : replace_in) {\n if (c == to_replace) {\n out.append(replace_with);\n } else {\n out.append(std::string{c});\n }\n }\n return out;\n}\n\n//!\\brief required replacements to use strings safely inside XML documents\ninline auto escapeXML(std::string str) {\n str = replace(str, '&', \"&\");\n str = replace(str, '>', \">\");\n str = replace(str, '\"', \""\");\n str = replace(str, '<', \"<\");\n str = replace(str, '\\'', \"'\");\n str = replace(str, '\\t', \"	\");\n str = replace(str, '\\n', \"#br#\");\n\n return str;\n}\n\n//!\\brief Simple structure representing an XML document (or parts of it)\nstruct XMLNode {\n std::string tag{}; //!\\brief tag of the xml Node, e.g. \"div\" for <div>\n std::map<std::string, std::optional<std::string>> attr{}; //!\\brief a list of attributes included in the tag\n std::vector<XMLNode> children{}; //!\\brief a list of child XMLNodes\n std::optional<std::string> data{}; //!\\brief plain data included in this tag\n\n //!\\brief Converts this structures to a string\n auto generateString(std::vector<std::string> const& order, std::string ind = \"\") const -> std::string {\n auto ss = std::stringstream{};\n ss << ind << \"<\" << escapeXML(tag);\n\n\n // orders the attributes according to the values in `order`\n auto attributes = [&]() {\n auto t_attr = this->attr;\n auto attr2 = std::vector<std::tuple<std::string, std::optional<std::string>>>{};\n for (auto o : order) {\n if (t_attr.count(o) > 0) {\n attr2.emplace_back(o, t_attr.at(o));\n t_attr.erase(o);\n }\n }\n for (auto [key, v] : t_attr) {\n attr2.emplace_back(key, v);\n }\n return attr2;\n }();\n\n // generate all attributes\n for (auto const& [key, v] : attributes) {\n ss << \" \" << key;\n if (v) {\n ss << \"=\\\"\" << escapeXML(*v) << \"\\\"\";\n }\n }\n assert(children.empty() or not data); // can only have children or data, not both\n if (children.empty() and not data) {\n ss << \" />\\n\";\n } else if (children.empty()) {\n ss << \">\" << *data << \"</\" << escapeXML(tag) << \">\\n\";\n } else {\n ss << \">\\n\";\n for (auto const& child : children) {\n ss << child.generateString(order, ind + \" \");\n }\n ss << ind << \"</\" << escapeXML(tag) << \">\\n\";\n }\n return ss.str();\n }\n};\n\n\n//!\\brief convenience function, to have highest precision for float/double values\ntemplate <typename T>\nauto convertToString(T v) -> std::string {\n auto ss = std::stringstream{};\n ss << std::setprecision(std::numeric_limits<std::decay_t<T>>::max_digits10)\n << v;\n return ss.str();\n}\n\n// helper function, to generate the restriction attribute\ntemplate <typename T>\nauto generateRestrictions(T const& value) -> std::optional<std::string> {\n if (!value.minLimit and !value.maxLimit) {\n return std::nullopt;\n }\n auto restrictions = std::string{};\n if (value.minLimit) {\n restrictions = convertToString(*value.minLimit);;\n }\n restrictions += ':';\n if (value.maxLimit) {\n restrictions += convertToString(*value.maxLimit);;\n }\n return restrictions;\n}\n\n// helper function to generate the restrictions of string values\ntemplate <typename T>\nauto generateValidList(T const& value) -> std::optional<std::string> {\n if (!value.validValues or value.validValues->empty()) {\n return std::nullopt;\n }\n auto restrictions = std::string{};\n restrictions = std::accumulate(++begin(*value.validValues), end(*value.validValues), *begin(*value.validValues), [](auto acc, auto const& next) {\n acc.append(\",\");\n acc.append(next);\n return acc;\n });\n return restrictions;\n}\n\n\n//!\\brief converts a Node into an XMLNode\ninline auto convertToCTD(Node const& param) -> XMLNode {\n // generate a single Node\n auto xmlNode = XMLNode{/*.tag = */\"NODE\",\n /*.attr = */{{\"name\", param.name}, {\"description\", param.description}}};\n\n\n auto tags = param.tags; // copy tags to make them mutable\n\n // fill xmlNode depending on the actual type\n std::visit(overloaded{\n [&](BoolValue value) {\n xmlNode.tag = \"ITEM\";\n xmlNode.attr[\"type\"] = \"bool\";\n xmlNode.attr[\"value\"] = value?\"true\":\"false\";\n },\n [&](IntValue value) {\n xmlNode.tag = \"ITEM\";\n xmlNode.attr[\"type\"] = \"int\";\n xmlNode.attr[\"value\"] = std::to_string(value.value);\n if (auto v = generateRestrictions(value)) xmlNode.attr[\"restrictions\"] = v;\n },\n [&](DoubleValue value) {\n xmlNode.tag = \"ITEM\";\n xmlNode.attr[\"type\"] = \"double\";\n xmlNode.attr[\"value\"] = convertToString(value.value);\n if (auto v = generateRestrictions(value)) xmlNode.attr[\"restrictions\"] = v;\n },\n [&](StringValue value) {\n xmlNode.tag = \"ITEM\";\n if (tags.count(\"input file\") > 0) {\n tags.erase(\"input file\");\n xmlNode.attr[\"type\"] = \"input-file\";\n if (auto v = generateValidList(value)) xmlNode.attr[\"supported_formats\"] = v;\n } else if (tags.count(\"output file\") > 0) {\n tags.erase(\"output file\");\n xmlNode.attr[\"type\"] = \"output-file\";\n if (auto v = generateValidList(value)) xmlNode.attr[\"supported_formats\"] = v;\n } else if (tags.count(\"output prefix\") > 0) {\n tags.erase(\"output prefix\");\n xmlNode.attr[\"type\"] = \"output-prefix\";\n if (auto v = generateValidList(value)) xmlNode.attr[\"supported_formats\"] = v;\n } else {\n xmlNode.attr[\"type\"] = \"string\";\n if (auto v = generateValidList(value)) xmlNode.attr[\"restrictions\"] = v;\n }\n xmlNode.attr[\"value\"] = value.value;\n },\n [&](IntValueList value) {\n xmlNode.tag = \"ITEMLIST\";\n xmlNode.attr[\"type\"] = \"int\";\n for (auto const& v : value.value) {\n xmlNode.children.push_back({\"LISTITEM\", {{\"value\", convertToString(v)}}});\n }\n if (auto v = generateRestrictions(value)) xmlNode.attr[\"restrictions\"] = v;\n\n },\n [&](DoubleValueList value) {\n xmlNode.tag = \"ITEMLIST\";\n xmlNode.attr[\"type\"] = \"double\";\n for (auto const& v : value.value) {\n xmlNode.children.push_back({\"LISTITEM\", {{\"value\", convertToString(v)}}});\n }\n if (auto v = generateRestrictions(value)) xmlNode.attr[\"restrictions\"] = v;\n },\n [&](StringValueList value) {\n xmlNode.tag = \"ITEMLIST\";\n if (tags.count(\"input file\") > 0) {\n tags.erase(\"input file\");\n xmlNode.attr[\"type\"] = \"input-file\";\n if (auto v = generateValidList(value)) xmlNode.attr[\"supported_formats\"] = v;\n } else if (tags.count(\"output file\") > 0) {\n tags.erase(\"output file\");\n xmlNode.attr[\"type\"] = \"output-file\";\n if (auto v = generateValidList(value)) xmlNode.attr[\"supported_formats\"] = v;\n } else {\n xmlNode.attr[\"type\"] = \"string\";\n if (auto v = generateValidList(value)) xmlNode.attr[\"restrictions\"] = v;\n }\n for (auto const& v : value.value) {\n xmlNode.children.push_back({\"LISTITEM\", {{\"value\", v}}});\n }\n },\n [&](Node::Children const& children) {\n for (auto const& child : children) {\n xmlNode.children.emplace_back(convertToCTD(child));\n }\n },\n }, param.value);\n\n // add description if available\n if (not param.description.empty()) {\n xmlNode.attr[\"description\"] = param.description;\n }\n\n if (xmlNode.tag != \"NODE\") {\n // convert special tags to special xml attributes\n auto convertTagToAttr = [&](std::string const& tag) {\n xmlNode.attr[tag] = tags.count(tag)?\"true\":\"false\";\n tags.erase(tag);\n };\n convertTagToAttr(\"required\");\n convertTagToAttr(\"advanced\");\n }\n\n // add all other tags to the \"tags\" xml attribute\n if (not tags.empty()) {\n auto list = std::accumulate(++begin(tags), end(tags), *begin(tags), [](auto acc, auto const& next) {\n acc.append(\",\");\n acc.append(next);\n return acc;\n });\n xmlNode.attr[\"tags\"] = list;\n }\n return xmlNode;\n}\n\n}\n\n\n/*!\\brief converts a ToolInfo into a string that\n * holds the CTD representation of the given tool\n */\ninline auto convertToCTD(ToolInfo const& doc) {\n auto& node = doc.params;\n auto& tool_info = doc.metaInfo;\n auto const schema_location = std::string{\"/SCHEMAS/Param_1_7_0.xsd\"};\n auto const schema_version = std::string{\"1.7.0\"};\n\n // Write ctd specific stuff\n auto toolNode = detail::XMLNode{/*.tag = */\"tool\",\n /*.attr = */{{\"ctdVersion\", \"1.7\"}}};\n\n auto emptyOrAttr = [&](std::string attr, std::string const& in) {\n if (not in.empty()) {\n toolNode.attr[attr] = in;\n }\n };\n emptyOrAttr(\"version\", tool_info.version);\n emptyOrAttr(\"name\", tool_info.name);\n emptyOrAttr(\"docurl\", tool_info.docurl);\n emptyOrAttr(\"category\", tool_info.category);\n\n auto emptyOrTag = [&](std::string tag, std::string const& in) {\n if (not in.empty()) {\n toolNode.children.push_back(detail::XMLNode {/*.tag =*/ tag,\n /*.attr =*/ {},\n /*.children =*/ {},\n /*.data =*/ \"<![CDATA[\" + in + \"]]>\"});\n }\n };\n emptyOrTag(\"description\", tool_info.description);\n emptyOrTag(\"manual\", tool_info.description); //!TODO why does OpenMS do this?\n emptyOrTag(\"executableName\", tool_info.executableName);\n\n\n auto citationNode = detail::XMLNode{/*.tag = */\"citations\"};\n for (auto& [doi, url] : tool_info.citations) {\n citationNode.children.push_back({/*.tag = */\"citation\",\n /*.attr = */{{\"doi\", doi}, {\"url\", url}}});\n }\n toolNode.children.push_back(citationNode);\n\n auto paramsNode = detail::XMLNode{/*.tag = */\"PARAMETERS\",\n /*.attr = */{{\"version\", schema_version},\n {\"xsi:noNamespaceSchemaLocation\", \"https://raw.githubusercontent.com/OpenMS/OpenMS/develop/share/OpenMS\" + schema_location},\n {\"xmlns:xsi\", \"http://www.w3.org/2001/XMLSchema-instance\"}}};\n\n for (auto child : node) {\n paramsNode.children.emplace_back(detail::convertToCTD(child));\n }\n toolNode.children.push_back(paramsNode);\n\n // add cli mapping\n if (not doc.cliMapping.empty()) {\n auto cliNode = detail::XMLNode{/*.tag = */\"cli\"};\n for (auto const& [optionIdentifier, referenceName] : doc.cliMapping) {\n cliNode.children.push_back({/*.tag = */\"clielement\", /*.attr = */{{\"optionIdentifier\", optionIdentifier}}});\n cliNode.children.back().children.push_back({/*.tag = */\"mapping\", /*.attr = */{{\"referenceName\", referenceName}}});\n }\n toolNode.children.emplace_back(std::move(cliNode));\n }\n\n\n auto ss = std::stringstream{};\n ss.precision(std::numeric_limits<double>::digits10);\n\n auto order = std::vector<std::string>{\"ctdVersion\", \"version\", \"name\", \"value\", \"type\", \"description\", \"docurl\", \"category\", \"xsi:noNamespaceSchemaLocation\", \"xmlns:xsi\", \"required\", \"advanced\", \"restrictions\"};\n\n // Write ctd specific stuff\n ss << \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n\";\n ss << toolNode.generateString(order);\n\n return ss.str();\n}\n\n}\n\n#if (defined(_WIN32) || defined(WIN32)) && !defined(__GNUG__)\n#undef and\n#undef or\n#undef not\n#endif\n"},"language":{"kind":"string","value":"Unknown"}}},{"rowIdx":9348,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/tool_description_lib/src/tdl/ToolInfo.h"},"file_extension":{"kind":"string","value":".h"},"file_size":{"kind":"number","value":5541,"string":"5,541"},"line_count":{"kind":"number","value":161,"string":"161"},"content":{"kind":"string","value":"// SPDX-FileCopyrightText: 2006-2023, Knut Reinert & Freie Universität Berlin\n// SPDX-FileCopyrightText: 2016-2023, Knut Reinert & MPI für molekulare Genetik\n// SPDX-License-Identifier: BSD-3-Clause\n#pragma once\n\n#include <numeric>\n#include <optional>\n#include <set>\n#include <string>\n#include <tuple>\n#include <variant>\n#include <vector>\n\nnamespace tdl {\n\nnamespace detail {\n\n//!\\brief Helper struct to detect if a datastructure is a vector\ntemplate <typename T>\nstruct is_vector : std::false_type {};\n\ntemplate <typename T>\nstruct is_vector<std::vector<T>> : std::true_type {};\n\ntemplate <typename T>\ninline static constexpr bool is_vector_v = is_vector<T>::value;\n\n/*!\\brief Stores a value with optional limits\n */\ntemplate <typename T, typename ListType=T>\nstruct TValue {\n ListType value{};\n std::optional<T> minLimit{};\n std::optional<T> maxLimit{};\n\n enum class State {Ok, LimitsInvalid, ValueToLow, ValueToHigh};\n auto state() const {\n if (minLimit and maxLimit and *minLimit > *maxLimit) {\n return State::LimitsInvalid;\n }\n if constexpr (is_vector_v<T>) {\n for (auto e : value) {\n if (minLimit and *minLimit > e) {\n return State::ValueToLow;\n }\n if (maxLimit and *maxLimit < e) {\n return State::ValueToHigh;\n }\n }\n } else {\n if (minLimit and *minLimit > value) {\n return State::ValueToLow;\n }\n if (maxLimit and *maxLimit < value) {\n return State::ValueToHigh;\n }\n }\n return State::Ok;\n }\n};\n\n/*!\\brief Stores a string with optional list of valid strings.\n */\ntemplate <typename T, typename ListType=T>\nstruct TStringValue {\n ListType value{};\n std::optional<std::vector<T>> validValues{};\n\n enum class State {Valid, Invalid};\n auto state() const {\n if (validValues) {\n auto checkSingleValue = [this](T const& value) {\n return std::accumulate(begin(*validValues), end(*validValues), false, [&](auto acc, auto const& pattern) {\n if (value == pattern) {\n return true;\n }\n return acc;\n });\n };\n\n if constexpr (is_vector_v<T>) {\n for (auto const& e : value) {\n auto isValid = checkSingleValue(e);\n if (not isValid) {\n return State::Invalid;;\n }\n }\n } else {\n auto isValid = checkSingleValue(value);\n if (not isValid) {\n return State::Invalid;;\n }\n }\n }\n return State::Valid;\n }\n};\n\n}\n\n// Value types that are valid entries in the Node\nusing BoolValue = bool;\nusing IntValue = detail::TValue<int>;\nusing DoubleValue = detail::TValue<double>;\nusing StringValue = detail::TStringValue<std::string>;\nusing IntValueList = detail::TValue<int, std::vector<int>>;\nusing DoubleValueList = detail::TValue<double, std::vector<double>>;\nusing StringValueList = detail::TStringValue<std::string, std::vector<std::string>>;\n\n/*!\\brief represents a parameter tree or a subtree of the parameter tree.\n *\n * This represents values that are structured in a tree and strongly typed.\n */\nstruct Node {\n using Children = std::vector<Node>;\n using Value = std::variant<BoolValue, // just a single bool value\n IntValue, // single int, double or string value\n DoubleValue,\n StringValue,\n IntValueList, // list of int, double or string values\n DoubleValueList,\n StringValueList,\n Children>; // not a value, but a node with children\n\n std::string name{}; //!< Name of the entry.\n std::string description{}; //!< Entry description.\n std::set<std::string> tags{}; //!< List of tags, e.g.: advanced parameter tag.\n Value value{Children{}}; //!< Current value of this entry\n};\n\n//! A pair of mapping from tree parameter names to cli names\nstruct CLIMapping {\n std::string optionIdentifier; //!< full name on the command line (including '-' or '--')\n std::string referenceName; //!< name of the option inside the parameter tree\n};\n\n//\\brief Citation information of the app\nstruct Citation {\n std::string doi; //!\\brief the doi (document object identifier)\n std::string url; //!\\brief an url for direct access.\n};\n\n//!\\brief Meta data of the tool\nstruct MetaInfo {\n std::string version{}; //!\\brief version as a string\n std::string name{}; //!\\brief name of the app\n std::string docurl{}; //!\\brief url to the documentation of the app\n std::string category{}; //!\\brief category of the app\n std::string description{}; //!\\brief a brief description of the app\n std::string executableName{}; //!\\brief the actual call of this app\n std::vector<Citation> citations{}; //!\\brief list publication integrated into this app\n};\n\n//! A full parameter tree document with cli mappings\nstruct ToolInfo {\n MetaInfo metaInfo{};\n Node::Children params{};\n std::vector<CLIMapping> cliMapping{};\n};\n}\n"},"language":{"kind":"string","value":"Unknown"}}},{"rowIdx":9349,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/tool_description_lib/src/tdl/tdl.h"},"file_extension":{"kind":"string","value":".h"},"file_size":{"kind":"number","value":290,"string":"290"},"line_count":{"kind":"number","value":10,"string":"10"},"content":{"kind":"string","value":"// SPDX-FileCopyrightText: 2006-2023, Knut Reinert & Freie Universität Berlin\n// SPDX-FileCopyrightText: 2016-2023, Knut Reinert & MPI für molekulare Genetik\n// SPDX-License-Identifier: BSD-3-Clause\n#pragma once\n\n#include \"ToolInfo.h\"\n#include \"convertToCTD.h\"\n#include \"convertToCWL.h\"\n\n"},"language":{"kind":"string","value":"Unknown"}}},{"rowIdx":9350,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/extern/tool_description_lib/src/tdl/cwl_v1_2.h"},"file_extension":{"kind":"string","value":".h"},"file_size":{"kind":"number","value":244006,"string":"244,006"},"line_count":{"kind":"number","value":5964,"string":"5,964"},"content":{"kind":"string","value":"// SPDX-FileCopyrightText: Copyright 2016-2023 CWL Project Contributors\n// SPDX-License-Identifier: Apache-2.0\n#pragma once\n\n/* This file was generated using schema-salad code generator.\n *\n * The embedded document is subject to the license of the original schema.\n */\n\n#include <any>\n#include <cassert>\n#include <cstddef>\n#include <cstdint>\n#include <map>\n#include <optional>\n#include <string>\n#include <string_view>\n#include <variant>\n#include <vector>\n#include <yaml-cpp/yaml.h>\n\ninline auto mergeYaml(YAML::Node n1, YAML::Node n2) {\n for (auto const& e : n1) {\n n2[e.first.as<std::string>()] = e.second;\n }\n return n2;\n}\n\n// declaring toYaml\ninline auto toYaml(bool v) {\n return YAML::Node{v};\n}\ninline auto toYaml(float v) {\n return YAML::Node{v};\n}\ninline auto toYaml(double v) {\n return YAML::Node{v};\n}\ninline auto toYaml(int32_t v) {\n return YAML::Node{v};\n}\ninline auto toYaml(int64_t v) {\n return YAML::Node{v};\n}\ninline auto toYaml(std::any const&) {\n return YAML::Node{};\n}\ninline auto toYaml(std::monostate const&) {\n return YAML::Node(YAML::NodeType::Undefined);\n}\ninline auto toYaml(std::string const& v) {\n return YAML::Node{v};\n}\n\n// declaring fromYaml\ninline void fromYaml(YAML::Node const& n, bool& v) {\n v = n.as<bool>();\n}\ninline void fromYaml(YAML::Node const& n, float& v) {\n v = n.as<float>();\n}\ninline void fromYaml(YAML::Node const& n, double& v) {\n v = n.as<double>();\n}\ninline void fromYaml(YAML::Node const& n, int32_t& v) {\n v = n.as<int32_t>();\n}\ninline void fromYaml(YAML::Node const& n, int64_t& v) {\n v = n.as<int64_t>();\n}\ninline void fromYaml(YAML::Node const& n, std::string& v) {\n v = n.as<std::string>();\n}\ninline void fromYaml(YAML::Node const&, std::any&) {\n}\ninline void fromYaml(YAML::Node const&, std::monostate&) {\n}\n\ninline void addYamlField(YAML::Node& node, std::string const& key, YAML::Node value) {\n if (value.IsDefined()) {\n node[key] = value;\n }\n}\n\ninline auto convertListToMap(YAML::Node list, std::string const& key_name) {\n if (list.size() == 0) return list;\n auto map = YAML::Node{};\n for (YAML::Node n : list) {\n auto key = n[key_name].as<std::string>();\n n.remove(key_name);\n map[key] = n;\n }\n return map;\n}\ninline auto convertMapToList(YAML::Node map, std::string const& key_name) {\n if (!map.IsDefined()) return map;\n if (!map.IsMap()) return map;\n auto list = YAML::Node{};\n for (auto n : map) {\n n.second[key_name] = n.first;\n list.push_back(n.second);\n }\n return list;\n}\n\ntemplate <typename T> struct IsConstant : std::false_type {};\n\n// fwd declaring toYaml\ntemplate <typename T>\nauto toYaml(std::vector<T> const& v) -> YAML::Node;\ntemplate <typename T>\nauto toYaml(T const& t) -> YAML::Node;\ntemplate <typename ...Args>\nauto toYaml(std::variant<Args...> const& t) -> YAML::Node;\n\n// fwd declaring fromYaml\ntemplate <typename T>\nvoid fromYaml(YAML::Node const& n, std::vector<T>& v);\ntemplate <typename T>\nvoid fromYaml(YAML::Node const& n, T& t);\ntemplate <typename ...Args>\nvoid fromYaml(YAML::Node const& n, std::variant<Args...>& t);\n\ntemplate <typename T>\nstruct DetectAndExtractFromYaml {\n auto operator()(YAML::Node const&) const -> std::optional<T> {\n return std::nullopt;\n }\n};\n\ntemplate <>\nstruct DetectAndExtractFromYaml<std::monostate> {\n auto operator()(YAML::Node const& n) const -> std::optional<std::monostate> {\n if (!n.IsDefined()) return std::monostate{};\n return std::nullopt;\n }\n};\n\ntemplate <typename S>\nstruct DetectAndExtractFromYaml_implScalar {\n auto operator()(YAML::Node const& n) const -> std::optional<S> {\n try {\n if (n.IsScalar()) return n.as<S>();\n } catch(...) {}\n return std::nullopt;\n }\n};\n\ntemplate <> struct DetectAndExtractFromYaml<bool> : DetectAndExtractFromYaml_implScalar<bool>{};\ntemplate <> struct DetectAndExtractFromYaml<float> : DetectAndExtractFromYaml_implScalar<float>{};\ntemplate <> struct DetectAndExtractFromYaml<double> : DetectAndExtractFromYaml_implScalar<double>{};\ntemplate <> struct DetectAndExtractFromYaml<int32_t> : DetectAndExtractFromYaml_implScalar<int32_t>{};\ntemplate <> struct DetectAndExtractFromYaml<int64_t> : DetectAndExtractFromYaml_implScalar<int64_t>{};\ntemplate <> struct DetectAndExtractFromYaml<std::string> : DetectAndExtractFromYaml_implScalar<std::string>{};\n\ntemplate <typename T>\nstruct DetectAndExtractFromYaml<std::vector<T>> {\n auto operator()(YAML::Node const& n) const -> std::optional<std::vector<T>> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsSequence()) return std::nullopt;\n auto res = std::vector<T>{};\n fromYaml(n, res);\n return res;\n }\n};\n\ntemplate <typename T>\nclass heap_object {\n std::unique_ptr<T> data = std::make_unique<T>();\n\npublic:\n using value_t = T;\n heap_object() noexcept(false) {}\n heap_object(heap_object const& oth) {\n *data = *oth;\n }\n heap_object(heap_object&& oth) noexcept(noexcept(*data = std::move(*oth))) {\n *data = std::move(*oth);\n }\n\n template <typename T2>\n heap_object(T2 const& oth) {\n *data = oth;\n }\n template <typename T2>\n heap_object(T2&& oth) noexcept(noexcept(*data = std::forward<T2>(oth))) {\n *data = std::forward<T2>(oth);\n }\n\n ~heap_object() = default;\n\n auto operator=(heap_object const& oth) -> heap_object& {\n *data = *oth;\n return *this;\n }\n auto operator=(heap_object&& oth) noexcept(noexcept(*data = std::move(*oth))) -> heap_object& {\n *data = std::move(*oth);\n return *this;\n }\n\n template <typename T2>\n auto operator=(T2 const& oth) -> heap_object& {\n *data = oth;\n return *this;\n }\n template <typename T2>\n auto operator=(T2&& oth) noexcept(noexcept(*data = std::forward<T2>(oth))) -> heap_object& {\n *data = std::forward<T2>(oth);\n return *this;\n }\n\n auto operator->() noexcept(true) -> T* {\n return data.get();\n }\n auto operator->() const noexcept(true) -> T const* {\n return data.get();\n }\n auto operator*() noexcept(true) -> T& {\n return *data;\n }\n auto operator*() const noexcept(true) -> T const& {\n return *data;\n }\n};\n\nnamespace https___w3id_org_cwl_salad { struct Documented; }\nnamespace https___w3id_org_cwl_salad { struct RecordField; }\nnamespace https___w3id_org_cwl_salad { struct RecordSchema; }\nnamespace https___w3id_org_cwl_salad { struct EnumSchema; }\nnamespace https___w3id_org_cwl_salad { struct ArraySchema; }\nnamespace https___w3id_org_cwl_cwl { struct File; }\nnamespace https___w3id_org_cwl_cwl { struct Directory; }\nnamespace https___w3id_org_cwl_cwl { struct Labeled; }\nnamespace https___w3id_org_cwl_cwl { struct Identified; }\nnamespace https___w3id_org_cwl_cwl { struct LoadContents; }\nnamespace https___w3id_org_cwl_cwl { struct FieldBase; }\nnamespace https___w3id_org_cwl_cwl { struct InputFormat; }\nnamespace https___w3id_org_cwl_cwl { struct OutputFormat; }\nnamespace https___w3id_org_cwl_cwl { struct Parameter; }\nnamespace https___w3id_org_cwl_cwl { struct InputBinding; }\nnamespace https___w3id_org_cwl_cwl { struct IOSchema; }\nnamespace https___w3id_org_cwl_cwl { struct InputSchema; }\nnamespace https___w3id_org_cwl_cwl { struct OutputSchema; }\nnamespace https___w3id_org_cwl_cwl { struct InputRecordField; }\nnamespace https___w3id_org_cwl_cwl { struct InputRecordSchema; }\nnamespace https___w3id_org_cwl_cwl { struct InputEnumSchema; }\nnamespace https___w3id_org_cwl_cwl { struct InputArraySchema; }\nnamespace https___w3id_org_cwl_cwl { struct OutputRecordField; }\nnamespace https___w3id_org_cwl_cwl { struct OutputRecordSchema; }\nnamespace https___w3id_org_cwl_cwl { struct OutputEnumSchema; }\nnamespace https___w3id_org_cwl_cwl { struct OutputArraySchema; }\nnamespace https___w3id_org_cwl_cwl { struct InputParameter; }\nnamespace https___w3id_org_cwl_cwl { struct OutputParameter; }\nnamespace https___w3id_org_cwl_cwl { struct ProcessRequirement; }\nnamespace https___w3id_org_cwl_cwl { struct Process; }\nnamespace https___w3id_org_cwl_cwl { struct InlineJavascriptRequirement; }\nnamespace https___w3id_org_cwl_cwl { struct CommandInputSchema; }\nnamespace https___w3id_org_cwl_cwl { struct SchemaDefRequirement; }\nnamespace https___w3id_org_cwl_cwl { struct SecondaryFileSchema; }\nnamespace https___w3id_org_cwl_cwl { struct LoadListingRequirement; }\nnamespace https___w3id_org_cwl_cwl { struct EnvironmentDef; }\nnamespace https___w3id_org_cwl_cwl { struct CommandLineBinding; }\nnamespace https___w3id_org_cwl_cwl { struct CommandOutputBinding; }\nnamespace https___w3id_org_cwl_cwl { struct CommandLineBindable; }\nnamespace https___w3id_org_cwl_cwl { struct CommandInputRecordField; }\nnamespace https___w3id_org_cwl_cwl { struct CommandInputRecordSchema; }\nnamespace https___w3id_org_cwl_cwl { struct CommandInputEnumSchema; }\nnamespace https___w3id_org_cwl_cwl { struct CommandInputArraySchema; }\nnamespace https___w3id_org_cwl_cwl { struct CommandOutputRecordField; }\nnamespace https___w3id_org_cwl_cwl { struct CommandOutputRecordSchema; }\nnamespace https___w3id_org_cwl_cwl { struct CommandOutputEnumSchema; }\nnamespace https___w3id_org_cwl_cwl { struct CommandOutputArraySchema; }\nnamespace https___w3id_org_cwl_cwl { struct CommandInputParameter; }\nnamespace https___w3id_org_cwl_cwl { struct CommandOutputParameter; }\nnamespace https___w3id_org_cwl_cwl { struct CommandLineTool; }\nnamespace https___w3id_org_cwl_cwl { struct DockerRequirement; }\nnamespace https___w3id_org_cwl_cwl { struct SoftwareRequirement; }\nnamespace https___w3id_org_cwl_cwl { struct SoftwarePackage; }\nnamespace https___w3id_org_cwl_cwl { struct Dirent; }\nnamespace https___w3id_org_cwl_cwl { struct InitialWorkDirRequirement; }\nnamespace https___w3id_org_cwl_cwl { struct EnvVarRequirement; }\nnamespace https___w3id_org_cwl_cwl { struct ShellCommandRequirement; }\nnamespace https___w3id_org_cwl_cwl { struct ResourceRequirement; }\nnamespace https___w3id_org_cwl_cwl { struct WorkReuse; }\nnamespace https___w3id_org_cwl_cwl { struct NetworkAccess; }\nnamespace https___w3id_org_cwl_cwl { struct InplaceUpdateRequirement; }\nnamespace https___w3id_org_cwl_cwl { struct ToolTimeLimit; }\nnamespace https___w3id_org_cwl_cwl { struct ExpressionToolOutputParameter; }\nnamespace https___w3id_org_cwl_cwl { struct WorkflowInputParameter; }\nnamespace https___w3id_org_cwl_cwl { struct ExpressionTool; }\nnamespace https___w3id_org_cwl_cwl { struct WorkflowOutputParameter; }\nnamespace https___w3id_org_cwl_cwl { struct Sink; }\nnamespace https___w3id_org_cwl_cwl { struct WorkflowStepInput; }\nnamespace https___w3id_org_cwl_cwl { struct WorkflowStepOutput; }\nnamespace https___w3id_org_cwl_cwl { struct WorkflowStep; }\nnamespace https___w3id_org_cwl_cwl { struct Workflow; }\nnamespace https___w3id_org_cwl_cwl { struct SubworkflowFeatureRequirement; }\nnamespace https___w3id_org_cwl_cwl { struct ScatterFeatureRequirement; }\nnamespace https___w3id_org_cwl_cwl { struct MultipleInputFeatureRequirement; }\nnamespace https___w3id_org_cwl_cwl { struct StepInputExpressionRequirement; }\nnamespace https___w3id_org_cwl_cwl { struct OperationInputParameter; }\nnamespace https___w3id_org_cwl_cwl { struct OperationOutputParameter; }\nnamespace https___w3id_org_cwl_cwl { struct Operation; }\nnamespace https___w3id_org_cwl_salad {\nenum class PrimitiveType : unsigned int {\n null,\n boolean,\n int_,\n long_,\n float_,\n double_,\n string\n};\ninline auto to_string(PrimitiveType v) {\n static auto m = std::vector<std::string_view> {\n \"null\",\n \"boolean\",\n \"int\",\n \"long\",\n \"float\",\n \"double\",\n \"string\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_salad::PrimitiveType>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_salad::PrimitiveType& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_salad::PrimitiveType, std::less<>> {\n {\"null\", https___w3id_org_cwl_salad::PrimitiveType::null},\n {\"boolean\", https___w3id_org_cwl_salad::PrimitiveType::boolean},\n {\"int\", https___w3id_org_cwl_salad::PrimitiveType::int_},\n {\"long\", https___w3id_org_cwl_salad::PrimitiveType::long_},\n {\"float\", https___w3id_org_cwl_salad::PrimitiveType::float_},\n {\"double\", https___w3id_org_cwl_salad::PrimitiveType::double_},\n {\"string\", https___w3id_org_cwl_salad::PrimitiveType::string},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_salad::PrimitiveType v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_salad::PrimitiveType& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_salad::PrimitiveType> : std::true_type {};namespace https___w3id_org_cwl_salad {\nenum class Any : unsigned int {\n Any\n};\ninline auto to_string(Any v) {\n static auto m = std::vector<std::string_view> {\n \"Any\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_salad::Any>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_salad::Any& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_salad::Any, std::less<>> {\n {\"Any\", https___w3id_org_cwl_salad::Any::Any},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_salad::Any v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_salad::Any& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_salad::Any> : std::true_type {};namespace https___w3id_org_cwl_salad {\nenum class RecordSchema_type_Record_name : unsigned int {\n record\n};\ninline auto to_string(RecordSchema_type_Record_name v) {\n static auto m = std::vector<std::string_view> {\n \"record\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_salad::RecordSchema_type_Record_name>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_salad::RecordSchema_type_Record_name& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_salad::RecordSchema_type_Record_name, std::less<>> {\n {\"record\", https___w3id_org_cwl_salad::RecordSchema_type_Record_name::record},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_salad::RecordSchema_type_Record_name v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_salad::RecordSchema_type_Record_name& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_salad::RecordSchema_type_Record_name> : std::true_type {};namespace https___w3id_org_cwl_salad {\nenum class EnumSchema_type_Enum_name : unsigned int {\n enum_\n};\ninline auto to_string(EnumSchema_type_Enum_name v) {\n static auto m = std::vector<std::string_view> {\n \"enum\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_salad::EnumSchema_type_Enum_name>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_salad::EnumSchema_type_Enum_name& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_salad::EnumSchema_type_Enum_name, std::less<>> {\n {\"enum\", https___w3id_org_cwl_salad::EnumSchema_type_Enum_name::enum_},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_salad::EnumSchema_type_Enum_name v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_salad::EnumSchema_type_Enum_name& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_salad::EnumSchema_type_Enum_name> : std::true_type {};namespace https___w3id_org_cwl_salad {\nenum class ArraySchema_type_Array_name : unsigned int {\n array\n};\ninline auto to_string(ArraySchema_type_Array_name v) {\n static auto m = std::vector<std::string_view> {\n \"array\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_salad::ArraySchema_type_Array_name>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_salad::ArraySchema_type_Array_name& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_salad::ArraySchema_type_Array_name, std::less<>> {\n {\"array\", https___w3id_org_cwl_salad::ArraySchema_type_Array_name::array},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_salad::ArraySchema_type_Array_name v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_salad::ArraySchema_type_Array_name& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_salad::ArraySchema_type_Array_name> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class CWLVersion : unsigned int {\n draft_2,\n draft_3_dev1,\n draft_3_dev2,\n draft_3_dev3,\n draft_3_dev4,\n draft_3_dev5,\n draft_3,\n draft_4_dev1,\n draft_4_dev2,\n draft_4_dev3,\n v1_0_dev4,\n v1_0,\n v1_1_0_dev1,\n v1_1,\n v1_2_0_dev1,\n v1_2_0_dev2,\n v1_2_0_dev3,\n v1_2_0_dev4,\n v1_2_0_dev5,\n v1_2\n};\ninline auto to_string(CWLVersion v) {\n static auto m = std::vector<std::string_view> {\n \"draft-2\",\n \"draft-3.dev1\",\n \"draft-3.dev2\",\n \"draft-3.dev3\",\n \"draft-3.dev4\",\n \"draft-3.dev5\",\n \"draft-3\",\n \"draft-4.dev1\",\n \"draft-4.dev2\",\n \"draft-4.dev3\",\n \"v1.0.dev4\",\n \"v1.0\",\n \"v1.1.0-dev1\",\n \"v1.1\",\n \"v1.2.0-dev1\",\n \"v1.2.0-dev2\",\n \"v1.2.0-dev3\",\n \"v1.2.0-dev4\",\n \"v1.2.0-dev5\",\n \"v1.2\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::CWLVersion>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::CWLVersion& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::CWLVersion, std::less<>> {\n {\"draft-2\", https___w3id_org_cwl_cwl::CWLVersion::draft_2},\n {\"draft-3.dev1\", https___w3id_org_cwl_cwl::CWLVersion::draft_3_dev1},\n {\"draft-3.dev2\", https___w3id_org_cwl_cwl::CWLVersion::draft_3_dev2},\n {\"draft-3.dev3\", https___w3id_org_cwl_cwl::CWLVersion::draft_3_dev3},\n {\"draft-3.dev4\", https___w3id_org_cwl_cwl::CWLVersion::draft_3_dev4},\n {\"draft-3.dev5\", https___w3id_org_cwl_cwl::CWLVersion::draft_3_dev5},\n {\"draft-3\", https___w3id_org_cwl_cwl::CWLVersion::draft_3},\n {\"draft-4.dev1\", https___w3id_org_cwl_cwl::CWLVersion::draft_4_dev1},\n {\"draft-4.dev2\", https___w3id_org_cwl_cwl::CWLVersion::draft_4_dev2},\n {\"draft-4.dev3\", https___w3id_org_cwl_cwl::CWLVersion::draft_4_dev3},\n {\"v1.0.dev4\", https___w3id_org_cwl_cwl::CWLVersion::v1_0_dev4},\n {\"v1.0\", https___w3id_org_cwl_cwl::CWLVersion::v1_0},\n {\"v1.1.0-dev1\", https___w3id_org_cwl_cwl::CWLVersion::v1_1_0_dev1},\n {\"v1.1\", https___w3id_org_cwl_cwl::CWLVersion::v1_1},\n {\"v1.2.0-dev1\", https___w3id_org_cwl_cwl::CWLVersion::v1_2_0_dev1},\n {\"v1.2.0-dev2\", https___w3id_org_cwl_cwl::CWLVersion::v1_2_0_dev2},\n {\"v1.2.0-dev3\", https___w3id_org_cwl_cwl::CWLVersion::v1_2_0_dev3},\n {\"v1.2.0-dev4\", https___w3id_org_cwl_cwl::CWLVersion::v1_2_0_dev4},\n {\"v1.2.0-dev5\", https___w3id_org_cwl_cwl::CWLVersion::v1_2_0_dev5},\n {\"v1.2\", https___w3id_org_cwl_cwl::CWLVersion::v1_2},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::CWLVersion v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::CWLVersion& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::CWLVersion> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class CWLType : unsigned int {\n null,\n boolean,\n int_,\n long_,\n float_,\n double_,\n string,\n File,\n Directory\n};\ninline auto to_string(CWLType v) {\n static auto m = std::vector<std::string_view> {\n \"null\",\n \"boolean\",\n \"int\",\n \"long\",\n \"float\",\n \"double\",\n \"string\",\n \"File\",\n \"Directory\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::CWLType>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::CWLType& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::CWLType, std::less<>> {\n {\"null\", https___w3id_org_cwl_cwl::CWLType::null},\n {\"boolean\", https___w3id_org_cwl_cwl::CWLType::boolean},\n {\"int\", https___w3id_org_cwl_cwl::CWLType::int_},\n {\"long\", https___w3id_org_cwl_cwl::CWLType::long_},\n {\"float\", https___w3id_org_cwl_cwl::CWLType::float_},\n {\"double\", https___w3id_org_cwl_cwl::CWLType::double_},\n {\"string\", https___w3id_org_cwl_cwl::CWLType::string},\n {\"File\", https___w3id_org_cwl_cwl::CWLType::File},\n {\"Directory\", https___w3id_org_cwl_cwl::CWLType::Directory},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::CWLType v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::CWLType& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::CWLType> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class File_class_File_class : unsigned int {\n File\n};\ninline auto to_string(File_class_File_class v) {\n static auto m = std::vector<std::string_view> {\n \"File\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::File_class_File_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::File_class_File_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::File_class_File_class, std::less<>> {\n {\"File\", https___w3id_org_cwl_cwl::File_class_File_class::File},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::File_class_File_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::File_class_File_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::File_class_File_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class Directory_class_Directory_class : unsigned int {\n Directory\n};\ninline auto to_string(Directory_class_Directory_class v) {\n static auto m = std::vector<std::string_view> {\n \"Directory\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::Directory_class_Directory_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::Directory_class_Directory_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::Directory_class_Directory_class, std::less<>> {\n {\"Directory\", https___w3id_org_cwl_cwl::Directory_class_Directory_class::Directory},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::Directory_class_Directory_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::Directory_class_Directory_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::Directory_class_Directory_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class LoadListingEnum : unsigned int {\n no_listing,\n shallow_listing,\n deep_listing\n};\ninline auto to_string(LoadListingEnum v) {\n static auto m = std::vector<std::string_view> {\n \"no_listing\",\n \"shallow_listing\",\n \"deep_listing\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::LoadListingEnum>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::LoadListingEnum& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::LoadListingEnum, std::less<>> {\n {\"no_listing\", https___w3id_org_cwl_cwl::LoadListingEnum::no_listing},\n {\"shallow_listing\", https___w3id_org_cwl_cwl::LoadListingEnum::shallow_listing},\n {\"deep_listing\", https___w3id_org_cwl_cwl::LoadListingEnum::deep_listing},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::LoadListingEnum v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::LoadListingEnum& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::LoadListingEnum> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class Expression : unsigned int {\n ExpressionPlaceholder\n};\ninline auto to_string(Expression v) {\n static auto m = std::vector<std::string_view> {\n \"ExpressionPlaceholder\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::Expression>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::Expression& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::Expression, std::less<>> {\n {\"ExpressionPlaceholder\", https___w3id_org_cwl_cwl::Expression::ExpressionPlaceholder},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::Expression v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::Expression& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::Expression> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class InlineJavascriptRequirement_class_InlineJavascriptRequirement_class : unsigned int {\n InlineJavascriptRequirement\n};\ninline auto to_string(InlineJavascriptRequirement_class_InlineJavascriptRequirement_class v) {\n static auto m = std::vector<std::string_view> {\n \"InlineJavascriptRequirement\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::InlineJavascriptRequirement_class_InlineJavascriptRequirement_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::InlineJavascriptRequirement_class_InlineJavascriptRequirement_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::InlineJavascriptRequirement_class_InlineJavascriptRequirement_class, std::less<>> {\n {\"InlineJavascriptRequirement\", https___w3id_org_cwl_cwl::InlineJavascriptRequirement_class_InlineJavascriptRequirement_class::InlineJavascriptRequirement},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::InlineJavascriptRequirement_class_InlineJavascriptRequirement_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::InlineJavascriptRequirement_class_InlineJavascriptRequirement_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::InlineJavascriptRequirement_class_InlineJavascriptRequirement_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class SchemaDefRequirement_class_SchemaDefRequirement_class : unsigned int {\n SchemaDefRequirement\n};\ninline auto to_string(SchemaDefRequirement_class_SchemaDefRequirement_class v) {\n static auto m = std::vector<std::string_view> {\n \"SchemaDefRequirement\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::SchemaDefRequirement_class_SchemaDefRequirement_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::SchemaDefRequirement_class_SchemaDefRequirement_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::SchemaDefRequirement_class_SchemaDefRequirement_class, std::less<>> {\n {\"SchemaDefRequirement\", https___w3id_org_cwl_cwl::SchemaDefRequirement_class_SchemaDefRequirement_class::SchemaDefRequirement},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::SchemaDefRequirement_class_SchemaDefRequirement_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::SchemaDefRequirement_class_SchemaDefRequirement_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::SchemaDefRequirement_class_SchemaDefRequirement_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class LoadListingRequirement_class_LoadListingRequirement_class : unsigned int {\n LoadListingRequirement\n};\ninline auto to_string(LoadListingRequirement_class_LoadListingRequirement_class v) {\n static auto m = std::vector<std::string_view> {\n \"LoadListingRequirement\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::LoadListingRequirement_class_LoadListingRequirement_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::LoadListingRequirement_class_LoadListingRequirement_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::LoadListingRequirement_class_LoadListingRequirement_class, std::less<>> {\n {\"LoadListingRequirement\", https___w3id_org_cwl_cwl::LoadListingRequirement_class_LoadListingRequirement_class::LoadListingRequirement},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::LoadListingRequirement_class_LoadListingRequirement_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::LoadListingRequirement_class_LoadListingRequirement_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::LoadListingRequirement_class_LoadListingRequirement_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class stdin_ : unsigned int {\n stdin_\n};\ninline auto to_string(stdin_ v) {\n static auto m = std::vector<std::string_view> {\n \"stdin\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::stdin_>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::stdin_& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::stdin_, std::less<>> {\n {\"stdin\", https___w3id_org_cwl_cwl::stdin_::stdin_},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::stdin_ v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::stdin_& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::stdin_> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class stdout_ : unsigned int {\n stdout_\n};\ninline auto to_string(stdout_ v) {\n static auto m = std::vector<std::string_view> {\n \"stdout\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::stdout_>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::stdout_& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::stdout_, std::less<>> {\n {\"stdout\", https___w3id_org_cwl_cwl::stdout_::stdout_},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::stdout_ v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::stdout_& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::stdout_> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class stderr_ : unsigned int {\n stderr_\n};\ninline auto to_string(stderr_ v) {\n static auto m = std::vector<std::string_view> {\n \"stderr\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::stderr_>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::stderr_& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::stderr_, std::less<>> {\n {\"stderr\", https___w3id_org_cwl_cwl::stderr_::stderr_},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::stderr_ v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::stderr_& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::stderr_> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class CommandLineTool_class_CommandLineTool_class : unsigned int {\n CommandLineTool\n};\ninline auto to_string(CommandLineTool_class_CommandLineTool_class v) {\n static auto m = std::vector<std::string_view> {\n \"CommandLineTool\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::CommandLineTool_class_CommandLineTool_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::CommandLineTool_class_CommandLineTool_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::CommandLineTool_class_CommandLineTool_class, std::less<>> {\n {\"CommandLineTool\", https___w3id_org_cwl_cwl::CommandLineTool_class_CommandLineTool_class::CommandLineTool},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::CommandLineTool_class_CommandLineTool_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::CommandLineTool_class_CommandLineTool_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::CommandLineTool_class_CommandLineTool_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class DockerRequirement_class_DockerRequirement_class : unsigned int {\n DockerRequirement\n};\ninline auto to_string(DockerRequirement_class_DockerRequirement_class v) {\n static auto m = std::vector<std::string_view> {\n \"DockerRequirement\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::DockerRequirement_class_DockerRequirement_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::DockerRequirement_class_DockerRequirement_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::DockerRequirement_class_DockerRequirement_class, std::less<>> {\n {\"DockerRequirement\", https___w3id_org_cwl_cwl::DockerRequirement_class_DockerRequirement_class::DockerRequirement},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::DockerRequirement_class_DockerRequirement_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::DockerRequirement_class_DockerRequirement_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::DockerRequirement_class_DockerRequirement_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class SoftwareRequirement_class_SoftwareRequirement_class : unsigned int {\n SoftwareRequirement\n};\ninline auto to_string(SoftwareRequirement_class_SoftwareRequirement_class v) {\n static auto m = std::vector<std::string_view> {\n \"SoftwareRequirement\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::SoftwareRequirement_class_SoftwareRequirement_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::SoftwareRequirement_class_SoftwareRequirement_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::SoftwareRequirement_class_SoftwareRequirement_class, std::less<>> {\n {\"SoftwareRequirement\", https___w3id_org_cwl_cwl::SoftwareRequirement_class_SoftwareRequirement_class::SoftwareRequirement},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::SoftwareRequirement_class_SoftwareRequirement_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::SoftwareRequirement_class_SoftwareRequirement_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::SoftwareRequirement_class_SoftwareRequirement_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class InitialWorkDirRequirement_class_InitialWorkDirRequirement_class : unsigned int {\n InitialWorkDirRequirement\n};\ninline auto to_string(InitialWorkDirRequirement_class_InitialWorkDirRequirement_class v) {\n static auto m = std::vector<std::string_view> {\n \"InitialWorkDirRequirement\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::InitialWorkDirRequirement_class_InitialWorkDirRequirement_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::InitialWorkDirRequirement_class_InitialWorkDirRequirement_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::InitialWorkDirRequirement_class_InitialWorkDirRequirement_class, std::less<>> {\n {\"InitialWorkDirRequirement\", https___w3id_org_cwl_cwl::InitialWorkDirRequirement_class_InitialWorkDirRequirement_class::InitialWorkDirRequirement},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::InitialWorkDirRequirement_class_InitialWorkDirRequirement_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::InitialWorkDirRequirement_class_InitialWorkDirRequirement_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::InitialWorkDirRequirement_class_InitialWorkDirRequirement_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class EnvVarRequirement_class_EnvVarRequirement_class : unsigned int {\n EnvVarRequirement\n};\ninline auto to_string(EnvVarRequirement_class_EnvVarRequirement_class v) {\n static auto m = std::vector<std::string_view> {\n \"EnvVarRequirement\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::EnvVarRequirement_class_EnvVarRequirement_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::EnvVarRequirement_class_EnvVarRequirement_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::EnvVarRequirement_class_EnvVarRequirement_class, std::less<>> {\n {\"EnvVarRequirement\", https___w3id_org_cwl_cwl::EnvVarRequirement_class_EnvVarRequirement_class::EnvVarRequirement},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::EnvVarRequirement_class_EnvVarRequirement_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::EnvVarRequirement_class_EnvVarRequirement_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::EnvVarRequirement_class_EnvVarRequirement_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class ShellCommandRequirement_class_ShellCommandRequirement_class : unsigned int {\n ShellCommandRequirement\n};\ninline auto to_string(ShellCommandRequirement_class_ShellCommandRequirement_class v) {\n static auto m = std::vector<std::string_view> {\n \"ShellCommandRequirement\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::ShellCommandRequirement_class_ShellCommandRequirement_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::ShellCommandRequirement_class_ShellCommandRequirement_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::ShellCommandRequirement_class_ShellCommandRequirement_class, std::less<>> {\n {\"ShellCommandRequirement\", https___w3id_org_cwl_cwl::ShellCommandRequirement_class_ShellCommandRequirement_class::ShellCommandRequirement},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::ShellCommandRequirement_class_ShellCommandRequirement_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::ShellCommandRequirement_class_ShellCommandRequirement_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::ShellCommandRequirement_class_ShellCommandRequirement_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class ResourceRequirement_class_ResourceRequirement_class : unsigned int {\n ResourceRequirement\n};\ninline auto to_string(ResourceRequirement_class_ResourceRequirement_class v) {\n static auto m = std::vector<std::string_view> {\n \"ResourceRequirement\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::ResourceRequirement_class_ResourceRequirement_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::ResourceRequirement_class_ResourceRequirement_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::ResourceRequirement_class_ResourceRequirement_class, std::less<>> {\n {\"ResourceRequirement\", https___w3id_org_cwl_cwl::ResourceRequirement_class_ResourceRequirement_class::ResourceRequirement},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::ResourceRequirement_class_ResourceRequirement_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::ResourceRequirement_class_ResourceRequirement_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::ResourceRequirement_class_ResourceRequirement_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class WorkReuse_class_WorkReuse_class : unsigned int {\n WorkReuse\n};\ninline auto to_string(WorkReuse_class_WorkReuse_class v) {\n static auto m = std::vector<std::string_view> {\n \"WorkReuse\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::WorkReuse_class_WorkReuse_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::WorkReuse_class_WorkReuse_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::WorkReuse_class_WorkReuse_class, std::less<>> {\n {\"WorkReuse\", https___w3id_org_cwl_cwl::WorkReuse_class_WorkReuse_class::WorkReuse},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::WorkReuse_class_WorkReuse_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::WorkReuse_class_WorkReuse_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::WorkReuse_class_WorkReuse_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class NetworkAccess_class_NetworkAccess_class : unsigned int {\n NetworkAccess\n};\ninline auto to_string(NetworkAccess_class_NetworkAccess_class v) {\n static auto m = std::vector<std::string_view> {\n \"NetworkAccess\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::NetworkAccess_class_NetworkAccess_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::NetworkAccess_class_NetworkAccess_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::NetworkAccess_class_NetworkAccess_class, std::less<>> {\n {\"NetworkAccess\", https___w3id_org_cwl_cwl::NetworkAccess_class_NetworkAccess_class::NetworkAccess},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::NetworkAccess_class_NetworkAccess_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::NetworkAccess_class_NetworkAccess_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::NetworkAccess_class_NetworkAccess_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class InplaceUpdateRequirement_class_InplaceUpdateRequirement_class : unsigned int {\n InplaceUpdateRequirement\n};\ninline auto to_string(InplaceUpdateRequirement_class_InplaceUpdateRequirement_class v) {\n static auto m = std::vector<std::string_view> {\n \"InplaceUpdateRequirement\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::InplaceUpdateRequirement_class_InplaceUpdateRequirement_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::InplaceUpdateRequirement_class_InplaceUpdateRequirement_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::InplaceUpdateRequirement_class_InplaceUpdateRequirement_class, std::less<>> {\n {\"InplaceUpdateRequirement\", https___w3id_org_cwl_cwl::InplaceUpdateRequirement_class_InplaceUpdateRequirement_class::InplaceUpdateRequirement},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::InplaceUpdateRequirement_class_InplaceUpdateRequirement_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::InplaceUpdateRequirement_class_InplaceUpdateRequirement_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::InplaceUpdateRequirement_class_InplaceUpdateRequirement_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class ToolTimeLimit_class_ToolTimeLimit_class : unsigned int {\n ToolTimeLimit\n};\ninline auto to_string(ToolTimeLimit_class_ToolTimeLimit_class v) {\n static auto m = std::vector<std::string_view> {\n \"ToolTimeLimit\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::ToolTimeLimit_class_ToolTimeLimit_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::ToolTimeLimit_class_ToolTimeLimit_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::ToolTimeLimit_class_ToolTimeLimit_class, std::less<>> {\n {\"ToolTimeLimit\", https___w3id_org_cwl_cwl::ToolTimeLimit_class_ToolTimeLimit_class::ToolTimeLimit},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::ToolTimeLimit_class_ToolTimeLimit_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::ToolTimeLimit_class_ToolTimeLimit_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::ToolTimeLimit_class_ToolTimeLimit_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class ExpressionTool_class_ExpressionTool_class : unsigned int {\n ExpressionTool\n};\ninline auto to_string(ExpressionTool_class_ExpressionTool_class v) {\n static auto m = std::vector<std::string_view> {\n \"ExpressionTool\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::ExpressionTool_class_ExpressionTool_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::ExpressionTool_class_ExpressionTool_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::ExpressionTool_class_ExpressionTool_class, std::less<>> {\n {\"ExpressionTool\", https___w3id_org_cwl_cwl::ExpressionTool_class_ExpressionTool_class::ExpressionTool},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::ExpressionTool_class_ExpressionTool_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::ExpressionTool_class_ExpressionTool_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::ExpressionTool_class_ExpressionTool_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class LinkMergeMethod : unsigned int {\n merge_nested,\n merge_flattened\n};\ninline auto to_string(LinkMergeMethod v) {\n static auto m = std::vector<std::string_view> {\n \"merge_nested\",\n \"merge_flattened\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::LinkMergeMethod>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::LinkMergeMethod& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::LinkMergeMethod, std::less<>> {\n {\"merge_nested\", https___w3id_org_cwl_cwl::LinkMergeMethod::merge_nested},\n {\"merge_flattened\", https___w3id_org_cwl_cwl::LinkMergeMethod::merge_flattened},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::LinkMergeMethod v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::LinkMergeMethod& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::LinkMergeMethod> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class PickValueMethod : unsigned int {\n first_non_null,\n the_only_non_null,\n all_non_null\n};\ninline auto to_string(PickValueMethod v) {\n static auto m = std::vector<std::string_view> {\n \"first_non_null\",\n \"the_only_non_null\",\n \"all_non_null\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::PickValueMethod>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::PickValueMethod& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::PickValueMethod, std::less<>> {\n {\"first_non_null\", https___w3id_org_cwl_cwl::PickValueMethod::first_non_null},\n {\"the_only_non_null\", https___w3id_org_cwl_cwl::PickValueMethod::the_only_non_null},\n {\"all_non_null\", https___w3id_org_cwl_cwl::PickValueMethod::all_non_null},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::PickValueMethod v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::PickValueMethod& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::PickValueMethod> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class ScatterMethod : unsigned int {\n dotproduct,\n nested_crossproduct,\n flat_crossproduct\n};\ninline auto to_string(ScatterMethod v) {\n static auto m = std::vector<std::string_view> {\n \"dotproduct\",\n \"nested_crossproduct\",\n \"flat_crossproduct\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::ScatterMethod>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::ScatterMethod& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::ScatterMethod, std::less<>> {\n {\"dotproduct\", https___w3id_org_cwl_cwl::ScatterMethod::dotproduct},\n {\"nested_crossproduct\", https___w3id_org_cwl_cwl::ScatterMethod::nested_crossproduct},\n {\"flat_crossproduct\", https___w3id_org_cwl_cwl::ScatterMethod::flat_crossproduct},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::ScatterMethod v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::ScatterMethod& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::ScatterMethod> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class Workflow_class_Workflow_class : unsigned int {\n Workflow\n};\ninline auto to_string(Workflow_class_Workflow_class v) {\n static auto m = std::vector<std::string_view> {\n \"Workflow\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::Workflow_class_Workflow_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::Workflow_class_Workflow_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::Workflow_class_Workflow_class, std::less<>> {\n {\"Workflow\", https___w3id_org_cwl_cwl::Workflow_class_Workflow_class::Workflow},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::Workflow_class_Workflow_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::Workflow_class_Workflow_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::Workflow_class_Workflow_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class SubworkflowFeatureRequirement_class_SubworkflowFeatureRequirement_class : unsigned int {\n SubworkflowFeatureRequirement\n};\ninline auto to_string(SubworkflowFeatureRequirement_class_SubworkflowFeatureRequirement_class v) {\n static auto m = std::vector<std::string_view> {\n \"SubworkflowFeatureRequirement\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::SubworkflowFeatureRequirement_class_SubworkflowFeatureRequirement_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::SubworkflowFeatureRequirement_class_SubworkflowFeatureRequirement_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::SubworkflowFeatureRequirement_class_SubworkflowFeatureRequirement_class, std::less<>> {\n {\"SubworkflowFeatureRequirement\", https___w3id_org_cwl_cwl::SubworkflowFeatureRequirement_class_SubworkflowFeatureRequirement_class::SubworkflowFeatureRequirement},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::SubworkflowFeatureRequirement_class_SubworkflowFeatureRequirement_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::SubworkflowFeatureRequirement_class_SubworkflowFeatureRequirement_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::SubworkflowFeatureRequirement_class_SubworkflowFeatureRequirement_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class ScatterFeatureRequirement_class_ScatterFeatureRequirement_class : unsigned int {\n ScatterFeatureRequirement\n};\ninline auto to_string(ScatterFeatureRequirement_class_ScatterFeatureRequirement_class v) {\n static auto m = std::vector<std::string_view> {\n \"ScatterFeatureRequirement\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::ScatterFeatureRequirement_class_ScatterFeatureRequirement_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::ScatterFeatureRequirement_class_ScatterFeatureRequirement_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::ScatterFeatureRequirement_class_ScatterFeatureRequirement_class, std::less<>> {\n {\"ScatterFeatureRequirement\", https___w3id_org_cwl_cwl::ScatterFeatureRequirement_class_ScatterFeatureRequirement_class::ScatterFeatureRequirement},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::ScatterFeatureRequirement_class_ScatterFeatureRequirement_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::ScatterFeatureRequirement_class_ScatterFeatureRequirement_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::ScatterFeatureRequirement_class_ScatterFeatureRequirement_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class MultipleInputFeatureRequirement_class_MultipleInputFeatureRequirement_class : unsigned int {\n MultipleInputFeatureRequirement\n};\ninline auto to_string(MultipleInputFeatureRequirement_class_MultipleInputFeatureRequirement_class v) {\n static auto m = std::vector<std::string_view> {\n \"MultipleInputFeatureRequirement\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::MultipleInputFeatureRequirement_class_MultipleInputFeatureRequirement_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::MultipleInputFeatureRequirement_class_MultipleInputFeatureRequirement_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::MultipleInputFeatureRequirement_class_MultipleInputFeatureRequirement_class, std::less<>> {\n {\"MultipleInputFeatureRequirement\", https___w3id_org_cwl_cwl::MultipleInputFeatureRequirement_class_MultipleInputFeatureRequirement_class::MultipleInputFeatureRequirement},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::MultipleInputFeatureRequirement_class_MultipleInputFeatureRequirement_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::MultipleInputFeatureRequirement_class_MultipleInputFeatureRequirement_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::MultipleInputFeatureRequirement_class_MultipleInputFeatureRequirement_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class StepInputExpressionRequirement_class_StepInputExpressionRequirement_class : unsigned int {\n StepInputExpressionRequirement\n};\ninline auto to_string(StepInputExpressionRequirement_class_StepInputExpressionRequirement_class v) {\n static auto m = std::vector<std::string_view> {\n \"StepInputExpressionRequirement\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::StepInputExpressionRequirement_class_StepInputExpressionRequirement_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::StepInputExpressionRequirement_class_StepInputExpressionRequirement_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::StepInputExpressionRequirement_class_StepInputExpressionRequirement_class, std::less<>> {\n {\"StepInputExpressionRequirement\", https___w3id_org_cwl_cwl::StepInputExpressionRequirement_class_StepInputExpressionRequirement_class::StepInputExpressionRequirement},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::StepInputExpressionRequirement_class_StepInputExpressionRequirement_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::StepInputExpressionRequirement_class_StepInputExpressionRequirement_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::StepInputExpressionRequirement_class_StepInputExpressionRequirement_class> : std::true_type {};namespace https___w3id_org_cwl_cwl {\nenum class Operation_class_Operation_class : unsigned int {\n Operation\n};\ninline auto to_string(Operation_class_Operation_class v) {\n static auto m = std::vector<std::string_view> {\n \"Operation\"\n };\n using U = std::underlying_type_t<https___w3id_org_cwl_cwl::Operation_class_Operation_class>;\n return m.at(static_cast<U>(v));\n}\n}\ninline void to_enum(std::string_view v, https___w3id_org_cwl_cwl::Operation_class_Operation_class& out) {\n static auto m = std::map<std::string, https___w3id_org_cwl_cwl::Operation_class_Operation_class, std::less<>> {\n {\"Operation\", https___w3id_org_cwl_cwl::Operation_class_Operation_class::Operation},\n };\n auto iter = m.find(v);\n if (iter == m.end()) throw bool{};\n out = iter->second;\n}\ninline auto toYaml(https___w3id_org_cwl_cwl::Operation_class_Operation_class v) {\n return YAML::Node{std::string{to_string(v)}};\n}\ninline void fromYaml(YAML::Node n, https___w3id_org_cwl_cwl::Operation_class_Operation_class& out) {\n to_enum(n.as<std::string>(), out);\n}\n template <> struct IsConstant<https___w3id_org_cwl_cwl::Operation_class_Operation_class> : std::true_type {};namespace https___w3id_org_cwl_salad {\nstruct Documented {\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n virtual ~Documented() = 0;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_salad {\nstruct RecordField\n : https___w3id_org_cwl_salad::Documented {\n heap_object<std::string> name;\n heap_object<std::variant<std::variant<bool, int32_t, int64_t, float, double, std::string>, RecordSchema, EnumSchema, ArraySchema, std::string, std::vector<std::variant<std::variant<bool, int32_t, int64_t, float, double, std::string>, RecordSchema, EnumSchema, ArraySchema, std::string>>>> type;\n ~RecordField() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_salad {\nstruct RecordSchema {\n heap_object<std::variant<std::monostate, std::vector<RecordField>>> fields;\n heap_object<RecordSchema_type_Record_name> type;\n virtual ~RecordSchema() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_salad {\nstruct EnumSchema {\n heap_object<std::variant<std::monostate, std::string>> name;\n heap_object<std::vector<std::string>> symbols;\n heap_object<EnumSchema_type_Enum_name> type;\n virtual ~EnumSchema() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_salad {\nstruct ArraySchema {\n heap_object<std::variant<std::variant<bool, int32_t, int64_t, float, double, std::string>, RecordSchema, EnumSchema, ArraySchema, std::string, std::vector<std::variant<std::variant<bool, int32_t, int64_t, float, double, std::string>, RecordSchema, EnumSchema, ArraySchema, std::string>>>> items;\n heap_object<ArraySchema_type_Array_name> type;\n virtual ~ArraySchema() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct File {\n heap_object<File_class_File_class> class_;\n heap_object<std::variant<std::monostate, std::string>> location;\n heap_object<std::variant<std::monostate, std::string>> path;\n heap_object<std::variant<std::monostate, std::string>> basename;\n heap_object<std::variant<std::monostate, std::string>> dirname;\n heap_object<std::variant<std::monostate, std::string>> nameroot;\n heap_object<std::variant<std::monostate, std::string>> nameext;\n heap_object<std::variant<std::monostate, std::string>> checksum;\n heap_object<std::variant<std::monostate, int32_t, int64_t>> size;\n heap_object<std::variant<std::monostate, std::vector<std::variant<File, Directory>>>> secondaryFiles;\n heap_object<std::variant<std::monostate, std::string>> format;\n heap_object<std::variant<std::monostate, std::string>> contents;\n virtual ~File() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct Directory {\n heap_object<Directory_class_Directory_class> class_;\n heap_object<std::variant<std::monostate, std::string>> location;\n heap_object<std::variant<std::monostate, std::string>> path;\n heap_object<std::variant<std::monostate, std::string>> basename;\n heap_object<std::variant<std::monostate, std::vector<std::variant<File, Directory>>>> listing;\n virtual ~Directory() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct Labeled {\n heap_object<std::variant<std::monostate, std::string>> label;\n virtual ~Labeled() = 0;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct Identified {\n heap_object<std::variant<std::monostate, std::string>> id;\n virtual ~Identified() = 0;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct LoadContents {\n heap_object<std::variant<std::monostate, bool>> loadContents;\n heap_object<std::variant<std::monostate, LoadListingEnum>> loadListing;\n virtual ~LoadContents() = 0;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct FieldBase\n : https___w3id_org_cwl_cwl::Labeled {\n heap_object<std::variant<std::monostate, SecondaryFileSchema, std::vector<SecondaryFileSchema>>> secondaryFiles;\n heap_object<std::variant<std::monostate, bool>> streamable;\n virtual ~FieldBase() = 0;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct InputFormat {\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>, Expression>> format;\n virtual ~InputFormat() = 0;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct OutputFormat {\n heap_object<std::variant<std::monostate, std::string, Expression>> format;\n virtual ~OutputFormat() = 0;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct Parameter\n : https___w3id_org_cwl_cwl::FieldBase\n , https___w3id_org_cwl_salad::Documented\n , https___w3id_org_cwl_cwl::Identified {\n virtual ~Parameter() = 0;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct InputBinding {\n heap_object<std::variant<std::monostate, bool>> loadContents;\n virtual ~InputBinding() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct IOSchema\n : https___w3id_org_cwl_cwl::Labeled\n , https___w3id_org_cwl_salad::Documented {\n heap_object<std::variant<std::monostate, std::string>> name;\n virtual ~IOSchema() = 0;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct InputSchema\n : https___w3id_org_cwl_cwl::IOSchema {\n virtual ~InputSchema() = 0;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct OutputSchema\n : https___w3id_org_cwl_cwl::IOSchema {\n virtual ~OutputSchema() = 0;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct InputRecordField {\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n heap_object<std::string> name;\n heap_object<std::variant<CWLType, InputRecordSchema, InputEnumSchema, InputArraySchema, std::string, std::vector<std::variant<CWLType, InputRecordSchema, InputEnumSchema, InputArraySchema, std::string>>>> type;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, SecondaryFileSchema, std::vector<SecondaryFileSchema>>> secondaryFiles;\n heap_object<std::variant<std::monostate, bool>> streamable;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>, Expression>> format;\n heap_object<std::variant<std::monostate, bool>> loadContents;\n heap_object<std::variant<std::monostate, LoadListingEnum>> loadListing;\n virtual ~InputRecordField() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct InputRecordSchema {\n heap_object<std::variant<std::monostate, std::vector<InputRecordField>>> fields;\n heap_object<https___w3id_org_cwl_salad::RecordSchema_type_Record_name> type;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n heap_object<std::variant<std::monostate, std::string>> name;\n virtual ~InputRecordSchema() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct InputEnumSchema\n : https___w3id_org_cwl_salad::EnumSchema\n , https___w3id_org_cwl_cwl::InputSchema {\n ~InputEnumSchema() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct InputArraySchema {\n heap_object<std::variant<CWLType, InputRecordSchema, InputEnumSchema, InputArraySchema, std::string, std::vector<std::variant<CWLType, InputRecordSchema, InputEnumSchema, InputArraySchema, std::string>>>> items;\n heap_object<https___w3id_org_cwl_salad::ArraySchema_type_Array_name> type;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n heap_object<std::variant<std::monostate, std::string>> name;\n virtual ~InputArraySchema() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct OutputRecordField {\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n heap_object<std::string> name;\n heap_object<std::variant<CWLType, OutputRecordSchema, OutputEnumSchema, OutputArraySchema, std::string, std::vector<std::variant<CWLType, OutputRecordSchema, OutputEnumSchema, OutputArraySchema, std::string>>>> type;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, SecondaryFileSchema, std::vector<SecondaryFileSchema>>> secondaryFiles;\n heap_object<std::variant<std::monostate, bool>> streamable;\n heap_object<std::variant<std::monostate, std::string, Expression>> format;\n virtual ~OutputRecordField() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct OutputRecordSchema {\n heap_object<std::variant<std::monostate, std::vector<OutputRecordField>>> fields;\n heap_object<https___w3id_org_cwl_salad::RecordSchema_type_Record_name> type;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n heap_object<std::variant<std::monostate, std::string>> name;\n virtual ~OutputRecordSchema() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct OutputEnumSchema\n : https___w3id_org_cwl_salad::EnumSchema\n , https___w3id_org_cwl_cwl::OutputSchema {\n ~OutputEnumSchema() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct OutputArraySchema {\n heap_object<std::variant<CWLType, OutputRecordSchema, OutputEnumSchema, OutputArraySchema, std::string, std::vector<std::variant<CWLType, OutputRecordSchema, OutputEnumSchema, OutputArraySchema, std::string>>>> items;\n heap_object<https___w3id_org_cwl_salad::ArraySchema_type_Array_name> type;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n heap_object<std::variant<std::monostate, std::string>> name;\n virtual ~OutputArraySchema() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct InputParameter\n : https___w3id_org_cwl_cwl::Parameter\n , https___w3id_org_cwl_cwl::InputFormat\n , https___w3id_org_cwl_cwl::LoadContents {\n heap_object<std::variant<std::monostate, File, Directory, std::any>> default_;\n virtual ~InputParameter() = 0;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct OutputParameter\n : https___w3id_org_cwl_cwl::Parameter\n , https___w3id_org_cwl_cwl::OutputFormat {\n virtual ~OutputParameter() = 0;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct ProcessRequirement {\n virtual ~ProcessRequirement() = 0;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct Process\n : https___w3id_org_cwl_cwl::Identified\n , https___w3id_org_cwl_cwl::Labeled\n , https___w3id_org_cwl_salad::Documented {\n heap_object<std::vector<std::variant<CommandInputParameter, WorkflowInputParameter, OperationInputParameter>>> inputs;\n heap_object<std::vector<std::variant<CommandOutputParameter, ExpressionToolOutputParameter, WorkflowOutputParameter, OperationOutputParameter>>> outputs;\n heap_object<std::variant<std::monostate, std::vector<std::variant<InlineJavascriptRequirement, SchemaDefRequirement, LoadListingRequirement, DockerRequirement, SoftwareRequirement, InitialWorkDirRequirement, EnvVarRequirement, ShellCommandRequirement, ResourceRequirement, WorkReuse, NetworkAccess, InplaceUpdateRequirement, ToolTimeLimit, SubworkflowFeatureRequirement, ScatterFeatureRequirement, MultipleInputFeatureRequirement, StepInputExpressionRequirement>>>> requirements;\n heap_object<std::variant<std::monostate, std::vector<std::variant<InlineJavascriptRequirement, SchemaDefRequirement, LoadListingRequirement, DockerRequirement, SoftwareRequirement, InitialWorkDirRequirement, EnvVarRequirement, ShellCommandRequirement, ResourceRequirement, WorkReuse, NetworkAccess, InplaceUpdateRequirement, ToolTimeLimit, SubworkflowFeatureRequirement, ScatterFeatureRequirement, MultipleInputFeatureRequirement, StepInputExpressionRequirement, std::any>>>> hints;\n heap_object<std::variant<std::monostate, CWLVersion>> cwlVersion;\n heap_object<std::variant<std::monostate, std::vector<std::string>>> intent;\n virtual ~Process() = 0;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct InlineJavascriptRequirement\n : https___w3id_org_cwl_cwl::ProcessRequirement {\n heap_object<InlineJavascriptRequirement_class_InlineJavascriptRequirement_class> class_;\n heap_object<std::variant<std::monostate, std::vector<std::string>>> expressionLib;\n ~InlineJavascriptRequirement() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct CommandInputSchema {\n virtual ~CommandInputSchema() = 0;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct SchemaDefRequirement\n : https___w3id_org_cwl_cwl::ProcessRequirement {\n heap_object<SchemaDefRequirement_class_SchemaDefRequirement_class> class_;\n heap_object<std::vector<std::variant<CommandInputRecordSchema, CommandInputEnumSchema, CommandInputArraySchema>>> types;\n ~SchemaDefRequirement() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct SecondaryFileSchema {\n heap_object<std::variant<std::string, Expression>> pattern;\n heap_object<std::variant<std::monostate, bool, Expression>> required;\n virtual ~SecondaryFileSchema() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct LoadListingRequirement\n : https___w3id_org_cwl_cwl::ProcessRequirement {\n heap_object<LoadListingRequirement_class_LoadListingRequirement_class> class_;\n heap_object<std::variant<std::monostate, LoadListingEnum>> loadListing;\n ~LoadListingRequirement() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct EnvironmentDef {\n heap_object<std::string> envName;\n heap_object<std::variant<std::string, Expression>> envValue;\n virtual ~EnvironmentDef() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct CommandLineBinding\n : https___w3id_org_cwl_cwl::InputBinding {\n heap_object<std::variant<std::monostate, int32_t, Expression>> position;\n heap_object<std::variant<std::monostate, std::string>> prefix;\n heap_object<std::variant<std::monostate, bool>> separate;\n heap_object<std::variant<std::monostate, std::string>> itemSeparator;\n heap_object<std::variant<std::monostate, std::string, Expression>> valueFrom;\n heap_object<std::variant<std::monostate, bool>> shellQuote;\n ~CommandLineBinding() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct CommandOutputBinding\n : https___w3id_org_cwl_cwl::LoadContents {\n heap_object<std::variant<std::monostate, std::string, Expression, std::vector<std::string>>> glob;\n heap_object<std::variant<std::monostate, Expression>> outputEval;\n ~CommandOutputBinding() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct CommandLineBindable {\n heap_object<std::variant<std::monostate, CommandLineBinding>> inputBinding;\n virtual ~CommandLineBindable() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct CommandInputRecordField {\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n heap_object<std::string> name;\n heap_object<std::variant<CWLType, CommandInputRecordSchema, CommandInputEnumSchema, CommandInputArraySchema, std::string, std::vector<std::variant<CWLType, CommandInputRecordSchema, CommandInputEnumSchema, CommandInputArraySchema, std::string>>>> type;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, SecondaryFileSchema, std::vector<SecondaryFileSchema>>> secondaryFiles;\n heap_object<std::variant<std::monostate, bool>> streamable;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>, Expression>> format;\n heap_object<std::variant<std::monostate, bool>> loadContents;\n heap_object<std::variant<std::monostate, LoadListingEnum>> loadListing;\n heap_object<std::variant<std::monostate, CommandLineBinding>> inputBinding;\n virtual ~CommandInputRecordField() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct CommandInputRecordSchema {\n heap_object<std::variant<std::monostate, std::vector<CommandInputRecordField>>> fields;\n heap_object<https___w3id_org_cwl_salad::RecordSchema_type_Record_name> type;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n heap_object<std::variant<std::monostate, std::string>> name;\n heap_object<std::variant<std::monostate, CommandLineBinding>> inputBinding;\n virtual ~CommandInputRecordSchema() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct CommandInputEnumSchema {\n heap_object<std::variant<std::monostate, std::string>> name;\n heap_object<std::vector<std::string>> symbols;\n heap_object<https___w3id_org_cwl_salad::EnumSchema_type_Enum_name> type;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n heap_object<std::variant<std::monostate, CommandLineBinding>> inputBinding;\n virtual ~CommandInputEnumSchema() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct CommandInputArraySchema {\n heap_object<std::variant<CWLType, CommandInputRecordSchema, CommandInputEnumSchema, CommandInputArraySchema, std::string, std::vector<std::variant<CWLType, CommandInputRecordSchema, CommandInputEnumSchema, CommandInputArraySchema, std::string>>>> items;\n heap_object<https___w3id_org_cwl_salad::ArraySchema_type_Array_name> type;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n heap_object<std::variant<std::monostate, std::string>> name;\n heap_object<std::variant<std::monostate, CommandLineBinding>> inputBinding;\n virtual ~CommandInputArraySchema() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct CommandOutputRecordField {\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n heap_object<std::string> name;\n heap_object<std::variant<CWLType, CommandOutputRecordSchema, CommandOutputEnumSchema, CommandOutputArraySchema, std::string, std::vector<std::variant<CWLType, CommandOutputRecordSchema, CommandOutputEnumSchema, CommandOutputArraySchema, std::string>>>> type;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, SecondaryFileSchema, std::vector<SecondaryFileSchema>>> secondaryFiles;\n heap_object<std::variant<std::monostate, bool>> streamable;\n heap_object<std::variant<std::monostate, std::string, Expression>> format;\n heap_object<std::variant<std::monostate, CommandOutputBinding>> outputBinding;\n virtual ~CommandOutputRecordField() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct CommandOutputRecordSchema {\n heap_object<std::variant<std::monostate, std::vector<CommandOutputRecordField>>> fields;\n heap_object<https___w3id_org_cwl_salad::RecordSchema_type_Record_name> type;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n heap_object<std::variant<std::monostate, std::string>> name;\n virtual ~CommandOutputRecordSchema() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct CommandOutputEnumSchema {\n heap_object<std::variant<std::monostate, std::string>> name;\n heap_object<std::vector<std::string>> symbols;\n heap_object<https___w3id_org_cwl_salad::EnumSchema_type_Enum_name> type;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n virtual ~CommandOutputEnumSchema() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct CommandOutputArraySchema {\n heap_object<std::variant<CWLType, CommandOutputRecordSchema, CommandOutputEnumSchema, CommandOutputArraySchema, std::string, std::vector<std::variant<CWLType, CommandOutputRecordSchema, CommandOutputEnumSchema, CommandOutputArraySchema, std::string>>>> items;\n heap_object<https___w3id_org_cwl_salad::ArraySchema_type_Array_name> type;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n heap_object<std::variant<std::monostate, std::string>> name;\n virtual ~CommandOutputArraySchema() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct CommandInputParameter\n : https___w3id_org_cwl_cwl::InputParameter {\n heap_object<std::variant<CWLType, stdin_, CommandInputRecordSchema, CommandInputEnumSchema, CommandInputArraySchema, std::string, std::vector<std::variant<CWLType, CommandInputRecordSchema, CommandInputEnumSchema, CommandInputArraySchema, std::string>>>> type;\n heap_object<std::variant<std::monostate, CommandLineBinding>> inputBinding;\n ~CommandInputParameter() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct CommandOutputParameter\n : https___w3id_org_cwl_cwl::OutputParameter {\n heap_object<std::variant<CWLType, stdout_, stderr_, CommandOutputRecordSchema, CommandOutputEnumSchema, CommandOutputArraySchema, std::string, std::vector<std::variant<CWLType, CommandOutputRecordSchema, CommandOutputEnumSchema, CommandOutputArraySchema, std::string>>>> type;\n heap_object<std::variant<std::monostate, CommandOutputBinding>> outputBinding;\n ~CommandOutputParameter() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct CommandLineTool {\n heap_object<std::variant<std::monostate, std::string>> id;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n heap_object<std::vector<CommandInputParameter>> inputs;\n heap_object<std::vector<CommandOutputParameter>> outputs;\n heap_object<std::variant<std::monostate, std::vector<std::variant<InlineJavascriptRequirement, SchemaDefRequirement, LoadListingRequirement, DockerRequirement, SoftwareRequirement, InitialWorkDirRequirement, EnvVarRequirement, ShellCommandRequirement, ResourceRequirement, WorkReuse, NetworkAccess, InplaceUpdateRequirement, ToolTimeLimit, SubworkflowFeatureRequirement, ScatterFeatureRequirement, MultipleInputFeatureRequirement, StepInputExpressionRequirement>>>> requirements;\n heap_object<std::variant<std::monostate, std::vector<std::variant<InlineJavascriptRequirement, SchemaDefRequirement, LoadListingRequirement, DockerRequirement, SoftwareRequirement, InitialWorkDirRequirement, EnvVarRequirement, ShellCommandRequirement, ResourceRequirement, WorkReuse, NetworkAccess, InplaceUpdateRequirement, ToolTimeLimit, SubworkflowFeatureRequirement, ScatterFeatureRequirement, MultipleInputFeatureRequirement, StepInputExpressionRequirement, std::any>>>> hints;\n heap_object<std::variant<std::monostate, CWLVersion>> cwlVersion;\n heap_object<std::variant<std::monostate, std::vector<std::string>>> intent;\n heap_object<CommandLineTool_class_CommandLineTool_class> class_;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> baseCommand;\n heap_object<std::variant<std::monostate, std::vector<std::variant<std::string, Expression, CommandLineBinding>>>> arguments;\n heap_object<std::variant<std::monostate, std::string, Expression>> stdin_;\n heap_object<std::variant<std::monostate, std::string, Expression>> stderr_;\n heap_object<std::variant<std::monostate, std::string, Expression>> stdout_;\n heap_object<std::variant<std::monostate, std::vector<int32_t>>> successCodes;\n heap_object<std::variant<std::monostate, std::vector<int32_t>>> temporaryFailCodes;\n heap_object<std::variant<std::monostate, std::vector<int32_t>>> permanentFailCodes;\n virtual ~CommandLineTool() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct DockerRequirement\n : https___w3id_org_cwl_cwl::ProcessRequirement {\n heap_object<DockerRequirement_class_DockerRequirement_class> class_;\n heap_object<std::variant<std::monostate, std::string>> dockerPull;\n heap_object<std::variant<std::monostate, std::string>> dockerLoad;\n heap_object<std::variant<std::monostate, std::string>> dockerFile;\n heap_object<std::variant<std::monostate, std::string>> dockerImport;\n heap_object<std::variant<std::monostate, std::string>> dockerImageId;\n heap_object<std::variant<std::monostate, std::string>> dockerOutputDirectory;\n ~DockerRequirement() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct SoftwareRequirement\n : https___w3id_org_cwl_cwl::ProcessRequirement {\n heap_object<SoftwareRequirement_class_SoftwareRequirement_class> class_;\n heap_object<std::vector<SoftwarePackage>> packages;\n ~SoftwareRequirement() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct SoftwarePackage {\n heap_object<std::string> package;\n heap_object<std::variant<std::monostate, std::vector<std::string>>> version;\n heap_object<std::variant<std::monostate, std::vector<std::string>>> specs;\n virtual ~SoftwarePackage() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct Dirent {\n heap_object<std::variant<std::monostate, std::string, Expression>> entryname;\n heap_object<std::variant<std::string, Expression>> entry;\n heap_object<std::variant<std::monostate, bool>> writable;\n virtual ~Dirent() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct InitialWorkDirRequirement\n : https___w3id_org_cwl_cwl::ProcessRequirement {\n heap_object<InitialWorkDirRequirement_class_InitialWorkDirRequirement_class> class_;\n heap_object<std::variant<Expression, std::vector<std::variant<std::monostate, Dirent, Expression, File, Directory, std::vector<std::variant<File, Directory>>>>>> listing;\n ~InitialWorkDirRequirement() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct EnvVarRequirement\n : https___w3id_org_cwl_cwl::ProcessRequirement {\n heap_object<EnvVarRequirement_class_EnvVarRequirement_class> class_;\n heap_object<std::vector<EnvironmentDef>> envDef;\n ~EnvVarRequirement() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct ShellCommandRequirement\n : https___w3id_org_cwl_cwl::ProcessRequirement {\n heap_object<ShellCommandRequirement_class_ShellCommandRequirement_class> class_;\n ~ShellCommandRequirement() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct ResourceRequirement\n : https___w3id_org_cwl_cwl::ProcessRequirement {\n heap_object<ResourceRequirement_class_ResourceRequirement_class> class_;\n heap_object<std::variant<std::monostate, int32_t, int64_t, float, Expression>> coresMin;\n heap_object<std::variant<std::monostate, int32_t, int64_t, float, Expression>> coresMax;\n heap_object<std::variant<std::monostate, int32_t, int64_t, float, Expression>> ramMin;\n heap_object<std::variant<std::monostate, int32_t, int64_t, float, Expression>> ramMax;\n heap_object<std::variant<std::monostate, int32_t, int64_t, float, Expression>> tmpdirMin;\n heap_object<std::variant<std::monostate, int32_t, int64_t, float, Expression>> tmpdirMax;\n heap_object<std::variant<std::monostate, int32_t, int64_t, float, Expression>> outdirMin;\n heap_object<std::variant<std::monostate, int32_t, int64_t, float, Expression>> outdirMax;\n ~ResourceRequirement() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct WorkReuse\n : https___w3id_org_cwl_cwl::ProcessRequirement {\n heap_object<WorkReuse_class_WorkReuse_class> class_;\n heap_object<std::variant<bool, Expression>> enableReuse;\n ~WorkReuse() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct NetworkAccess\n : https___w3id_org_cwl_cwl::ProcessRequirement {\n heap_object<NetworkAccess_class_NetworkAccess_class> class_;\n heap_object<std::variant<bool, Expression>> networkAccess;\n ~NetworkAccess() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct InplaceUpdateRequirement\n : https___w3id_org_cwl_cwl::ProcessRequirement {\n heap_object<InplaceUpdateRequirement_class_InplaceUpdateRequirement_class> class_;\n heap_object<bool> inplaceUpdate;\n ~InplaceUpdateRequirement() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct ToolTimeLimit\n : https___w3id_org_cwl_cwl::ProcessRequirement {\n heap_object<ToolTimeLimit_class_ToolTimeLimit_class> class_;\n heap_object<std::variant<int32_t, int64_t, Expression>> timelimit;\n ~ToolTimeLimit() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct ExpressionToolOutputParameter\n : https___w3id_org_cwl_cwl::OutputParameter {\n heap_object<std::variant<CWLType, OutputRecordSchema, OutputEnumSchema, OutputArraySchema, std::string, std::vector<std::variant<CWLType, OutputRecordSchema, OutputEnumSchema, OutputArraySchema, std::string>>>> type;\n ~ExpressionToolOutputParameter() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct WorkflowInputParameter\n : https___w3id_org_cwl_cwl::InputParameter {\n heap_object<std::variant<CWLType, InputRecordSchema, InputEnumSchema, InputArraySchema, std::string, std::vector<std::variant<CWLType, InputRecordSchema, InputEnumSchema, InputArraySchema, std::string>>>> type;\n heap_object<std::variant<std::monostate, InputBinding>> inputBinding;\n ~WorkflowInputParameter() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct ExpressionTool {\n heap_object<std::variant<std::monostate, std::string>> id;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n heap_object<std::vector<WorkflowInputParameter>> inputs;\n heap_object<std::vector<ExpressionToolOutputParameter>> outputs;\n heap_object<std::variant<std::monostate, std::vector<std::variant<InlineJavascriptRequirement, SchemaDefRequirement, LoadListingRequirement, DockerRequirement, SoftwareRequirement, InitialWorkDirRequirement, EnvVarRequirement, ShellCommandRequirement, ResourceRequirement, WorkReuse, NetworkAccess, InplaceUpdateRequirement, ToolTimeLimit, SubworkflowFeatureRequirement, ScatterFeatureRequirement, MultipleInputFeatureRequirement, StepInputExpressionRequirement>>>> requirements;\n heap_object<std::variant<std::monostate, std::vector<std::variant<InlineJavascriptRequirement, SchemaDefRequirement, LoadListingRequirement, DockerRequirement, SoftwareRequirement, InitialWorkDirRequirement, EnvVarRequirement, ShellCommandRequirement, ResourceRequirement, WorkReuse, NetworkAccess, InplaceUpdateRequirement, ToolTimeLimit, SubworkflowFeatureRequirement, ScatterFeatureRequirement, MultipleInputFeatureRequirement, StepInputExpressionRequirement, std::any>>>> hints;\n heap_object<std::variant<std::monostate, CWLVersion>> cwlVersion;\n heap_object<std::variant<std::monostate, std::vector<std::string>>> intent;\n heap_object<ExpressionTool_class_ExpressionTool_class> class_;\n heap_object<Expression> expression;\n virtual ~ExpressionTool() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct WorkflowOutputParameter\n : https___w3id_org_cwl_cwl::OutputParameter {\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> outputSource;\n heap_object<std::variant<std::monostate, LinkMergeMethod>> linkMerge;\n heap_object<std::variant<std::monostate, PickValueMethod>> pickValue;\n heap_object<std::variant<CWLType, OutputRecordSchema, OutputEnumSchema, OutputArraySchema, std::string, std::vector<std::variant<CWLType, OutputRecordSchema, OutputEnumSchema, OutputArraySchema, std::string>>>> type;\n ~WorkflowOutputParameter() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct Sink {\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> source;\n heap_object<std::variant<std::monostate, LinkMergeMethod>> linkMerge;\n heap_object<std::variant<std::monostate, PickValueMethod>> pickValue;\n virtual ~Sink() = 0;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct WorkflowStepInput\n : https___w3id_org_cwl_cwl::Identified\n , https___w3id_org_cwl_cwl::Sink\n , https___w3id_org_cwl_cwl::LoadContents\n , https___w3id_org_cwl_cwl::Labeled {\n heap_object<std::variant<std::monostate, File, Directory, std::any>> default_;\n heap_object<std::variant<std::monostate, std::string, Expression>> valueFrom;\n ~WorkflowStepInput() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct WorkflowStepOutput\n : https___w3id_org_cwl_cwl::Identified {\n ~WorkflowStepOutput() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct WorkflowStep\n : https___w3id_org_cwl_cwl::Identified\n , https___w3id_org_cwl_cwl::Labeled\n , https___w3id_org_cwl_salad::Documented {\n heap_object<std::vector<WorkflowStepInput>> in;\n heap_object<std::vector<std::variant<std::string, WorkflowStepOutput>>> out;\n heap_object<std::variant<std::monostate, std::vector<std::variant<InlineJavascriptRequirement, SchemaDefRequirement, LoadListingRequirement, DockerRequirement, SoftwareRequirement, InitialWorkDirRequirement, EnvVarRequirement, ShellCommandRequirement, ResourceRequirement, WorkReuse, NetworkAccess, InplaceUpdateRequirement, ToolTimeLimit, SubworkflowFeatureRequirement, ScatterFeatureRequirement, MultipleInputFeatureRequirement, StepInputExpressionRequirement>>>> requirements;\n heap_object<std::variant<std::monostate, std::vector<std::any>>> hints;\n heap_object<std::variant<std::string, CommandLineTool, ExpressionTool, Workflow, Operation>> run;\n heap_object<std::variant<std::monostate, Expression>> when;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> scatter;\n heap_object<std::variant<std::monostate, ScatterMethod>> scatterMethod;\n ~WorkflowStep() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct Workflow {\n heap_object<std::variant<std::monostate, std::string>> id;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n heap_object<std::vector<WorkflowInputParameter>> inputs;\n heap_object<std::vector<WorkflowOutputParameter>> outputs;\n heap_object<std::variant<std::monostate, std::vector<std::variant<InlineJavascriptRequirement, SchemaDefRequirement, LoadListingRequirement, DockerRequirement, SoftwareRequirement, InitialWorkDirRequirement, EnvVarRequirement, ShellCommandRequirement, ResourceRequirement, WorkReuse, NetworkAccess, InplaceUpdateRequirement, ToolTimeLimit, SubworkflowFeatureRequirement, ScatterFeatureRequirement, MultipleInputFeatureRequirement, StepInputExpressionRequirement>>>> requirements;\n heap_object<std::variant<std::monostate, std::vector<std::variant<InlineJavascriptRequirement, SchemaDefRequirement, LoadListingRequirement, DockerRequirement, SoftwareRequirement, InitialWorkDirRequirement, EnvVarRequirement, ShellCommandRequirement, ResourceRequirement, WorkReuse, NetworkAccess, InplaceUpdateRequirement, ToolTimeLimit, SubworkflowFeatureRequirement, ScatterFeatureRequirement, MultipleInputFeatureRequirement, StepInputExpressionRequirement, std::any>>>> hints;\n heap_object<std::variant<std::monostate, CWLVersion>> cwlVersion;\n heap_object<std::variant<std::monostate, std::vector<std::string>>> intent;\n heap_object<Workflow_class_Workflow_class> class_;\n heap_object<std::vector<WorkflowStep>> steps;\n virtual ~Workflow() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct SubworkflowFeatureRequirement\n : https___w3id_org_cwl_cwl::ProcessRequirement {\n heap_object<SubworkflowFeatureRequirement_class_SubworkflowFeatureRequirement_class> class_;\n ~SubworkflowFeatureRequirement() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct ScatterFeatureRequirement\n : https___w3id_org_cwl_cwl::ProcessRequirement {\n heap_object<ScatterFeatureRequirement_class_ScatterFeatureRequirement_class> class_;\n ~ScatterFeatureRequirement() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct MultipleInputFeatureRequirement\n : https___w3id_org_cwl_cwl::ProcessRequirement {\n heap_object<MultipleInputFeatureRequirement_class_MultipleInputFeatureRequirement_class> class_;\n ~MultipleInputFeatureRequirement() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct StepInputExpressionRequirement\n : https___w3id_org_cwl_cwl::ProcessRequirement {\n heap_object<StepInputExpressionRequirement_class_StepInputExpressionRequirement_class> class_;\n ~StepInputExpressionRequirement() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct OperationInputParameter\n : https___w3id_org_cwl_cwl::InputParameter {\n heap_object<std::variant<CWLType, InputRecordSchema, InputEnumSchema, InputArraySchema, std::string, std::vector<std::variant<CWLType, InputRecordSchema, InputEnumSchema, InputArraySchema, std::string>>>> type;\n ~OperationInputParameter() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct OperationOutputParameter\n : https___w3id_org_cwl_cwl::OutputParameter {\n heap_object<std::variant<CWLType, OutputRecordSchema, OutputEnumSchema, OutputArraySchema, std::string, std::vector<std::variant<CWLType, OutputRecordSchema, OutputEnumSchema, OutputArraySchema, std::string>>>> type;\n ~OperationOutputParameter() override = default;\n auto toYaml() const -> YAML::Node override;\n void fromYaml(YAML::Node const& n) override;\n};\n}\n\nnamespace https___w3id_org_cwl_cwl {\nstruct Operation {\n heap_object<std::variant<std::monostate, std::string>> id;\n heap_object<std::variant<std::monostate, std::string>> label;\n heap_object<std::variant<std::monostate, std::string, std::vector<std::string>>> doc;\n heap_object<std::vector<OperationInputParameter>> inputs;\n heap_object<std::vector<OperationOutputParameter>> outputs;\n heap_object<std::variant<std::monostate, std::vector<std::variant<InlineJavascriptRequirement, SchemaDefRequirement, LoadListingRequirement, DockerRequirement, SoftwareRequirement, InitialWorkDirRequirement, EnvVarRequirement, ShellCommandRequirement, ResourceRequirement, WorkReuse, NetworkAccess, InplaceUpdateRequirement, ToolTimeLimit, SubworkflowFeatureRequirement, ScatterFeatureRequirement, MultipleInputFeatureRequirement, StepInputExpressionRequirement>>>> requirements;\n heap_object<std::variant<std::monostate, std::vector<std::variant<InlineJavascriptRequirement, SchemaDefRequirement, LoadListingRequirement, DockerRequirement, SoftwareRequirement, InitialWorkDirRequirement, EnvVarRequirement, ShellCommandRequirement, ResourceRequirement, WorkReuse, NetworkAccess, InplaceUpdateRequirement, ToolTimeLimit, SubworkflowFeatureRequirement, ScatterFeatureRequirement, MultipleInputFeatureRequirement, StepInputExpressionRequirement, std::any>>>> hints;\n heap_object<std::variant<std::monostate, CWLVersion>> cwlVersion;\n heap_object<std::variant<std::monostate, std::vector<std::string>>> intent;\n heap_object<Operation_class_Operation_class> class_;\n virtual ~Operation() = default;\n virtual auto toYaml() const -> YAML::Node;\n virtual void fromYaml(YAML::Node const& n);\n};\n}\n\ninline https___w3id_org_cwl_salad::Documented::~Documented() = default;\ninline auto https___w3id_org_cwl_salad::Documented::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"doc\", toYaml(*doc));\n return n;\n}\ninline void https___w3id_org_cwl_salad::Documented::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"doc\"], *doc);\n}\ninline auto https___w3id_org_cwl_salad::RecordField::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_salad::Documented::toYaml());\n addYamlField(n, \"name\", toYaml(*name));\n addYamlField(n, \"type\", toYaml(*type));\n return n;\n}\ninline void https___w3id_org_cwl_salad::RecordField::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_salad::Documented::fromYaml(n);\n fromYaml(n[\"name\"], *name);\n fromYaml(n[\"type\"], *type);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_salad::RecordField> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_salad::RecordField> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_salad::RecordField{};\n\n if constexpr (IsConstant<decltype(res.name)::value_t>::value) try {\n fromYaml(n[\"name\"], *res.name);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_salad::RecordSchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"fields\",\n convertListToMap(toYaml(*fields), \"name\"));\n addYamlField(n, \"type\", toYaml(*type));\n return n;\n}\ninline void https___w3id_org_cwl_salad::RecordSchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n\n fromYaml(convertMapToList(n[\"fields\"],\n\"name\"), *fields);\n fromYaml(n[\"type\"], *type);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_salad::RecordSchema> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_salad::RecordSchema> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_salad::RecordSchema{};\n\n if constexpr (IsConstant<decltype(res.fields)::value_t>::value) try {\n fromYaml(n[\"fields\"], *res.fields);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_salad::EnumSchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"name\", toYaml(*name));\n addYamlField(n, \"symbols\", toYaml(*symbols));\n addYamlField(n, \"type\", toYaml(*type));\n return n;\n}\ninline void https___w3id_org_cwl_salad::EnumSchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"name\"], *name);\n fromYaml(n[\"symbols\"], *symbols);\n fromYaml(n[\"type\"], *type);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_salad::EnumSchema> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_salad::EnumSchema> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_salad::EnumSchema{};\n\n if constexpr (IsConstant<decltype(res.name)::value_t>::value) try {\n fromYaml(n[\"name\"], *res.name);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.symbols)::value_t>::value) try {\n fromYaml(n[\"symbols\"], *res.symbols);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_salad::ArraySchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"items\", toYaml(*items));\n addYamlField(n, \"type\", toYaml(*type));\n return n;\n}\ninline void https___w3id_org_cwl_salad::ArraySchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"items\"], *items);\n fromYaml(n[\"type\"], *type);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_salad::ArraySchema> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_salad::ArraySchema> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_salad::ArraySchema{};\n\n if constexpr (IsConstant<decltype(res.items)::value_t>::value) try {\n fromYaml(n[\"items\"], *res.items);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::File::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"class\", toYaml(*class_));\n addYamlField(n, \"location\", toYaml(*location));\n addYamlField(n, \"path\", toYaml(*path));\n addYamlField(n, \"basename\", toYaml(*basename));\n addYamlField(n, \"dirname\", toYaml(*dirname));\n addYamlField(n, \"nameroot\", toYaml(*nameroot));\n addYamlField(n, \"nameext\", toYaml(*nameext));\n addYamlField(n, \"checksum\", toYaml(*checksum));\n addYamlField(n, \"size\", toYaml(*size));\n addYamlField(n, \"secondaryFiles\", toYaml(*secondaryFiles));\n addYamlField(n, \"format\", toYaml(*format));\n addYamlField(n, \"contents\", toYaml(*contents));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::File::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"class\"], *class_);\n fromYaml(n[\"location\"], *location);\n fromYaml(n[\"path\"], *path);\n fromYaml(n[\"basename\"], *basename);\n fromYaml(n[\"dirname\"], *dirname);\n fromYaml(n[\"nameroot\"], *nameroot);\n fromYaml(n[\"nameext\"], *nameext);\n fromYaml(n[\"checksum\"], *checksum);\n fromYaml(n[\"size\"], *size);\n fromYaml(n[\"secondaryFiles\"], *secondaryFiles);\n fromYaml(n[\"format\"], *format);\n fromYaml(n[\"contents\"], *contents);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::File> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::File> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::File{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.location)::value_t>::value) try {\n fromYaml(n[\"location\"], *res.location);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.path)::value_t>::value) try {\n fromYaml(n[\"path\"], *res.path);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.basename)::value_t>::value) try {\n fromYaml(n[\"basename\"], *res.basename);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.dirname)::value_t>::value) try {\n fromYaml(n[\"dirname\"], *res.dirname);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.nameroot)::value_t>::value) try {\n fromYaml(n[\"nameroot\"], *res.nameroot);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.nameext)::value_t>::value) try {\n fromYaml(n[\"nameext\"], *res.nameext);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.checksum)::value_t>::value) try {\n fromYaml(n[\"checksum\"], *res.checksum);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.size)::value_t>::value) try {\n fromYaml(n[\"size\"], *res.size);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.secondaryFiles)::value_t>::value) try {\n fromYaml(n[\"secondaryFiles\"], *res.secondaryFiles);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.format)::value_t>::value) try {\n fromYaml(n[\"format\"], *res.format);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.contents)::value_t>::value) try {\n fromYaml(n[\"contents\"], *res.contents);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::Directory::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"class\", toYaml(*class_));\n addYamlField(n, \"location\", toYaml(*location));\n addYamlField(n, \"path\", toYaml(*path));\n addYamlField(n, \"basename\", toYaml(*basename));\n addYamlField(n, \"listing\", toYaml(*listing));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::Directory::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"class\"], *class_);\n fromYaml(n[\"location\"], *location);\n fromYaml(n[\"path\"], *path);\n fromYaml(n[\"basename\"], *basename);\n fromYaml(n[\"listing\"], *listing);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::Directory> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::Directory> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::Directory{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.location)::value_t>::value) try {\n fromYaml(n[\"location\"], *res.location);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.path)::value_t>::value) try {\n fromYaml(n[\"path\"], *res.path);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.basename)::value_t>::value) try {\n fromYaml(n[\"basename\"], *res.basename);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.listing)::value_t>::value) try {\n fromYaml(n[\"listing\"], *res.listing);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline https___w3id_org_cwl_cwl::Labeled::~Labeled() = default;\ninline auto https___w3id_org_cwl_cwl::Labeled::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"label\", toYaml(*label));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::Labeled::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"label\"], *label);\n}\ninline https___w3id_org_cwl_cwl::Identified::~Identified() = default;\ninline auto https___w3id_org_cwl_cwl::Identified::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"id\", toYaml(*id));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::Identified::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"id\"], *id);\n}\ninline https___w3id_org_cwl_cwl::LoadContents::~LoadContents() = default;\ninline auto https___w3id_org_cwl_cwl::LoadContents::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"loadContents\", toYaml(*loadContents));\n addYamlField(n, \"loadListing\", toYaml(*loadListing));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::LoadContents::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"loadContents\"], *loadContents);\n fromYaml(n[\"loadListing\"], *loadListing);\n}\ninline https___w3id_org_cwl_cwl::FieldBase::~FieldBase() = default;\ninline auto https___w3id_org_cwl_cwl::FieldBase::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::Labeled::toYaml());\n addYamlField(n, \"secondaryFiles\", toYaml(*secondaryFiles));\n addYamlField(n, \"streamable\", toYaml(*streamable));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::FieldBase::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::Labeled::fromYaml(n);\n fromYaml(n[\"secondaryFiles\"], *secondaryFiles);\n fromYaml(n[\"streamable\"], *streamable);\n}\ninline https___w3id_org_cwl_cwl::InputFormat::~InputFormat() = default;\ninline auto https___w3id_org_cwl_cwl::InputFormat::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"format\", toYaml(*format));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::InputFormat::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"format\"], *format);\n}\ninline https___w3id_org_cwl_cwl::OutputFormat::~OutputFormat() = default;\ninline auto https___w3id_org_cwl_cwl::OutputFormat::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"format\", toYaml(*format));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::OutputFormat::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"format\"], *format);\n}\ninline https___w3id_org_cwl_cwl::Parameter::~Parameter() = default;\ninline auto https___w3id_org_cwl_cwl::Parameter::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::FieldBase::toYaml());\n n = mergeYaml(n, https___w3id_org_cwl_salad::Documented::toYaml());\n n = mergeYaml(n, https___w3id_org_cwl_cwl::Identified::toYaml());\n return n;\n}\ninline void https___w3id_org_cwl_cwl::Parameter::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::FieldBase::fromYaml(n);\n https___w3id_org_cwl_salad::Documented::fromYaml(n);\n https___w3id_org_cwl_cwl::Identified::fromYaml(n);\n}\ninline auto https___w3id_org_cwl_cwl::InputBinding::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"loadContents\", toYaml(*loadContents));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::InputBinding::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"loadContents\"], *loadContents);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::InputBinding> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::InputBinding> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::InputBinding{};\n\n if constexpr (IsConstant<decltype(res.loadContents)::value_t>::value) try {\n fromYaml(n[\"loadContents\"], *res.loadContents);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline https___w3id_org_cwl_cwl::IOSchema::~IOSchema() = default;\ninline auto https___w3id_org_cwl_cwl::IOSchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::Labeled::toYaml());\n n = mergeYaml(n, https___w3id_org_cwl_salad::Documented::toYaml());\n addYamlField(n, \"name\", toYaml(*name));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::IOSchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::Labeled::fromYaml(n);\n https___w3id_org_cwl_salad::Documented::fromYaml(n);\n fromYaml(n[\"name\"], *name);\n}\ninline https___w3id_org_cwl_cwl::InputSchema::~InputSchema() = default;\ninline auto https___w3id_org_cwl_cwl::InputSchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::IOSchema::toYaml());\n return n;\n}\ninline void https___w3id_org_cwl_cwl::InputSchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::IOSchema::fromYaml(n);\n}\ninline https___w3id_org_cwl_cwl::OutputSchema::~OutputSchema() = default;\ninline auto https___w3id_org_cwl_cwl::OutputSchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::IOSchema::toYaml());\n return n;\n}\ninline void https___w3id_org_cwl_cwl::OutputSchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::IOSchema::fromYaml(n);\n}\ninline auto https___w3id_org_cwl_cwl::InputRecordField::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"doc\", toYaml(*doc));\n addYamlField(n, \"name\", toYaml(*name));\n addYamlField(n, \"type\", toYaml(*type));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"secondaryFiles\", toYaml(*secondaryFiles));\n addYamlField(n, \"streamable\", toYaml(*streamable));\n addYamlField(n, \"format\", toYaml(*format));\n addYamlField(n, \"loadContents\", toYaml(*loadContents));\n addYamlField(n, \"loadListing\", toYaml(*loadListing));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::InputRecordField::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"doc\"], *doc);\n fromYaml(n[\"name\"], *name);\n fromYaml(n[\"type\"], *type);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"secondaryFiles\"], *secondaryFiles);\n fromYaml(n[\"streamable\"], *streamable);\n fromYaml(n[\"format\"], *format);\n fromYaml(n[\"loadContents\"], *loadContents);\n fromYaml(n[\"loadListing\"], *loadListing);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::InputRecordField> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::InputRecordField> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::InputRecordField{};\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.name)::value_t>::value) try {\n fromYaml(n[\"name\"], *res.name);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.secondaryFiles)::value_t>::value) try {\n fromYaml(n[\"secondaryFiles\"], *res.secondaryFiles);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.streamable)::value_t>::value) try {\n fromYaml(n[\"streamable\"], *res.streamable);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.format)::value_t>::value) try {\n fromYaml(n[\"format\"], *res.format);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.loadContents)::value_t>::value) try {\n fromYaml(n[\"loadContents\"], *res.loadContents);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.loadListing)::value_t>::value) try {\n fromYaml(n[\"loadListing\"], *res.loadListing);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::InputRecordSchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"fields\",\n convertListToMap(toYaml(*fields), \"name\"));\n addYamlField(n, \"type\", toYaml(*type));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"doc\", toYaml(*doc));\n addYamlField(n, \"name\", toYaml(*name));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::InputRecordSchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n\n fromYaml(convertMapToList(n[\"fields\"],\n\"name\"), *fields);\n fromYaml(n[\"type\"], *type);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"doc\"], *doc);\n fromYaml(n[\"name\"], *name);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::InputRecordSchema> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::InputRecordSchema> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::InputRecordSchema{};\n\n if constexpr (IsConstant<decltype(res.fields)::value_t>::value) try {\n fromYaml(n[\"fields\"], *res.fields);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.name)::value_t>::value) try {\n fromYaml(n[\"name\"], *res.name);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::InputEnumSchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_salad::EnumSchema::toYaml());\n n = mergeYaml(n, https___w3id_org_cwl_cwl::InputSchema::toYaml());\n return n;\n}\ninline void https___w3id_org_cwl_cwl::InputEnumSchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_salad::EnumSchema::fromYaml(n);\n https___w3id_org_cwl_cwl::InputSchema::fromYaml(n);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::InputEnumSchema> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::InputEnumSchema> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::InputEnumSchema{};\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::InputArraySchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"items\", toYaml(*items));\n addYamlField(n, \"type\", toYaml(*type));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"doc\", toYaml(*doc));\n addYamlField(n, \"name\", toYaml(*name));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::InputArraySchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"items\"], *items);\n fromYaml(n[\"type\"], *type);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"doc\"], *doc);\n fromYaml(n[\"name\"], *name);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::InputArraySchema> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::InputArraySchema> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::InputArraySchema{};\n\n if constexpr (IsConstant<decltype(res.items)::value_t>::value) try {\n fromYaml(n[\"items\"], *res.items);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.name)::value_t>::value) try {\n fromYaml(n[\"name\"], *res.name);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::OutputRecordField::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"doc\", toYaml(*doc));\n addYamlField(n, \"name\", toYaml(*name));\n addYamlField(n, \"type\", toYaml(*type));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"secondaryFiles\", toYaml(*secondaryFiles));\n addYamlField(n, \"streamable\", toYaml(*streamable));\n addYamlField(n, \"format\", toYaml(*format));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::OutputRecordField::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"doc\"], *doc);\n fromYaml(n[\"name\"], *name);\n fromYaml(n[\"type\"], *type);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"secondaryFiles\"], *secondaryFiles);\n fromYaml(n[\"streamable\"], *streamable);\n fromYaml(n[\"format\"], *format);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::OutputRecordField> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::OutputRecordField> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::OutputRecordField{};\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.name)::value_t>::value) try {\n fromYaml(n[\"name\"], *res.name);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.secondaryFiles)::value_t>::value) try {\n fromYaml(n[\"secondaryFiles\"], *res.secondaryFiles);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.streamable)::value_t>::value) try {\n fromYaml(n[\"streamable\"], *res.streamable);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.format)::value_t>::value) try {\n fromYaml(n[\"format\"], *res.format);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::OutputRecordSchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"fields\",\n convertListToMap(toYaml(*fields), \"name\"));\n addYamlField(n, \"type\", toYaml(*type));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"doc\", toYaml(*doc));\n addYamlField(n, \"name\", toYaml(*name));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::OutputRecordSchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n\n fromYaml(convertMapToList(n[\"fields\"],\n\"name\"), *fields);\n fromYaml(n[\"type\"], *type);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"doc\"], *doc);\n fromYaml(n[\"name\"], *name);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::OutputRecordSchema> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::OutputRecordSchema> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::OutputRecordSchema{};\n\n if constexpr (IsConstant<decltype(res.fields)::value_t>::value) try {\n fromYaml(n[\"fields\"], *res.fields);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.name)::value_t>::value) try {\n fromYaml(n[\"name\"], *res.name);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::OutputEnumSchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_salad::EnumSchema::toYaml());\n n = mergeYaml(n, https___w3id_org_cwl_cwl::OutputSchema::toYaml());\n return n;\n}\ninline void https___w3id_org_cwl_cwl::OutputEnumSchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_salad::EnumSchema::fromYaml(n);\n https___w3id_org_cwl_cwl::OutputSchema::fromYaml(n);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::OutputEnumSchema> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::OutputEnumSchema> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::OutputEnumSchema{};\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::OutputArraySchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"items\", toYaml(*items));\n addYamlField(n, \"type\", toYaml(*type));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"doc\", toYaml(*doc));\n addYamlField(n, \"name\", toYaml(*name));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::OutputArraySchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"items\"], *items);\n fromYaml(n[\"type\"], *type);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"doc\"], *doc);\n fromYaml(n[\"name\"], *name);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::OutputArraySchema> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::OutputArraySchema> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::OutputArraySchema{};\n\n if constexpr (IsConstant<decltype(res.items)::value_t>::value) try {\n fromYaml(n[\"items\"], *res.items);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.name)::value_t>::value) try {\n fromYaml(n[\"name\"], *res.name);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline https___w3id_org_cwl_cwl::InputParameter::~InputParameter() = default;\ninline auto https___w3id_org_cwl_cwl::InputParameter::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::Parameter::toYaml());\n n = mergeYaml(n, https___w3id_org_cwl_cwl::InputFormat::toYaml());\n n = mergeYaml(n, https___w3id_org_cwl_cwl::LoadContents::toYaml());\n addYamlField(n, \"default\", toYaml(*default_));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::InputParameter::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::Parameter::fromYaml(n);\n https___w3id_org_cwl_cwl::InputFormat::fromYaml(n);\n https___w3id_org_cwl_cwl::LoadContents::fromYaml(n);\n fromYaml(n[\"default\"], *default_);\n}\ninline https___w3id_org_cwl_cwl::OutputParameter::~OutputParameter() = default;\ninline auto https___w3id_org_cwl_cwl::OutputParameter::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::Parameter::toYaml());\n n = mergeYaml(n, https___w3id_org_cwl_cwl::OutputFormat::toYaml());\n return n;\n}\ninline void https___w3id_org_cwl_cwl::OutputParameter::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::Parameter::fromYaml(n);\n https___w3id_org_cwl_cwl::OutputFormat::fromYaml(n);\n}\ninline https___w3id_org_cwl_cwl::ProcessRequirement::~ProcessRequirement() = default;\ninline auto https___w3id_org_cwl_cwl::ProcessRequirement::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n return n;\n}\ninline void https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n}\ninline https___w3id_org_cwl_cwl::Process::~Process() = default;\ninline auto https___w3id_org_cwl_cwl::Process::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::Identified::toYaml());\n n = mergeYaml(n, https___w3id_org_cwl_cwl::Labeled::toYaml());\n n = mergeYaml(n, https___w3id_org_cwl_salad::Documented::toYaml());\n addYamlField(n, \"inputs\",\n convertListToMap(toYaml(*inputs), \"id\"));\n addYamlField(n, \"outputs\",\n convertListToMap(toYaml(*outputs), \"id\"));\n addYamlField(n, \"requirements\",\n convertListToMap(toYaml(*requirements), \"class\"));\n addYamlField(n, \"hints\",\n convertListToMap(toYaml(*hints), \"class\"));\n addYamlField(n, \"cwlVersion\", toYaml(*cwlVersion));\n addYamlField(n, \"intent\", toYaml(*intent));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::Process::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::Identified::fromYaml(n);\n https___w3id_org_cwl_cwl::Labeled::fromYaml(n);\n https___w3id_org_cwl_salad::Documented::fromYaml(n);\n\n fromYaml(convertMapToList(n[\"inputs\"],\n\"id\"), *inputs);\n\n fromYaml(convertMapToList(n[\"outputs\"],\n\"id\"), *outputs);\n\n fromYaml(convertMapToList(n[\"requirements\"],\n\"class\"), *requirements);\n\n fromYaml(convertMapToList(n[\"hints\"],\n\"class\"), *hints);\n fromYaml(n[\"cwlVersion\"], *cwlVersion);\n fromYaml(n[\"intent\"], *intent);\n}\ninline auto https___w3id_org_cwl_cwl::InlineJavascriptRequirement::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::ProcessRequirement::toYaml());\n addYamlField(n, \"class\", toYaml(*class_));\n addYamlField(n, \"expressionLib\", toYaml(*expressionLib));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::InlineJavascriptRequirement::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml(n);\n fromYaml(n[\"class\"], *class_);\n fromYaml(n[\"expressionLib\"], *expressionLib);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::InlineJavascriptRequirement> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::InlineJavascriptRequirement> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::InlineJavascriptRequirement{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.expressionLib)::value_t>::value) try {\n fromYaml(n[\"expressionLib\"], *res.expressionLib);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline https___w3id_org_cwl_cwl::CommandInputSchema::~CommandInputSchema() = default;\ninline auto https___w3id_org_cwl_cwl::CommandInputSchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n return n;\n}\ninline void https___w3id_org_cwl_cwl::CommandInputSchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n}\ninline auto https___w3id_org_cwl_cwl::SchemaDefRequirement::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::ProcessRequirement::toYaml());\n addYamlField(n, \"class\", toYaml(*class_));\n addYamlField(n, \"types\", toYaml(*types));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::SchemaDefRequirement::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml(n);\n fromYaml(n[\"class\"], *class_);\n fromYaml(n[\"types\"], *types);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::SchemaDefRequirement> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::SchemaDefRequirement> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::SchemaDefRequirement{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.types)::value_t>::value) try {\n fromYaml(n[\"types\"], *res.types);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::SecondaryFileSchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"pattern\", toYaml(*pattern));\n addYamlField(n, \"required\", toYaml(*required));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::SecondaryFileSchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"pattern\"], *pattern);\n fromYaml(n[\"required\"], *required);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::SecondaryFileSchema> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::SecondaryFileSchema> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::SecondaryFileSchema{};\n\n if constexpr (IsConstant<decltype(res.pattern)::value_t>::value) try {\n fromYaml(n[\"pattern\"], *res.pattern);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.required)::value_t>::value) try {\n fromYaml(n[\"required\"], *res.required);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::LoadListingRequirement::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::ProcessRequirement::toYaml());\n addYamlField(n, \"class\", toYaml(*class_));\n addYamlField(n, \"loadListing\", toYaml(*loadListing));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::LoadListingRequirement::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml(n);\n fromYaml(n[\"class\"], *class_);\n fromYaml(n[\"loadListing\"], *loadListing);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::LoadListingRequirement> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::LoadListingRequirement> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::LoadListingRequirement{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.loadListing)::value_t>::value) try {\n fromYaml(n[\"loadListing\"], *res.loadListing);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::EnvironmentDef::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"envName\", toYaml(*envName));\n addYamlField(n, \"envValue\", toYaml(*envValue));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::EnvironmentDef::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"envName\"], *envName);\n fromYaml(n[\"envValue\"], *envValue);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::EnvironmentDef> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::EnvironmentDef> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::EnvironmentDef{};\n\n if constexpr (IsConstant<decltype(res.envName)::value_t>::value) try {\n fromYaml(n[\"envName\"], *res.envName);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.envValue)::value_t>::value) try {\n fromYaml(n[\"envValue\"], *res.envValue);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::CommandLineBinding::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::InputBinding::toYaml());\n addYamlField(n, \"position\", toYaml(*position));\n addYamlField(n, \"prefix\", toYaml(*prefix));\n addYamlField(n, \"separate\", toYaml(*separate));\n addYamlField(n, \"itemSeparator\", toYaml(*itemSeparator));\n addYamlField(n, \"valueFrom\", toYaml(*valueFrom));\n addYamlField(n, \"shellQuote\", toYaml(*shellQuote));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::CommandLineBinding::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::InputBinding::fromYaml(n);\n fromYaml(n[\"position\"], *position);\n fromYaml(n[\"prefix\"], *prefix);\n fromYaml(n[\"separate\"], *separate);\n fromYaml(n[\"itemSeparator\"], *itemSeparator);\n fromYaml(n[\"valueFrom\"], *valueFrom);\n fromYaml(n[\"shellQuote\"], *shellQuote);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::CommandLineBinding> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::CommandLineBinding> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::CommandLineBinding{};\n\n if constexpr (IsConstant<decltype(res.position)::value_t>::value) try {\n fromYaml(n[\"position\"], *res.position);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.prefix)::value_t>::value) try {\n fromYaml(n[\"prefix\"], *res.prefix);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.separate)::value_t>::value) try {\n fromYaml(n[\"separate\"], *res.separate);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.itemSeparator)::value_t>::value) try {\n fromYaml(n[\"itemSeparator\"], *res.itemSeparator);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.valueFrom)::value_t>::value) try {\n fromYaml(n[\"valueFrom\"], *res.valueFrom);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.shellQuote)::value_t>::value) try {\n fromYaml(n[\"shellQuote\"], *res.shellQuote);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::CommandOutputBinding::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::LoadContents::toYaml());\n addYamlField(n, \"glob\", toYaml(*glob));\n addYamlField(n, \"outputEval\", toYaml(*outputEval));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::CommandOutputBinding::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::LoadContents::fromYaml(n);\n fromYaml(n[\"glob\"], *glob);\n fromYaml(n[\"outputEval\"], *outputEval);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::CommandOutputBinding> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::CommandOutputBinding> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::CommandOutputBinding{};\n\n if constexpr (IsConstant<decltype(res.glob)::value_t>::value) try {\n fromYaml(n[\"glob\"], *res.glob);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.outputEval)::value_t>::value) try {\n fromYaml(n[\"outputEval\"], *res.outputEval);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::CommandLineBindable::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"inputBinding\", toYaml(*inputBinding));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::CommandLineBindable::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"inputBinding\"], *inputBinding);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::CommandLineBindable> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::CommandLineBindable> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::CommandLineBindable{};\n\n if constexpr (IsConstant<decltype(res.inputBinding)::value_t>::value) try {\n fromYaml(n[\"inputBinding\"], *res.inputBinding);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::CommandInputRecordField::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"doc\", toYaml(*doc));\n addYamlField(n, \"name\", toYaml(*name));\n addYamlField(n, \"type\", toYaml(*type));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"secondaryFiles\", toYaml(*secondaryFiles));\n addYamlField(n, \"streamable\", toYaml(*streamable));\n addYamlField(n, \"format\", toYaml(*format));\n addYamlField(n, \"loadContents\", toYaml(*loadContents));\n addYamlField(n, \"loadListing\", toYaml(*loadListing));\n addYamlField(n, \"inputBinding\", toYaml(*inputBinding));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::CommandInputRecordField::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"doc\"], *doc);\n fromYaml(n[\"name\"], *name);\n fromYaml(n[\"type\"], *type);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"secondaryFiles\"], *secondaryFiles);\n fromYaml(n[\"streamable\"], *streamable);\n fromYaml(n[\"format\"], *format);\n fromYaml(n[\"loadContents\"], *loadContents);\n fromYaml(n[\"loadListing\"], *loadListing);\n fromYaml(n[\"inputBinding\"], *inputBinding);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::CommandInputRecordField> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::CommandInputRecordField> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::CommandInputRecordField{};\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.name)::value_t>::value) try {\n fromYaml(n[\"name\"], *res.name);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.secondaryFiles)::value_t>::value) try {\n fromYaml(n[\"secondaryFiles\"], *res.secondaryFiles);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.streamable)::value_t>::value) try {\n fromYaml(n[\"streamable\"], *res.streamable);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.format)::value_t>::value) try {\n fromYaml(n[\"format\"], *res.format);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.loadContents)::value_t>::value) try {\n fromYaml(n[\"loadContents\"], *res.loadContents);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.loadListing)::value_t>::value) try {\n fromYaml(n[\"loadListing\"], *res.loadListing);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.inputBinding)::value_t>::value) try {\n fromYaml(n[\"inputBinding\"], *res.inputBinding);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::CommandInputRecordSchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"fields\",\n convertListToMap(toYaml(*fields), \"name\"));\n addYamlField(n, \"type\", toYaml(*type));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"doc\", toYaml(*doc));\n addYamlField(n, \"name\", toYaml(*name));\n addYamlField(n, \"inputBinding\", toYaml(*inputBinding));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::CommandInputRecordSchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n\n fromYaml(convertMapToList(n[\"fields\"],\n\"name\"), *fields);\n fromYaml(n[\"type\"], *type);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"doc\"], *doc);\n fromYaml(n[\"name\"], *name);\n fromYaml(n[\"inputBinding\"], *inputBinding);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::CommandInputRecordSchema> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::CommandInputRecordSchema> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::CommandInputRecordSchema{};\n\n if constexpr (IsConstant<decltype(res.fields)::value_t>::value) try {\n fromYaml(n[\"fields\"], *res.fields);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.name)::value_t>::value) try {\n fromYaml(n[\"name\"], *res.name);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.inputBinding)::value_t>::value) try {\n fromYaml(n[\"inputBinding\"], *res.inputBinding);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::CommandInputEnumSchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"name\", toYaml(*name));\n addYamlField(n, \"symbols\", toYaml(*symbols));\n addYamlField(n, \"type\", toYaml(*type));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"doc\", toYaml(*doc));\n addYamlField(n, \"inputBinding\", toYaml(*inputBinding));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::CommandInputEnumSchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"name\"], *name);\n fromYaml(n[\"symbols\"], *symbols);\n fromYaml(n[\"type\"], *type);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"doc\"], *doc);\n fromYaml(n[\"inputBinding\"], *inputBinding);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::CommandInputEnumSchema> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::CommandInputEnumSchema> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::CommandInputEnumSchema{};\n\n if constexpr (IsConstant<decltype(res.name)::value_t>::value) try {\n fromYaml(n[\"name\"], *res.name);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.symbols)::value_t>::value) try {\n fromYaml(n[\"symbols\"], *res.symbols);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.inputBinding)::value_t>::value) try {\n fromYaml(n[\"inputBinding\"], *res.inputBinding);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::CommandInputArraySchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"items\", toYaml(*items));\n addYamlField(n, \"type\", toYaml(*type));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"doc\", toYaml(*doc));\n addYamlField(n, \"name\", toYaml(*name));\n addYamlField(n, \"inputBinding\", toYaml(*inputBinding));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::CommandInputArraySchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"items\"], *items);\n fromYaml(n[\"type\"], *type);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"doc\"], *doc);\n fromYaml(n[\"name\"], *name);\n fromYaml(n[\"inputBinding\"], *inputBinding);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::CommandInputArraySchema> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::CommandInputArraySchema> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::CommandInputArraySchema{};\n\n if constexpr (IsConstant<decltype(res.items)::value_t>::value) try {\n fromYaml(n[\"items\"], *res.items);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.name)::value_t>::value) try {\n fromYaml(n[\"name\"], *res.name);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.inputBinding)::value_t>::value) try {\n fromYaml(n[\"inputBinding\"], *res.inputBinding);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::CommandOutputRecordField::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"doc\", toYaml(*doc));\n addYamlField(n, \"name\", toYaml(*name));\n addYamlField(n, \"type\", toYaml(*type));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"secondaryFiles\", toYaml(*secondaryFiles));\n addYamlField(n, \"streamable\", toYaml(*streamable));\n addYamlField(n, \"format\", toYaml(*format));\n addYamlField(n, \"outputBinding\", toYaml(*outputBinding));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::CommandOutputRecordField::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"doc\"], *doc);\n fromYaml(n[\"name\"], *name);\n fromYaml(n[\"type\"], *type);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"secondaryFiles\"], *secondaryFiles);\n fromYaml(n[\"streamable\"], *streamable);\n fromYaml(n[\"format\"], *format);\n fromYaml(n[\"outputBinding\"], *outputBinding);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::CommandOutputRecordField> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::CommandOutputRecordField> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::CommandOutputRecordField{};\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.name)::value_t>::value) try {\n fromYaml(n[\"name\"], *res.name);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.secondaryFiles)::value_t>::value) try {\n fromYaml(n[\"secondaryFiles\"], *res.secondaryFiles);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.streamable)::value_t>::value) try {\n fromYaml(n[\"streamable\"], *res.streamable);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.format)::value_t>::value) try {\n fromYaml(n[\"format\"], *res.format);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.outputBinding)::value_t>::value) try {\n fromYaml(n[\"outputBinding\"], *res.outputBinding);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::CommandOutputRecordSchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"fields\",\n convertListToMap(toYaml(*fields), \"name\"));\n addYamlField(n, \"type\", toYaml(*type));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"doc\", toYaml(*doc));\n addYamlField(n, \"name\", toYaml(*name));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::CommandOutputRecordSchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n\n fromYaml(convertMapToList(n[\"fields\"],\n\"name\"), *fields);\n fromYaml(n[\"type\"], *type);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"doc\"], *doc);\n fromYaml(n[\"name\"], *name);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::CommandOutputRecordSchema> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::CommandOutputRecordSchema> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::CommandOutputRecordSchema{};\n\n if constexpr (IsConstant<decltype(res.fields)::value_t>::value) try {\n fromYaml(n[\"fields\"], *res.fields);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.name)::value_t>::value) try {\n fromYaml(n[\"name\"], *res.name);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::CommandOutputEnumSchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"name\", toYaml(*name));\n addYamlField(n, \"symbols\", toYaml(*symbols));\n addYamlField(n, \"type\", toYaml(*type));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"doc\", toYaml(*doc));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::CommandOutputEnumSchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"name\"], *name);\n fromYaml(n[\"symbols\"], *symbols);\n fromYaml(n[\"type\"], *type);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"doc\"], *doc);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::CommandOutputEnumSchema> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::CommandOutputEnumSchema> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::CommandOutputEnumSchema{};\n\n if constexpr (IsConstant<decltype(res.name)::value_t>::value) try {\n fromYaml(n[\"name\"], *res.name);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.symbols)::value_t>::value) try {\n fromYaml(n[\"symbols\"], *res.symbols);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::CommandOutputArraySchema::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"items\", toYaml(*items));\n addYamlField(n, \"type\", toYaml(*type));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"doc\", toYaml(*doc));\n addYamlField(n, \"name\", toYaml(*name));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::CommandOutputArraySchema::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"items\"], *items);\n fromYaml(n[\"type\"], *type);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"doc\"], *doc);\n fromYaml(n[\"name\"], *name);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::CommandOutputArraySchema> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::CommandOutputArraySchema> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::CommandOutputArraySchema{};\n\n if constexpr (IsConstant<decltype(res.items)::value_t>::value) try {\n fromYaml(n[\"items\"], *res.items);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.name)::value_t>::value) try {\n fromYaml(n[\"name\"], *res.name);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::CommandInputParameter::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::InputParameter::toYaml());\n addYamlField(n, \"type\", toYaml(*type));\n addYamlField(n, \"inputBinding\", toYaml(*inputBinding));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::CommandInputParameter::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::InputParameter::fromYaml(n);\n fromYaml(n[\"type\"], *type);\n fromYaml(n[\"inputBinding\"], *inputBinding);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::CommandInputParameter> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::CommandInputParameter> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::CommandInputParameter{};\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.inputBinding)::value_t>::value) try {\n fromYaml(n[\"inputBinding\"], *res.inputBinding);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::CommandOutputParameter::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::OutputParameter::toYaml());\n addYamlField(n, \"type\", toYaml(*type));\n addYamlField(n, \"outputBinding\", toYaml(*outputBinding));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::CommandOutputParameter::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::OutputParameter::fromYaml(n);\n fromYaml(n[\"type\"], *type);\n fromYaml(n[\"outputBinding\"], *outputBinding);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::CommandOutputParameter> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::CommandOutputParameter> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::CommandOutputParameter{};\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.outputBinding)::value_t>::value) try {\n fromYaml(n[\"outputBinding\"], *res.outputBinding);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::CommandLineTool::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"id\", toYaml(*id));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"doc\", toYaml(*doc));\n addYamlField(n, \"inputs\",\n convertListToMap(toYaml(*inputs), \"id\"));\n addYamlField(n, \"outputs\",\n convertListToMap(toYaml(*outputs), \"id\"));\n addYamlField(n, \"requirements\",\n convertListToMap(toYaml(*requirements), \"class\"));\n addYamlField(n, \"hints\",\n convertListToMap(toYaml(*hints), \"class\"));\n addYamlField(n, \"cwlVersion\", toYaml(*cwlVersion));\n addYamlField(n, \"intent\", toYaml(*intent));\n addYamlField(n, \"class\", toYaml(*class_));\n addYamlField(n, \"baseCommand\", toYaml(*baseCommand));\n addYamlField(n, \"arguments\", toYaml(*arguments));\n addYamlField(n, \"stdin\", toYaml(*stdin_));\n addYamlField(n, \"stderr\", toYaml(*stderr_));\n addYamlField(n, \"stdout\", toYaml(*stdout_));\n addYamlField(n, \"successCodes\", toYaml(*successCodes));\n addYamlField(n, \"temporaryFailCodes\", toYaml(*temporaryFailCodes));\n addYamlField(n, \"permanentFailCodes\", toYaml(*permanentFailCodes));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::CommandLineTool::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"id\"], *id);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"doc\"], *doc);\n\n fromYaml(convertMapToList(n[\"inputs\"],\n\"id\"), *inputs);\n\n fromYaml(convertMapToList(n[\"outputs\"],\n\"id\"), *outputs);\n\n fromYaml(convertMapToList(n[\"requirements\"],\n\"class\"), *requirements);\n\n fromYaml(convertMapToList(n[\"hints\"],\n\"class\"), *hints);\n fromYaml(n[\"cwlVersion\"], *cwlVersion);\n fromYaml(n[\"intent\"], *intent);\n fromYaml(n[\"class\"], *class_);\n fromYaml(n[\"baseCommand\"], *baseCommand);\n fromYaml(n[\"arguments\"], *arguments);\n fromYaml(n[\"stdin\"], *stdin_);\n fromYaml(n[\"stderr\"], *stderr_);\n fromYaml(n[\"stdout\"], *stdout_);\n fromYaml(n[\"successCodes\"], *successCodes);\n fromYaml(n[\"temporaryFailCodes\"], *temporaryFailCodes);\n fromYaml(n[\"permanentFailCodes\"], *permanentFailCodes);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::CommandLineTool> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::CommandLineTool> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::CommandLineTool{};\n\n if constexpr (IsConstant<decltype(res.id)::value_t>::value) try {\n fromYaml(n[\"id\"], *res.id);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.inputs)::value_t>::value) try {\n fromYaml(n[\"inputs\"], *res.inputs);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.outputs)::value_t>::value) try {\n fromYaml(n[\"outputs\"], *res.outputs);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.requirements)::value_t>::value) try {\n fromYaml(n[\"requirements\"], *res.requirements);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.hints)::value_t>::value) try {\n fromYaml(n[\"hints\"], *res.hints);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.cwlVersion)::value_t>::value) try {\n fromYaml(n[\"cwlVersion\"], *res.cwlVersion);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.intent)::value_t>::value) try {\n fromYaml(n[\"intent\"], *res.intent);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.baseCommand)::value_t>::value) try {\n fromYaml(n[\"baseCommand\"], *res.baseCommand);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.arguments)::value_t>::value) try {\n fromYaml(n[\"arguments\"], *res.arguments);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.stdin_)::value_t>::value) try {\n fromYaml(n[\"stdin\"], *res.stdin_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.stderr_)::value_t>::value) try {\n fromYaml(n[\"stderr\"], *res.stderr_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.stdout_)::value_t>::value) try {\n fromYaml(n[\"stdout\"], *res.stdout_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.successCodes)::value_t>::value) try {\n fromYaml(n[\"successCodes\"], *res.successCodes);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.temporaryFailCodes)::value_t>::value) try {\n fromYaml(n[\"temporaryFailCodes\"], *res.temporaryFailCodes);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.permanentFailCodes)::value_t>::value) try {\n fromYaml(n[\"permanentFailCodes\"], *res.permanentFailCodes);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::DockerRequirement::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::ProcessRequirement::toYaml());\n addYamlField(n, \"class\", toYaml(*class_));\n addYamlField(n, \"dockerPull\", toYaml(*dockerPull));\n addYamlField(n, \"dockerLoad\", toYaml(*dockerLoad));\n addYamlField(n, \"dockerFile\", toYaml(*dockerFile));\n addYamlField(n, \"dockerImport\", toYaml(*dockerImport));\n addYamlField(n, \"dockerImageId\", toYaml(*dockerImageId));\n addYamlField(n, \"dockerOutputDirectory\", toYaml(*dockerOutputDirectory));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::DockerRequirement::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml(n);\n fromYaml(n[\"class\"], *class_);\n fromYaml(n[\"dockerPull\"], *dockerPull);\n fromYaml(n[\"dockerLoad\"], *dockerLoad);\n fromYaml(n[\"dockerFile\"], *dockerFile);\n fromYaml(n[\"dockerImport\"], *dockerImport);\n fromYaml(n[\"dockerImageId\"], *dockerImageId);\n fromYaml(n[\"dockerOutputDirectory\"], *dockerOutputDirectory);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::DockerRequirement> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::DockerRequirement> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::DockerRequirement{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.dockerPull)::value_t>::value) try {\n fromYaml(n[\"dockerPull\"], *res.dockerPull);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.dockerLoad)::value_t>::value) try {\n fromYaml(n[\"dockerLoad\"], *res.dockerLoad);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.dockerFile)::value_t>::value) try {\n fromYaml(n[\"dockerFile\"], *res.dockerFile);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.dockerImport)::value_t>::value) try {\n fromYaml(n[\"dockerImport\"], *res.dockerImport);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.dockerImageId)::value_t>::value) try {\n fromYaml(n[\"dockerImageId\"], *res.dockerImageId);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.dockerOutputDirectory)::value_t>::value) try {\n fromYaml(n[\"dockerOutputDirectory\"], *res.dockerOutputDirectory);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::SoftwareRequirement::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::ProcessRequirement::toYaml());\n addYamlField(n, \"class\", toYaml(*class_));\n addYamlField(n, \"packages\",\n convertListToMap(toYaml(*packages), \"package\"));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::SoftwareRequirement::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml(n);\n fromYaml(n[\"class\"], *class_);\n\n fromYaml(convertMapToList(n[\"packages\"],\n\"package\"), *packages);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::SoftwareRequirement> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::SoftwareRequirement> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::SoftwareRequirement{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.packages)::value_t>::value) try {\n fromYaml(n[\"packages\"], *res.packages);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::SoftwarePackage::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"package\", toYaml(*package));\n addYamlField(n, \"version\", toYaml(*version));\n addYamlField(n, \"specs\", toYaml(*specs));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::SoftwarePackage::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"package\"], *package);\n fromYaml(n[\"version\"], *version);\n fromYaml(n[\"specs\"], *specs);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::SoftwarePackage> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::SoftwarePackage> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::SoftwarePackage{};\n\n if constexpr (IsConstant<decltype(res.package)::value_t>::value) try {\n fromYaml(n[\"package\"], *res.package);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.version)::value_t>::value) try {\n fromYaml(n[\"version\"], *res.version);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.specs)::value_t>::value) try {\n fromYaml(n[\"specs\"], *res.specs);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::Dirent::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"entryname\", toYaml(*entryname));\n addYamlField(n, \"entry\", toYaml(*entry));\n addYamlField(n, \"writable\", toYaml(*writable));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::Dirent::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"entryname\"], *entryname);\n fromYaml(n[\"entry\"], *entry);\n fromYaml(n[\"writable\"], *writable);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::Dirent> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::Dirent> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::Dirent{};\n\n if constexpr (IsConstant<decltype(res.entryname)::value_t>::value) try {\n fromYaml(n[\"entryname\"], *res.entryname);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.entry)::value_t>::value) try {\n fromYaml(n[\"entry\"], *res.entry);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.writable)::value_t>::value) try {\n fromYaml(n[\"writable\"], *res.writable);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::InitialWorkDirRequirement::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::ProcessRequirement::toYaml());\n addYamlField(n, \"class\", toYaml(*class_));\n addYamlField(n, \"listing\", toYaml(*listing));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::InitialWorkDirRequirement::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml(n);\n fromYaml(n[\"class\"], *class_);\n fromYaml(n[\"listing\"], *listing);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::InitialWorkDirRequirement> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::InitialWorkDirRequirement> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::InitialWorkDirRequirement{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.listing)::value_t>::value) try {\n fromYaml(n[\"listing\"], *res.listing);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::EnvVarRequirement::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::ProcessRequirement::toYaml());\n addYamlField(n, \"class\", toYaml(*class_));\n addYamlField(n, \"envDef\",\n convertListToMap(toYaml(*envDef), \"envName\"));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::EnvVarRequirement::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml(n);\n fromYaml(n[\"class\"], *class_);\n\n fromYaml(convertMapToList(n[\"envDef\"],\n\"envName\"), *envDef);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::EnvVarRequirement> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::EnvVarRequirement> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::EnvVarRequirement{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.envDef)::value_t>::value) try {\n fromYaml(n[\"envDef\"], *res.envDef);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::ShellCommandRequirement::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::ProcessRequirement::toYaml());\n addYamlField(n, \"class\", toYaml(*class_));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::ShellCommandRequirement::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml(n);\n fromYaml(n[\"class\"], *class_);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::ShellCommandRequirement> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::ShellCommandRequirement> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::ShellCommandRequirement{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::ResourceRequirement::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::ProcessRequirement::toYaml());\n addYamlField(n, \"class\", toYaml(*class_));\n addYamlField(n, \"coresMin\", toYaml(*coresMin));\n addYamlField(n, \"coresMax\", toYaml(*coresMax));\n addYamlField(n, \"ramMin\", toYaml(*ramMin));\n addYamlField(n, \"ramMax\", toYaml(*ramMax));\n addYamlField(n, \"tmpdirMin\", toYaml(*tmpdirMin));\n addYamlField(n, \"tmpdirMax\", toYaml(*tmpdirMax));\n addYamlField(n, \"outdirMin\", toYaml(*outdirMin));\n addYamlField(n, \"outdirMax\", toYaml(*outdirMax));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::ResourceRequirement::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml(n);\n fromYaml(n[\"class\"], *class_);\n fromYaml(n[\"coresMin\"], *coresMin);\n fromYaml(n[\"coresMax\"], *coresMax);\n fromYaml(n[\"ramMin\"], *ramMin);\n fromYaml(n[\"ramMax\"], *ramMax);\n fromYaml(n[\"tmpdirMin\"], *tmpdirMin);\n fromYaml(n[\"tmpdirMax\"], *tmpdirMax);\n fromYaml(n[\"outdirMin\"], *outdirMin);\n fromYaml(n[\"outdirMax\"], *outdirMax);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::ResourceRequirement> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::ResourceRequirement> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::ResourceRequirement{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.coresMin)::value_t>::value) try {\n fromYaml(n[\"coresMin\"], *res.coresMin);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.coresMax)::value_t>::value) try {\n fromYaml(n[\"coresMax\"], *res.coresMax);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.ramMin)::value_t>::value) try {\n fromYaml(n[\"ramMin\"], *res.ramMin);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.ramMax)::value_t>::value) try {\n fromYaml(n[\"ramMax\"], *res.ramMax);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.tmpdirMin)::value_t>::value) try {\n fromYaml(n[\"tmpdirMin\"], *res.tmpdirMin);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.tmpdirMax)::value_t>::value) try {\n fromYaml(n[\"tmpdirMax\"], *res.tmpdirMax);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.outdirMin)::value_t>::value) try {\n fromYaml(n[\"outdirMin\"], *res.outdirMin);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.outdirMax)::value_t>::value) try {\n fromYaml(n[\"outdirMax\"], *res.outdirMax);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::WorkReuse::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::ProcessRequirement::toYaml());\n addYamlField(n, \"class\", toYaml(*class_));\n addYamlField(n, \"enableReuse\", toYaml(*enableReuse));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::WorkReuse::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml(n);\n fromYaml(n[\"class\"], *class_);\n fromYaml(n[\"enableReuse\"], *enableReuse);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::WorkReuse> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::WorkReuse> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::WorkReuse{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.enableReuse)::value_t>::value) try {\n fromYaml(n[\"enableReuse\"], *res.enableReuse);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::NetworkAccess::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::ProcessRequirement::toYaml());\n addYamlField(n, \"class\", toYaml(*class_));\n addYamlField(n, \"networkAccess\", toYaml(*networkAccess));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::NetworkAccess::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml(n);\n fromYaml(n[\"class\"], *class_);\n fromYaml(n[\"networkAccess\"], *networkAccess);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::NetworkAccess> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::NetworkAccess> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::NetworkAccess{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.networkAccess)::value_t>::value) try {\n fromYaml(n[\"networkAccess\"], *res.networkAccess);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::InplaceUpdateRequirement::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::ProcessRequirement::toYaml());\n addYamlField(n, \"class\", toYaml(*class_));\n addYamlField(n, \"inplaceUpdate\", toYaml(*inplaceUpdate));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::InplaceUpdateRequirement::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml(n);\n fromYaml(n[\"class\"], *class_);\n fromYaml(n[\"inplaceUpdate\"], *inplaceUpdate);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::InplaceUpdateRequirement> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::InplaceUpdateRequirement> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::InplaceUpdateRequirement{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.inplaceUpdate)::value_t>::value) try {\n fromYaml(n[\"inplaceUpdate\"], *res.inplaceUpdate);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::ToolTimeLimit::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::ProcessRequirement::toYaml());\n addYamlField(n, \"class\", toYaml(*class_));\n addYamlField(n, \"timelimit\", toYaml(*timelimit));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::ToolTimeLimit::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml(n);\n fromYaml(n[\"class\"], *class_);\n fromYaml(n[\"timelimit\"], *timelimit);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::ToolTimeLimit> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::ToolTimeLimit> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::ToolTimeLimit{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.timelimit)::value_t>::value) try {\n fromYaml(n[\"timelimit\"], *res.timelimit);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::ExpressionToolOutputParameter::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::OutputParameter::toYaml());\n addYamlField(n, \"type\", toYaml(*type));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::ExpressionToolOutputParameter::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::OutputParameter::fromYaml(n);\n fromYaml(n[\"type\"], *type);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::ExpressionToolOutputParameter> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::ExpressionToolOutputParameter> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::ExpressionToolOutputParameter{};\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::WorkflowInputParameter::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::InputParameter::toYaml());\n addYamlField(n, \"type\", toYaml(*type));\n addYamlField(n, \"inputBinding\", toYaml(*inputBinding));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::WorkflowInputParameter::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::InputParameter::fromYaml(n);\n fromYaml(n[\"type\"], *type);\n fromYaml(n[\"inputBinding\"], *inputBinding);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::WorkflowInputParameter> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::WorkflowInputParameter> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::WorkflowInputParameter{};\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.inputBinding)::value_t>::value) try {\n fromYaml(n[\"inputBinding\"], *res.inputBinding);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::ExpressionTool::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"id\", toYaml(*id));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"doc\", toYaml(*doc));\n addYamlField(n, \"inputs\",\n convertListToMap(toYaml(*inputs), \"id\"));\n addYamlField(n, \"outputs\",\n convertListToMap(toYaml(*outputs), \"id\"));\n addYamlField(n, \"requirements\",\n convertListToMap(toYaml(*requirements), \"class\"));\n addYamlField(n, \"hints\",\n convertListToMap(toYaml(*hints), \"class\"));\n addYamlField(n, \"cwlVersion\", toYaml(*cwlVersion));\n addYamlField(n, \"intent\", toYaml(*intent));\n addYamlField(n, \"class\", toYaml(*class_));\n addYamlField(n, \"expression\", toYaml(*expression));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::ExpressionTool::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"id\"], *id);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"doc\"], *doc);\n\n fromYaml(convertMapToList(n[\"inputs\"],\n\"id\"), *inputs);\n\n fromYaml(convertMapToList(n[\"outputs\"],\n\"id\"), *outputs);\n\n fromYaml(convertMapToList(n[\"requirements\"],\n\"class\"), *requirements);\n\n fromYaml(convertMapToList(n[\"hints\"],\n\"class\"), *hints);\n fromYaml(n[\"cwlVersion\"], *cwlVersion);\n fromYaml(n[\"intent\"], *intent);\n fromYaml(n[\"class\"], *class_);\n fromYaml(n[\"expression\"], *expression);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::ExpressionTool> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::ExpressionTool> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::ExpressionTool{};\n\n if constexpr (IsConstant<decltype(res.id)::value_t>::value) try {\n fromYaml(n[\"id\"], *res.id);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.inputs)::value_t>::value) try {\n fromYaml(n[\"inputs\"], *res.inputs);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.outputs)::value_t>::value) try {\n fromYaml(n[\"outputs\"], *res.outputs);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.requirements)::value_t>::value) try {\n fromYaml(n[\"requirements\"], *res.requirements);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.hints)::value_t>::value) try {\n fromYaml(n[\"hints\"], *res.hints);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.cwlVersion)::value_t>::value) try {\n fromYaml(n[\"cwlVersion\"], *res.cwlVersion);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.intent)::value_t>::value) try {\n fromYaml(n[\"intent\"], *res.intent);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.expression)::value_t>::value) try {\n fromYaml(n[\"expression\"], *res.expression);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::WorkflowOutputParameter::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::OutputParameter::toYaml());\n addYamlField(n, \"outputSource\", toYaml(*outputSource));\n addYamlField(n, \"linkMerge\", toYaml(*linkMerge));\n addYamlField(n, \"pickValue\", toYaml(*pickValue));\n addYamlField(n, \"type\", toYaml(*type));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::WorkflowOutputParameter::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::OutputParameter::fromYaml(n);\n fromYaml(n[\"outputSource\"], *outputSource);\n fromYaml(n[\"linkMerge\"], *linkMerge);\n fromYaml(n[\"pickValue\"], *pickValue);\n fromYaml(n[\"type\"], *type);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::WorkflowOutputParameter> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::WorkflowOutputParameter> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::WorkflowOutputParameter{};\n\n if constexpr (IsConstant<decltype(res.outputSource)::value_t>::value) try {\n fromYaml(n[\"outputSource\"], *res.outputSource);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.linkMerge)::value_t>::value) try {\n fromYaml(n[\"linkMerge\"], *res.linkMerge);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.pickValue)::value_t>::value) try {\n fromYaml(n[\"pickValue\"], *res.pickValue);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline https___w3id_org_cwl_cwl::Sink::~Sink() = default;\ninline auto https___w3id_org_cwl_cwl::Sink::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"source\", toYaml(*source));\n addYamlField(n, \"linkMerge\", toYaml(*linkMerge));\n addYamlField(n, \"pickValue\", toYaml(*pickValue));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::Sink::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"source\"], *source);\n fromYaml(n[\"linkMerge\"], *linkMerge);\n fromYaml(n[\"pickValue\"], *pickValue);\n}\ninline auto https___w3id_org_cwl_cwl::WorkflowStepInput::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::Identified::toYaml());\n n = mergeYaml(n, https___w3id_org_cwl_cwl::Sink::toYaml());\n n = mergeYaml(n, https___w3id_org_cwl_cwl::LoadContents::toYaml());\n n = mergeYaml(n, https___w3id_org_cwl_cwl::Labeled::toYaml());\n addYamlField(n, \"default\", toYaml(*default_));\n addYamlField(n, \"valueFrom\", toYaml(*valueFrom));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::WorkflowStepInput::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::Identified::fromYaml(n);\n https___w3id_org_cwl_cwl::Sink::fromYaml(n);\n https___w3id_org_cwl_cwl::LoadContents::fromYaml(n);\n https___w3id_org_cwl_cwl::Labeled::fromYaml(n);\n fromYaml(n[\"default\"], *default_);\n fromYaml(n[\"valueFrom\"], *valueFrom);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::WorkflowStepInput> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::WorkflowStepInput> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::WorkflowStepInput{};\n\n if constexpr (IsConstant<decltype(res.default_)::value_t>::value) try {\n fromYaml(n[\"default\"], *res.default_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.valueFrom)::value_t>::value) try {\n fromYaml(n[\"valueFrom\"], *res.valueFrom);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::WorkflowStepOutput::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::Identified::toYaml());\n return n;\n}\ninline void https___w3id_org_cwl_cwl::WorkflowStepOutput::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::Identified::fromYaml(n);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::WorkflowStepOutput> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::WorkflowStepOutput> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::WorkflowStepOutput{};\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::WorkflowStep::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::Identified::toYaml());\n n = mergeYaml(n, https___w3id_org_cwl_cwl::Labeled::toYaml());\n n = mergeYaml(n, https___w3id_org_cwl_salad::Documented::toYaml());\n addYamlField(n, \"in\",\n convertListToMap(toYaml(*in), \"id\"));\n addYamlField(n, \"out\", toYaml(*out));\n addYamlField(n, \"requirements\",\n convertListToMap(toYaml(*requirements), \"class\"));\n addYamlField(n, \"hints\",\n convertListToMap(toYaml(*hints), \"class\"));\n addYamlField(n, \"run\", toYaml(*run));\n addYamlField(n, \"when\", toYaml(*when));\n addYamlField(n, \"scatter\", toYaml(*scatter));\n addYamlField(n, \"scatterMethod\", toYaml(*scatterMethod));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::WorkflowStep::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::Identified::fromYaml(n);\n https___w3id_org_cwl_cwl::Labeled::fromYaml(n);\n https___w3id_org_cwl_salad::Documented::fromYaml(n);\n\n fromYaml(convertMapToList(n[\"in\"],\n\"id\"), *in);\n fromYaml(n[\"out\"], *out);\n\n fromYaml(convertMapToList(n[\"requirements\"],\n\"class\"), *requirements);\n\n fromYaml(convertMapToList(n[\"hints\"],\n\"class\"), *hints);\n fromYaml(n[\"run\"], *run);\n fromYaml(n[\"when\"], *when);\n fromYaml(n[\"scatter\"], *scatter);\n fromYaml(n[\"scatterMethod\"], *scatterMethod);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::WorkflowStep> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::WorkflowStep> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::WorkflowStep{};\n\n if constexpr (IsConstant<decltype(res.in)::value_t>::value) try {\n fromYaml(n[\"in\"], *res.in);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.out)::value_t>::value) try {\n fromYaml(n[\"out\"], *res.out);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.requirements)::value_t>::value) try {\n fromYaml(n[\"requirements\"], *res.requirements);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.hints)::value_t>::value) try {\n fromYaml(n[\"hints\"], *res.hints);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.run)::value_t>::value) try {\n fromYaml(n[\"run\"], *res.run);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.when)::value_t>::value) try {\n fromYaml(n[\"when\"], *res.when);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.scatter)::value_t>::value) try {\n fromYaml(n[\"scatter\"], *res.scatter);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.scatterMethod)::value_t>::value) try {\n fromYaml(n[\"scatterMethod\"], *res.scatterMethod);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::Workflow::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"id\", toYaml(*id));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"doc\", toYaml(*doc));\n addYamlField(n, \"inputs\",\n convertListToMap(toYaml(*inputs), \"id\"));\n addYamlField(n, \"outputs\",\n convertListToMap(toYaml(*outputs), \"id\"));\n addYamlField(n, \"requirements\",\n convertListToMap(toYaml(*requirements), \"class\"));\n addYamlField(n, \"hints\",\n convertListToMap(toYaml(*hints), \"class\"));\n addYamlField(n, \"cwlVersion\", toYaml(*cwlVersion));\n addYamlField(n, \"intent\", toYaml(*intent));\n addYamlField(n, \"class\", toYaml(*class_));\n addYamlField(n, \"steps\",\n convertListToMap(toYaml(*steps), \"id\"));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::Workflow::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"id\"], *id);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"doc\"], *doc);\n\n fromYaml(convertMapToList(n[\"inputs\"],\n\"id\"), *inputs);\n\n fromYaml(convertMapToList(n[\"outputs\"],\n\"id\"), *outputs);\n\n fromYaml(convertMapToList(n[\"requirements\"],\n\"class\"), *requirements);\n\n fromYaml(convertMapToList(n[\"hints\"],\n\"class\"), *hints);\n fromYaml(n[\"cwlVersion\"], *cwlVersion);\n fromYaml(n[\"intent\"], *intent);\n fromYaml(n[\"class\"], *class_);\n\n fromYaml(convertMapToList(n[\"steps\"],\n\"id\"), *steps);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::Workflow> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::Workflow> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::Workflow{};\n\n if constexpr (IsConstant<decltype(res.id)::value_t>::value) try {\n fromYaml(n[\"id\"], *res.id);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.inputs)::value_t>::value) try {\n fromYaml(n[\"inputs\"], *res.inputs);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.outputs)::value_t>::value) try {\n fromYaml(n[\"outputs\"], *res.outputs);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.requirements)::value_t>::value) try {\n fromYaml(n[\"requirements\"], *res.requirements);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.hints)::value_t>::value) try {\n fromYaml(n[\"hints\"], *res.hints);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.cwlVersion)::value_t>::value) try {\n fromYaml(n[\"cwlVersion\"], *res.cwlVersion);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.intent)::value_t>::value) try {\n fromYaml(n[\"intent\"], *res.intent);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.steps)::value_t>::value) try {\n fromYaml(n[\"steps\"], *res.steps);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::SubworkflowFeatureRequirement::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::ProcessRequirement::toYaml());\n addYamlField(n, \"class\", toYaml(*class_));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::SubworkflowFeatureRequirement::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml(n);\n fromYaml(n[\"class\"], *class_);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::SubworkflowFeatureRequirement> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::SubworkflowFeatureRequirement> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::SubworkflowFeatureRequirement{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::ScatterFeatureRequirement::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::ProcessRequirement::toYaml());\n addYamlField(n, \"class\", toYaml(*class_));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::ScatterFeatureRequirement::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml(n);\n fromYaml(n[\"class\"], *class_);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::ScatterFeatureRequirement> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::ScatterFeatureRequirement> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::ScatterFeatureRequirement{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::MultipleInputFeatureRequirement::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::ProcessRequirement::toYaml());\n addYamlField(n, \"class\", toYaml(*class_));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::MultipleInputFeatureRequirement::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml(n);\n fromYaml(n[\"class\"], *class_);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::MultipleInputFeatureRequirement> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::MultipleInputFeatureRequirement> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::MultipleInputFeatureRequirement{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::StepInputExpressionRequirement::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::ProcessRequirement::toYaml());\n addYamlField(n, \"class\", toYaml(*class_));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::StepInputExpressionRequirement::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::ProcessRequirement::fromYaml(n);\n fromYaml(n[\"class\"], *class_);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::StepInputExpressionRequirement> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::StepInputExpressionRequirement> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::StepInputExpressionRequirement{};\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::OperationInputParameter::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::InputParameter::toYaml());\n addYamlField(n, \"type\", toYaml(*type));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::OperationInputParameter::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::InputParameter::fromYaml(n);\n fromYaml(n[\"type\"], *type);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::OperationInputParameter> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::OperationInputParameter> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::OperationInputParameter{};\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::OperationOutputParameter::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n n = mergeYaml(n, https___w3id_org_cwl_cwl::OutputParameter::toYaml());\n addYamlField(n, \"type\", toYaml(*type));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::OperationOutputParameter::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n https___w3id_org_cwl_cwl::OutputParameter::fromYaml(n);\n fromYaml(n[\"type\"], *type);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::OperationOutputParameter> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::OperationOutputParameter> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::OperationOutputParameter{};\n\n if constexpr (IsConstant<decltype(res.type)::value_t>::value) try {\n fromYaml(n[\"type\"], *res.type);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\ninline auto https___w3id_org_cwl_cwl::Operation::toYaml() const -> YAML::Node {\n using ::toYaml;\n auto n = YAML::Node{};\n addYamlField(n, \"id\", toYaml(*id));\n addYamlField(n, \"label\", toYaml(*label));\n addYamlField(n, \"doc\", toYaml(*doc));\n addYamlField(n, \"inputs\",\n convertListToMap(toYaml(*inputs), \"id\"));\n addYamlField(n, \"outputs\",\n convertListToMap(toYaml(*outputs), \"id\"));\n addYamlField(n, \"requirements\",\n convertListToMap(toYaml(*requirements), \"class\"));\n addYamlField(n, \"hints\",\n convertListToMap(toYaml(*hints), \"class\"));\n addYamlField(n, \"cwlVersion\", toYaml(*cwlVersion));\n addYamlField(n, \"intent\", toYaml(*intent));\n addYamlField(n, \"class\", toYaml(*class_));\n return n;\n}\ninline void https___w3id_org_cwl_cwl::Operation::fromYaml([[maybe_unused]] YAML::Node const& n) {\n using ::fromYaml;\n fromYaml(n[\"id\"], *id);\n fromYaml(n[\"label\"], *label);\n fromYaml(n[\"doc\"], *doc);\n\n fromYaml(convertMapToList(n[\"inputs\"],\n\"id\"), *inputs);\n\n fromYaml(convertMapToList(n[\"outputs\"],\n\"id\"), *outputs);\n\n fromYaml(convertMapToList(n[\"requirements\"],\n\"class\"), *requirements);\n\n fromYaml(convertMapToList(n[\"hints\"],\n\"class\"), *hints);\n fromYaml(n[\"cwlVersion\"], *cwlVersion);\n fromYaml(n[\"intent\"], *intent);\n fromYaml(n[\"class\"], *class_);\n}\n\ntemplate <>\nstruct DetectAndExtractFromYaml<https___w3id_org_cwl_cwl::Operation> {\n auto operator()(YAML::Node const& n) const -> std::optional<https___w3id_org_cwl_cwl::Operation> {\n if (!n.IsDefined()) return std::nullopt;\n if (!n.IsMap()) return std::nullopt;\n auto res = https___w3id_org_cwl_cwl::Operation{};\n\n if constexpr (IsConstant<decltype(res.id)::value_t>::value) try {\n fromYaml(n[\"id\"], *res.id);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.label)::value_t>::value) try {\n fromYaml(n[\"label\"], *res.label);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.doc)::value_t>::value) try {\n fromYaml(n[\"doc\"], *res.doc);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.inputs)::value_t>::value) try {\n fromYaml(n[\"inputs\"], *res.inputs);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.outputs)::value_t>::value) try {\n fromYaml(n[\"outputs\"], *res.outputs);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.requirements)::value_t>::value) try {\n fromYaml(n[\"requirements\"], *res.requirements);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.hints)::value_t>::value) try {\n fromYaml(n[\"hints\"], *res.hints);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.cwlVersion)::value_t>::value) try {\n fromYaml(n[\"cwlVersion\"], *res.cwlVersion);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.intent)::value_t>::value) try {\n fromYaml(n[\"intent\"], *res.intent);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n if constexpr (IsConstant<decltype(res.class_)::value_t>::value) try {\n fromYaml(n[\"class\"], *res.class_);\n fromYaml(n, res);\n return res;\n } catch(...) {}\n\n return std::nullopt;\n }\n};\n\ntemplate <typename T>\nauto toYaml(std::vector<T> const& v) -> YAML::Node {\n auto n = YAML::Node(YAML::NodeType::Sequence);\n for (auto const& e : v) {\n n.push_back(toYaml(e));\n }\n return n;\n}\n\ntemplate <typename T>\nauto toYaml(T const& t) -> YAML::Node {\n if constexpr (std::is_enum_v<T>) {\n return toYaml(t);\n } else {\n return t.toYaml();\n }\n}\n\ntemplate <typename ...Args>\nauto toYaml(std::variant<Args...> const& t) -> YAML::Node {\n return std::visit([](auto const& e) {\n return toYaml(e);\n }, t);\n}\n\ntemplate <typename T>\nvoid fromYaml(YAML::Node const& n, std::vector<T>& v){\n if (!n.IsSequence()) return;\n for (auto e : n) {\n v.emplace_back();\n fromYaml(e, v.back());\n }\n}\n\ntemplate <typename T>\nvoid fromYaml(YAML::Node const& n, T& t){\n if constexpr (std::is_enum_v<T>) {\n fromYaml(n, t);\n } else {\n t.fromYaml(n);\n }\n}\n\ntemplate <typename SomeVariant, typename Head, typename ...Args>\nbool detectAndExtractFromYaml(YAML::Node const& n, SomeVariant& v, Head* = nullptr) {\n auto r = DetectAndExtractFromYaml<Head>{}(n);\n if (r) {\n v = *r;\n return true;\n }\n if constexpr (sizeof...(Args) > 0) {\n return detectAndExtractFromYaml<SomeVariant, Args...>(n, v);\n }\n return false;\n}\n\ntemplate <typename SomeVariant, typename Head, typename Tail>\nbool detectAndExtractFromYaml(YAML::Node const& n, std::variant<std::monostate, Tail>& v, Head* = nullptr) {\n auto r = DetectAndExtractFromYaml<Head>{}(n);\n if (r) {\n v = *r;\n return true;\n }\n auto t = Tail{};\n fromYaml(n, t);\n v = t;\n return true;\n}\n\ntemplate <typename ...Args>\nvoid fromYaml(YAML::Node const& n, std::variant<Args...>& v){\n bool found = detectAndExtractFromYaml<std::variant<Args...>, Args...>(n, v);\n if (!found) throw std::runtime_error{\"didn't find any overload\"};\n}\n"},"language":{"kind":"string","value":"Unknown"}}},{"rowIdx":9351,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/INTERFACES_IMPL/MockImplementation.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":4168,"string":"4,168"},"line_count":{"kind":"number","value":132,"string":"132"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Hannes Roest $\n// $Authors: Hannes Roest $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/INTERFACES/DataStructures.h>\n#include <OpenMS/INTERFACES/ISpectrumAccess.h>\n\nnamespace OpenMS::Interfaces\n{\n\n class OPENMS_DLLAPI MockISpectraReader :\n public ISpectraReader\n {\npublic:\n MockISpectraReader() = default;\n ~MockISpectraReader() override = default;\n /// Return a pointer to a spectrum at the given id\n SpectrumPtr getSpectrumById(int /* id */) const override\n {\n SpectrumPtr spectrum(new Spectrum);\n return spectrum;\n }\n /// Return a pointer to a spectrum at the given string id\n SpectrumPtr getSpectrumById(const std::string& /* id */) const override\n {\n SpectrumPtr spectrum(new Spectrum);\n return spectrum;\n }\n /// Return a vector of ids of spectra that are within RT +/- deltaRT\n std::vector<std::size_t> getSpectraByRT(double /* RT */, double /* deltaRT */) const override\n {\n return std::vector<std::size_t>();\n }\n /// Returns the number of spectra available\n size_t getNrSpectra() const override\n {\n return 0;\n }\n /// Returns the meta information for a spectrum\n SpectrumMetaPtr getSpectrumMetaById(int /* id */) const override\n {\n SpectrumMetaPtr spectrum_meta(new SpectrumMeta);\n return spectrum_meta;\n }\n };\n // create an instance of the mock object to test\n MockISpectraReader test_mock_spectra_reader;\n\n class OPENMS_DLLAPI MockIChromatogramsReader :\n public IChromatogramsReader\n {\npublic:\n MockIChromatogramsReader() = default;\n ~MockIChromatogramsReader() override = default;\n /// Return a pointer to a chromatogram at the given id\n ChromatogramPtr getChromatogramById(int /* id */) const override\n {\n ChromatogramPtr chromatogram(new Chromatogram);\n return chromatogram;\n }\n /// Return a pointer to a chromatogram at the given string id\n ChromatogramPtr getChromatogramById(const std::string& /* id */) const override\n {\n ChromatogramPtr chromatogram(new Chromatogram);\n return chromatogram;\n }\n /// Return a vector of ids of spectra that are within RT +/- deltaRT\n std::vector<std::size_t> getChromatogramByPrecursorMZ(double /* mz */, double /* deltaMZ */) const override\n {\n return std::vector<std::size_t>();\n }\n /// Returns the number of spectra available\n size_t getNrChromatograms() const override\n {\n return 0;\n }\n /// Returns the meta information for a chromatogram\n ChromatogramMetaPtr getChromatogramMetaById(int /* id */) const override\n {\n ChromatogramMetaPtr chromatogram_meta(new ChromatogramMeta);\n return chromatogram_meta;\n }\n };\n // create an instance of the mock object to test\n MockIChromatogramsReader test_mock_chromatograms_reader;\n\n class OPENMS_DLLAPI MockISpectraWriter :\n public ISpectraWriter\n {\npublic:\n MockISpectraWriter() = default;\n ~MockISpectraWriter() override = default;\n /// Append a spectrum to the end\n void appendSpectrum(SpectrumPtr /* spectrum */, bool /* write_through*/) override\n {\n // do nothing\n }\n /// write all cached data to disk\n void flush() override\n {\n // do nothing\n }\n };\n // create an instance of the mock object to test\n MockISpectraWriter test_mock_specrta_writer;\n\n class OPENMS_DLLAPI MockIChromatogramsWriter :\n public IChromatogramsWriter\n {\npublic:\n MockIChromatogramsWriter() = default;\n ~MockIChromatogramsWriter() override = default;\n /// Append a chromatogram to the end\n void appendChromatogram(ChromatogramPtr /* chromatogram */, bool /* write_through */) override\n {\n // do nothing\n }\n /// write all cached data to disk\n void flush() override\n {\n // do nothing\n }\n };\n // create an instance of the mock object to test\n MockIChromatogramsWriter test_mock_chromatograms_writer;\n\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9352,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/ConsensusFeature.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":11984,"string":"11,984"},"line_count":{"kind":"number","value":419,"string":"419"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg $\n// $Authors: $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/ConsensusFeature.h>\n\n#include <OpenMS/CONCEPT/Constants.h>\n#include <OpenMS/CONCEPT/LogStream.h>\n#include <OpenMS/KERNEL/FeatureMap.h>\n#include <OpenMS/METADATA/ProteinIdentification.h>\n#include <OpenMS/METADATA/PeptideIdentification.h>\n\nnamespace OpenMS\n{\n ConsensusFeature::ConsensusFeature() :\n BaseFeature(), handles_(), ratios_()\n {\n }\n\n ConsensusFeature::ConsensusFeature(const BaseFeature& feature) :\n BaseFeature(feature), handles_(), ratios_()\n {\n }\n\n ConsensusFeature::ConsensusFeature(UInt64 map_index, const Peak2D& element, UInt64 element_index) :\n BaseFeature(element), handles_(), ratios_()\n {\n insert(map_index, element, element_index);\n }\n\n ConsensusFeature::ConsensusFeature(UInt64 map_index, const BaseFeature& element) :\n BaseFeature(element, map_index), handles_(), ratios_()\n {\n insert(FeatureHandle(map_index, element));\n }\n\n ConsensusFeature::~ConsensusFeature() = default;\n\n void ConsensusFeature::insert(const ConsensusFeature& cf)\n {\n handles_.insert(cf.handles_.begin(), cf.handles_.end());\n peptides_.insert(peptides_.end(), cf.getPeptideIdentifications().begin(), cf.getPeptideIdentifications().end());\n }\n\n void ConsensusFeature::insert(ConsensusFeature&& cf)\n {\n handles_.insert(make_move_iterator(cf.handles_.begin()), make_move_iterator(cf.handles_.end()));\n peptides_.insert(peptides_.end(), make_move_iterator(cf.getPeptideIdentifications().begin()), make_move_iterator(cf.getPeptideIdentifications().end()));\n }\n\n void ConsensusFeature::insert(const FeatureHandle& handle)\n {\n if (!(handles_.insert(handle).second))\n {\n String key = String(\"map\") + handle.getMapIndex() + \"/feature\" + handle.getUniqueId();\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"The set already contained an element with this key.\", key);\n }\n }\n\n void ConsensusFeature::insert(FeatureHandle&& handle)\n {\n if (!(handles_.insert(std::move(handle)).second))\n {\n String key = String(\"map\") + handle.getMapIndex() + \"/feature\" + handle.getUniqueId();\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"The set already contained an element with this key.\", key);\n }\n }\n\n void ConsensusFeature::insert(const HandleSetType& handle_set)\n {\n for (auto& handle : handle_set)\n {\n insert(handle);\n }\n }\n\n void ConsensusFeature::insert(HandleSetType&& handle_set)\n {\n for (auto& handle : handle_set)\n {\n insert(std::move(handle));\n }\n }\n\n void ConsensusFeature::insert(UInt64 map_index, const Peak2D& element, UInt64 element_index)\n {\n insert(FeatureHandle(map_index, element, element_index));\n }\n\n void ConsensusFeature::insert(UInt64 map_index, const BaseFeature& element)\n {\n insert(FeatureHandle(map_index, element));\n // annotate map index to peptide identification\n PeptideIdentificationList ids(element.getPeptideIdentifications());\n for (PeptideIdentification& it : ids)\n {\n it.setMetaValue(\"map_index\", map_index);\n }\n peptides_.insert(peptides_.end(), ids.begin(), ids.end());\n }\n\n void ConsensusFeature::setFeatures(HandleSetType h)\n {\n handles_ = std::move(h);\n }\n\n const ConsensusFeature::HandleSetType& ConsensusFeature::getFeatures() const\n {\n return handles_;\n }\n\n std::vector<FeatureHandle> ConsensusFeature::getFeatureList() const\n {\n std::vector<FeatureHandle> tmp;\n for (ConsensusFeature::HandleSetType::const_iterator it = handles_.begin(); it != handles_.end(); ++it)\n {\n tmp.push_back(*it);\n }\n return tmp;\n }\n\n DRange<2> ConsensusFeature::getPositionRange() const\n {\n DPosition<2> min = DPosition<2>::maxPositive();\n DPosition<2> max = DPosition<2>::minPositive();\n for (ConsensusFeature::HandleSetType::const_iterator it = handles_.begin(); it != handles_.end(); ++it)\n {\n if (it->getRT() < min[0])\n {\n min[0] = it->getRT();\n }\n if (it->getRT() > max[0])\n {\n max[0] = it->getRT();\n }\n if (it->getMZ() < min[1])\n {\n min[1] = it->getMZ();\n }\n if (it->getMZ() > max[1])\n {\n max[1] = it->getMZ();\n }\n }\n return DRange<2>(min, max);\n }\n\n DRange<1> ConsensusFeature::getIntensityRange() const\n {\n DPosition<1> min = DPosition<1>::maxPositive();\n DPosition<1> max = DPosition<1>::minPositive();\n for (ConsensusFeature::HandleSetType::const_iterator it = handles_.begin(); it != handles_.end(); ++it)\n {\n if (it->getIntensity() < min[0])\n {\n min[0] = it->getIntensity();\n }\n if (it->getIntensity() > max[0])\n {\n max[0] = it->getIntensity();\n }\n }\n return DRange<1>(min, max);\n }\n\n void ConsensusFeature::computeConsensus()\n {\n // for computing average position and intensity\n double rt = 0.0;\n double mz = 0.0;\n double intensity = 0.0;\n\n // The most frequent charge state wins. Tie breaking prefers smaller charge.\n std::map<Int, UInt> charge_occ;\n Int charge_most_frequent = 0;\n UInt charge_most_frequent_occ = 0;\n\n for (ConsensusFeature::HandleSetType::const_iterator it = handles_.begin(); it != handles_.end(); ++it)\n {\n rt += it->getRT();\n mz += it->getMZ();\n intensity += it->getIntensity();\n const Int it_charge = it->getCharge();\n const UInt it_charge_occ = ++charge_occ[it_charge];\n if (it_charge_occ > charge_most_frequent_occ)\n {\n charge_most_frequent_occ = it_charge_occ;\n charge_most_frequent = it_charge;\n }\n else\n {\n if (it_charge_occ >= charge_most_frequent_occ && abs(it_charge) < abs(charge_most_frequent))\n {\n charge_most_frequent = it_charge;\n }\n }\n }\n\n // compute the average position and intensity\n setRT(rt / size());\n setMZ(mz / size());\n setIntensity(intensity / size());\n setCharge(charge_most_frequent);\n return;\n }\n\n void ConsensusFeature::computeMonoisotopicConsensus()\n {\n // for computing average rt position, minimal m/z position and intensity\n double rt = 0.0;\n double mz = std::numeric_limits<double>::max();\n double intensity = 0.0;\n\n // The most frequent charge state wins. Tie breaking prefers smaller charge.\n std::map<Int, UInt> charge_occ;\n Int charge_most_frequent = 0;\n UInt charge_most_frequent_occ = 0;\n\n for (ConsensusFeature::HandleSetType::const_iterator it = handles_.begin(); it != handles_.end(); ++it)\n {\n rt += it->getRT();\n if (it->getMZ() < mz)\n {\n mz = it->getMZ();\n }\n intensity += it->getIntensity();\n const Int it_charge = it->getCharge();\n const UInt it_charge_occ = ++charge_occ[it_charge];\n if (it_charge_occ > charge_most_frequent_occ)\n {\n charge_most_frequent_occ = it_charge_occ;\n charge_most_frequent = it_charge;\n }\n else\n {\n if (it_charge_occ >= charge_most_frequent_occ && abs(it_charge) < abs(charge_most_frequent))\n {\n charge_most_frequent = it_charge;\n }\n }\n }\n\n // compute the position and intensity\n setRT(rt / size());\n setMZ(mz);\n setIntensity(intensity / size());\n setCharge(charge_most_frequent);\n return;\n }\n\n void ConsensusFeature::computeDechargeConsensus(const FeatureMap& fm, bool intensity_weighted_averaging)\n {\n // for computing average position and intensity\n double rt = 0.0;\n double m = 0.0;\n double intensity = 0.0;\n\n double proton_mass = Constants::PROTON_MASS_U;\n\n // intensity sum (for weighting)\n for (ConsensusFeature::HandleSetType::const_iterator it = handles_.begin(); it != handles_.end(); ++it)\n {\n intensity += it->getIntensity();\n }\n\n // unweighted averaging by default\n // TODO: add outlier removal\n // TODO: split cluster for each channel (in FD.C)\n double weighting_factor = 1.0 / size();\n\n // RT and Mass\n for (ConsensusFeature::HandleSetType::const_iterator it = handles_.begin(); it != handles_.end(); ++it)\n {\n Int q = it->getCharge();\n if (q == 0)\n {\n OPENMS_LOG_WARN << \"ConsensusFeature::computeDechargeConsensus() WARNING: Feature's charge is 0! This will lead to M=0!\\n\";\n }\n double adduct_mass;\n Size index = fm.uniqueIdToIndex(it->getUniqueId());\n if (index > fm.size())\n {\n throw Exception::IndexOverflow(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, index, fm.size());\n }\n if (fm[index].metaValueExists(\"dc_charge_adduct_mass\"))\n {\n adduct_mass = (double) fm[index].getMetaValue(\"dc_charge_adduct_mass\");\n }\n else\n {\n adduct_mass = q * proton_mass;\n }\n\n if (intensity_weighted_averaging)\n {\n weighting_factor = it->getIntensity() / intensity;\n }\n rt += it->getRT() * weighting_factor;\n m += (it->getMZ() * abs(q) - adduct_mass) * weighting_factor;\n }\n\n // compute the average position and intensity\n setRT(rt);\n setMZ(m);\n setIntensity(intensity);\n setCharge(0);\n return;\n }\n\n void ConsensusFeature::addRatio(const ConsensusFeature::Ratio& r)\n {\n ratios_.push_back(r);\n }\n\n void ConsensusFeature::setRatios(std::vector<ConsensusFeature::Ratio>& rs)\n {\n ratios_ = rs;\n }\n\n std::vector<ConsensusFeature::Ratio>& ConsensusFeature::getRatios()\n {\n return ratios_;\n }\n\n const std::vector<ConsensusFeature::Ratio>& ConsensusFeature::getRatios() const\n {\n return ratios_;\n }\n\n Size ConsensusFeature::size() const\n {\n return handles_.size();\n }\n\n ConsensusFeature::const_iterator ConsensusFeature::begin() const\n {\n return handles_.begin();\n }\n\n ConsensusFeature::iterator ConsensusFeature::begin()\n {\n return handles_.begin();\n }\n\n ConsensusFeature::const_iterator ConsensusFeature::end() const\n {\n return handles_.end();\n }\n\n ConsensusFeature::iterator ConsensusFeature::end()\n {\n return handles_.end();\n }\n\n ConsensusFeature::const_reverse_iterator ConsensusFeature::rbegin() const\n {\n return handles_.rbegin();\n }\n\n ConsensusFeature::reverse_iterator ConsensusFeature::rbegin()\n {\n return handles_.rbegin();\n }\n\n ConsensusFeature::const_reverse_iterator ConsensusFeature::rend() const\n {\n return handles_.rend();\n }\n\n ConsensusFeature::reverse_iterator ConsensusFeature::rend()\n {\n return handles_.rend();\n }\n\n void ConsensusFeature::clear()\n {\n handles_.clear();\n }\n\n bool ConsensusFeature::empty() const\n {\n return handles_.empty();\n }\n\n std::ostream& operator<<(std::ostream& os, const ConsensusFeature& cons)\n {\n os << \"---------- CONSENSUS ELEMENT BEGIN -----------------\\n\";\n os << \"Position: \" << cons.getPosition() << '\\n';\n os << \"Intensity \" << precisionWrapper(cons.getIntensity()) << '\\n';\n os << \"Quality \" << precisionWrapper(cons.getQuality()) << '\\n';\n os << \"Grouped features: \\n\";\n\n for (ConsensusFeature::HandleSetType::const_iterator it = cons.begin(); it != cons.end(); ++it)\n {\n os << \" - Map index: \" << it->getMapIndex() << '\\n'\n << \" Feature id: \" << it->getUniqueId() << '\\n'\n << \" RT: \" << precisionWrapper(it->getRT()) << '\\n'\n << \" m/z: \" << precisionWrapper(it->getMZ()) << '\\n'\n << \" Intensity: \" << precisionWrapper(it->getIntensity()) << '\\n';\n }\n\n os << \"Meta information: \\n\";\n std::vector<String> keys;\n cons.getKeys(keys);\n for (const String& it : keys)\n {\n os << \" \" << (it) << \": \" << cons.getMetaValue(it) << '\\n';\n }\n os << \"---------- CONSENSUS ELEMENT END ----------------- \\n\";\n\n return os;\n }\n\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9353,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/ChromatogramPeak.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":632,"string":"632"},"line_count":{"kind":"number","value":20,"string":"20"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg $\n// $Authors: Andreas Bertsch $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/ChromatogramPeak.h>\n#include <OpenMS/KERNEL/MSSpectrum.h>\n\nnamespace OpenMS\n{\n std::ostream & operator<<(std::ostream & os, const ChromatogramPeak & point)\n {\n os << \"POS: \" << point.getRT() << \" INT: \" << point.getIntensity();\n return os;\n }\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9354,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/SpectrumHelper.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":903,"string":"903"},"line_count":{"kind":"number","value":29,"string":"29"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Hannes Roest g$\n// $Authors: Hannes Roest $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/SpectrumHelper.h>\n\nnamespace OpenMS\n{\n\n void copySpectrumMeta(const MSSpectrum & input, MSSpectrum & output, bool clear_spectrum)\n {\n // clear old spectrum first before copying\n if (clear_spectrum) output.clear(true);\n\n // copy the spectrum meta data\n output.SpectrumSettings::operator=(input);\n output.setRT(input.getRT());\n output.setDriftTime(input.getDriftTime());\n output.setDriftTimeUnit(input.getDriftTimeUnit());\n output.setMSLevel(input.getMSLevel());\n output.setName(input.getName());\n }\n}\n\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9355,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/Feature.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":6151,"string":"6,151"},"line_count":{"kind":"number","value":219,"string":"219"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg $\n// $Authors: $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/Feature.h>\n\nusing namespace std;\n\nnamespace OpenMS\n{\n Feature::Feature() :\n BaseFeature(),\n convex_hulls_(),\n convex_hulls_modified_(true),\n convex_hull_(),\n subordinates_()\n {\n std::fill(qualities_, qualities_ + 2, QualityType(0.0));\n }\n\n Feature::Feature(const BaseFeature& base) :\n BaseFeature(base)\n {\n std::fill(qualities_, qualities_ + 2, QualityType(0.0));\n }\n\n Feature::Feature(const Feature& feature) :\n BaseFeature(feature),\n convex_hulls_(feature.convex_hulls_),\n convex_hulls_modified_(feature.convex_hulls_modified_),\n convex_hull_(feature.convex_hull_),\n subordinates_(feature.subordinates_)\n {\n std::copy(feature.qualities_, feature.qualities_ + 2, qualities_);\n }\n\n Feature::Feature(Feature&& feature) noexcept :\n BaseFeature(std::move(feature)),\n convex_hulls_(std::move(feature.convex_hulls_)),\n convex_hulls_modified_(std::move(feature.convex_hulls_modified_)),\n convex_hull_(std::move(feature.convex_hull_)),\n subordinates_(std::move(feature.subordinates_))\n {\n // TODO: no strong exception safety here\n std::copy(feature.qualities_, feature.qualities_ + 2, qualities_);\n }\n\n Feature::~Feature() = default;\n\n Feature::QualityType Feature::getOverallQuality() const\n {\n return quality_;\n }\n\n void Feature::setOverallQuality(Feature::QualityType q)\n {\n quality_ = q;\n }\n\n Feature::QualityType Feature::getQuality(Size index) const\n {\n OPENMS_PRECONDITION(index < 2, \"Feature<2>::getQuality(Size): index overflow!\");\n return qualities_[index];\n }\n\n void Feature::setQuality(Size index, Feature::QualityType q)\n {\n OPENMS_PRECONDITION(index < 2, \"Feature<2>::setQuality(Size): index overflow!\");\n qualities_[index] = q;\n }\n\n const std::vector<ConvexHull2D>& Feature::getConvexHulls() const\n {\n return convex_hulls_;\n }\n\n std::vector<ConvexHull2D>& Feature::getConvexHulls()\n {\n convex_hulls_modified_ = true;\n return convex_hulls_;\n }\n\n void Feature::setConvexHulls(const std::vector<ConvexHull2D>& hulls)\n {\n convex_hulls_modified_ = true;\n convex_hulls_ = hulls;\n }\n\n ConvexHull2D& Feature::getConvexHull() const\n {\n //recalculate convex hull if necessary\n if (convex_hulls_modified_)\n {\n //only one mass trace convex hull => use it as overall convex hull\n if (convex_hulls_.size() == 1)\n {\n convex_hull_ = convex_hulls_[0];\n }\n else\n {\n convex_hull_.clear();\n if (!convex_hulls_.empty())\n {\n /*\n -- this does not work with our current approach of \"non-convex\"hull computation as the mass traces of features cannot be combined\n -- meaningfully. We thus print only the bounding box of the traces (for now)\n\n for (Size hull=0; hull<convex_hulls_.size(); ++hull)\n {\n convex_hull_.addPoints(convex_hulls_[hull].getHullPoints());\n }\n */\n\n DBoundingBox<2> box;\n for (Size hull = 0; hull < convex_hulls_.size(); ++hull)\n {\n box.enlarge(convex_hulls_[hull].getBoundingBox().minPosition()[0], convex_hulls_[hull].getBoundingBox().minPosition()[1]);\n box.enlarge(convex_hulls_[hull].getBoundingBox().maxPosition()[0], convex_hulls_[hull].getBoundingBox().maxPosition()[1]);\n }\n convex_hull_.addPoint(ConvexHull2D::PointType(box.minX(), box.minY()));\n convex_hull_.addPoint(ConvexHull2D::PointType(box.maxX(), box.minY()));\n convex_hull_.addPoint(ConvexHull2D::PointType(box.minX(), box.maxY()));\n convex_hull_.addPoint(ConvexHull2D::PointType(box.maxX(), box.maxY()));\n }\n\n }\n\n convex_hulls_modified_ = false;\n }\n\n return convex_hull_;\n }\n\n bool Feature::encloses(double rt, double mz) const\n {\n ConvexHull2D::PointType tmp(rt, mz);\n\n for (const ConvexHull2D& hull : convex_hulls_)\n {\n if (hull.encloses(tmp))\n {\n return true;\n }\n }\n return false;\n }\n\n Feature& Feature::operator=(const Feature& rhs)\n {\n if (this == &rhs)\n {\n return *this;\n }\n\n BaseFeature::operator=(rhs);\n std::copy(rhs.qualities_, rhs.qualities_ + 2, qualities_);\n convex_hulls_ = rhs.convex_hulls_;\n convex_hulls_modified_ = rhs.convex_hulls_modified_;\n convex_hull_ = rhs.convex_hull_;\n subordinates_ = rhs.subordinates_;\n\n return *this;\n }\n\n Feature& Feature::operator=(Feature&& rhs) & noexcept\n {\n if (this == &rhs)\n {\n return *this;\n }\n\n BaseFeature::operator=(std::move(rhs));\n std::copy(rhs.qualities_, rhs.qualities_ + 2, qualities_);\n convex_hulls_ = std::move(rhs.convex_hulls_);\n convex_hulls_modified_ = std::move(rhs.convex_hulls_modified_);\n convex_hull_ = std::move(rhs.convex_hull_);\n subordinates_ = std::move(rhs.subordinates_);\n\n return *this;\n }\n\n bool Feature::operator==(const Feature& rhs) const\n {\n return BaseFeature::operator==(rhs)\n && equal(qualities_, qualities_ + 2, rhs.qualities_)\n && (convex_hulls_ == rhs.convex_hulls_)\n && (subordinates_ == rhs.subordinates_);\n }\n\n const std::vector<Feature>& Feature::getSubordinates() const\n {\n return subordinates_;\n }\n\n std::vector<Feature>& Feature::getSubordinates()\n {\n return subordinates_;\n }\n\n void Feature::setSubordinates(const std::vector<Feature>& rhs)\n {\n subordinates_ = rhs;\n }\n\n void Feature::updateAllIDReferences(const IdentificationData::RefTranslator& trans)\n {\n updateIDReferences(trans); // update the feature itself (via BaseFeature method)\n for (Feature& sub : subordinates_) // recursively update subordinate features\n {\n sub.updateAllIDReferences(trans);\n }\n }\n\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9356,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/PeakIndex.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":370,"string":"370"},"line_count":{"kind":"number","value":13,"string":"13"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg$\n// $Authors: Marc Sturm $\n// --------------------------------------------------------------------------\n\nnamespace OpenMS\n{\n\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9357,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/MobilityPeak1D.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":1786,"string":"1,786"},"line_count":{"kind":"number","value":74,"string":"74"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Chris Bielow $\n// $Authors: Chris Bielow $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/MobilityPeak1D.h>\n\nnamespace OpenMS\n{\n bool MobilityPeak1D::operator==(const MobilityPeak1D& rhs) const\n {\n return position_ == rhs.position_ && intensity_ == rhs.intensity_;\n }\n\n MobilityPeak1D::IntensityType MobilityPeak1D::getIntensity() const\n {\n return intensity_;\n }\n\n void MobilityPeak1D::setIntensity(MobilityPeak1D::IntensityType intensity)\n {\n intensity_ = intensity;\n }\n\n MobilityPeak1D::CoordinateType MobilityPeak1D::getMobility() const\n {\n return position_[0];\n }\n\n void MobilityPeak1D::setMobility(MobilityPeak1D::CoordinateType mobility)\n {\n position_[0] = mobility;\n }\n\n MobilityPeak1D::CoordinateType MobilityPeak1D::getPos() const\n {\n return position_[0];\n }\n\n void MobilityPeak1D::setPos(MobilityPeak1D::CoordinateType pos)\n {\n position_[0] = pos;\n }\n\n MobilityPeak1D::PositionType const& MobilityPeak1D::getPosition() const\n {\n return position_;\n }\n\n MobilityPeak1D::PositionType& MobilityPeak1D::getPosition()\n {\n return position_;\n }\n\n void MobilityPeak1D::setPosition(MobilityPeak1D::PositionType const& position)\n {\n position_ = position;\n }\n\n bool MobilityPeak1D::operator!=(const MobilityPeak1D& rhs) const\n {\n return !(operator==(rhs));\n }\n\n std::ostream & operator<<(std::ostream & os, const MobilityPeak1D & point)\n {\n os << \"POS: \" << point.getMobility() << \" INT: \" << point.getIntensity();\n return os;\n }\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9358,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/DPeak.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":527,"string":"527"},"line_count":{"kind":"number","value":18,"string":"18"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg $\n// $Authors: $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/DPeak.h>\n\nnamespace OpenMS\n{\n DPeak<1> default_dpeak_1;\n DPeak<1>::Type default_dpeak_1_type;\n DPeak<2> default_dpeak_2;\n DPeak<2>::Type default_dpeak_2_type;\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9359,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/ConsensusMap.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":27942,"string":"27,942"},"line_count":{"kind":"number","value":840,"string":"840"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg $\n// $Authors: $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/config.h>\n\n#include <OpenMS/KERNEL/ConsensusMap.h>\n#include <OpenMS/KERNEL/FeatureMap.h>\n\n#include <OpenMS/METADATA/DataProcessing.h>\n#include <OpenMS/METADATA/ProteinIdentification.h>\n#include <OpenMS/METADATA/PeptideIdentification.h>\n#include <OpenMS/QC/QCBase.h>\n#include <OpenMS/SYSTEM/File.h>\n#include <OpenMS/CONCEPT/LogStream.h>\n\n#include <map>\n\nnamespace OpenMS\n{\n ConsensusMap::ConsensusMap() = default;\n\n ConsensusMap::ConsensusMap(const ConsensusMap& source) :\n MetaInfoInterface(source),\n RangeManagerContainerType(source),\n DocumentIdentifier(source),\n ExposedVector<ConsensusFeature>(source),\n UniqueIdInterface(source),\n UniqueIdIndexer<ConsensusMap>(source),\n column_description_(source.column_description_),\n experiment_type_(source.experiment_type_),\n protein_identifications_(source.protein_identifications_),\n unassigned_peptide_identifications_(source.unassigned_peptide_identifications_),\n data_processing_(source.data_processing_),\n id_data_() // updated below\n {\n // copy ID data and update references in features:\n IdentificationData::RefTranslator trans = id_data_.merge(source.id_data_);\n for (ConsensusFeature& feature : *this)\n {\n feature.updateIDReferences(trans);\n }\n }\n\n ConsensusMap::ConsensusMap(ConsensusMap&& source) = default;\n\n ConsensusMap::~ConsensusMap() = default;\n\n ConsensusMap::ConsensusMap(size_type n) :\n ExposedVector<ConsensusFeature>(n)\n {\n }\n\n ConsensusMap& ConsensusMap::operator=(const ConsensusMap& source) = default;\n\n ConsensusMap& ConsensusMap::appendRows(const ConsensusMap& rhs)\n {\n ConsensusMap empty_map;\n\n // reset these:\n RangeManagerContainerType::operator=(empty_map);\n\n if (!this->getIdentifier().empty() || !rhs.getIdentifier().empty())\n {\n OPENMS_LOG_INFO << \"DocumentIdentifiers are lost during merge of ConsensusMaps\\n\";\n }\n\n DocumentIdentifier::operator=(empty_map);\n UniqueIdInterface::operator=(empty_map);\n\n // append dataProcessing\n data_processing_.insert(data_processing_.end(),\n rhs.data_processing_.begin(),\n rhs.data_processing_.end());\n\n // append fileDescription\n column_description_.insert(rhs.column_description_.begin(), rhs.column_description_.end());\n\n // update filename and map size\n std::map<UInt64, ColumnHeader>::const_iterator it = column_description_.begin();\n std::map<UInt64, ColumnHeader>::const_iterator it2 = rhs.column_description_.begin();\n\n for (; it != column_description_.end() && it2 != rhs.column_description_.end(); ++it, ++it2)\n {\n getColumnHeaders()[it->first].filename = \"mergedConsensusXMLFile\";\n getColumnHeaders()[it->first].size = it->second.size + it2->second.size;\n }\n\n // append proteinIdentification\n protein_identifications_.insert(protein_identifications_.end(),\n rhs.protein_identifications_.begin(),\n rhs.protein_identifications_.end());\n\n // ensure non-redundant modification parameter\n for (auto& pi : protein_identifications_)\n {\n std::vector<String>::iterator it_2;\n\n // remove redundant variable modifications\n std::vector<String>& varMod = pi.getSearchParameters().variable_modifications;\n sort(varMod.begin(), varMod.end());\n it_2 = unique(varMod.begin(), varMod.end());\n varMod.resize(it_2 - varMod.begin());\n\n // remove redundant fixed modifications\n std::vector<String>& fixMod = pi.getSearchParameters().fixed_modifications;\n sort(fixMod.begin(), fixMod.end());\n it_2 = unique(fixMod.begin(), fixMod.end());\n fixMod.resize(it_2 - fixMod.begin());\n }\n\n // append unassigned PeptideIdentifications\n unassigned_peptide_identifications_.insert(unassigned_peptide_identifications_.end(),\n rhs.unassigned_peptide_identifications_.begin(),\n rhs.unassigned_peptide_identifications_.end());\n\n Size old_size = size();\n // append consensusElements to consensusElementList:\n this->insert(this->end(), rhs.begin(), rhs.end());\n\n // combine IDs (new format):\n IdentificationData::RefTranslator trans = id_data_.merge(rhs.id_data_);\n // update IDs in new consensus features:\n for (Size i = old_size; i < size(); ++i) {\n (*this)[i].updateIDReferences(trans);\n }\n\n // consistency\n try\n {\n UniqueIdIndexer<ConsensusMap>::updateUniqueIdToIndex();\n }\n catch (Exception::Postcondition&) // assign new UID's for conflicting entries\n {\n Size replaced_uids = UniqueIdIndexer<ConsensusMap>::resolveUniqueIdConflicts();\n OPENMS_LOG_INFO << \"Replaced \" << replaced_uids << \" invalid uniqueID's\\n\";\n }\n\n return *this;\n }\n\n ConsensusMap& ConsensusMap::appendColumns(const ConsensusMap& rhs)\n {\n ConsensusMap empty_map;\n\n // reset these:\n RangeManagerType::operator=(empty_map);\n\n if (!this->getIdentifier().empty() || !rhs.getIdentifier().empty())\n {\n OPENMS_LOG_INFO << \"DocumentIdentifiers are lost during merge of ConsensusMaps\\n\";\n }\n\n DocumentIdentifier::operator=(empty_map);\n UniqueIdInterface::operator=(empty_map);\n\n // append dataProcessing\n data_processing_.insert(data_processing_.end(),\n rhs.data_processing_.begin(),\n rhs.data_processing_.end());\n\n // append column headers (file descriptions) and increase column index (map index)\n Size lhs_map_size = column_description_.size();\n for (const auto& rhsfd : rhs.column_description_)\n {\n column_description_.insert(std::make_pair(lhs_map_size + rhsfd.first, rhsfd.second));\n }\n\n // append proteinIdentification\n protein_identifications_.insert(protein_identifications_.end(),\n rhs.protein_identifications_.begin(),\n rhs.protein_identifications_.end());\n\n // ensure non-redundant modification parameter\n for (auto& pi : protein_identifications_)\n {\n std::vector<String>::iterator it_2;\n\n // remove redundant variable modifications\n std::vector<String>& varMod = pi.getSearchParameters().variable_modifications;\n sort(varMod.begin(), varMod.end());\n it_2 = unique(varMod.begin(), varMod.end());\n varMod.resize(it_2 - varMod.begin());\n\n // remove redundant fixed modifications\n std::vector<String>& fixMod = pi.getSearchParameters().fixed_modifications;\n sort(fixMod.begin(), fixMod.end());\n it_2 = unique(fixMod.begin(), fixMod.end());\n fixMod.resize(it_2 - fixMod.begin());\n }\n\n // append unassigned identifications and update map index:\n for (PeptideIdentification pid : rhs.unassigned_peptide_identifications_)\n {\n if (pid.metaValueExists(\"map_index\"))\n {\n Size old_index = pid.getMetaValue(\"map_index\");\n pid.setMetaValue(\"map_index\", lhs_map_size + old_index);\n }\n unassigned_peptide_identifications_.push_back(pid);\n }\n\n // combine IDs (new format):\n IdentificationData::RefTranslator trans = id_data_.merge(rhs.id_data_);\n\n // append consensusElements to consensusElementList and update map index:\n for (ConsensusFeature cf : rhs)\n {\n for (PeptideIdentification& pid : cf.getPeptideIdentifications())\n {\n if (pid.metaValueExists(\"map_index\"))\n {\n Size old_index = pid.getMetaValue(\"map_index\");\n pid.setMetaValue(\"map_index\", lhs_map_size + old_index);\n }\n }\n\n // update map indices\n ConsensusFeature::HandleSetType new_handles;\n for (auto handle : cf) // OMS_CODING_TEST_EXCLUDE Note: std::set only provides const iterators, so we copy\n {\n //since we only add a constant to the map_index, the set order will not change.\n handle.setMapIndex(lhs_map_size + handle.getMapIndex());\n new_handles.insert(handle);\n }\n cf.setFeatures(std::move(new_handles));\n new_handles.clear();\n\n // update IDs (new format):\n cf.updateIDReferences(trans);\n\n emplace_back(cf);\n }\n\n // consistency\n try\n {\n UniqueIdIndexer<ConsensusMap>::updateUniqueIdToIndex();\n }\n catch (Exception::Postcondition&) // assign new UID's for conflicting entries\n {\n Size replaced_uids = UniqueIdIndexer<ConsensusMap>::resolveUniqueIdConflicts();\n OPENMS_LOG_INFO << \"Replaced \" << replaced_uids << \" invalid uniqueID's\\n\";\n }\n\n return *this;\n }\n\n\n void ConsensusMap::clear(bool clear_meta_data)\n {\n data_.clear();\n\n if (clear_meta_data)\n {\n clearMetaInfo();\n clearRanges();\n // no \"clear\" method for DocumentIdentifier available\n this->DocumentIdentifier::operator=(DocumentIdentifier());\n clearUniqueId();\n column_description_.clear();\n experiment_type_ = \"label-free\"; // default\n protein_identifications_.clear();\n unassigned_peptide_identifications_.clear();\n data_processing_.clear();\n id_data_.clear();\n }\n }\n\n const ConsensusMap::ColumnHeaders& ConsensusMap::getColumnHeaders() const\n {\n return column_description_;\n }\n\n ConsensusMap::ColumnHeaders& ConsensusMap::getColumnHeaders()\n {\n return column_description_;\n }\n\n void ConsensusMap::setColumnHeaders(const ConsensusMap::ColumnHeaders& column_description)\n {\n column_description_ = column_description;\n }\n\n const String& ConsensusMap::getExperimentType() const\n {\n return experiment_type_;\n }\n\n void ConsensusMap::setExperimentType(const String& experiment_type)\n {\n if (experiment_type != \"label-free\"\n && experiment_type != \"labeled_MS1\"\n && experiment_type != \"labeled_MS2\")\n {\n throw Exception::IllegalArgument(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION,\n \"Unknown experiment type. \" + experiment_type + \". Must be one of (label-free, labeled_MS1, labeled_MS2)\");\n }\n experiment_type_ = experiment_type;\n }\n\n void ConsensusMap::sortByIntensity(bool reverse)\n {\n if (reverse)\n {\n std::stable_sort(begin(), end(), [](auto &left, auto &right) {ConsensusFeature::IntensityLess cmp; return cmp(right, left);});\n }\n else\n {\n std::stable_sort(begin(), end(), ConsensusFeature::IntensityLess());\n }\n }\n\n void ConsensusMap::sortByRT()\n {\n std::stable_sort(begin(), end(), ConsensusFeature::RTLess());\n }\n\n void ConsensusMap::sortByMZ()\n {\n std::stable_sort(begin(), end(), ConsensusFeature::MZLess());\n }\n\n void ConsensusMap::sortByPosition()\n {\n std::stable_sort(begin(), end(), ConsensusFeature::PositionLess());\n }\n\n void ConsensusMap::sortByQuality(bool reverse)\n {\n if (reverse)\n {\n std::stable_sort(begin(), end(), [](auto &left, auto &right) {ConsensusFeature::QualityLess cmp; return cmp(right, left);});\n }\n else\n {\n std::stable_sort(begin(), end(), ConsensusFeature::QualityLess());\n }\n }\n\n void ConsensusMap::sortBySize()\n {\n std::stable_sort(begin(), end(), [](auto &left, auto &right) {ConsensusFeature::SizeLess cmp; return cmp(right, left);});\n }\n\n void ConsensusMap::sortByMaps()\n {\n std::stable_sort(begin(), end(), ConsensusFeature::MapsLess());\n }\n\n void ConsensusMap::sortPeptideIdentificationsByMapIndex()\n {\n // lambda predicate\n auto mapIndexLess = [] (const PeptideIdentification & a, const PeptideIdentification & b) -> bool\n {\n const bool has_a = a.metaValueExists(\"map_index\");\n const bool has_b = b.metaValueExists(\"map_index\");\n\n // moves IDs without meta value to end\n if (has_a && !has_b)\n {\n return true;\n }\n if (!has_a && has_b)\n {\n return false;\n }\n\n // both have map index annotated\n if (has_a && has_b)\n {\n return a.getMetaValue(\"map_index\") < b.getMetaValue(\"map_index\");\n }\n\n // no map index annotated in both\n return false;\n };\n\n std::transform(begin(), end(), begin(),\n [mapIndexLess](ConsensusFeature& c)\n {\n auto& pids = c.getPeptideIdentifications();\n stable_sort(pids.begin(), pids.end(), mapIndexLess);\n return c;\n });\n }\n\n void ConsensusMap::swap(ConsensusMap& from)\n {\n ConsensusMap tmp;\n\n //swap range information\n tmp.RangeManagerType::operator=(* this);\n this->RangeManagerType::operator=(from);\n from.RangeManagerType::operator=(tmp);\n\n //swap consensus features\n data_.swap(from.data_);\n\n // swap DocumentIdentifier\n DocumentIdentifier::swap(from);\n\n // swap unique id\n UniqueIdInterface::swap(from);\n\n // swap unique id index\n UniqueIdIndexer<ConsensusMap>::swap(from);\n\n // swap the remaining members\n std::swap(column_description_, from.column_description_);\n experiment_type_.swap(from.experiment_type_);\n protein_identifications_.swap(from.protein_identifications_);\n unassigned_peptide_identifications_.swap(from.unassigned_peptide_identifications_);\n data_processing_.swap(from.data_processing_);\n id_data_.swap(from.id_data_);\n }\n\n /// non-mutable access to the protein identifications\n const std::vector<ProteinIdentification>& ConsensusMap::getProteinIdentifications() const\n {\n return protein_identifications_;\n }\n\n /// mutable access to the protein identifications\n std::vector<ProteinIdentification>& ConsensusMap::getProteinIdentifications()\n {\n return protein_identifications_;\n }\n\n /// sets the protein identifications\n void ConsensusMap::setProteinIdentifications(const std::vector<ProteinIdentification>& protein_identifications)\n {\n protein_identifications_ = protein_identifications;\n }\n\n /// sets the protein identifications\n void ConsensusMap::setProteinIdentifications(std::vector<ProteinIdentification>&& protein_identifications)\n {\n protein_identifications_ = std::move(protein_identifications);\n }\n\n /// non-mutable access to the unassigned peptide identifications\n const PeptideIdentificationList& ConsensusMap::getUnassignedPeptideIdentifications() const\n {\n return unassigned_peptide_identifications_;\n }\n\n /// mutable access to the unassigned peptide identifications\n PeptideIdentificationList& ConsensusMap::getUnassignedPeptideIdentifications()\n {\n return unassigned_peptide_identifications_;\n }\n\n /// sets the unassigned peptide identifications\n void ConsensusMap::setUnassignedPeptideIdentifications(const PeptideIdentificationList& unassigned_peptide_identifications)\n {\n unassigned_peptide_identifications_ = unassigned_peptide_identifications;\n }\n\n /// returns a const reference to the description of the applied data processing\n const std::vector<DataProcessing>& ConsensusMap::getDataProcessing() const\n {\n return data_processing_;\n }\n\n /// returns a mutable reference to the description of the applied data processing\n std::vector<DataProcessing>& ConsensusMap::getDataProcessing()\n {\n return data_processing_;\n }\n\n /// sets the description of the applied data processing\n void ConsensusMap::setDataProcessing(const std::vector<DataProcessing>& processing_method)\n {\n data_processing_ = processing_method;\n }\n\n /// set the file path to the primary MS run (usually the mzML file obtained after data conversion from raw files)\n void ConsensusMap::setPrimaryMSRunPath(const StringList& s)\n {\n if (s.empty())\n {\n OPENMS_LOG_WARN << \"Setting empty MS runs paths. Expected one for each map. Resulting ConsensusMap contains \" + String(column_description_.size()) + \" maps.\" << std::endl;\n for (auto & cd : column_description_)\n {\n cd.second.filename = \"UNKNOWN\";\n }\n }\n else if (!column_description_.empty() && s.size() != column_description_.size())\n {\n throw Exception::InvalidParameter(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION,\n \"Number of MS runs paths (\" + String(s.size()) +\n \") must match number of columns (\" + String(column_description_.size()) + \").\");\n }\n\n Size i(0);\n for (auto const & p : s)\n {\n if (!p.hasSuffix(\"mzML\") && !p.hasSuffix(\"mzml\"))\n {\n OPENMS_LOG_WARN << \"To ensure tracability of results please prefer mzML files as primary MS run.\" << std::endl\n << \"Filename: '\" << p << \"'\" << std::endl;\n }\n\n column_description_[i].filename = p;\n ++i;\n }\n }\n\n void ConsensusMap::setPrimaryMSRunPath(const StringList& s, MSExperiment & e)\n {\n StringList ms_path;\n e.getPrimaryMSRunPath(ms_path);\n if (ms_path.size() == 1 && ms_path[0].hasSuffix(\"mzML\") && File::exists(ms_path[0]))\n {\n setPrimaryMSRunPath(ms_path);\n }\n else\n {\n setPrimaryMSRunPath(s);\n }\n }\n\n void ConsensusMap::getPrimaryMSRunPath(StringList& toFill) const\n {\n /// get the file path to the MS run\n for (auto const & fd : column_description_)\n {\n toFill.push_back(fd.second.filename);\n }\n }\n\n /// Equality operator\n bool ConsensusMap::operator==(const ConsensusMap& rhs) const\n {\n return data_ == rhs.data_ &&\n MetaInfoInterface::operator==(rhs) &&\n RangeManagerType::operator==(rhs) &&\n DocumentIdentifier::operator==(rhs) &&\n UniqueIdInterface::operator==(rhs) &&\n column_description_ == rhs.column_description_ &&\n experiment_type_ == rhs.experiment_type_ &&\n protein_identifications_ == rhs.protein_identifications_ &&\n unassigned_peptide_identifications_ == rhs.unassigned_peptide_identifications_ &&\n data_processing_ == rhs.data_processing_;\n // @TODO: implement \"operator==\" for IdentificationData?\n }\n\n /// Equality operator\n bool ConsensusMap::operator!=(const ConsensusMap& rhs) const\n {\n return !(operator==(rhs));\n }\n\n std::ostream& operator<<(std::ostream& os, const ConsensusMap& cons_map)\n {\n for (ConsensusMap::ColumnHeaders::const_iterator it = cons_map.getColumnHeaders().begin(); it != cons_map.getColumnHeaders().end(); ++it)\n {\n os << \"Map \" << it->first << \": \" << it->second.filename << \" - \" << it->second.label << \" - \" << it->second.size << std::endl;\n }\n\n for (Size i = 0; i < cons_map.size(); ++i)\n {\n os << cons_map[i] << std::endl;\n }\n\n return os;\n }\n\n void ConsensusMap::updateRanges()\n {\n #ifdef OPENMS_ASSERTIONS\n double rt_min = RangeRT::isEmpty() ? 0 : getMinRT();\n double rt_max = RangeRT::isEmpty() ? 0 : getMaxRT();\n double mz_min = RangeMZ::isEmpty() ? 0 : getMinMZ();\n double mz_max = RangeMZ::isEmpty() ? 0 : getMaxMZ();\n double int_min = RangeIntensity::isEmpty() ? 0 : getMinIntensity();\n double int_max = RangeIntensity::isEmpty() ? 0 : getMaxIntensity();\n #endif\n clearRanges();\n // enlarge the range by the internal points of each feature\n for (const auto& cf : data_)\n {\n extendRT(cf.getRT());\n extendMZ(cf.getMZ());\n extendIntensity(cf.getIntensity());\n for (const auto& handle : cf.getFeatures())\n {\n extendRT(handle.getRT());\n extendMZ(handle.getMZ());\n extendIntensity(handle.getIntensity());\n }\n }\n\n #ifdef OPENMS_ASSERTIONS\n // check if updateRanges() was necessary and find places where it was not\n double rt_min_new = RangeRT::isEmpty() ? 0 : getMinRT();\n double rt_max_new = RangeRT::isEmpty() ? 0 : getMaxRT();\n double mz_min_new = RangeMZ::isEmpty() ? 0 : getMinMZ();\n double mz_max_new = RangeMZ::isEmpty() ? 0 : getMaxMZ();\n double int_min_new = RangeIntensity::isEmpty() ? 0 : getMinIntensity();\n double int_max_new = RangeIntensity::isEmpty() ? 0 : getMaxIntensity();\n\n // check if all are equal and no update range was necessary\n if (rt_min_new == rt_min && rt_max_new == rt_max\n && int_min_new == int_min && int_max_new == int_max\n && mz_min_new == mz_min && mz_max_new == mz_max)\n {\n OPENMS_LOG_WARN << \"Update ranges was called but ranges were already up-to-date\" << std::endl;\n }\n #endif\n }\n\n bool ConsensusMap::isMapConsistent(Logger::LogStream* stream) const\n {\n Size stats_wrongMID(0); // invalid map ID references by a feature handle\n std::map<Size, Size> wrong_ID_count; // which IDs were given which are not valid\n\n // check file descriptions\n std::set<String> maps;\n String all_maps; // for output later\n for (ColumnHeaders::const_iterator it = column_description_.begin(); it != column_description_.end(); ++it)\n {\n String s = String(\" file: \") + it->second.filename + \" label: \" + it->second.label;\n maps.insert(s);\n all_maps += s;\n }\n\n if (maps.size() != column_description_.size())\n {\n if (stream != nullptr)\n {\nOPENMS_THREAD_CRITICAL(LOGSTREAM)\n *stream << \"Map descriptions (file name + label) in ConsensusMap are not unique:\\n\" << all_maps << std::endl;\n }\n return false;\n }\n\n // check map IDs\n for (Size i = 0; i < size(); ++i)\n {\n const ConsensusFeature& elem = (*this)[i];\n for (ConsensusFeature::HandleSetType::const_iterator it = elem.begin(); it != elem.end(); ++it)\n {\n if (column_description_.find(it->getMapIndex()) == column_description_.end())\n {\n ++stats_wrongMID;\n ++wrong_ID_count[it->getMapIndex()];\n }\n }\n }\n\n if (stats_wrongMID > 0)\n {\n if (stream != nullptr)\n {\nOPENMS_THREAD_CRITICAL(LOGSTREAM)\n *stream << \"ConsensusMap contains \" << stats_wrongMID << \" invalid references to maps:\\n\";\n for (std::map<Size, Size>::const_iterator it = wrong_ID_count.begin(); it != wrong_ID_count.end(); ++it)\n {\nOPENMS_THREAD_CRITICAL(LOGSTREAM)\n *stream << \" wrong id=\" << it->first << \" (occurred \" << it->second << \"x)\\n\";\n }\nOPENMS_THREAD_CRITICAL(LOGSTREAM)\n *stream << std::endl;\n }\n return false;\n }\n\n return true;\n }\n\n std::vector<FeatureMap> ConsensusMap::split(ConsensusMap::SplitMeta mode) const\n {\n // @TODO: handle IDs in new format (IdentificationData)\n\n Size numbr_exps = column_description_.size();\n std::vector<FeatureMap>fmaps(numbr_exps);\n\n // Check for Isobaric Analyzer\n bool iso_analyze = QCBase::isLabeledExperiment(*this);\n\n for (const auto& cf : *this)\n {\n UInt64 min_index = std::numeric_limits<UInt64>::max();\n // Create new Features from FeatureHandles\n std::map<UInt64, BaseFeature> new_feats;\n for (const FeatureHandle& fh : cf.getFeatures())\n {\n UInt64 index = fh.getMapIndex();\n // GCC-OPT 4.8 does not compile with: new_feats.emplace(index, fh);\n // , thus we use:\n new_feats[index] = BaseFeature(fh);\n min_index = std::min(index, min_index);\n }\n\n if (iso_analyze)\n {\n if (min_index != 0)\n {\n throw Exception::ElementNotFound(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION,\n \"File seems to have gone through IsobaricAnalyzer, but there was no feature with map index 0 found. Check Input!\");\n }\n }\n\n // Add PeptideIdentifications to ...\n for (const PeptideIdentification& pep_id : cf.getPeptideIdentifications())\n {\n // ... the first Feature.\n if (iso_analyze)\n {\n (*new_feats.begin()).second.getPeptideIdentifications().push_back(pep_id);\n continue;\n }\n\n // ... the corresponding Feature by map_index.\n if (!pep_id.metaValueExists(\"map_index\"))\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION,\n \"File did not undergo IsobaricAnalyzer, but no map index was found at PeptideIdentifications. Check Input!\");\n }\n new_feats[pep_id.getMetaValue(\"map_index\")].getPeptideIdentifications().push_back(pep_id);\n }\n\n // handle MetaValues of current CF\n switch (mode)\n {\n case SplitMeta::DISCARD :\n break;\n\n case SplitMeta::COPY_ALL :\n for (auto it = new_feats.begin(); it != new_feats.end(); ++it)\n {\n (it->second).MetaInfoInterface::operator=(cf);\n }\n break;\n\n case SplitMeta::COPY_FIRST :\n if (min_index != 0)\n {\n throw Exception::ElementNotFound(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION,\n \"No feature with map index 0 to copy MetaValues to. Check Input or switch mode!\");\n }\n new_feats.begin()->second.MetaInfoInterface::operator=(cf);\n break;\n }\n\n // Add new Features to corresponding FeatureMap.\n for (auto it = new_feats.begin(); it != new_feats.end(); ++it)\n {\n fmaps[it->first].emplace_back(std::move(it->second));\n }\n }\n\n // Add unassigned PeptideIdentifications to ...\n if (iso_analyze)\n {\n // ... the first FeatureMap.\n fmaps[0].getUnassignedPeptideIdentifications() = this->getUnassignedPeptideIdentifications();\n fmaps[0].getProteinIdentifications() = this->getProteinIdentifications(); // wrong! improve: only copy the ProtID which belongs to this FMap!\n }\n else\n {\n // ... the corresponding FeatureMap by map_index.\n for (const PeptideIdentification& upep_id : this->getUnassignedPeptideIdentifications())\n {\n if (!upep_id.metaValueExists(\"map_index\"))\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION,\n \"File did not undergo IsobaricAnalyzer, but no map index was found at PeptideIdentifications. Check Input!\");\n }\n fmaps[upep_id.getMetaValue(\"map_index\")].getUnassignedPeptideIdentifications().push_back(upep_id);\n }\n }\n\n for (auto& fm : fmaps)\n {\n fm.getDataProcessing() = this->getDataProcessing();\n }\n\n return fmaps;\n }\n\n unsigned ConsensusMap::ColumnHeader::getLabelAsUInt(const String& experiment_type) const\n {\n if (metaValueExists(\"channel_id\"))\n {\n return static_cast<unsigned int>(getMetaValue(\"channel_id\")) + 1;\n }\n else\n {\n if (experiment_type != \"label-free\")\n {\n // TODO There seem to be files in our test data from the Multiplex toolset that do not annotate\n // a channel id but only add the \"label\" attribute with the SILAC modification. Add a fall-back here?\n OPENMS_LOG_WARN << \"No channel id annotated in labelled consensusXML. Assuming only a single channel was used.\" << std::endl;\n }\n return 1;\n }\n }\n\n std::set<IdentificationDataInternal::ObservationMatchRef> ConsensusMap::getUnassignedIDMatches() const\n {\n std::set<IdentificationData::ObservationMatchRef> all_matches;\n for (auto it = id_data_.getObservationMatches().begin();\n it != id_data_.getObservationMatches().end(); ++it)\n {\n all_matches.insert(it);\n }\n std::set<IdentificationData::ObservationMatchRef> assigned_matches;\n for (const ConsensusFeature& feat : *this)\n {\n assigned_matches.insert(feat.getIDMatches().begin(), feat.getIDMatches().end());\n // @TODO: consider subordinate features? - probably not\n }\n std::set<IdentificationData::ObservationMatchRef> result;\n std::set_difference(all_matches.begin(), all_matches.end(),\n assigned_matches.begin(), assigned_matches.end(),\n inserter(result, result.end()));\n return result;\n }\n\n\n const IdentificationData& ConsensusMap::getIdentificationData() const\n {\n return id_data_;\n }\n\n\n IdentificationData& ConsensusMap::getIdentificationData()\n {\n return id_data_;\n }\n\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9360,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/BinnedSpectrum.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":5434,"string":"5,434"},"line_count":{"kind":"number","value":194,"string":"194"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Mathias Walzer $\n// $Authors: Timo Sachsenberg $\n// --------------------------------------------------------------------------\n//\n\n#include <OpenMS/KERNEL/BinnedSpectrum.h>\n\n#include <Eigen/Sparse>\n\nusing namespace std;\n\n/// typedef for the index into the sparse vector\nusing SparseVectorIndexType = Eigen::SparseVector<float>::Index;\n\n/// typedef for the index into the sparse vector\nusing SparseVectorIteratorType = Eigen::SparseVector<float>::InnerIterator;\n\nnamespace OpenMS\n{\n\n BinnedSpectrum::BinnedSpectrum(const PeakSpectrum& ps, float size, bool unit_ppm, UInt spread, float offset) :\n bin_spread_(spread), \n bin_size_(size),\n unit_ppm_(unit_ppm),\n offset_(offset)\n {\n bins_ = new SparseVectorType(numeric_limits<SparseVectorIndexType>::max());\n precursors_ = ps.getPrecursors();\n binSpectrum_(ps);\n }\n\n BinnedSpectrum::BinnedSpectrum(const BinnedSpectrum& rhs) :\n bin_spread_(rhs.bin_spread_), \n bin_size_(rhs.bin_size_),\n unit_ppm_(rhs.unit_ppm_),\n offset_(rhs.offset_),\n bins_(new SparseVectorType(*rhs.bins_)),\n precursors_(rhs.precursors_)\n {\n }\n\n BinnedSpectrum& BinnedSpectrum::operator=(const BinnedSpectrum& rhs)\n {\n if (this != &rhs)\n {\n bin_spread_ = rhs.bin_spread_;\n bin_size_ = rhs.bin_size_;\n unit_ppm_ = rhs.unit_ppm_;\n offset_ = rhs.offset_;\n precursors_ = rhs.precursors_;\n\n delete bins_;\n bins_ = new SparseVectorType(*rhs.bins_);\n }\n\n return *this;\n }\n\n BinnedSpectrum::~BinnedSpectrum()\n {\n delete bins_;\n }\n\n const BinnedSpectrum::SparseVectorType* BinnedSpectrum::getBins() const\n {\n return bins_;\n }\n\n BinnedSpectrum::SparseVectorType* BinnedSpectrum::getBins()\n {\n return bins_;\n }\n\n const std::vector<Precursor>& BinnedSpectrum::getPrecursors() const\n {\n return precursors_;\n }\n\n std::vector<Precursor>& BinnedSpectrum::getPrecursors()\n {\n return precursors_;\n }\n\n void BinnedSpectrum::binSpectrum_(const PeakSpectrum& ps)\n {\n OPENMS_PRECONDITION(ps.isSorted(), \"Spectrum needs to be sorted by m/z.\");\n\n if (ps.empty())\n { \n return;\n }\n\n // delete bins_;\n // bins_ = new SparseVectorType(numeric_limits<SparseVectorIndexType>::max());\n\n for (auto const & p : ps)\n {\n // if bin size is in relative units (ppm), check if minimum value is >= 1 (otherwise we might get numerical problems with the negative log)\n OPENMS_PRECONDITION(!unit_ppm_ || p.getMZ() >= BinnedSpectrum::MIN_MZ_, \"Spectrum with relative bin size contains peaks with m/z < 1\");\n\n // e.g.: bin_size_ = 1.5: first bin covers range [0, 1.5) so peak at 1.5 falls in second bin (index 1)\n const size_t idx = getBinIndex(p.getMZ());\n\n // add peak to corresponding bin\n bins_->coeffRef(idx) += p.getIntensity();\n\n // add peak to neighboring bins\n for (Size j = 0; j < bin_spread_; ++j)\n {\n bins_->coeffRef(idx + j + 1) += p.getIntensity();\n \n // prevent spreading over left boundaries\n if (static_cast<int>(idx - j - 1) >= 0)\n {\n bins_->coeffRef(idx - j - 1) += p.getIntensity();\n }\n }\n }\n }\n\n bool BinnedSpectrum::operator==(const BinnedSpectrum& rhs) const\n {\n // first compare bin layout and precursors\n if (std::tie(unit_ppm_, bin_size_, bin_spread_, precursors_)\n != std::tie(rhs.unit_ppm_, rhs.bin_size_, rhs.bin_spread_, rhs.precursors_)) \n {\n return false; \n }\n\n // efficient look-up of number of non-zero entries, so we use this as-well\n if (bins_->nonZeros() != rhs.bins_->nonZeros())\n {\n return false;\n }\n\n // test non-sparse (non-zero) elements for equality\n SparseVectorIteratorType it(*bins_);\n SparseVectorIteratorType rhs_it(*rhs.bins_); \n while (it) \n {\n if (it.index() != rhs_it.index() || it.value() != rhs_it.value())\n {\n return false;\n }\n ++it;\n ++rhs_it;\n }\n return true;\n }\n\n // static\n bool BinnedSpectrum::isCompatible(const BinnedSpectrum& a, const BinnedSpectrum& b)\n {\n // check if bin size, offset (and unit) are equal\n return std::tie(a.unit_ppm_, a.bin_size_, a.offset_) \n == std::tie(b.unit_ppm_, b.bin_size_, b.offset_);\n }\n\n bool BinnedSpectrum::operator!=(const BinnedSpectrum& rhs) const\n {\n return !(operator==(rhs));\n }\n\n size_t BinnedSpectrum::getBinIndex(float mz) const \n {\n if (unit_ppm_)\n {\n /*\n * By solving: mz = MIN_MZ_ * (1.0 + bin_size_ * 1e-6)^index for index\n * we get: index = floor(log(mz/MIN_MZ_)/log(1.0 + bin_size_ * 1e-6))\n * Note: for ppm we don't need to consider an offset_.\n */ \n return static_cast<SparseVectorIndexType>(floor(log(mz/MIN_MZ_)/log1p(bin_size_ * 1e-6)));\n }\n else \n { // implemented as described in PMC4607604\n // Note: Consider a peak offset (important for low-resolution data, where most peak boundaries\n // may fall on the mass peak apex. See publication for details.).\n return static_cast<SparseVectorIndexType>(floor(mz / bin_size_ + offset_)); \n }\n }\n\n float BinnedSpectrum::getBinIntensity(double mz)\n {\n return bins_->coeffRef(getBinIndex(mz));\n }\n\n}\n\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9361,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/Peak1D.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":569,"string":"569"},"line_count":{"kind":"number","value":20,"string":"20"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg$\n// $Authors: Marc Sturm $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/Peak1D.h>\n\nnamespace OpenMS\n{\n std::ostream & operator<<(std::ostream & os, const Peak1D & point)\n {\n os << \"POS: \" << point.getMZ() << \" INT: \" << point.getIntensity();\n return os;\n }\n\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9362,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/MobilityPeak2D.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":2282,"string":"2,282"},"line_count":{"kind":"number","value":104,"string":"104"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Chris Bielow $\n// $Authors: Chris Bielow $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/MobilityPeak2D.h>\n\nnamespace OpenMS\n{\n char const * const MobilityPeak2D::dimension_name_short_[] =\n {\n \"IM\",\n \"MZ\"\n };\n\n char const * const MobilityPeak2D::dimension_name_full_[] =\n {\n \"ion mobility\",\n \"mass-to-charge\"\n };\n\n char const * const MobilityPeak2D::dimension_unit_short_[] =\n {\n \"?\",\n \"Th\"\n };\n\n char const * const MobilityPeak2D::dimension_unit_full_[] =\n {\n \"?\",\n \"Thomson\"\n };\n\n char const * MobilityPeak2D::shortDimensionName(UInt const dim)\n {\n return dimension_name_short_[dim];\n }\n\n char const * MobilityPeak2D::shortDimensionNameIM()\n {\n return dimension_name_short_[IM];\n }\n\n char const * MobilityPeak2D::shortDimensionNameMZ()\n {\n return dimension_name_short_[MZ];\n }\n\n char const * MobilityPeak2D::fullDimensionName(UInt const dim)\n {\n return dimension_name_full_[dim];\n }\n\n char const * MobilityPeak2D::fullDimensionNameIM()\n {\n return dimension_name_full_[IM];\n }\n\n char const * MobilityPeak2D::fullDimensionNameMZ()\n {\n return dimension_name_full_[MZ];\n }\n\n char const * MobilityPeak2D::shortDimensionUnit(UInt const dim)\n {\n return dimension_unit_short_[dim];\n }\n\n char const * MobilityPeak2D::shortDimensionUnitIM()\n {\n return dimension_unit_short_[IM];\n }\n\n char const * MobilityPeak2D::shortDimensionUnitMZ()\n {\n return dimension_unit_short_[MZ];\n }\n\n char const * MobilityPeak2D::fullDimensionUnit(UInt const dim)\n {\n return dimension_unit_full_[dim];\n }\n\n char const * MobilityPeak2D::fullDimensionUnitIM()\n {\n return dimension_unit_full_[IM];\n }\n\n char const * MobilityPeak2D::fullDimensionUnitMZ()\n {\n return dimension_unit_full_[MZ];\n }\n\n std::ostream & operator<<(std::ostream & os, const MobilityPeak2D & point)\n {\n os << \"IM: \" << point.getMobility() << \" MZ: \" << point.getMZ() << \" INT: \" << point.getIntensity();\n return os;\n }\n\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9363,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/Peak2D.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":2143,"string":"2,143"},"line_count":{"kind":"number","value":104,"string":"104"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg$\n// $Authors: Marc Sturm $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/Peak2D.h>\n\nnamespace OpenMS\n{\n char const * const Peak2D::dimension_name_short_[] =\n {\n \"RT\",\n \"MZ\"\n };\n\n char const * const Peak2D::dimension_name_full_[] =\n {\n \"retention time\",\n \"mass-to-charge\"\n };\n\n char const * const Peak2D::dimension_unit_short_[] =\n {\n \"sec\",\n \"Th\"\n };\n\n char const * const Peak2D::dimension_unit_full_[] =\n {\n \"Seconds\",\n \"Thomson\"\n };\n\n char const * Peak2D::shortDimensionName(UInt const dim)\n {\n return dimension_name_short_[dim];\n }\n\n char const * Peak2D::shortDimensionNameRT()\n {\n return dimension_name_short_[RT];\n }\n\n char const * Peak2D::shortDimensionNameMZ()\n {\n return dimension_name_short_[MZ];\n }\n\n char const * Peak2D::fullDimensionName(UInt const dim)\n {\n return dimension_name_full_[dim];\n }\n\n char const * Peak2D::fullDimensionNameRT()\n {\n return dimension_name_full_[RT];\n }\n\n char const * Peak2D::fullDimensionNameMZ()\n {\n return dimension_name_full_[MZ];\n }\n\n char const * Peak2D::shortDimensionUnit(UInt const dim)\n {\n return dimension_unit_short_[dim];\n }\n\n char const * Peak2D::shortDimensionUnitRT()\n {\n return dimension_unit_short_[RT];\n }\n\n char const * Peak2D::shortDimensionUnitMZ()\n {\n return dimension_unit_short_[MZ];\n }\n\n char const * Peak2D::fullDimensionUnit(UInt const dim)\n {\n return dimension_unit_full_[dim];\n }\n\n char const * Peak2D::fullDimensionUnitRT()\n {\n return dimension_unit_full_[RT];\n }\n\n char const * Peak2D::fullDimensionUnitMZ()\n {\n return dimension_unit_full_[MZ];\n }\n\n std::ostream & operator<<(std::ostream & os, const Peak2D & point)\n {\n os << \"RT: \" << point.getRT() << \" MZ: \" << point.getMZ() << \" INT: \" << point.getIntensity();\n return os;\n }\n\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9364,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/Mobilogram.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":10941,"string":"10,941"},"line_count":{"kind":"number","value":414,"string":"414"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Chris Bielow $\n// $Authors: Chris Bielow $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/config.h> // for OPENMS_ASSERTIONS\n#include <OpenMS/CONCEPT/LogStream.h>\n\n#include <OpenMS/KERNEL/Peak1D.h>\n\n#include <OpenMS/KERNEL/Mobilogram.h>\n\n#include <OpenMS/IONMOBILITY/IMTypes.h>\n#include <numeric>\n\nnamespace OpenMS\n{\n bool Mobilogram::RTLess::operator()(const Mobilogram& a, const Mobilogram& b) const\n {\n return a.getRT() < b.getRT();\n }\n\n bool Mobilogram::operator==(const Mobilogram& rhs) const\n {\n return data_ == rhs.data_ && retention_time_ == rhs.retention_time_ && drift_time_unit_ == rhs.drift_time_unit_;\n }\n void Mobilogram::updateRanges()\n {\n #ifdef OPENMS_ASSERTIONS\n double im_min = RangeMobility::isEmpty() ? 0 : getMinMobility();\n double im_max = RangeMobility::isEmpty() ? 0 : getMaxMobility();\n double int_min = RangeIntensity::isEmpty() ? 0 : getMinIntensity();\n double int_max = RangeIntensity::isEmpty() ? 0 : getMaxIntensity();\n #endif\n\n clearRanges();\n for (const auto& peak : data_)\n {\n extendMobility(peak.getMobility());\n extendIntensity(peak.getIntensity());\n }\n\n #ifdef OPENMS_ASSERTIONS\n // check if updateRanges() was necessary and find places where it was not\n double im_min_new = RangeMobility::isEmpty() ? 0 : getMinMobility();\n double im_max_new = RangeMobility::isEmpty() ? 0 : getMaxMobility();\n double int_min_new = RangeIntensity::isEmpty() ? 0 : getMinIntensity();\n double int_max_new = RangeIntensity::isEmpty() ? 0 : getMaxIntensity();\n\n if (im_min_new == im_min && im_max_new == im_max \n && int_min_new == int_min && int_max_new == int_max)\n {\n OPENMS_LOG_WARN << \"Update ranges was called but ranges were already up-to-date\" << std::endl;\n } \n #endif \n }\n\n const Mobilogram::FloatDataArrays &Mobilogram::getFloatDataArrays() const\n {\n return float_data_arrays_;\n }\n\n Mobilogram::FloatDataArrays &Mobilogram::getFloatDataArrays()\n {\n return float_data_arrays_;\n }\n\n const Mobilogram::StringDataArrays &Mobilogram::getStringDataArrays() const\n {\n return string_data_arrays_;\n }\n\n Mobilogram::StringDataArrays &Mobilogram::getStringDataArrays()\n {\n return string_data_arrays_;\n }\n\n const Mobilogram::IntegerDataArrays &Mobilogram::getIntegerDataArrays() const\n {\n return integer_data_arrays_;\n }\n\n Mobilogram::IntegerDataArrays &Mobilogram::getIntegerDataArrays()\n {\n return integer_data_arrays_;\n }\n\n String Mobilogram::getDriftTimeUnitAsString() const\n {\n return NamesOfDriftTimeUnit[(size_t)drift_time_unit_];\n }\n\n void Mobilogram::setDriftTimeUnit(DriftTimeUnit dt) noexcept\n {\n drift_time_unit_ = dt;\n }\n void Mobilogram::sortByIntensity(bool reverse)\n {\n if (reverse && std::is_sorted(cbegin(), cend(), [](auto& left, auto& right) {\n PeakType::IntensityLess cmp;\n return cmp(right, left);\n }))\n {\n return;\n }\n else if (!reverse && std::is_sorted(cbegin(), cend(), PeakType::IntensityLess()))\n {\n return;\n }\n if (reverse)\n {\n std::stable_sort(begin(), end(), [](auto& left, auto& right) {\n PeakType::IntensityLess cmp;\n return cmp(right, left);\n });\n }\n else\n {\n std::stable_sort(begin(), end(), PeakType::IntensityLess());\n }\n }\n\n void Mobilogram::sortByPosition()\n {\n if (isSorted())\n {\n return;\n }\n std::stable_sort(begin(), end(), PeakType::PositionLess());\n }\n\n bool Mobilogram::isSorted() const\n {\n return std::is_sorted(begin(), end(), PeakType::PositionLess());\n }\n\n Size Mobilogram::findNearest(CoordinateType mb) const\n {\n // no peak => no search\n if (empty())\n {\n throw Exception::Precondition(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"There must be at least one peak to determine the nearest peak!\");\n }\n // search for position for inserting\n ConstIterator it = MBBegin(mb);\n // border cases\n if (it == cbegin())\n {\n return 0;\n }\n if (it == cend())\n {\n return size() - 1;\n }\n // the peak before or the current peak are closest\n auto it2 = it;\n --it2;\n if (std::fabs(it->getMobility() - mb) < std::fabs(it2->getMobility() - mb))\n {\n return Size(it - cbegin());\n }\n else\n {\n return Size(it2 - cbegin());\n }\n }\n\n Int Mobilogram::findNearest(CoordinateType mb, CoordinateType tolerance) const\n {\n if (empty())\n {\n return -1;\n }\n Size i = findNearest(mb);\n const double found_mb = this->operator[](i).getMobility();\n if (found_mb >= mb - tolerance && found_mb <= mb + tolerance)\n {\n return static_cast<Int>(i);\n }\n else\n {\n return -1;\n }\n }\n\n Int Mobilogram::findNearest(CoordinateType mb, CoordinateType tolerance_left, CoordinateType tolerance_right) const\n {\n if (empty())\n {\n return -1;\n }\n // do a binary search for nearest peak first\n Size i = findNearest(mb);\n\n const double nearest_mb = data_[i].getMobility();\n\n if (nearest_mb < mb)\n {\n if (nearest_mb >= mb - tolerance_left)\n {\n return i; // success: nearest peak is in left tolerance window\n }\n else\n {\n if (i == this->size() - 1)\n {\n return -1; // we are at the last peak which is too far left\n }\n // Nearest peak is too far left so there can't be a closer peak in the left window.\n // There still might be a peak to the right of mz that falls in the right window\n ++i; // now we are at a peak exactly on or to the right of mz\n const double next_mz = data_[i].getMobility();\n if (next_mz <= mb + tolerance_right)\n {\n return i;\n }\n }\n }\n else\n {\n if (nearest_mb <= mb + tolerance_right)\n {\n return i; // success: nearest peak is in right tolerance window\n }\n else\n {\n if (i == 0)\n {\n return -1; // we are at the first peak which is too far right\n }\n --i; // now we are at a peak exactly on or to the right of mz\n const double next_mz = data_[i].getMobility();\n if (next_mz >= mb - tolerance_left)\n {\n return i;\n }\n }\n }\n\n // neither in the left nor the right tolerance window\n return -1;\n }\n\n Int Mobilogram::findHighestInWindow(CoordinateType mb, CoordinateType tolerance_left, CoordinateType tolerance_right) const\n {\n if (empty())\n {\n return -1;\n }\n // get left/right iterator\n auto left = this->MBBegin(mb - tolerance_left);\n auto right = this->MBEnd(mb + tolerance_right);\n\n if (left == right)\n {\n return -1;\n }\n\n auto max_intensity_it = std::max_element(left, right, MobilityPeak1D::IntensityLess());\n\n // find peak (index) with highest intensity to expected position\n return max_intensity_it - this->begin();\n }\n\n Mobilogram::Iterator Mobilogram::MBBegin(CoordinateType mb)\n {\n PeakType p;\n p.setPosition(mb);\n return lower_bound(begin(), end(), p, PeakType::PositionLess());\n }\n\n Mobilogram::Iterator Mobilogram::MBBegin(Iterator begin, CoordinateType mb, Iterator end)\n {\n PeakType p;\n p.setPosition(mb);\n return lower_bound(begin, end, p, PeakType::PositionLess());\n }\n\n Mobilogram::Iterator Mobilogram::MBEnd(CoordinateType mb)\n {\n PeakType p;\n p.setPosition(mb);\n return upper_bound(begin(), end(), p, PeakType::PositionLess());\n }\n\n Mobilogram::Iterator Mobilogram::MBEnd(Iterator begin, CoordinateType mb, Iterator end)\n {\n PeakType p;\n p.setPosition(mb);\n return upper_bound(begin, end, p, PeakType::PositionLess());\n }\n\n Mobilogram::ConstIterator Mobilogram::MBBegin(CoordinateType mb) const\n {\n PeakType p;\n p.setPosition(mb);\n return lower_bound(cbegin(), cend(), p, PeakType::PositionLess());\n }\n\n Mobilogram::ConstIterator Mobilogram::MBBegin(ConstIterator begin, CoordinateType mb, ConstIterator end) const\n {\n PeakType p;\n p.setPosition(mb);\n return lower_bound(begin, end, p, PeakType::PositionLess());\n }\n\n Mobilogram::ConstIterator Mobilogram::MBEnd(CoordinateType mb) const\n {\n PeakType p;\n p.setPosition(mb);\n return upper_bound(cbegin(), cend(), p, PeakType::PositionLess());\n }\n\n Mobilogram::ConstIterator Mobilogram::MBEnd(ConstIterator begin, CoordinateType mb, ConstIterator end) const\n {\n PeakType p;\n p.setPosition(mb);\n return upper_bound(begin, end, p, PeakType::PositionLess());\n }\n\n Mobilogram::Iterator Mobilogram::PosBegin(CoordinateType mz)\n {\n return MBBegin(mz);\n }\n\n Mobilogram::Iterator Mobilogram::PosBegin(Iterator begin, CoordinateType mb, Iterator end)\n {\n return MBBegin(begin, mb, end);\n }\n\n Mobilogram::ConstIterator Mobilogram::PosBegin(CoordinateType mb) const\n {\n return MBBegin(mb);\n }\n\n Mobilogram::ConstIterator Mobilogram::PosBegin(ConstIterator begin, CoordinateType mb, ConstIterator end) const\n {\n return MBBegin(begin, mb, end);\n }\n\n Mobilogram::Iterator Mobilogram::PosEnd(CoordinateType mb)\n {\n return MBEnd(mb);\n }\n\n Mobilogram::Iterator Mobilogram::PosEnd(Iterator begin, CoordinateType mb, Iterator end)\n {\n return MBEnd(begin, mb, end);\n }\n\n Mobilogram::ConstIterator Mobilogram::PosEnd(CoordinateType mb) const\n {\n return MBEnd(mb);\n }\n\n Mobilogram::ConstIterator Mobilogram::PosEnd(ConstIterator begin, CoordinateType mb, ConstIterator end) const\n {\n return MBEnd(begin, mb, end);\n }\n\n void Mobilogram::clear() noexcept\n {\n data_.clear();\n RangeManager::clearRanges();\n }\n\n Mobilogram::ConstIterator Mobilogram::getBasePeak() const\n {\n ConstIterator largest = cbegin();\n if (empty())\n {\n return largest;\n }\n ConstIterator current = cbegin();\n ++current;\n for (; current != cend(); ++current)\n {\n if (largest->getIntensity() < current->getIntensity())\n {\n largest = current;\n }\n }\n return largest;\n }\n\n Mobilogram::Iterator Mobilogram::getBasePeak()\n {\n ConstIterator largest = const_cast<const Mobilogram&>(*this).getBasePeak();\n return begin() + std::distance(cbegin(), largest);\n }\n\n MobilityPeak1D::IntensityType Mobilogram::calculateTIC() const\n {\n return std::accumulate(cbegin(), cend(), 0.0f, [](PeakType::IntensityType sum, const PeakType& p) { return sum + p.getIntensity(); });\n }\n\n std::ostream& operator<<(std::ostream& os, const Mobilogram& mb)\n {\n os << \"-- MOBILOGRAM BEGIN --\\n\";\n\n // peaklist\n for (const auto& peak : mb)\n {\n os << peak << '\\n';\n }\n\n os << \"-- MOBILOGRAM END --\\n\";\n return os;\n }\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9365,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/ChromatogramTools.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":514,"string":"514"},"line_count":{"kind":"number","value":18,"string":"18"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg $\n// $Authors: Andreas Bertsch $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/ChromatogramTools.h>\n\n\nusing namespace std;\n\nnamespace OpenMS\n{\n ChromatogramTools default_chromatogramtools_mschromatogram_peakmap;\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9366,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/MSChromatogram.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":14344,"string":"14,344"},"line_count":{"kind":"number","value":498,"string":"498"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg $\n// $Authors: Andreas Bertsch $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/config.h>\n#include <OpenMS/CONCEPT/LogStream.h>\n\n#include <OpenMS/KERNEL/MSChromatogram.h>\n\nusing namespace OpenMS;\n\nstd::ostream& OpenMS::operator<<(std::ostream& os, const MSChromatogram& chrom)\n{\n os << \"-- MSCHROMATOGRAM BEGIN --\" << std::endl;\n\n //chromatogram settings\n os << static_cast<const ChromatogramSettings&>(chrom);\n\n //data list\n for (const ChromatogramPeak& pe : chrom)\n {\n os << pe << std::endl;\n }\n\n os << \"-- MSCHROMATOGRAM END --\" << std::endl;\n\n return os;\n}\n\nbool MSChromatogram::MZLess::operator()(const MSChromatogram &a, const MSChromatogram &b) const\n{\n return a.getMZ() < b.getMZ();\n}\n\nMSChromatogram &MSChromatogram::operator=(const MSChromatogram &source)\n{\n if (&source == this)\n {\n return *this;\n }\n\n RangeManagerType::operator=(source);\n ContainerType::operator=(source);\n ChromatogramSettings::operator=(source);\n\n name_ = source.name_;\n float_data_arrays_ = source.float_data_arrays_;\n string_data_arrays_ = source.string_data_arrays_;\n integer_data_arrays_ = source.integer_data_arrays_;\n\n return *this;\n}\n\nbool MSChromatogram::operator==(const MSChromatogram &rhs) const\n{\n //name_ can differ => it is not checked; also ranges are not checked\n return std::operator==(*this, rhs) &&\n ChromatogramSettings::operator==(rhs) &&\n float_data_arrays_ == rhs.float_data_arrays_ &&\n string_data_arrays_ == rhs.string_data_arrays_ &&\n integer_data_arrays_ == rhs.integer_data_arrays_;\n}\n\nconst String &MSChromatogram::getName() const\n{\n return name_;\n}\n\nvoid MSChromatogram::setName(const String &name)\n{\n name_ = name;\n}\n\ndouble MSChromatogram::getMZ() const\n{\n return getProduct().getMZ();\n}\n\nconst MSChromatogram::FloatDataArrays &MSChromatogram::getFloatDataArrays() const\n{\n return float_data_arrays_;\n}\n\nMSChromatogram::FloatDataArrays &MSChromatogram::getFloatDataArrays()\n{\n return float_data_arrays_;\n}\n\nconst MSChromatogram::StringDataArrays &MSChromatogram::getStringDataArrays() const\n{\n return string_data_arrays_;\n}\n\nMSChromatogram::StringDataArrays &MSChromatogram::getStringDataArrays()\n{\n return string_data_arrays_;\n}\n\nconst MSChromatogram::IntegerDataArrays &MSChromatogram::getIntegerDataArrays() const\n{\n return integer_data_arrays_;\n}\n\nMSChromatogram::IntegerDataArrays &MSChromatogram::getIntegerDataArrays()\n{\n return integer_data_arrays_;\n}\n\nvoid MSChromatogram::sortByIntensity(bool reverse) {\n if (float_data_arrays_.empty() && !string_data_arrays_.empty() && !integer_data_arrays_.empty())\n {\n if (reverse)\n {\n std::sort(ContainerType::begin(), ContainerType::end(), [](auto &left, auto &right) {PeakType::IntensityLess cmp; return cmp(right, left);});\n }\n else\n {\n std::sort(ContainerType::begin(), ContainerType::end(), PeakType::IntensityLess());\n }\n }\n else\n {\n //sort index list\n std::vector<std::pair<PeakType::IntensityType, Size> > sorted_indices;\n sorted_indices.reserve(ContainerType::size());\n for (Size i = 0; i < ContainerType::size(); ++i)\n {\n sorted_indices.emplace_back(ContainerType::operator[](i).getIntensity(), i);\n }\n\n if (reverse)\n {\n std::sort(sorted_indices.begin(), sorted_indices.end(), [](auto& left, auto& right){return left > right;});\n }\n else\n {\n std::sort(sorted_indices.begin(), sorted_indices.end());\n }\n\n //apply sorting to ContainerType and to meta data arrays\n ContainerType tmp;\n for (Size i = 0; i < sorted_indices.size(); ++i)\n {\n tmp.push_back(*(ContainerType::begin() + (sorted_indices[i].second)));\n }\n ContainerType::swap(tmp);\n\n for (Size i = 0; i < float_data_arrays_.size(); ++i)\n {\n std::vector<float> mda_tmp;\n for (Size j = 0; j < float_data_arrays_[i].size(); ++j)\n {\n mda_tmp.push_back(*(float_data_arrays_[i].begin() + (sorted_indices[j].second)));\n }\n mda_tmp.swap(float_data_arrays_[i]);\n }\n\n for (Size i = 0; i < string_data_arrays_.size(); ++i)\n {\n std::vector<String> mda_tmp;\n for (Size j = 0; j < string_data_arrays_[i].size(); ++j)\n {\n mda_tmp.push_back(*(string_data_arrays_[i].begin() + (sorted_indices[j].second)));\n }\n mda_tmp.swap(string_data_arrays_[i]);\n }\n\n for (Size i = 0; i < integer_data_arrays_.size(); ++i)\n {\n std::vector<Int> mda_tmp;\n for (Size j = 0; j < integer_data_arrays_[i].size(); ++j)\n {\n mda_tmp.push_back(*(integer_data_arrays_[i].begin() + (sorted_indices[j].second)));\n }\n mda_tmp.swap(integer_data_arrays_[i]);\n }\n }\n}\n\nvoid MSChromatogram::sortByPosition()\n{\n if (float_data_arrays_.empty())\n {\n std::sort(ContainerType::begin(), ContainerType::end(), PeakType::PositionLess());\n }\n else\n {\n //sort index list\n std::vector<std::pair<PeakType::PositionType, Size> > sorted_indices;\n sorted_indices.reserve(ContainerType::size());\n for (Size i = 0; i < ContainerType::size(); ++i)\n {\n sorted_indices.emplace_back(ContainerType::operator[](i).getPosition(), i);\n }\n std::sort(sorted_indices.begin(), sorted_indices.end());\n\n //apply sorting to ContainerType and to metadataarrays\n ContainerType tmp;\n for (Size i = 0; i < sorted_indices.size(); ++i)\n {\n tmp.push_back(*(ContainerType::begin() + (sorted_indices[i].second)));\n }\n ContainerType::swap(tmp);\n\n for (Size i = 0; i < float_data_arrays_.size(); ++i)\n {\n std::vector<float> mda_tmp;\n for (Size j = 0; j < float_data_arrays_[i].size(); ++j)\n {\n mda_tmp.push_back(*(float_data_arrays_[i].begin() + (sorted_indices[j].second)));\n }\n std::swap(float_data_arrays_[i], mda_tmp);\n }\n\n for (Size i = 0; i < string_data_arrays_.size(); ++i)\n {\n std::vector<String> mda_tmp;\n for (Size j = 0; j < string_data_arrays_[i].size(); ++j)\n {\n mda_tmp.push_back(*(string_data_arrays_[i].begin() + (sorted_indices[j].second)));\n }\n std::swap(string_data_arrays_[i], mda_tmp);\n }\n\n for (Size i = 0; i < integer_data_arrays_.size(); ++i)\n {\n std::vector<Int> mda_tmp;\n for (Size j = 0; j < integer_data_arrays_[i].size(); ++j)\n {\n mda_tmp.push_back(*(integer_data_arrays_[i].begin() + (sorted_indices[j].second)));\n }\n std::swap(integer_data_arrays_[i], mda_tmp);\n }\n }\n}\n\nbool MSChromatogram::isSorted() const\n{\n for (Size i = 1; i < this->size(); ++i)\n {\n if (this->operator[](i - 1).getRT() > this->operator[](i).getRT())\n {\n return false;\n }\n }\n return true;\n}\n\nSize MSChromatogram::findNearest(MSChromatogram::CoordinateType rt) const\n{\n //no peak => no search\n if (empty())\n {\n throw Exception::Precondition(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"There must be at least one peak to determine the nearest peak!\");\n }\n //search for position for inserting\n ConstIterator it = RTBegin(rt);\n //border cases\n if (it == ContainerType::begin())\n {\n return 0;\n }\n if (it == ContainerType::end())\n {\n return ContainerType::size() - 1;\n }\n //the peak before or the current peak are closest\n ConstIterator it2 = it;\n --it2;\n if (std::fabs(it->getRT() - rt) < std::fabs(it2->getRT() - rt))\n {\n return Size(it - ContainerType::begin());\n }\n else\n {\n return Size(it2 - ContainerType::begin());\n }\n}\n\nMSChromatogram::Iterator MSChromatogram::RTBegin(MSChromatogram::CoordinateType rt)\n{\n PeakType p;\n p.setPosition(rt);\n return lower_bound(ContainerType::begin(), ContainerType::end(), p, PeakType::PositionLess());\n}\n\nMSChromatogram::Iterator\nMSChromatogram::RTBegin(MSChromatogram::Iterator begin, MSChromatogram::CoordinateType rt, MSChromatogram::Iterator end)\n{\n PeakType p;\n p.setPosition(rt);\n return lower_bound(begin, end, p, PeakType::PositionLess());\n}\n\nMSChromatogram::Iterator MSChromatogram::RTEnd(MSChromatogram::CoordinateType rt)\n{\n PeakType p;\n p.setPosition(rt);\n return upper_bound(ContainerType::begin(), ContainerType::end(), p, PeakType::PositionLess());\n}\n\nMSChromatogram::Iterator\nMSChromatogram::RTEnd(MSChromatogram::Iterator begin, MSChromatogram::CoordinateType rt, MSChromatogram::Iterator end)\n{\n PeakType p;\n p.setPosition(rt);\n return upper_bound(begin, end, p, PeakType::PositionLess());\n}\n\nMSChromatogram::ConstIterator MSChromatogram::RTBegin(MSChromatogram::CoordinateType rt) const\n{\n PeakType p;\n p.setPosition(rt);\n return lower_bound(ContainerType::begin(), ContainerType::end(), p, PeakType::PositionLess());\n}\n\nMSChromatogram::ConstIterator\nMSChromatogram::RTBegin(MSChromatogram::ConstIterator begin, MSChromatogram::CoordinateType rt,\n MSChromatogram::ConstIterator end) const\n{\n PeakType p;\n p.setPosition(rt);\n return lower_bound(begin, end, p, PeakType::PositionLess());\n}\n\nMSChromatogram::ConstIterator MSChromatogram::RTEnd(MSChromatogram::CoordinateType rt) const\n{\n PeakType p;\n p.setPosition(rt);\n return upper_bound(ContainerType::begin(), ContainerType::end(), p, PeakType::PositionLess());\n}\n\nMSChromatogram::ConstIterator\nMSChromatogram::RTEnd(MSChromatogram::ConstIterator begin, MSChromatogram::CoordinateType rt,\n MSChromatogram::ConstIterator end) const\n{\n PeakType p;\n p.setPosition(rt);\n return upper_bound(begin, end, p, PeakType::PositionLess());\n}\n\nMSChromatogram::Iterator MSChromatogram::PosBegin(MSChromatogram::CoordinateType rt)\n{\n return RTBegin(rt);\n}\n\nMSChromatogram::Iterator\nMSChromatogram::PosBegin(MSChromatogram::Iterator begin, MSChromatogram::CoordinateType rt, MSChromatogram::Iterator end)\n{\n return RTBegin(begin, rt, end);\n}\n\n\nMSChromatogram::Iterator\nMSChromatogram::PosEnd(MSChromatogram::Iterator begin, MSChromatogram::CoordinateType rt, MSChromatogram::Iterator end)\n{\n return RTEnd(begin, rt, end);\n}\n\nMSChromatogram::ConstIterator MSChromatogram::PosBegin(MSChromatogram::CoordinateType rt) const\n{\n return RTBegin(rt);\n}\n\nMSChromatogram::ConstIterator\nMSChromatogram::PosBegin(MSChromatogram::ConstIterator begin, MSChromatogram::CoordinateType rt, MSChromatogram::ConstIterator end) const\n{\n return RTBegin(begin, rt, end);\n}\n\nMSChromatogram::ConstIterator\nMSChromatogram::PosEnd(MSChromatogram::ConstIterator begin, MSChromatogram::CoordinateType rt, MSChromatogram::ConstIterator end) const\n{\n return RTEnd(begin, rt, end);\n}\n\nMSChromatogram::Iterator MSChromatogram::PosEnd(MSChromatogram::CoordinateType rt)\n{\n return RTEnd(rt);\n}\n\nMSChromatogram::ConstIterator MSChromatogram::PosEnd(MSChromatogram::CoordinateType rt) const \n{\n return RTEnd(rt);\n}\n\nvoid MSChromatogram::clear(bool clear_meta_data)\n{\n ContainerType::clear();\n\n if (clear_meta_data)\n {\n clearRanges();\n this->ChromatogramSettings::operator=(ChromatogramSettings()); // no \"clear\" method\n name_.clear();\n float_data_arrays_.clear();\n string_data_arrays_.clear();\n integer_data_arrays_.clear();\n }\n}\n\n// This helper function is based on the cstd::set_union implementation. It is different in that it has a separate concept of \"close enough to merge\"\n// This is defined as having retention times of within 1/1000 seconds\n// Note: We assume that RTs are distinct in each of the two Chromatograms but may be the same between Chromatograms.\nOpenMS::MSChromatogram::Iterator setSumSimilarUnion(OpenMS::MSChromatogram::Iterator first1,\n OpenMS::MSChromatogram::Iterator last1,\n OpenMS::MSChromatogram::Iterator first2,\n OpenMS::MSChromatogram::Iterator last2,\n OpenMS::MSChromatogram::Iterator result)\n{\n while (true)\n {\n if (first1 == last1)\n {\n return std::copy(first2,last2,result);\n }\n if (first2 == last2)\n {\n return std::copy(first1,last1,result);\n }\n auto smaller_RT = [](OpenMS::MSChromatogram::Iterator a, OpenMS::MSChromatogram::Iterator b)->bool\n {\n return round(a->getRT() * 1000.0) < round(b->getRT() * 1000.0);\n };\n\n if (smaller_RT(first1, first2))\n {\n *result = *first1; ++first1;\n }\n else if (smaller_RT(first2, first1))\n {\n *result = *first2; ++first2;\n }\n else\n { // approx. equal\n *result = *first1;\n result->setIntensity(result->getIntensity() + first2->getIntensity());\n ++first1;\n ++first2;\n }\n ++result;\n }\n}\n\nvoid MSChromatogram::updateRanges()\n{\n #ifdef OPENMS_ASSERTIONS\n double rt_min = RangeRT::isEmpty() ? 0 : getMinRT();\n double rt_max = RangeRT::isEmpty() ? 0 : getMaxRT();\n double int_min = RangeIntensity::isEmpty() ? 0 : getMinIntensity();\n double int_max = RangeIntensity::isEmpty() ? 0 : getMaxIntensity();\n #endif\n\n clearRanges();\n for (const auto& peak : (ContainerType&) *this)\n {\n extendRT(peak.getRT());\n extendIntensity(peak.getIntensity());\n }\n\n #ifdef OPENMS_ASSERTIONS\n double rt_min_new = RangeRT::isEmpty() ? 0 : getMinRT();\n double rt_max_new = RangeRT::isEmpty() ? 0 : getMaxRT();\n double int_min_new = RangeIntensity::isEmpty() ? 0 : getMinIntensity();\n double int_max_new = RangeIntensity::isEmpty() ? 0 : getMaxIntensity();\n\n // check if all are equal and no update range was necessary\n if (rt_min_new == rt_min && rt_max_new == rt_max\n && int_min_new == int_min && int_max_new == int_max)\n {\n OPENMS_LOG_WARN << \"Update ranges was called but ranges were already up-to-date\" << std::endl;\n }\n #endif\n}\n\nvoid MSChromatogram::mergePeaks(MSChromatogram& other, bool add_meta)\n{\n vector<ChromatogramPeak> temp;\n temp.resize(size() + other.size());\n auto new_end = setSumSimilarUnion(begin(), end(), other.begin(), other.end(), temp.begin());\n ContainerType::assign(temp.begin(), new_end);\n\n if (add_meta)\n {\n DoubleList ls;\n if (metaValueExists(Constants::UserParam::MERGED_CHROMATOGRAM_MZS))\n {\n ls = getMetaValue(Constants::UserParam::MERGED_CHROMATOGRAM_MZS).toDoubleList();\n }\n ls.push_back(other.getMZ());\n setMetaValue(Constants::UserParam::MERGED_CHROMATOGRAM_MZS, ls);\n }\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9367,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/BaseFeature.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":6976,"string":"6,976"},"line_count":{"kind":"number","value":262,"string":"262"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Hendrik Weisser $\n// $Authors: Hendrik Weisser, Chris Bielow $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/BaseFeature.h>\n#include <OpenMS/KERNEL/FeatureHandle.h>\n\nusing namespace std;\n\nnamespace OpenMS\n{\n const std::string BaseFeature::NamesOfAnnotationState[] =\n {\"no ID\", \"single ID\", \"multiple IDs (identical)\", \"multiple IDs (divergent)\"};\n\n\n BaseFeature::BaseFeature() :\n RichPeak2D(), quality_(0.0), charge_(0), width_(0)\n {\n }\n\n BaseFeature::BaseFeature(const BaseFeature& rhs, UInt64 map_index) :\n RichPeak2D(rhs), quality_(rhs.quality_), charge_(rhs.charge_), width_(rhs.width_),\n peptides_(rhs.peptides_), primary_id_(rhs.primary_id_), id_matches_(rhs.id_matches_)\n {\n for (auto& pep : this->peptides_)\n {\n pep.setMetaValue(\"map_index\", map_index);\n }\n }\n\n BaseFeature::BaseFeature(const RichPeak2D& point) :\n RichPeak2D(point), quality_(0.0), charge_(0), width_(0)\n {\n }\n\n BaseFeature::BaseFeature(const FeatureHandle& fh) :\n RichPeak2D(fh),\n quality_(0.0),\n charge_(fh.getCharge()),\n width_(fh.getWidth()),\n peptides_()\n {\n }\n\n BaseFeature::BaseFeature(const Peak2D& point) :\n RichPeak2D(point), quality_(0.0), charge_(0), width_(0)\n {\n }\n\n bool BaseFeature::operator==(const BaseFeature& rhs) const\n {\n return RichPeak2D::operator==(rhs)\n && (quality_ == rhs.quality_)\n && (charge_ == rhs.charge_)\n && (width_ == rhs.width_)\n && (peptides_ == rhs.peptides_)\n && (primary_id_ == rhs.primary_id_)\n && (id_matches_ == rhs.id_matches_);\n }\n\n bool BaseFeature::operator!=(const BaseFeature& rhs) const\n {\n return !operator==(rhs);\n }\n\n BaseFeature::~BaseFeature() = default;\n\n BaseFeature::QualityType BaseFeature::getQuality() const\n {\n return quality_;\n }\n\n void BaseFeature::setQuality(BaseFeature::QualityType quality)\n {\n quality_ = quality;\n }\n\n BaseFeature::WidthType BaseFeature::getWidth() const\n {\n return width_;\n }\n\n void BaseFeature::setWidth(BaseFeature::WidthType fwhm)\n {\n // !!! Dirty hack: as long as featureXML doesn't support a width field,\n // we abuse the meta information for this.\n // See also FeatureXMLFile::readFeature_().\n width_ = fwhm;\n setMetaValue(\"FWHM\", fwhm);\n }\n\n const BaseFeature::ChargeType& BaseFeature::getCharge() const\n {\n return charge_;\n }\n\n void BaseFeature::setCharge(const BaseFeature::ChargeType& charge)\n {\n charge_ = charge;\n }\n\n const PeptideIdentificationList& BaseFeature::getPeptideIdentifications()\n const\n {\n return peptides_;\n }\n\n PeptideIdentificationList& BaseFeature::getPeptideIdentifications()\n {\n return peptides_;\n }\n\n void BaseFeature::setPeptideIdentifications(\n const PeptideIdentificationList& peptides)\n {\n peptides_ = peptides;\n }\n\n void BaseFeature::sortPeptideIdentifications()\n {\n std::sort(peptides_.rbegin(),peptides_.rend(),\n [](PeptideIdentification& p1, PeptideIdentification& p2)\n {p1.sort();p2.sort();\n if (p1.empty())\n {\n return true;\n }\n if (p2.empty())\n {\n return false;\n }\n if (p1.isHigherScoreBetter())\n {\n return p1.getHits()[0].getScore() < p2.getHits()[0].getScore();\n }\n else\n {\n return p1.getHits()[0].getScore() > p2.getHits()[0].getScore();\n }});\n }\n\n BaseFeature::AnnotationState BaseFeature::getAnnotationState() const\n {\n if (id_matches_.empty()) // consider IDs in old format\n {\n if (peptides_.empty())\n {\n return AnnotationState::FEATURE_ID_NONE;\n }\n if (peptides_.size() == 1 && !peptides_[0].getHits().empty())\n {\n return AnnotationState::FEATURE_ID_SINGLE;\n }\n std::set<String> seqs;\n for (Size i = 0; i < peptides_.size(); ++i)\n {\n if (!peptides_[i].getHits().empty())\n {\n PeptideIdentification id_tmp = peptides_[i];\n id_tmp.sort(); // look at best hit only - requires sorting\n seqs.insert(id_tmp.getHits()[0].getSequence().toString());\n }\n }\n if (seqs.size() == 1)\n {\n return AnnotationState::FEATURE_ID_MULTIPLE_SAME; // hits have identical seqs\n }\n if (seqs.size() > 1)\n {\n return AnnotationState::FEATURE_ID_MULTIPLE_DIVERGENT; // multiple different annotations ... probably bad mapping\n }\n /*else if (seqs.size()==0)*/\n return AnnotationState::FEATURE_ID_NONE; // very rare case of empty hits\n }\n else // consider IDs in new format\n {\n if (id_matches_.size() == 1)\n {\n return AnnotationState::FEATURE_ID_SINGLE;\n }\n // if there are multiple IDs, check if all are equal (to the first):\n auto it = id_matches_.begin();\n IdentificationData::IdentifiedMolecule molecule = (*it)->identified_molecule_var;\n for (++it; it != id_matches_.end(); ++it)\n {\n if ((*it)->identified_molecule_var != molecule)\n {\n return AnnotationState::FEATURE_ID_MULTIPLE_DIVERGENT;\n }\n }\n return AnnotationState::FEATURE_ID_MULTIPLE_SAME;\n }\n }\n\n\n bool BaseFeature::hasPrimaryID() const\n {\n return bool(primary_id_);\n }\n\n\n const IdentificationData::IdentifiedMolecule& BaseFeature::getPrimaryID() const\n {\n if (!primary_id_)\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION,\n \"no primary ID assigned\");\n }\n\n return *primary_id_; // unpack the option\n }\n\n\n void BaseFeature::clearPrimaryID()\n {\n primary_id_ = nullopt;\n }\n\n\n void BaseFeature::setPrimaryID(const IdentificationData::IdentifiedMolecule& id)\n {\n primary_id_ = id;\n }\n\n\n const std::set<IdentificationData::ObservationMatchRef>& BaseFeature::getIDMatches() const\n {\n return id_matches_;\n }\n\n\n std::set<IdentificationData::ObservationMatchRef>& BaseFeature::getIDMatches()\n {\n return id_matches_;\n }\n\n\n void BaseFeature::addIDMatch(IdentificationData::ObservationMatchRef ref)\n {\n id_matches_.insert(ref);\n }\n\n void BaseFeature::updateIDReferences(const IdentificationData::RefTranslator& trans)\n {\n if (primary_id_ != nullopt) // is feature annotated with a \"primary ID\"?\n {\n primary_id_ = trans.translate(*primary_id_);\n }\n set<IdentificationData::ObservationMatchRef> matches; // refs. to e.g. PSMs\n matches.swap(id_matches_);\n for (const auto& item : matches)\n {\n id_matches_.insert(trans.translate(item));\n }\n }\n\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9368,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/RichPeak2D.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":370,"string":"370"},"line_count":{"kind":"number","value":13,"string":"13"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg$\n// $Authors: Marc Sturm $\n// --------------------------------------------------------------------------\n\nnamespace OpenMS\n{\n\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9369,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/AreaIterator.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":370,"string":"370"},"line_count":{"kind":"number","value":13,"string":"13"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg$\n// $Authors: Marc Sturm $\n// --------------------------------------------------------------------------\n\nnamespace OpenMS\n{\n\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9370,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/MRMFeature.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":7015,"string":"7,015"},"line_count":{"kind":"number","value":194,"string":"194"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Hannes Roest $\n// $Authors: Hannes Roest $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/MRMFeature.h>\n\nnamespace OpenMS\n{\n\n MRMFeature::MRMFeature() :\n Feature()\n {\n }\n\n /// Copy constructor\n MRMFeature::MRMFeature(const MRMFeature & rhs) :\n Feature(rhs),\n features_(rhs.features_),\n precursor_features_(rhs.precursor_features_),\n pg_scores_(rhs.pg_scores_),\n feature_map_(rhs.feature_map_),\n precursor_feature_map_(rhs.precursor_feature_map_)\n {\n setScores(rhs.getScores());\n }\n\n /// Assignment operator\n MRMFeature & MRMFeature::operator = (const MRMFeature &rhs)\n {\n if (&rhs == this)\n {\n return *this;\n }\n Feature::operator = (rhs);\n setScores(rhs.getScores());\n features_ = rhs.features_;\n precursor_features_ = rhs.precursor_features_;\n feature_map_ = rhs.feature_map_;\n precursor_feature_map_ = rhs.precursor_feature_map_;\n\n return *this;\n }\n\n MRMFeature::~MRMFeature() = default;\n\n const OpenSwath_Scores & MRMFeature::getScores() const\n {\n return pg_scores_;\n }\n\n OpenSwath_Scores & MRMFeature::getScores()\n {\n return pg_scores_;\n }\n\n void MRMFeature::setScores(const OpenSwath_Scores & scores)\n {\n pg_scores_ = scores;\n }\n\n void MRMFeature::addScore(const String & score_name, double score)\n {\n setMetaValue(score_name, score);\n }\n\n void MRMFeature::addFeature(const Feature & feature, const String& key)\n {\n features_.push_back(feature);\n feature_map_[key] = Int(features_.size()) - 1;\n }\n\n void MRMFeature::addFeature(Feature && feature, const String& key)\n {\n features_.push_back(std::move(feature));\n feature_map_[key] = Int(features_.size()) - 1;\n }\n\n Feature & MRMFeature::getFeature(const String& key) \n {\n return features_.at(feature_map_[key]);\n }\n\n const Feature & MRMFeature::getFeature(const String& key) const \n {\n return features_.at(feature_map_.at(key));\n }\n\n const std::vector<Feature> & MRMFeature::getFeatures() const\n {\n return features_;\n }\n\n void MRMFeature::getFeatureIDs(std::vector<String> & result) const\n {\n for (std::map<String, int>::const_iterator it = feature_map_.begin(); it != feature_map_.end(); ++it)\n {\n result.push_back(it->first);\n }\n }\n\n void MRMFeature::addPrecursorFeature(const Feature & feature, const String& key)\n {\n precursor_features_.push_back(feature);\n precursor_feature_map_[key] = Int(precursor_features_.size()) - 1;\n }\n\n void MRMFeature::addPrecursorFeature(Feature && feature, const String& key)\n {\n precursor_features_.push_back(std::move(feature));\n precursor_feature_map_[key] = Int(precursor_features_.size()) - 1;\n }\n\n void MRMFeature::getPrecursorFeatureIDs(std::vector<String> & result) const\n {\n for (std::map<String, int>::const_iterator it = precursor_feature_map_.begin(); it != precursor_feature_map_.end(); ++it)\n {\n result.push_back(it->first);\n }\n }\n\n Feature & MRMFeature::getPrecursorFeature(const String& key)\n {\n return precursor_features_.at(precursor_feature_map_[key]);\n }\n\n const Feature & MRMFeature::getPrecursorFeature(const String& key) const\n {\n return precursor_features_.at(precursor_feature_map_.at(key));\n }\n\n void MRMFeature::IDScoresAsMetaValue(bool decoy, const OpenSwath_Ind_Scores& idscores)\n {\n String id = \"id_target_\";\n if (decoy)\n {\n id = \"id_decoy_\";\n }\n setMetaValue(id + \"transition_names\", idscores.ind_transition_names);\n setMetaValue(id + \"num_transitions\", idscores.ind_num_transitions);\n setMetaValue(id + \"area_intensity\", idscores.ind_area_intensity);\n setMetaValue(id + \"total_area_intensity\", idscores.ind_total_area_intensity);\n setMetaValue(id + \"intensity_score\", idscores.ind_intensity_score);\n setMetaValue(id + \"intensity_ratio_score\", idscores.ind_intensity_ratio);\n setMetaValue(id + \"apex_intensity\", idscores.ind_apex_intensity);\n setMetaValue(id + \"peak_apex_position\", idscores.ind_apex_position);\n setMetaValue(id + \"width_at_50\", idscores.ind_fwhm);\n setMetaValue(id + \"total_mi\", idscores.ind_total_mi);\n setMetaValue(id + \"transition_names\", idscores.ind_transition_names);\n setMetaValue(id + \"ind_log_intensity\", idscores.ind_log_intensity);\n setMetaValue(id + \"ind_xcorr_coelution\", idscores.ind_xcorr_coelution_score);\n setMetaValue(id + \"ind_xcorr_shape\", idscores.ind_xcorr_shape_score);\n setMetaValue(id + \"ind_log_sn_score\", idscores.ind_log_sn_score);\n setMetaValue(id + \"ind_isotope_correlation\", idscores.ind_isotope_correlation);\n setMetaValue(id + \"ind_isotope_overlap\", idscores.ind_isotope_overlap);\n setMetaValue(id + \"ind_massdev_score\", idscores.ind_massdev_score);\n setMetaValue(id + \"ind_mi_score\", idscores.ind_mi_score);\n setMetaValue(id + \"ind_mi_ratio_score\", idscores.ind_mi_ratio);\n\n // Ion mobility scores\n setMetaValue(id + \"ind_im_drift\", idscores.ind_im_drift);\n setMetaValue(id + \"ind_im_drift_left\", idscores.ind_im_drift_left);\n setMetaValue(id + \"ind_im_drift_right\", idscores.ind_im_drift_right);\n setMetaValue(id + \"ind_im_delta\", idscores.ind_im_delta);\n setMetaValue(id + \"ind_im_delta_score\", idscores.ind_im_delta_score);\n setMetaValue(id + \"ind_im_log_intensity\", idscores.ind_im_log_intensity);\n setMetaValue(id + \"ind_im_contrast_coelution\", idscores.ind_im_contrast_coelution);\n setMetaValue(id + \"ind_im_contrast_shape\", idscores.ind_im_contrast_shape);\n setMetaValue(id + \"ind_im_sum_contrast_coelution\", idscores.ind_im_sum_contrast_coelution);\n setMetaValue(id + \"ind_im_sum_contrast_shape\", idscores.ind_im_sum_contrast_shape);\n\n // peak shape metrics\n setMetaValue(id + \"ind_start_position_at_5\", idscores.ind_start_position_at_5);\n setMetaValue(id + \"ind_end_position_at_5\", idscores.ind_end_position_at_5);\n setMetaValue(id + \"ind_start_position_at_10\", idscores.ind_start_position_at_10);\n setMetaValue(id + \"ind_end_position_at_10\", idscores.ind_end_position_at_10);\n setMetaValue(id + \"ind_start_position_at_50\", idscores.ind_start_position_at_50);\n setMetaValue(id + \"ind_end_position_at_50\", idscores.ind_end_position_at_50);\n setMetaValue(id + \"ind_total_width\", idscores.ind_total_width);\n setMetaValue(id + \"ind_tailing_factor\", idscores.ind_tailing_factor);\n setMetaValue(id + \"ind_asymmetry_factor\", idscores.ind_asymmetry_factor);\n setMetaValue(id + \"ind_slope_of_baseline\", idscores.ind_slope_of_baseline);\n setMetaValue(id + \"ind_baseline_delta_2_height\", idscores.ind_baseline_delta_2_height);\n setMetaValue(id + \"ind_points_across_baseline\", idscores.ind_points_across_baseline);\n setMetaValue(id + \"ind_points_across_half_height\", idscores.ind_points_across_half_height);\n\n\n }\n}\n\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9371,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/ConversionHelper.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":3419,"string":"3,419"},"line_count":{"kind":"number","value":111,"string":"111"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg $\n// $Authors: $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/ConversionHelper.h>\n\nnamespace OpenMS\n{\n void MapConversion::convert(UInt64 const input_map_index,\n PeakMap& input_map,\n ConsensusMap& output_map,\n Size n)\n {\n output_map.clear(true);\n\n // see @todo above\n output_map.setUniqueId();\n\n input_map.updateRanges();\n if (n > input_map.getSize())\n {\n n = input_map.getSize();\n }\n output_map.reserve(n);\n std::vector<Peak2D> tmp;\n tmp.reserve(input_map.getSize());\n\n // TODO Avoid tripling the memory consumption by this call\n input_map.get2DData(tmp);\n\n std::partial_sort(tmp.begin(),\n tmp.begin() + n,\n tmp.end(),\n [](auto &left, auto &right) {Peak2D::IntensityLess cmp; return cmp(right, left);});\n\n for (Size element_index = 0; element_index < n; ++element_index)\n {\n output_map.push_back(ConsensusFeature(input_map_index,\n tmp[element_index],\n element_index));\n }\n\n output_map.getColumnHeaders()[input_map_index].size = n;\n output_map.updateRanges();\n }\n\n void MapConversion::convert(ConsensusMap const& input_map,\n const bool keep_uids,\n FeatureMap& output_map)\n {\n output_map.clear(true);\n output_map.resize(input_map.size());\n output_map.DocumentIdentifier::operator=(input_map);\n\n if (keep_uids)\n {\n output_map.UniqueIdInterface::operator=(input_map);\n }\n else\n {\n output_map.setUniqueId();\n }\n output_map.setProteinIdentifications(input_map.getProteinIdentifications());\n output_map.setUnassignedPeptideIdentifications(input_map.getUnassignedPeptideIdentifications());\n\n for (Size i = 0; i < input_map.size(); ++i)\n {\n Feature& f = output_map[i];\n const ConsensusFeature& c = input_map[i];\n f.BaseFeature::operator=(c);\n if (!keep_uids)\n {\n f.setUniqueId();\n }\n }\n\n output_map.updateRanges();\n }\n\n void MapConversion::convert(UInt64 const input_map_index,\n FeatureMap const& input_map,\n ConsensusMap& output_map,\n Size n)\n {\n if (n > input_map.size())\n {\n n = input_map.size();\n }\n\n output_map.clear(true);\n output_map.reserve(n);\n\n // An arguable design decision, see above.\n output_map.setUniqueId(input_map.getUniqueId());\n\n for (UInt64 element_index = 0; element_index < n; ++element_index)\n {\n output_map.push_back(ConsensusFeature(input_map_index, input_map[element_index]));\n }\n output_map.getColumnHeaders()[input_map_index].size = static_cast<Size>(input_map.size());\n output_map.setProteinIdentifications(input_map.getProteinIdentifications());\n output_map.setUnassignedPeptideIdentifications(input_map.getUnassignedPeptideIdentifications());\n output_map.updateRanges();\n }\n\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9372,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/FeatureHandle.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":2526,"string":"2,526"},"line_count":{"kind":"number","value":104,"string":"104"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg $\n// $Authors: $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/FeatureHandle.h>\n\n#include <OpenMS/KERNEL/BaseFeature.h>\n\nnamespace OpenMS\n{\n FeatureHandle::FeatureHandle() :\n Peak2D(),\n UniqueIdInterface(),\n map_index_(0),\n charge_(0),\n width_(0)\n {\n }\n\n FeatureHandle::FeatureHandle(UInt64 map_index, const Peak2D& point, UInt64 element_index) :\n Peak2D(point),\n map_index_(map_index),\n charge_(0),\n width_(0)\n {\n setUniqueId(element_index);\n }\n\n FeatureHandle::FeatureHandle(UInt64 map_index, const BaseFeature& feature) :\n Peak2D(feature),\n UniqueIdInterface(feature),\n map_index_(map_index),\n charge_(feature.getCharge()),\n width_(feature.getWidth())\n {\n }\n\n FeatureHandle::FeatureHandle(const FeatureHandle& rhs) = default;\n\n FeatureHandle& FeatureHandle::operator=(const FeatureHandle& rhs) = default;\n\n FeatureHandle::~FeatureHandle() = default;\n\n UInt64 FeatureHandle::getMapIndex() const\n {\n return map_index_;\n }\n\n void FeatureHandle::setMapIndex(UInt64 i)\n {\n map_index_ = i;\n }\n\n void FeatureHandle::setCharge(FeatureHandle::ChargeType charge)\n {\n charge_ = charge;\n }\n\n FeatureHandle::ChargeType FeatureHandle::getCharge() const\n {\n return charge_;\n }\n\n void FeatureHandle::setWidth(FeatureHandle::WidthType width)\n {\n width_ = width;\n }\n\n FeatureHandle::WidthType FeatureHandle::getWidth() const\n {\n return width_;\n }\n\n bool FeatureHandle::operator==(const FeatureHandle& i) const\n {\n return (Peak2D::operator==(i))\n && (UniqueIdInterface::operator==(i))\n && (map_index_ == i.map_index_)\n && (charge_ == i.charge_)\n && (width_ == i.width_);\n }\n\n bool FeatureHandle::operator!=(const FeatureHandle& i) const\n {\n return !(operator==(i));\n }\n\n std::ostream& operator<<(std::ostream& os, const FeatureHandle& cons)\n {\n os << \"---------- FeatureHandle -----------------\\n\"\n << \"RT: \" << cons.getRT() << std::endl\n << \"m/z: \" << cons.getMZ() << std::endl\n << \"Intensity: \" << cons.getIntensity() << std::endl\n << \"Map Index: \" << cons.getMapIndex() << std::endl\n << \"Element Id: \" << cons.getUniqueId() << std::endl;\n return os;\n }\n\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9373,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/MSSpectrum.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":24429,"string":"24,429"},"line_count":{"kind":"number","value":819,"string":"819"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg $\n// $Authors: Marc Sturm $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/config.h>\n#include <OpenMS/CONCEPT/LogStream.h>\n\n#include <OpenMS/KERNEL/MSSpectrum.h>\n\n#include <OpenMS/CONCEPT/LogStream.h>\n#include <OpenMS/FORMAT/ControlledVocabulary.h>\n#include <OpenMS/FORMAT/PeakTypeEstimator.h>\n#include <OpenMS/IONMOBILITY/IMDataConverter.h>\n\nnamespace OpenMS\n{\n MSSpectrum &MSSpectrum::select(const std::vector<Size> &indices)\n {\n Size snew = indices.size();\n ContainerType tmp;\n tmp.reserve(indices.size());\n\n const Size peaks_old = size();\n\n for (Size i = 0; i < snew; ++i)\n {\n tmp.push_back(std::move(ContainerType::operator[](indices[i])));\n }\n ContainerType::swap(tmp);\n\n std::vector<float> mda_tmp_float;\n for (Size i = 0; i < float_data_arrays_.size(); ++i)\n {\n if (float_data_arrays_[i].empty())\n {\n continue;\n }\n if (float_data_arrays_[i].size() != peaks_old)\n {\n throw Exception::Precondition(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"FloatDataArray[\" + String(i) + \"] size (\" +\n String(float_data_arrays_[i].size()) + \") does not match spectrum size (\" + String(peaks_old) + \")\");\n }\n\n mda_tmp_float.clear();\n mda_tmp_float.reserve(float_data_arrays_[i].size());\n for (Size j = 0; j < snew; ++j)\n {\n mda_tmp_float.push_back(std::move(float_data_arrays_[i][indices[j]]));\n }\n std::swap(float_data_arrays_[i], mda_tmp_float);\n }\n\n std::vector<String> mda_tmp_str;\n for (Size i = 0; i < string_data_arrays_.size(); ++i)\n {\n if (string_data_arrays_[i].empty())\n {\n continue;\n }\n if (string_data_arrays_[i].size() != peaks_old)\n {\n throw Exception::Precondition(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"StringDataArray[\" + String(i) + \"] size (\" +\n String(string_data_arrays_[i].size()) + \") does not match spectrum size (\" + String(peaks_old) + \")\");\n }\n\n mda_tmp_str.clear();\n mda_tmp_str.reserve(string_data_arrays_[i].size());\n for (Size j = 0; j < snew; ++j)\n {\n mda_tmp_str.push_back(std::move(string_data_arrays_[i][indices[j]]));\n }\n std::swap(string_data_arrays_[i], mda_tmp_str);\n }\n\n std::vector<Int> mda_tmp_int;\n for (Size i = 0; i < integer_data_arrays_.size(); ++i)\n {\n if (integer_data_arrays_[i].empty())\n {\n continue;\n }\n if (integer_data_arrays_[i].size() != peaks_old)\n {\n throw Exception::Precondition(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"IntegerDataArray[\" + String(i) + \"] size (\" +\n String(integer_data_arrays_[i].size()) + \") does not match spectrum size (\" + String(peaks_old) + \")\");\n }\n\n mda_tmp_int.clear();\n mda_tmp_int.reserve(integer_data_arrays_[i].size());\n for (Size j = 0; j < snew; ++j)\n {\n mda_tmp_int.push_back(std::move(integer_data_arrays_[i][indices[j]]));\n }\n std::swap(integer_data_arrays_[i], mda_tmp_int);\n }\n\n return *this;\n }\n\n SpectrumSettings::SpectrumType MSSpectrum::getType(const bool query_data) const\n {\n SpectrumSettings::SpectrumType t = SpectrumSettings::getType();\n // easy case: type is known\n if (t != SpectrumSettings::SpectrumType::UNKNOWN)\n {\n return t;\n }\n // Some conversion software only annotate \"MS:1000525 spectrum representation\" leading to an UNKNOWN type\n // Fortunately, some store a data processing item that indicates that the data has been picked\n for (auto& dp : getDataProcessing())\n {\n if (dp->getProcessingActions().count(DataProcessing::PEAK_PICKING) == 1)\n {\n return SpectrumSettings::SpectrumType::CENTROID;\n }\n }\n\n if (query_data)\n {\n return PeakTypeEstimator::estimateType(begin(), end());\n }\n return SpectrumSettings::SpectrumType::UNKNOWN;\n }\n\n MSSpectrum::ConstIterator MSSpectrum::getBasePeak() const\n {\n ConstIterator largest = cbegin();\n if (empty())\n {\n return largest;\n }\n ConstIterator current = cbegin();\n ++current;\n for (; current != cend(); ++current)\n {\n if (largest->getIntensity() < current->getIntensity())\n {\n largest = current;\n }\n }\n return largest;\n }\n\n MSSpectrum::Iterator MSSpectrum::getBasePeak()\n {\n ConstIterator largest = const_cast<const MSSpectrum&>(*this).getBasePeak();\n return begin() + std::distance(cbegin(), largest);\n }\n\n MSSpectrum::PeakType::IntensityType MSSpectrum::calculateTIC() const\n {\n return std::accumulate(cbegin(),\n cend(),\n 0.0,\n [](MSSpectrum::PeakType::IntensityType sum, const PeakType& p)\n {\n return sum + p.getIntensity();\n });\n }\n\n void MSSpectrum::clear(bool clear_meta_data)\n {\n ContainerType::clear();\n\n clearRanges();\n float_data_arrays_.clear();\n string_data_arrays_.clear();\n integer_data_arrays_.clear();\n\n if (clear_meta_data)\n {\n ContainerType::shrink_to_fit();\n float_data_arrays_.shrink_to_fit();\n string_data_arrays_.shrink_to_fit();\n integer_data_arrays_.shrink_to_fit();\n\n this->SpectrumSettings::operator=(SpectrumSettings()); // no \"clear\" method\n retention_time_ = -1.0;\n drift_time_ = IMTypes::DRIFTTIME_NOT_SET;\n drift_time_unit_ = DriftTimeUnit::NONE;\n ms_level_ = 1;\n name_.clear();\n name_.shrink_to_fit();\n }\n }\n\n MSSpectrum::ConstIterator\n MSSpectrum::MZEnd(MSSpectrum::ConstIterator begin, MSSpectrum::CoordinateType mz, MSSpectrum::ConstIterator end) const\n {\n PeakType p;\n p.setPosition(mz);\n return upper_bound(begin, end, p, PeakType::PositionLess());\n }\n\n MSSpectrum::ConstIterator MSSpectrum::MZEnd(MSSpectrum::CoordinateType mz) const\n {\n PeakType p;\n p.setPosition(mz);\n return upper_bound(ContainerType::begin(), ContainerType::end(), p, PeakType::PositionLess());\n }\n\n MSSpectrum::ConstIterator MSSpectrum::MZBegin(MSSpectrum::ConstIterator begin, MSSpectrum::CoordinateType mz,\n MSSpectrum::ConstIterator end) const\n {\n PeakType p;\n p.setPosition(mz);\n return lower_bound(begin, end, p, PeakType::PositionLess());\n }\n\n Int MSSpectrum::findNearest(MSSpectrum::CoordinateType mz, MSSpectrum::CoordinateType tolerance_left,\n MSSpectrum::CoordinateType tolerance_right) const\n {\n if (ContainerType::empty())\n {\n return -1;\n }\n // do a binary search for nearest peak first\n Size i = findNearest(mz);\n\n const double nearest_mz = this->operator[](i).getMZ();\n\n if (nearest_mz < mz)\n {\n if (nearest_mz >= mz - tolerance_left)\n {\n return i; // success: nearest peak is in left tolerance window\n }\n else\n {\n if (i == this->size() - 1)\n {\n return -1; // we are at the last peak which is too far left\n }\n // Nearest peak is too far left so there can't be a closer peak in the left window.\n // There still might be a peak to the right of mz that falls in the right window\n ++i; // now we are at a peak exactly on or to the right of mz\n const double next_mz = this->operator[](i).getMZ();\n if (next_mz <= mz + tolerance_right) \n {\n return i;\n }\n }\n }\n else\n {\n if (nearest_mz <= mz + tolerance_right)\n {\n return i; // success: nearest peak is in right tolerance window\n }\n else\n {\n if (i == 0)\n {\n return -1; // we are at the first peak which is too far right\n }\n --i; // now we are at a peak exactly on or to the right of mz\n const double next_mz = this->operator[](i).getMZ();\n if (next_mz >= mz - tolerance_left)\n {\n return i;\n }\n }\n }\n\n // neither in the left nor the right tolerance window\n return -1;\n }\n\n Int MSSpectrum::findNearest(MSSpectrum::CoordinateType mz, MSSpectrum::CoordinateType tolerance) const\n {\n if (ContainerType::empty())\n {\n return -1;\n }\n Size i = findNearest(mz);\n const double found_mz = this->operator[](i).getMZ();\n if (found_mz >= mz - tolerance && found_mz <= mz + tolerance)\n {\n return static_cast<Int>(i);\n }\n else\n {\n return -1;\n }\n }\n\n Size MSSpectrum::findNearest(MSSpectrum::CoordinateType mz) const\n {\n // no peak => no search\n if (empty())\n {\n throw Exception::Precondition(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"There must be at least one peak to determine the nearest peak!\");\n }\n // search for position for inserting\n ConstIterator it = MZBegin(mz);\n // border cases\n if (it == ContainerType::begin())\n {\n return 0;\n }\n if (it == ContainerType::end())\n {\n return ContainerType::size() - 1;\n }\n // the peak before or the current peak are closest\n ConstIterator it2 = it;\n --it2;\n if (std::fabs(it->getMZ() - mz) < std::fabs(it2->getMZ() - mz))\n {\n return Size(it - ContainerType::begin());\n }\n else\n {\n return Size(it2 - ContainerType::begin());\n }\n }\n\n Int MSSpectrum::findHighestInWindow(MSSpectrum::CoordinateType mz, MSSpectrum::CoordinateType tolerance_left,\n MSSpectrum::CoordinateType tolerance_right) const\n {\n if (ContainerType::empty())\n {\n return -1;\n }\n // get left/right iterator\n auto left = this->MZBegin(mz - tolerance_left);\n auto right = this->MZEnd(mz + tolerance_right);\n\n // no MS1 precursor peak in +- tolerance window found\n if (left == right)\n {\n return -1;\n }\n\n auto max_intensity_it = std::max_element(left, right, Peak1D::IntensityLess());\n\n // find peak (index) with highest intensity to expected position\n return (max_intensity_it - this->begin());\n }\n\n void MSSpectrum::sortByIonMobility()\n {\n // can throw if IM float data array is missing\n const auto [im_data_index, im_unit] = getIMData();\n // Capture IM array by Ref, because .getIMData() is expensive to call for every peak!\n const auto& im_data = getFloatDataArrays()[im_data_index];\n\n // check if data is sorted by IM... if not, sort\n if (! std::is_sorted(im_data.begin(), im_data.end()))\n { // sorts the spectrum (and its binary data arrays) according to IM\n this->sort([&im_data](const Size i1, const Size i2) { return im_data[i1] < im_data[i2]; });\n }\n }\n\n void MSSpectrum::sortByPositionPresorted(const std::vector<Chunk>& chunks)\n {\n if (chunks.empty()) return;\n\n if (chunks.size() == 1 && chunks[0].is_sorted)\n {\n return;\n }\n if (float_data_arrays_.empty() && string_data_arrays_.empty() && integer_data_arrays_.empty())\n {\n std::stable_sort(ContainerType::begin(), ContainerType::end(), PeakType::PositionLess());\n }\n else\n {\n std::vector<Size> select_indices(this->size());\n std::iota(select_indices.begin(), select_indices.end(), 0);\n\n auto comparePos = [this] (Size a, Size b) { return this->ContainerType::operator[](a).getPos() < this->ContainerType::operator[](b).getPos(); };\n\n // sort all chunks, that haven't been sorted yet\n for (Size i = 0; i < chunks.size(); ++i)\n {\n if (!chunks[i].is_sorted)\n {\n std::stable_sort(select_indices.begin() + chunks[i].start, select_indices.begin() + chunks[i].end, comparePos);\n }\n }\n\n // now we can recursively merge all chunks, which is faster than using stable_sort in the first place\n std::function<void(Size,Size)> rec;\n rec = [&chunks, &select_indices, &rec, &comparePos] (Size first, Size last)->void {\n if (last > first)\n {\n Size mid = first + (last - first) / 2;\n rec(first, mid);\n rec(mid + 1, last);\n std::inplace_merge(select_indices.begin() + chunks[first].start, select_indices.begin() + chunks[mid].end, select_indices.begin() + chunks[last].end, comparePos);\n }\n };\n\n rec(0, chunks.size() - 1);\n\n select(select_indices);\n }\n }\n\n void MSSpectrum::sortByPosition()\n {\n if (isSorted())\n {\n return;\n }\n if (float_data_arrays_.empty() && string_data_arrays_.empty() && integer_data_arrays_.empty())\n {\n std::stable_sort(ContainerType::begin(), ContainerType::end(), PeakType::PositionLess());\n return;\n }\n\n // sort index list\n sort([this](const Size i1, const Size i2) -> bool {\n return this->operator[](i1).getPosition() < this->operator[](i2).getPosition();\n });\n }\n\n void MSSpectrum::sortByIntensity(bool reverse)\n {\n if (reverse && std::is_sorted(ContainerType::begin(), ContainerType::end(), [](auto &left, auto &right) {PeakType::IntensityLess cmp; return cmp(right, left);}))\n {\n return;\n }\n else if (!reverse && std::is_sorted(ContainerType::begin(), ContainerType::end(), PeakType::IntensityLess()))\n {\n return;\n }\n if (float_data_arrays_.empty() && string_data_arrays_.empty() && integer_data_arrays_.empty())\n {\n if (reverse)\n {\n std::stable_sort(ContainerType::begin(), ContainerType::end(), [](auto &left, auto &right) {PeakType::IntensityLess cmp; return cmp(right, left);});\n }\n else\n {\n std::stable_sort(ContainerType::begin(), ContainerType::end(), PeakType::IntensityLess());\n }\n return;\n }\n\n // sort index list\n if (reverse)\n {\n this->sort([this](const Size i1, const Size i2) -> bool \n {\n return this->operator[](i2).getIntensity() < this->operator[](i1).getIntensity();\n });\n }\n else\n {\n this->sort([this](const Size i1, const Size i2) -> bool {\n return this->operator[](i1).getIntensity() < this->operator[](i2).getIntensity();\n });\n };\n }\n\n bool MSSpectrum::isSorted() const\n {\n return std::is_sorted(ContainerType::begin(), ContainerType::end(), PeakType::PositionLess());\n }\n\n bool MSSpectrum::isSortedByIM() const\n {\n auto [im_data_index, D] = getIMData(); // may throw\n const auto& im_data = getFloatDataArrays()[im_data_index];\n // check if data is sorted by IM\n return std::is_sorted(im_data.begin(), im_data.end());\n }\n\n bool MSSpectrum::operator==(const MSSpectrum &rhs) const\n {\n //name_ can differ => it is not checked, range is not checked\n#ifdef __clang__\n #pragma clang diagnostic push\n #pragma clang diagnostic ignored \"-Wfloat-equal\"\n#endif\n return std::operator==(*this, rhs) &&\n SpectrumSettings::operator==(rhs) &&\n retention_time_ == rhs.retention_time_ &&\n drift_time_ == rhs.drift_time_ &&\n drift_time_unit_ == rhs.drift_time_unit_ &&\n ms_level_ == rhs.ms_level_ &&\n float_data_arrays_ == rhs.float_data_arrays_ &&\n string_data_arrays_ == rhs.string_data_arrays_ &&\n integer_data_arrays_ == rhs.integer_data_arrays_;\n\n#ifdef __clang__\n #pragma clang diagnostic pop\n#endif\n }\n\n MSSpectrum &MSSpectrum::operator=(const MSSpectrum &source)\n {\n if (&source == this)\n {\n return *this;\n }\n ContainerType::operator=(source);\n SpectrumSettings::operator=(source);\n RangeManagerType::operator=(source);\n\n retention_time_ = source.retention_time_;\n drift_time_ = source.drift_time_;\n drift_time_unit_ = source.drift_time_unit_;\n ms_level_ = source.ms_level_;\n name_ = source.name_;\n float_data_arrays_ = source.float_data_arrays_;\n string_data_arrays_ = source.string_data_arrays_;\n integer_data_arrays_ = source.integer_data_arrays_;\n\n return *this;\n }\n\n MSSpectrum::MSSpectrum() = default;\n\n MSSpectrum::MSSpectrum(const std::initializer_list<Peak1D>& init)\n : ContainerType(init)\n {\n }\n\n MSSpectrum::MSSpectrum(const MSSpectrum &source) = default;\n\n MSSpectrum &MSSpectrum::operator=(const SpectrumSettings &source)\n {\n SpectrumSettings::operator=(source);\n return *this;\n }\n\n void MSSpectrum::updateRanges()\n {\n #ifdef OPENMS_ASSERTIONS\n double im_min = RangeMobility::isEmpty() ? 0 : getMinMobility();\n double im_max = RangeMobility::isEmpty() ? 0 : getMaxMobility();\n double mz_min = RangeMZ::isEmpty() ? 0 : getMinMZ();\n double mz_max = RangeMZ::isEmpty() ? 0 : getMaxMZ();\n double int_min = RangeIntensity::isEmpty() ? 0 : getMinIntensity();\n double int_max = RangeIntensity::isEmpty() ? 0 : getMaxIntensity();\n #endif\n\n clearRanges();\n for (const auto& peak : (ContainerType&)*this)\n {\n extendMZ(peak.getMZ()); \n extendIntensity(peak.getIntensity());\n }\n // IM\n // if this is an ion mobility frame, consider the binary data array as well\n if (this->containsIMData())\n {\n auto [im_array_index, im_unit] = getIMData();\n const auto& im_data = getFloatDataArrays()[im_array_index];\n for (const auto& im : im_data)\n {\n this->extendMobility(im);\n }\n }\n else if (getDriftTime() != IMTypes::DRIFTTIME_NOT_SET) // != -1\n { \n this->extendMobility(getDriftTime());\n }\n #ifdef OPENMS_ASSERTIONS\n double im_min_new = RangeMobility::isEmpty() ? 0 : getMinMobility();\n double im_max_new = RangeMobility::isEmpty() ? 0 : getMaxMobility();\n double mz_min_new = RangeMZ::isEmpty() ? 0 : getMinMZ();\n double mz_max_new = RangeMZ::isEmpty() ? 0 : getMaxMZ();\n double int_min_new = RangeIntensity::isEmpty() ? 0 : getMinIntensity();\n double int_max_new = RangeIntensity::isEmpty() ? 0 : getMaxIntensity();\n\n // check if all are equal and no update range was necessary\n if (im_min_new == im_min && im_max_new == im_max\n && int_min_new == int_min && int_max_new == int_max\n && mz_min_new == mz_min && mz_max_new == mz_max)\n {\n OPENMS_LOG_WARN << \"Update ranges was called but ranges were already up-to-date\" << std::endl;\n } \n #endif\n }\n\n double MSSpectrum::getRT() const\n {\n return retention_time_;\n }\n\n void MSSpectrum::setRT(double rt)\n {\n retention_time_ = rt;\n }\n\n DriftTimeUnit MSSpectrum::getDriftTimeUnit() const\n {\n return drift_time_unit_;\n }\n\n String MSSpectrum::getDriftTimeUnitAsString() const\n {\n return NamesOfDriftTimeUnit[(size_t)drift_time_unit_];\n }\n\n void MSSpectrum::setDriftTimeUnit(DriftTimeUnit dt)\n {\n drift_time_unit_ = dt;\n }\n\n double MSSpectrum::getDriftTime() const\n {\n return drift_time_;\n }\n\n void MSSpectrum::setDriftTime(double dt)\n {\n drift_time_ = dt;\n }\n\n UInt MSSpectrum::getMSLevel() const\n {\n return ms_level_;\n }\n\n void MSSpectrum::setMSLevel(UInt ms_level)\n {\n ms_level_ = ms_level;\n }\n\n const String &MSSpectrum::getName() const\n {\n return name_;\n }\n\n void MSSpectrum::setName(const String &name)\n {\n name_ = name;\n }\n\n const MSSpectrum::FloatDataArrays &MSSpectrum::getFloatDataArrays() const\n {\n return float_data_arrays_;\n }\n\n void MSSpectrum::setFloatDataArrays(const MSSpectrum::FloatDataArrays &fda)\n {\n float_data_arrays_ = fda;\n }\n\n const MSSpectrum::StringDataArrays &MSSpectrum::getStringDataArrays() const\n {\n return string_data_arrays_;\n }\n\n void MSSpectrum::setStringDataArrays(const MSSpectrum::StringDataArrays &sda)\n {\n string_data_arrays_ = sda;\n }\n\n MSSpectrum::StringDataArrays &MSSpectrum::getStringDataArrays()\n {\n return string_data_arrays_;\n }\n\n const MSSpectrum::IntegerDataArrays &MSSpectrum::getIntegerDataArrays() const\n {\n return integer_data_arrays_;\n }\n\n MSSpectrum::IntegerDataArrays &MSSpectrum::getIntegerDataArrays()\n {\n return integer_data_arrays_;\n }\n\n void MSSpectrum::setIntegerDataArrays(const MSSpectrum::IntegerDataArrays &ida)\n {\n integer_data_arrays_ = ida;\n }\n\n MSSpectrum::Iterator MSSpectrum::MZBegin(MSSpectrum::CoordinateType mz)\n {\n PeakType p;\n p.setPosition(mz);\n return lower_bound(ContainerType::begin(), ContainerType::end(), p, PeakType::PositionLess());\n }\n\n MSSpectrum::Iterator\n MSSpectrum::MZBegin(MSSpectrum::Iterator begin, MSSpectrum::CoordinateType mz, MSSpectrum::Iterator end)\n {\n PeakType p;\n p.setPosition(mz);\n return lower_bound(begin, end, p, PeakType::PositionLess());\n }\n\n MSSpectrum::Iterator MSSpectrum::MZEnd(MSSpectrum::CoordinateType mz)\n {\n PeakType p;\n p.setPosition(mz);\n return upper_bound(ContainerType::begin(), ContainerType::end(), p, PeakType::PositionLess());\n }\n\n MSSpectrum::Iterator\n MSSpectrum::MZEnd(MSSpectrum::Iterator begin, MSSpectrum::CoordinateType mz, MSSpectrum::Iterator end)\n {\n PeakType p;\n p.setPosition(mz);\n return upper_bound(begin, end, p, PeakType::PositionLess());\n }\n\n MSSpectrum::ConstIterator MSSpectrum::MZBegin(MSSpectrum::CoordinateType mz) const\n {\n PeakType p;\n p.setPosition(mz);\n return lower_bound(ContainerType::begin(), ContainerType::end(), p, PeakType::PositionLess());\n }\n\n MSSpectrum::Iterator MSSpectrum::PosBegin(MSSpectrum::CoordinateType mz)\n {\n return MZBegin(mz);\n }\n\n MSSpectrum::Iterator\n MSSpectrum::PosBegin(MSSpectrum::Iterator begin, MSSpectrum::CoordinateType mz, MSSpectrum::Iterator end)\n {\n return MZBegin(begin, mz, end);\n }\n\n MSSpectrum::Iterator MSSpectrum::PosEnd(MSSpectrum::CoordinateType mz)\n {\n return MZEnd(mz);\n }\n\n MSSpectrum::Iterator\n MSSpectrum::PosEnd(MSSpectrum::Iterator begin, MSSpectrum::CoordinateType mz, MSSpectrum::Iterator end)\n {\n return MZEnd(begin, mz, end);\n }\n\n MSSpectrum::ConstIterator MSSpectrum::PosBegin(MSSpectrum::CoordinateType mz) const\n {\n return MZBegin(mz);\n }\n\n MSSpectrum::ConstIterator\n MSSpectrum::PosBegin(MSSpectrum::ConstIterator begin, MSSpectrum::CoordinateType mz, MSSpectrum::ConstIterator end) const\n {\n return MZBegin(begin, mz, end);\n }\n\n MSSpectrum::ConstIterator MSSpectrum::PosEnd(MSSpectrum::CoordinateType mz) const\n {\n return MZEnd(mz);\n }\n\n MSSpectrum::ConstIterator\n MSSpectrum::PosEnd(MSSpectrum::ConstIterator begin, MSSpectrum::CoordinateType mz, MSSpectrum::ConstIterator end) const\n {\n return MZEnd(begin, mz, end);\n }\n\n bool MSSpectrum::RTLess::operator()(const MSSpectrum &a, const MSSpectrum &b) const\n {\n return a.getRT() < b.getRT();\n }\n bool MSSpectrum::IMLess::operator()(const MSSpectrum& a, const MSSpectrum& b) const\n {\n return a.getDriftTime() < b.getDriftTime();\n }\n\n bool getIonMobilityArray__(const MSSpectrum::FloatDataArrays& fdas, Size& index, DriftTimeUnit& unit)\n {\n for (index = 0; index < fdas.size(); ++index)\n {\n if (IMDataConverter::getIMUnit(fdas[index], unit))\n {\n return true;\n }\n }\n return false;\n }\n\n bool MSSpectrum::containsIMData() const\n {\n Size index;\n DriftTimeUnit unit;\n return getIonMobilityArray__(this->getFloatDataArrays(), index, unit);\n }\n\n std::pair<Size, DriftTimeUnit> MSSpectrum::getIMData() const\n {\n Size index;\n DriftTimeUnit unit;\n bool has_IM = getIonMobilityArray__(this->getFloatDataArrays(), index, unit);\n \n if (!has_IM)\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION,\n \"Cannot get ion mobility data. No float array with the correct name available.\"\n \" Number of float arrays: \" +\n String(this->getFloatDataArrays().size()));\n }\n\n return {index, unit };\n }\n\n std::pair<DriftTimeUnit, std::vector<float>> MSSpectrum::maybeGetIMData() const\n {\n Size index;\n DriftTimeUnit unit = DriftTimeUnit::NONE;\n bool has_IM = getIonMobilityArray__(this->getFloatDataArrays(), index, unit);\n\n if (!has_IM)\n {\n return {unit, {}}; // empty vector\n }\n return {unit, this->getFloatDataArrays()[index]};\n }\n \n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9374,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/FeatureMap.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":15290,"string":"15,290"},"line_count":{"kind":"number","value":499,"string":"499"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Chris Bielow $\n// $Authors: Marc Sturm, Chris Bielow, Clemens Groepl $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/config.h>\n\n#include <OpenMS/KERNEL/FeatureMap.h>\n#include <OpenMS/CONCEPT/LogStream.h>\n#include <OpenMS/METADATA/DataProcessing.h>\n#include <OpenMS/METADATA/ProteinIdentification.h>\n#include <OpenMS/METADATA/PeptideIdentification.h>\n\n#include <OpenMS/SYSTEM/File.h>\n\nnamespace OpenMS\n{\n std::ostream& operator<<(std::ostream& os, const AnnotationStatistics& ann)\n {\n os << \"Feature annotation with identifications:\" << \"\\n\";\n for (Size i = 0; i < ann.states.size(); ++i)\n {\n os << \" \" << BaseFeature::NamesOfAnnotationState[i] << \": \" << ann.states[i] << \"\\n\";\n }\n os << std::endl;\n return os;\n }\n\n std::ostream& operator<<(std::ostream& os, const FeatureMap& map)\n {\n os << \"# -- DFEATUREMAP BEGIN --\" << \"\\n\";\n os << \"# POS \\tINTENS\\tOVALLQ\\tCHARGE\\tUniqueID\" << \"\\n\";\n for (FeatureMap::const_iterator iter = map.begin(); iter != map.end(); ++iter)\n {\n os << iter->getPosition() << '\\t'\n << iter->getIntensity() << '\\t'\n << iter->getOverallQuality() << '\\t'\n << iter->getCharge() << '\\t'\n << iter->getUniqueId() << \"\\n\";\n }\n os << \"# -- DFEATUREMAP END --\" << std::endl;\n return os;\n }\n\n AnnotationStatistics::AnnotationStatistics() :\n states(static_cast<size_t>(BaseFeature::AnnotationState::SIZE_OF_ANNOTATIONSTATE), 0) // initialize all with 0\n {\n }\n\n AnnotationStatistics::AnnotationStatistics(const AnnotationStatistics& rhs) = default;\n\n AnnotationStatistics& AnnotationStatistics::operator=(const AnnotationStatistics& rhs)\n {\n if (this == &rhs)\n {\n return *this;\n }\n states = rhs.states;\n return *this;\n }\n\n bool AnnotationStatistics::operator==(const AnnotationStatistics& rhs) const\n {\n return states == rhs.states;\n }\n\n AnnotationStatistics& AnnotationStatistics::operator+=(BaseFeature::AnnotationState state)\n {\n ++states[static_cast<Size>(state)];\n return *this;\n }\n\n FeatureMap::FeatureMap() :\n MetaInfoInterface(),\n RangeManagerContainerType(),\n DocumentIdentifier(),\n ExposedVector<Feature>(),\n UniqueIdInterface(),\n UniqueIdIndexer<FeatureMap>(),\n protein_identifications_(),\n unassigned_peptide_identifications_(),\n data_processing_(),\n id_data_()\n {\n }\n\n FeatureMap::FeatureMap(const FeatureMap& source) :\n MetaInfoInterface(source),\n RangeManagerContainerType(source),\n DocumentIdentifier(source),\n ExposedVector<Feature>(source),\n UniqueIdInterface(source),\n UniqueIdIndexer<FeatureMap>(source),\n protein_identifications_(source.protein_identifications_),\n unassigned_peptide_identifications_(source.unassigned_peptide_identifications_),\n data_processing_(source.data_processing_),\n id_data_() // updated below\n {\n // copy ID data and update references in features:\n IdentificationData::RefTranslator trans = id_data_.merge(source.id_data_);\n for (Feature& feature : *this)\n {\n feature.updateAllIDReferences(trans);\n }\n }\n\n FeatureMap::FeatureMap(FeatureMap&& source) = default;\n\n FeatureMap::~FeatureMap() = default;\n\n FeatureMap& FeatureMap::operator=(const FeatureMap& rhs) // TODO: cannot be defaulted since OpenMS::IdentificationData is missing operator=\n {\n if (&rhs == this)\n {\n return *this;\n }\n MetaInfoInterface::operator=(rhs);\n RangeManagerType::operator=(rhs);\n DocumentIdentifier::operator=(rhs);\n UniqueIdInterface::operator=(rhs);\n data_ = rhs.data_;\n protein_identifications_ = rhs.protein_identifications_;\n unassigned_peptide_identifications_ = rhs.unassigned_peptide_identifications_;\n data_processing_ = rhs.data_processing_;\n\n // copy ID data and update references in features:\n id_data_.clear();\n IdentificationData::RefTranslator trans = id_data_.merge(rhs.id_data_);\n for (Feature& feature : *this)\n {\n feature.updateAllIDReferences(trans);\n }\n\n return *this;\n }\n\n //FeatureMap& FeatureMap::operator=(FeatureMap&&) = default; // TODO: cannot be defaulted since OpenMS::IdentificationData is missing operator=\n\n\n bool FeatureMap::operator==(const FeatureMap& rhs) const\n {\n return data_ == rhs.data_ &&\n MetaInfoInterface::operator==(rhs) &&\n RangeManagerType::operator==(rhs) &&\n DocumentIdentifier::operator==(rhs) &&\n UniqueIdInterface::operator==(rhs) &&\n protein_identifications_ == rhs.protein_identifications_ &&\n unassigned_peptide_identifications_ == rhs.unassigned_peptide_identifications_ &&\n data_processing_ == rhs.data_processing_;\n // @TODO: implement \"operator==\" for IdentificationData?\n }\n\n bool FeatureMap::operator!=(const FeatureMap& rhs) const\n {\n return !(operator==(rhs));\n }\n\n FeatureMap FeatureMap::operator+(const FeatureMap& rhs) const\n {\n FeatureMap tmp(*this);\n tmp += rhs;\n return tmp;\n }\n\n FeatureMap& FeatureMap::operator+=(const FeatureMap& rhs)\n {\n FeatureMap empty_map;\n // reset these:\n RangeManagerType::operator=(empty_map);\n\n if (!this->getIdentifier().empty() || !rhs.getIdentifier().empty())\n {\n OPENMS_LOG_INFO << \"DocumentIdentifiers are lost during merge of FeatureMaps\\n\";\n }\n DocumentIdentifier::operator=(empty_map);\n\n UniqueIdInterface::operator=(empty_map);\n\n // merge these:\n protein_identifications_.insert(protein_identifications_.end(), rhs.protein_identifications_.begin(), rhs.protein_identifications_.end());\n unassigned_peptide_identifications_.insert(unassigned_peptide_identifications_.end(), rhs.unassigned_peptide_identifications_.begin(), rhs.unassigned_peptide_identifications_.end());\n data_processing_.insert(data_processing_.end(), rhs.data_processing_.begin(), rhs.data_processing_.end());\n\n Size n_old_features = size();\n // append features:\n this->insert(this->end(), rhs.begin(), rhs.end());\n\n // todo: check for double entries\n // features, unassignedpeptides, proteins...\n\n // merge IDs (new format):\n IdentificationData::RefTranslator trans = id_data_.merge(rhs.id_data_);\n // update ID references of new features:\n for (Size i = n_old_features; i < size(); ++i)\n {\n operator[](i).updateAllIDReferences(trans);\n }\n\n // consistency\n try\n {\n UniqueIdIndexer<FeatureMap>::updateUniqueIdToIndex();\n }\n catch (Exception::Postcondition&) // assign new UID's for conflicting entries\n {\n Size replaced_uids = UniqueIdIndexer<FeatureMap>::resolveUniqueIdConflicts();\n OPENMS_LOG_INFO << \"Replaced \" << replaced_uids << \" invalid uniqueID's\\n\";\n }\n\n return *this;\n }\n\n void FeatureMap::sortByIntensity(bool reverse)\n {\n if (reverse)\n {\n std::sort(this->begin(), this->end(), [](auto &left, auto &right) {Feature::IntensityLess cmp; return cmp(right, left);});\n }\n else\n {\n std::sort(this->begin(), this->end(), Feature::IntensityLess());\n }\n }\n\n void FeatureMap::sortByPosition()\n {\n std::sort(this->begin(), this->end(), Feature::PositionLess());\n }\n\n void FeatureMap::sortByRT()\n {\n std::sort(this->begin(), this->end(), Feature::RTLess());\n }\n\n void FeatureMap::sortByMZ()\n {\n std::sort(this->begin(), this->end(), Feature::MZLess());\n }\n\n void FeatureMap::sortByOverallQuality(bool reverse)\n {\n if (reverse)\n {\n std::sort(this->begin(), this->end(), [](auto& left, auto& right) {Feature::OverallQualityLess cmp; return cmp(right, left);});\n }\n else\n {\n std::sort(this->begin(), this->end(), Feature::OverallQualityLess());\n }\n }\n\n void FeatureMap::updateRanges()\n {\n #ifdef OPENMS_ASSERTIONS\n double rt_min = RangeRT::isEmpty() ? 0 : getMinRT();\n double rt_max = RangeRT::isEmpty() ? 0 : getMaxRT();\n double mz_min = RangeMZ::isEmpty() ? 0 : getMinMZ();\n double mz_max = RangeMZ::isEmpty() ? 0 : getMaxMZ();\n double int_min = RangeIntensity::isEmpty() ? 0 : getMinIntensity();\n double int_max = RangeIntensity::isEmpty() ? 0 : getMaxIntensity();\n #endif\n\n clearRanges();\n for (const auto& f : *this)\n {\n extendRT(f.getRT());\n extendMZ(f.getMZ());\n extendIntensity(f.getIntensity());\n }\n\n // enlarge the range by the convex hull points\n for (Size i = 0; i < this->size(); ++i)\n {\n const DBoundingBox<2>& box = this->operator[](i).getConvexHull().getBoundingBox();\n if (!box.isEmpty())\n {\n extendRT(box.minPosition()[Peak2D::RT]);\n extendRT(box.maxPosition()[Peak2D::RT]);\n extendMZ(box.minPosition()[Peak2D::MZ]);\n extendMZ(box.maxPosition()[Peak2D::MZ]);\n }\n }\n\n #ifdef OPENMS_ASSERTIONS\n // check if updateRanges() was necessary and find places where it was not\n double rt_min_new = RangeRT::isEmpty() ? 0 : getMinRT();\n double rt_max_new = RangeRT::isEmpty() ? 0 : getMaxRT();\n double mz_min_new = RangeMZ::isEmpty() ? 0 : getMinMZ();\n double mz_max_new = RangeMZ::isEmpty() ? 0 : getMaxMZ();\n double int_min_new = RangeIntensity::isEmpty() ? 0 : getMinIntensity();\n double int_max_new = RangeIntensity::isEmpty() ? 0 : getMaxIntensity();\n\n // check if all are equal and no update range was necessary\n if (rt_min_new == rt_min && rt_max_new == rt_max\n && int_min_new == int_min && int_max_new == int_max\n && mz_min_new == mz_min && mz_max_new == mz_max)\n {\n OPENMS_LOG_WARN << \"Update ranges was called but ranges were already up-to-date\" << std::endl;\n }\n #endif\n }\n\n \n void FeatureMap::swapFeaturesOnly(FeatureMap& from)\n {\n data_.swap(from.data_);\n\n // swap range information (otherwise its false in both maps)\n FeatureMap tmp;\n tmp.RangeManagerType::operator=(* this);\n this->RangeManagerType::operator=(from);\n from.RangeManagerType::operator=(tmp);\n }\n\n void FeatureMap::swap(FeatureMap& from)\n {\n // swap features and ranges\n swapFeaturesOnly(from);\n\n // swap DocumentIdentifier\n DocumentIdentifier::swap(from);\n\n // swap unique id\n UniqueIdInterface::swap(from);\n\n // swap unique id index\n UniqueIdIndexer<FeatureMap>::swap(from);\n\n // swap the remaining members\n protein_identifications_.swap(from.protein_identifications_);\n unassigned_peptide_identifications_.swap(from.unassigned_peptide_identifications_);\n data_processing_.swap(from.data_processing_);\n id_data_.swap(from.id_data_);\n }\n\n const std::vector<ProteinIdentification>& FeatureMap::getProteinIdentifications() const\n {\n return protein_identifications_;\n }\n\n std::vector<ProteinIdentification>& FeatureMap::getProteinIdentifications()\n {\n return protein_identifications_;\n }\n\n void FeatureMap::setProteinIdentifications(const std::vector<ProteinIdentification>& protein_identifications)\n {\n protein_identifications_ = protein_identifications;\n }\n\n const PeptideIdentificationList& FeatureMap::getUnassignedPeptideIdentifications() const\n {\n return unassigned_peptide_identifications_;\n }\n\n PeptideIdentificationList& FeatureMap::getUnassignedPeptideIdentifications()\n {\n return unassigned_peptide_identifications_;\n }\n\n void FeatureMap::setUnassignedPeptideIdentifications(const PeptideIdentificationList& unassigned_peptide_identifications)\n {\n unassigned_peptide_identifications_ = unassigned_peptide_identifications;\n }\n\n const std::vector<DataProcessing>& FeatureMap::getDataProcessing() const\n {\n return data_processing_;\n }\n\n std::vector<DataProcessing>& FeatureMap::getDataProcessing()\n {\n return data_processing_;\n }\n\n void FeatureMap::setDataProcessing(const std::vector<DataProcessing>& processing_method)\n {\n data_processing_ = processing_method;\n }\n\n /// set the file path to the primary MS run (usually the mzML file obtained after data conversion from raw files)\n void FeatureMap::setPrimaryMSRunPath(const StringList& s)\n {\n if (s.empty())\n {\n OPENMS_LOG_WARN << \"Setting empty MS runs paths.\" << std::endl;\n this->setMetaValue(\"spectra_data\", DataValue(s));\n return;\n }\n\n for (const String& filename : s)\n {\n if (!filename.hasSuffix(\"mzML\") && !filename.hasSuffix(\"mzml\"))\n {\n OPENMS_LOG_WARN << \"To ensure tracability of results please prefer mzML files as primary MS run.\" << std::endl\n << \"Filename: '\" << filename << \"'\" << std::endl;\n }\n }\n\n this->setMetaValue(\"spectra_data\", DataValue(s));\n }\n\n\n void FeatureMap::setPrimaryMSRunPath(const StringList& s, MSExperiment& e)\n {\n StringList ms_path;\n e.getPrimaryMSRunPath(ms_path);\n if (ms_path.size() == 1 && ms_path[0].hasSuffix(\"mzML\") && File::exists(ms_path[0]))\n {\n setPrimaryMSRunPath(ms_path);\n }\n else\n {\n setPrimaryMSRunPath(s);\n }\n }\n\n\n /// get the file path to the first MS run\n void FeatureMap::getPrimaryMSRunPath(StringList& toFill) const\n {\n if (this->metaValueExists(\"spectra_data\"))\n {\n toFill = this->getMetaValue(\"spectra_data\");\n }\n\n if (toFill.empty())\n {\n OPENMS_LOG_WARN << \"No MS run annotated in feature map. Setting to 'UNKNOWN' \" << std::endl;\n toFill.push_back(\"UNKNOWN\");\n }\n }\n\n void FeatureMap::clear(bool clear_meta_data)\n {\n data_.clear();\n\n if (clear_meta_data)\n {\n clearMetaInfo();\n clearRanges();\n this->DocumentIdentifier::operator=(DocumentIdentifier()); // no \"clear\" method\n clearUniqueId();\n protein_identifications_.clear();\n unassigned_peptide_identifications_.clear();\n data_processing_.clear();\n id_data_.clear();\n }\n }\n\n AnnotationStatistics FeatureMap::getAnnotationStatistics() const\n {\n AnnotationStatistics result;\n for (ConstIterator iter = this->begin(); iter != this->end(); ++iter)\n {\n result += iter->getAnnotationState();\n }\n return result;\n }\n\n\n std::set<IdentificationDataInternal::ObservationMatchRef> FeatureMap::getUnassignedIDMatches() const\n {\n std::set<IdentificationData::ObservationMatchRef> all_matches;\n for (auto it = id_data_.getObservationMatches().begin();\n it != id_data_.getObservationMatches().end(); ++it)\n {\n all_matches.insert(it);\n }\n std::set<IdentificationData::ObservationMatchRef> assigned_matches;\n for (const Feature& feat : *this)\n {\n assigned_matches.insert(feat.getIDMatches().begin(), feat.getIDMatches().end());\n // @TODO: consider subordinate features? - probably not\n }\n std::set<IdentificationData::ObservationMatchRef> result;\n std::set_difference(all_matches.begin(), all_matches.end(),\n assigned_matches.begin(), assigned_matches.end(),\n inserter(result, result.end()));\n return result;\n }\n\n\n const IdentificationData& FeatureMap::getIdentificationData() const\n {\n return id_data_;\n }\n\n\n IdentificationData& FeatureMap::getIdentificationData()\n {\n return id_data_;\n }\n\n}\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9375,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/MRMTransitionGroup.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":416,"string":"416"},"line_count":{"kind":"number","value":15,"string":"15"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Hannes Roest $\n// $Authors: Hannes Roest $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/MRMTransitionGroup.h>\n\nnamespace OpenMS\n{\n}\n\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9376,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/RangeManager.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":1787,"string":"1,787"},"line_count":{"kind":"number","value":78,"string":"78"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Chris Bielow $\n// $Authors: Chris Bielow $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/RangeManager.h>\n\n#include <ostream>\n\nnamespace OpenMS\n{\n std::ostream& operator<<(std::ostream& out, const RangeBase& b)\n {\n if (!b.isEmpty())\n {\n out << \"[\" << b.getMin() << \", \" << b.getMax() << \"]\";\n }\n else // empty range\n {\n out << \"[, ]\";\n }\n \n return out;\n }\n \n std::ostream& operator<<(std::ostream& out, const RangeRT& range)\n {\n out << \"rt: \" << (OpenMS::RangeBase) range << \"\\n\";\n return out;\n }\n\n std::ostream& operator<<(std::ostream& out, const RangeMZ& range)\n {\n out << \"mz: \" << (RangeBase) range << \"\\n\";\n return out;\n }\n\n std::ostream& operator<<(std::ostream& out, const RangeIntensity& range)\n {\n out << \"intensity: \" << (RangeBase) range << \"\\n\";\n return out;\n }\n\n std::ostream& operator<<(std::ostream& out, const RangeMobility& range)\n {\n out << \"mobility: \" << (RangeBase) range << \"\\n\";\n return out;\n }\n\n RangeBase::operator RangeRT() const\n {\n RangeRT out;\n out.RangeBase::operator=(*this);\n return out;\n }\n RangeBase::operator RangeMZ() const\n {\n RangeMZ out;\n out.RangeBase::operator=(*this);\n return out;\n }\n RangeBase::operator RangeIntensity() const\n {\n RangeIntensity out;\n out.RangeBase::operator=(*this);\n return out;\n }\n RangeBase::operator RangeMobility() const\n {\n RangeMobility out;\n out.RangeBase::operator=(*this);\n return out;\n }\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9377,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/OnDiscMSExperiment.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":7558,"string":"7,558"},"line_count":{"kind":"number","value":233,"string":"233"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Hannes Roest $\n// $Authors: Hannes Roest $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/OnDiscMSExperiment.h>\n\n#include <OpenMS/FORMAT/FileHandler.h>\n\nnamespace OpenMS\n{\n bool OnDiscMSExperiment::openFile(const String& filename, bool skipMetaData)\n {\n filename_ = filename;\n indexed_mzml_file_.openFile(filename);\n if (!filename.empty() && !skipMetaData)\n {\n loadMetaData_(filename);\n }\n return indexed_mzml_file_.getParsingSuccess();\n }\n\n void OnDiscMSExperiment::setSkipXMLChecks(bool skip)\n {\n indexed_mzml_file_.setSkipXMLChecks(skip);\n }\n\n PeakFileOptions& OnDiscMSExperiment::getOptions()\n {\n return options_;\n }\n\n const PeakFileOptions& OnDiscMSExperiment::getOptions() const\n {\n return options_;\n }\n\n void OnDiscMSExperiment::setOptions(const PeakFileOptions& options)\n {\n options_ = options;\n }\n\n OpenMS::Interfaces::ChromatogramPtr OnDiscMSExperiment::getChromatogramById(Size id)\n {\n return indexed_mzml_file_.getChromatogramById(id);\n }\n\n void OnDiscMSExperiment::loadMetaData_(const String& filename)\n {\n meta_ms_experiment_ = std::shared_ptr< PeakMap >(new PeakMap);\n\n FileHandler f;\n // Always load ALL metadata without RT/MS level filters to maintain proper index correspondence\n // with indexed_mzml_file_. Filtering is applied at retrieval time in getSpectrum()/getChromatogram().\n // We only set fillData=false to avoid loading peak data during metadata loading.\n PeakFileOptions options;\n options.setFillData(false);\n f.setOptions(options);\n f.loadExperiment(filename, *meta_ms_experiment_.get(), {FileTypes::MZML});\n }\n\n MSChromatogram OnDiscMSExperiment::getMetaChromatogramById_(const std::string& id)\n {\n if (chromatograms_native_ids_.empty())\n {\n for (Size k = 0; k < meta_ms_experiment_->getChromatograms().size(); k++)\n {\n chromatograms_native_ids_.emplace(meta_ms_experiment_->getChromatograms()[k].getNativeID(), k);\n }\n }\n\n if (chromatograms_native_ids_.find(id) == chromatograms_native_ids_.end())\n {\n throw Exception::IllegalArgument(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION,\n String(\"Could not find chromatogram with id '\") + id + \"'.\");\n }\n return meta_ms_experiment_->getChromatogram(chromatograms_native_ids_[id]);\n }\n\n MSChromatogram OnDiscMSExperiment::getChromatogramByNativeId(const std::string& id)\n {\n if (!meta_ms_experiment_)\n {\n MSChromatogram chromatogram;\n indexed_mzml_file_.getMSChromatogramByNativeId(id, chromatogram);\n return chromatogram;\n }\n\n MSChromatogram chromatogram = getMetaChromatogramById_(id);\n indexed_mzml_file_.getMSChromatogramByNativeId(id, chromatogram);\n return chromatogram;\n }\n\n MSSpectrum OnDiscMSExperiment::getMetaSpectrumById_(const std::string& id)\n {\n if (spectra_native_ids_.empty())\n {\n for (Size k = 0; k < meta_ms_experiment_->getSpectra().size(); k++)\n {\n spectra_native_ids_.emplace(meta_ms_experiment_->getSpectra()[k].getNativeID(), k);\n }\n }\n\n if (spectra_native_ids_.find(id) == spectra_native_ids_.end())\n {\n throw Exception::IllegalArgument(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION,\n String(\"Could not find spectrum with id '\") + id + \"'.\");\n }\n return meta_ms_experiment_->getSpectrum(spectra_native_ids_[id]);\n }\n\n MSSpectrum OnDiscMSExperiment::getSpectrumByNativeId(const std::string& id)\n {\n if (!meta_ms_experiment_)\n {\n MSSpectrum spec;\n indexed_mzml_file_.getMSSpectrumByNativeId(id, spec);\n return spec;\n }\n\n MSSpectrum spec = getMetaSpectrumById_(id);\n indexed_mzml_file_.getMSSpectrumByNativeId(id, spec);\n return spec;\n }\n\n MSSpectrum OnDiscMSExperiment::getSpectrum(Size id)\n {\n MSSpectrum spectrum;\n\n // If we have metadata, we can check RT range and MS level filters BEFORE loading peak data\n // This allows skipping expensive I/O for spectra that will be filtered out anyway\n if (meta_ms_experiment_)\n {\n spectrum = meta_ms_experiment_->operator[](id);\n\n // Check RT range filter - skip loading peaks if outside range\n if (options_.hasRTRange() && !options_.getRTRange().encloses(DPosition<1>(spectrum.getRT())))\n {\n // Return spectrum with metadata but no peaks (filtered out)\n return spectrum;\n }\n\n // Check MS level filter - skip loading peaks if MS level doesn't match\n if (options_.hasMSLevels() && !options_.containsMSLevel(spectrum.getMSLevel()))\n {\n // Return spectrum with metadata but no peaks (filtered out)\n return spectrum;\n }\n\n // Check precursor m/z range filter - skip loading peaks if precursor m/z is outside range\n // This applies to any spectrum that has precursor information\n if (options_.hasPrecursorMZRange() && !spectrum.getPrecursors().empty())\n {\n double precursor_mz = spectrum.getPrecursors()[0].getMZ();\n if (!options_.getPrecursorMZRange().encloses(DPosition<1>(precursor_mz)))\n {\n // Return spectrum with metadata but no peaks (filtered out)\n return spectrum;\n }\n }\n\n // Spectrum passes metadata filters, load peak data\n indexed_mzml_file_.getMSSpectrumById(int(id), spectrum);\n }\n else\n {\n // No metadata available, must load full spectrum\n spectrum = indexed_mzml_file_.getMSSpectrumById(int(id));\n }\n\n // Apply m/z and intensity range filters if set (requires peak data)\n if (options_.hasMZRange() || options_.hasIntensityRange())\n {\n MSSpectrum filtered;\n filtered.SpectrumSettings::operator=(spectrum);\n filtered.reserve(spectrum.size());\n\n for (const auto& peak : spectrum)\n {\n bool pass_mz = !options_.hasMZRange() || options_.getMZRange().encloses(DPosition<1>(peak.getMZ()));\n bool pass_int = !options_.hasIntensityRange() || options_.getIntensityRange().encloses(DPosition<1>(peak.getIntensity()));\n if (pass_mz && pass_int)\n {\n filtered.push_back(peak);\n }\n }\n return filtered;\n }\n\n return spectrum;\n }\n\n MSChromatogram OnDiscMSExperiment::getChromatogram(Size id)\n {\n MSChromatogram chromatogram;\n if (!meta_ms_experiment_)\n {\n chromatogram = indexed_mzml_file_.getMSChromatogramById(int(id));\n }\n else\n {\n chromatogram = meta_ms_experiment_->getChromatogram(id);\n indexed_mzml_file_.getMSChromatogramById(int(id), chromatogram);\n }\n\n // Apply RT and intensity range filters if set (RT range for chromatograms filters on RT dimension)\n if (options_.hasRTRange() || options_.hasIntensityRange())\n {\n MSChromatogram filtered;\n filtered.ChromatogramSettings::operator=(chromatogram);\n filtered.reserve(chromatogram.size());\n\n for (const auto& peak : chromatogram)\n {\n bool pass_rt = !options_.hasRTRange() || options_.getRTRange().encloses(DPosition<1>(peak.getRT()));\n bool pass_int = !options_.hasIntensityRange() || options_.getIntensityRange().encloses(DPosition<1>(peak.getIntensity()));\n if (pass_rt && pass_int)\n {\n filtered.push_back(peak);\n }\n }\n return filtered;\n }\n\n return chromatogram;\n }\n\n} //namespace OpenMS\n\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9378,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/ChromatogramRangeManager.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":496,"string":"496"},"line_count":{"kind":"number","value":14,"string":"14"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg $\n// $Authors: Administrator $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/ChromatogramRangeManager.h>\n\nnamespace OpenMS\n{\n // Currently empty as the class only contains inline implementations\n}"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9379,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/MassTrace.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":20322,"string":"20,322"},"line_count":{"kind":"number","value":668,"string":"668"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg $\n// $Authors: Erhan Kenar, Holger Franken, Chris Bielow $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/MassTrace.h>\n\n#include <boost/dynamic_bitset.hpp>\n\nnamespace OpenMS\n{\n // must match MassTrace::MT_QUANTMETHOD enum!\n const std::string MassTrace::names_of_quantmethod[] = {\"area\", \"median\", \"max_height\"};\n\n MassTrace::MT_QUANTMETHOD MassTrace::getQuantMethod(const String& val)\n {\n const std::string* qb = MassTrace::names_of_quantmethod;\n const std::string* qe = qb + (int)MassTrace::SIZE_OF_MT_QUANTMETHOD;\n const std::string* qm = std::find(qb, qe, val);\n return (MassTrace::MT_QUANTMETHOD)std::distance(qb, qm);\n }\n\n MassTrace::MassTrace(const std::list<PeakType>& trace_peaks) :\n \n trace_peaks_(),\n \n label_(),\n smoothed_intensities_()\n \n {\n trace_peaks_.reserve(trace_peaks.size());\n std::copy(trace_peaks.begin(), trace_peaks.end(), back_inserter(trace_peaks_));\n }\n\n MassTrace::MassTrace(const std::vector<PeakType>& trace_peaks) :\n \n trace_peaks_(trace_peaks),\n \n label_(),\n smoothed_intensities_()\n \n {\n }\n\n PeakType& MassTrace::operator[](const Size& mt_idx)\n {\n return trace_peaks_[mt_idx];\n }\n\n const PeakType& MassTrace::operator[](const Size& mt_idx) const\n {\n return trace_peaks_[mt_idx];\n }\n\n double MassTrace::computeSmoothedPeakArea() const\n {\n // sum all smoothed intensities in MassTrace which are non-negative\n double peak_area(0.0);\n\n double int_before = smoothed_intensities_[0];\n double rt_before = trace_peaks_.begin()->getRT();\n for (Size i = 1; i < smoothed_intensities_.size(); ++i)\n {\n if (smoothed_intensities_[i] > 0.0)\n {\n double rt_diff = trace_peaks_[i].getRT() - rt_before;\n peak_area += (int_before + trace_peaks_[i].getIntensity())/2 * rt_diff;\n }\n int_before = trace_peaks_[i].getIntensity();\n rt_before = trace_peaks_[i].getRT();\n }\n return peak_area;\n }\n\n double MassTrace::computePeakArea() const\n {\n double peak_area(0.0);\n\n if (trace_peaks_.empty())\n {\n return peak_area;\n }\n double int_before = trace_peaks_.begin()->getIntensity();\n double rt_before = trace_peaks_.begin()->getRT();\n for (const Peak2D& l_it : trace_peaks_)\n {\n double rt_diff = l_it.getRT() - rt_before;\n peak_area += (int_before + l_it.getIntensity())/2 * rt_diff;\n int_before = l_it.getIntensity();\n rt_before = l_it.getRT();\n }\n\n return peak_area;\n }\n\n\n double MassTrace::computeIntensitySum() const\n {\n return std::accumulate(trace_peaks_.begin(), trace_peaks_.end(), 0.0, \n [](double sum, const Peak2D& peak) { return sum + peak.getIntensity(); });\n } \n\n Size MassTrace::findMaxByIntPeak(bool use_smoothed_ints) const\n {\n if (use_smoothed_ints && smoothed_intensities_.empty())\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"MassTrace was not smoothed before! Aborting...\", String(smoothed_intensities_.size()));\n }\n\n if (trace_peaks_.empty())\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"MassTrace appears to be empty! Aborting...\", String(trace_peaks_.size()));\n }\n\n double max_int;\n Size max_idx(0);\n\n if (use_smoothed_ints)\n {\n max_int = smoothed_intensities_[0];\n }\n else\n {\n max_int = trace_peaks_.begin()->getIntensity();\n }\n\n for (Size i = 0; i < trace_peaks_.size(); ++i)\n {\n double act_int = use_smoothed_ints ? smoothed_intensities_[i] : trace_peaks_[i].getIntensity();\n\n if (act_int > max_int)\n {\n max_int = act_int;\n max_idx = i;\n }\n\n }\n\n return max_idx;\n }\n\n double MassTrace::estimateFWHM(bool use_smoothed_ints)\n {\n Size max_idx(this->findMaxByIntPeak(use_smoothed_ints));\n\n std::vector<double> tmp_ints;\n\n if (use_smoothed_ints)\n {\n tmp_ints = smoothed_intensities_;\n }\n else\n {\n for (Size vec_idx = 0; vec_idx < trace_peaks_.size(); ++vec_idx)\n {\n tmp_ints.push_back(trace_peaks_[vec_idx].getIntensity());\n }\n }\n\n double half_max_int(tmp_ints[max_idx] / 2.0);\n\n // mass trace is empty OR no points left of apex in mass trace OR no points right of apex in mass trace\n if (tmp_ints.empty() || max_idx == 0 || max_idx == tmp_ints.size() - 1)\n {\n fwhm_start_idx_ = 0;\n fwhm_end_idx_ = 0;\n return 0;\n }\n\n Size left_border(max_idx), right_border(max_idx);\n\n while (left_border > 0 && tmp_ints[left_border] >= half_max_int)\n {\n --left_border;\n }\n\n while (right_border + 1 < tmp_ints.size() && tmp_ints[right_border] >= half_max_int)\n {\n ++right_border;\n }\n\n fwhm_start_idx_ = left_border;\n fwhm_end_idx_ = right_border;\n\n // calculate RT of left side\n Size fwhm_left_top_idx = left_border + 1;\n double left_rt_bottom = trace_peaks_[left_border].getRT();\n double left_rt_top = trace_peaks_[fwhm_left_top_idx].getRT();\n double fwhm_begin_rt;\n // no points below half max -> don't extrapolate, use leftmost RT\n if (tmp_ints[left_border] > half_max_int)\n {\n fwhm_begin_rt = trace_peaks_[left_border].getRT();\n }\n else\n {\n fwhm_begin_rt = linearInterpolationAtY_(left_rt_bottom, left_rt_top,\n (tmp_ints[left_border]),\n (tmp_ints[fwhm_left_top_idx]),\n (half_max_int));\n }\n\n // calculate RT of right side\n Size fwhm_right_top_idx = right_border - 1;\n double right_rt_bottom = trace_peaks_[right_border].getRT();\n double right_rt_top = trace_peaks_[fwhm_right_top_idx].getRT();\n\n double fwhm_end_rt;\n // no points below half max -> don't extrapolate, use rightmost RT\n if (tmp_ints[right_border] > half_max_int)\n {\n fwhm_end_rt = trace_peaks_[right_border].getRT();\n }\n else\n {\n fwhm_end_rt = linearInterpolationAtY_(right_rt_top, right_rt_bottom,\n (tmp_ints[right_border]),\n (tmp_ints[fwhm_right_top_idx]),\n (half_max_int));\n }\n\n fwhm_ = std::fabs(fwhm_end_rt - fwhm_begin_rt);\n\n OPENMS_POSTCONDITION(fwhm_ <= std::fabs(trace_peaks_[right_border].getRT() - trace_peaks_[left_border].getRT()), \"Interpolated fwhm is not smaller than extrapolated fwhm!\")\n\n return fwhm_;\n }\n\n double MassTrace::linearInterpolationAtY_(double xA, double xB, double yA, double yB, double y_eval) const\n {\n OPENMS_PRECONDITION(yA <= y_eval && y_eval <= yB, \"y_eval is not between yA and yB\")\n // no solution -> return an estimate\n if (std::fabs(xA - xB) == 0 || std::fabs(yA - yB) == 0) { return xA; }\n\n double xC = (xA + ((y_eval - yA) * (xB - xA) / (yB - yA)));\n OPENMS_POSTCONDITION(xA <= xC && xC <= xB, \"xC is not between xA and xB\");\n\n return xC;\n }\n\n /// determine if area or median is used for quantification\n /// @throw Exception::InvalidValue if SIZE_OF_MT_QUANTMETHOD is given\n void MassTrace::setQuantMethod(MassTrace::MT_QUANTMETHOD method)\n {\n if (method >= SIZE_OF_MT_QUANTMETHOD)\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Value of 'quant_method' cannot be 'SIZE_OF_MT_QUANTMETHOD'.\", \"\");\n }\n quant_method_ = method;\n }\n\n /// check if area or median is used for quantification\n MassTrace::MT_QUANTMETHOD MassTrace::getQuantMethod() const\n {\n return quant_method_;\n }\n\n double MassTrace::computeFwhmAreaSmooth() const\n {\n if (fwhm_start_idx_ == 0 && fwhm_end_idx_ == 0)\n {\n return 0;\n }\n\n double t_area(0.0);\n double int_before = smoothed_intensities_[fwhm_start_idx_];\n double rt_before = trace_peaks_[fwhm_start_idx_].getRT();\n // note '<=' operator, since fwhm_end_idx_ is inclusive!\n for (Size i = fwhm_start_idx_ + 1; i <= fwhm_end_idx_; ++i)\n {\n t_area += (int_before + smoothed_intensities_[i])/2 * (trace_peaks_[i].getRT() - rt_before);\n int_before = smoothed_intensities_[i];\n rt_before = trace_peaks_[i].getRT();\n }\n\n return t_area;\n }\n\n double MassTrace::computeFwhmArea() const\n {\n if (fwhm_start_idx_ == 0 && fwhm_end_idx_ == 0)\n {\n return 0;\n }\n\n double t_area(0);\n double int_before = trace_peaks_[fwhm_start_idx_].getIntensity();\n double rt_before = trace_peaks_[fwhm_start_idx_].getRT();\n // note '<=' operator, since fwhm_end_idx_ is inclusive!\n for (Size i = fwhm_start_idx_ + 1; i <= fwhm_end_idx_; ++i)\n {\n t_area += (int_before + trace_peaks_[i].getIntensity())/2 * (trace_peaks_[i].getRT() - rt_before);\n int_before = trace_peaks_[i].getIntensity();\n rt_before = trace_peaks_[i].getRT();\n }\n\n return t_area;\n }\n\n double MassTrace::computeMedianIntensity_() const\n {\n // determine median of intensities\n double t_area(0);\n std::vector<double> ints;\n ints.reserve(trace_peaks_.size());\n for (Size i=0; i<trace_peaks_.size(); ++i)\n {\n ints.push_back(trace_peaks_[i].getIntensity());\n }\n sort(ints.begin(), ints.end());\n t_area = (ints.size() % 2 == 0 ? 0.5*(ints[ints.size()/2-1]+ints[ints.size()/2])\n : ints[ints.size()/2]);\n return t_area;\n }\n\n double MassTrace::getIntensity(bool smoothed) const\n {\n if (smoothed)\n { // will be removed soon\n switch (quant_method_)\n {\n case MT_QUANT_AREA:\n return computeFwhmAreaSmooth();\n case MT_QUANT_MEDIAN:\n // median quantification (e.g. for direct infusion data) should work indepentently from smoothing\n return computeMedianIntensity_();\n case MT_QUANT_HEIGHT:\n return getMaxIntensity(true);\n default:\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Member 'quant_method_' has unsupported value.\", String(quant_method_));\n }\n\n }\n else\n {\n switch (quant_method_)\n {\n case MT_QUANT_AREA:\n return computeFwhmArea();\n case MT_QUANT_MEDIAN:\n return computeMedianIntensity_();\n case MT_QUANT_HEIGHT:\n return getMaxIntensity(false);\n default:\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Member 'quant_method_' has unsupported value.\", String(quant_method_));\n\n }\n }\n }\n\n double MassTrace::getMaxIntensity(bool smoothed) const\n {\n double max_int(0.0);\n\n if (smoothed)\n {\n for (Size i = 0; i < smoothed_intensities_.size(); ++i)\n {\n if (smoothed_intensities_[i] > max_int)\n {\n max_int = smoothed_intensities_[i];\n }\n }\n }\n else\n {\n for (Size i = 0; i < trace_peaks_.size(); ++i)\n {\n if (trace_peaks_[i].getIntensity() > max_int)\n {\n max_int = trace_peaks_[i].getIntensity();\n }\n }\n }\n\n return max_int;\n }\n\n ConvexHull2D MassTrace::getConvexhull() const\n {\n ConvexHull2D::PointArrayType hull_points(trace_peaks_.size());\n\n Size i = 0;\n for (const Peak2D& l_it : trace_peaks_)\n {\n hull_points[i][0] = (l_it).getRT();\n hull_points[i][1] = (l_it).getMZ();\n ++i;\n }\n\n ConvexHull2D hull;\n hull.addPoints(hull_points);\n\n return hull;\n }\n\n void MassTrace::updateWeightedMeanRT()\n {\n if (trace_peaks_.empty())\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"MassTrace is empty... centroid RT undefined!\", String(trace_peaks_.size()));\n }\n\n // support single peak traces\n if (trace_peaks_.size() == 1)\n {\n centroid_rt_ = (*(trace_peaks_.begin())).getRT();\n return;\n }\n\n\n\n\n /* seems not to work with the way we compute the area in the code below -> as a result the RT values are outside the feature boundaries\n trace_area = this->computePeakArea();\n\n if (trace_area < std::numeric_limits<double>::epsilon())\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Peak area equals zero... impossible to compute weights!\", String(trace_peaks_.size()));\n }\n the reason is because computePeakArea uses trapezoidal rule to compute the area, which is not the same as the sum of the intensities\n we could probably change the part below to also use trapezoidal rule to compute the trace area\n */\n\n double wmean_rt(0.0);\n double trace_area = 0;\n\n double rt_before = trace_peaks_[0].getRT();\n for (MassTrace::const_iterator l_it = trace_peaks_.begin() + 1; l_it != trace_peaks_.end(); ++l_it)\n {\n double rt_diff = l_it->getRT() - rt_before; \n wmean_rt += l_it->getIntensity() * l_it->getRT() * rt_diff;\n rt_before = l_it->getRT();\n trace_area += l_it->getIntensity() * rt_diff;\n }\n centroid_rt_ = wmean_rt / trace_area;\n }\n\n void MassTrace::updateSmoothedWeightedMeanRT()\n {\n if (smoothed_intensities_.empty())\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"MassTrace was not smoothed before! Aborting...\", String(smoothed_intensities_.size()));\n }\n\n // support single peak traces\n if (trace_peaks_.size() == 1)\n {\n centroid_rt_ = (*(trace_peaks_.begin())).getRT();\n return;\n }\n\n double trace_area(0.0), wmean_rt(0.0);\n\n for (Size i = 0; i < smoothed_intensities_.size(); ++i)\n {\n if (smoothed_intensities_[i] > 0.0)\n {\n wmean_rt += smoothed_intensities_[i] * trace_peaks_[i].getRT();\n trace_area += smoothed_intensities_[i];\n }\n }\n\n if (trace_area < std::numeric_limits<double>::epsilon())\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Peak area equals to zero... impossible to compute weights!\", String(trace_peaks_.size()));\n }\n\n centroid_rt_ = wmean_rt / trace_area;\n }\n\n void MassTrace::updateSmoothedMaxRT()\n {\n if (smoothed_intensities_.empty())\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"MassTrace was not smoothed before! Aborting...\", String(smoothed_intensities_.size()));\n }\n // Handle single-peak traces: set centroid RT directly from the only peak\n if (trace_peaks_.size() == 1)\n {\n centroid_rt_ = (*(trace_peaks_.begin())).getRT();\n return;\n }\n\n double tmp_max(-1.0);\n Size max_idx(0);\n\n for (Size i = 0; i < smoothed_intensities_.size(); ++i)\n {\n if (smoothed_intensities_[i] > tmp_max)\n {\n tmp_max = smoothed_intensities_[i];\n max_idx = i;\n }\n }\n\n if (tmp_max <= 0.0)\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Negative max intensity encountered!\", String(tmp_max));\n }\n\n centroid_rt_ = trace_peaks_[max_idx].getRT();\n }\n\n void MassTrace::updateMedianRT()\n {\n if (trace_peaks_.empty())\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"MassTrace is empty... centroid RT undefined!\", String(trace_peaks_.size()));\n }\n\n if (trace_peaks_.size() == 1)\n {\n centroid_rt_ = (*(trace_peaks_.begin())).getRT();\n return;\n }\n\n // copy mz values to temp vec\n std::vector<double> temp_rt;\n\n for (const Peak2D& l_it : trace_peaks_)\n {\n temp_rt.push_back((l_it).getRT());\n }\n\n std::sort(temp_rt.begin(), temp_rt.end());\n\n Size temp_mz_size = temp_rt.size();\n Size mid = static_cast<Size>(temp_mz_size / 2.0);\n if ((temp_mz_size % 2) == 0)\n {\n centroid_rt_ = (temp_rt[mid - 1] + temp_rt[mid]) / 2;\n }\n else\n {\n centroid_rt_ = temp_rt[mid];\n }\n\n\n return;\n }\n\n void MassTrace::updateMedianMZ()\n {\n if (trace_peaks_.empty())\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"MassTrace is empty... centroid MZ undefined!\", String(trace_peaks_.size()));\n }\n\n if (trace_peaks_.size() == 1)\n {\n centroid_mz_ = (*(trace_peaks_.begin())).getMZ();\n return;\n }\n\n // copy mz values to temp vec\n std::vector<double> temp_mz;\n\n for (const Peak2D& l_it : trace_peaks_)\n {\n temp_mz.push_back((l_it).getMZ());\n }\n\n std::sort(temp_mz.begin(), temp_mz.end());\n\n Size temp_mz_size = temp_mz.size();\n Size mid = static_cast<Size>(temp_mz_size / 2.0);\n if ((temp_mz_size % 2) == 0)\n {\n centroid_mz_ = (temp_mz[mid - 1] + temp_mz[mid]) / 2;\n }\n else\n {\n centroid_mz_ = temp_mz[mid];\n }\n\n return;\n }\n\n void MassTrace::updateMeanMZ()\n {\n if (trace_peaks_.empty())\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"MassTrace is empty... centroid MZ undefined!\", String(trace_peaks_.size()));\n }\n\n if (trace_peaks_.size() == 1)\n {\n centroid_mz_ = (*(trace_peaks_.begin())).getMZ();\n return;\n }\n\n Size trace_size = trace_peaks_.size();\n\n double sum_mz(0.0);\n\n for (const Peak2D& l_it : trace_peaks_)\n {\n sum_mz += (l_it).getMZ();\n }\n\n centroid_mz_ = sum_mz / trace_size;\n\n return;\n }\n\n void MassTrace::updateWeightedMeanMZ()\n {\n if (trace_peaks_.empty())\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"MassTrace is empty... centroid MZ undefined!\", String(trace_peaks_.size()));\n }\n\n if (trace_peaks_.size() == 1)\n {\n centroid_mz_ = (*(trace_peaks_.begin())).getMZ();\n return;\n }\n\n double weighted_sum(0.0);\n double total_weight(0.0);\n\n for (const Peak2D& l_it : trace_peaks_)\n {\n double w_i = (l_it).getIntensity();\n total_weight += w_i;\n weighted_sum += w_i * (l_it).getMZ();\n }\n\n if (total_weight < std::numeric_limits<double>::epsilon())\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"All weights were equal to zero! Empty trace? Aborting...\", String(total_weight));\n }\n\n centroid_mz_ = weighted_sum / total_weight;\n }\n\n void MassTrace::updateWeightedMZsd()\n {\n if (trace_peaks_.empty())\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"MassTrace is empty... std of MZ undefined!\", String(trace_peaks_.size()));\n }\n\n double weighted_sum(0.0);\n double total_weight(0.0);\n\n for (const Peak2D& l_it : trace_peaks_)\n {\n double w_i = l_it.getIntensity();\n total_weight += w_i;\n weighted_sum += w_i * std::exp(2 * std::log(std::abs(l_it.getMZ() - centroid_mz_)));\n }\n\n if (total_weight < std::numeric_limits<double>::epsilon())\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"All weights were equal to zero! Empty trace? Aborting...\", String(total_weight));\n }\n\n centroid_sd_ = std::sqrt(weighted_sum) / std::sqrt(total_weight);\n\n }\n\n} // end of MassTrace.cpp\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9380,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/SpectrumRangeManager.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":492,"string":"492"},"line_count":{"kind":"number","value":14,"string":"14"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg $\n// $Authors: Administrator $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/SpectrumRangeManager.h>\n\nnamespace OpenMS\n{\n // Currently empty as the class only contains inline implementations\n}"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9381,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/DimMapper.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":1556,"string":"1,556"},"line_count":{"kind":"number","value":58,"string":"58"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Chris Bielow $\n// $Authors: Chris Bielow $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/DimMapper.h>\n\n#include <OpenMS/DATASTRUCTURES/String.h>\n\n#include <QtCore/QLocale>\n\nusing namespace std;\n\n\nnamespace OpenMS\n{\n namespace\n {\n DimMapper<1> dims({DIM_UNIT::RT});\n DimMapper<1> d({DIM_UNIT::RT});\n DimMapper<1> d2(d);\n bool x = (d == dims);\n Area<2> area(nullptr);\n }\n\n String DimBase::formattedValue(const ValueType value) const\n {\n // hint: QLocale::c().toString adds group separators to better visualize large numbers (e.g. 23.009.646.54,3)\n return String(this->getDimNameShort()) + \": \" + QLocale::c().toString(value, 'f', valuePrecision());\n }\n\n String DimBase::formattedValue(const ValueType value, const String& prefix) const\n {\n return prefix + formattedValue(value);\n }\n\n int DimBase::valuePrecision() const\n {\n // decide on precision depending on unit; add more units if you have some intuition\n constexpr auto precision_for_unit = [](DIM_UNIT u) {\n switch (u)\n {\n case DIM_UNIT::RT:\n case DIM_UNIT::INT:\n return 2;\n case DIM_UNIT::MZ:\n return 8;\n default:\n return 4;\n }\n };\n return precision_for_unit(this->getUnit());\n }\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9382,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/KERNEL/MSExperiment.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":35753,"string":"35,753"},"line_count":{"kind":"number","value":1116,"string":"1,116"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Timo Sachsenberg$\n// $Authors: Marc Sturm, Tom Waschischeck $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/config.h> // for OPENMS_ASSERTIONS\n\n#include <OpenMS/KERNEL/MSExperiment.h>\n\n#include <OpenMS/CONCEPT/LogStream.h>\n#include <OpenMS/DATASTRUCTURES/ListUtils.h>\n#include <OpenMS/PROCESSING/RESAMPLING/LinearResamplerAlign.h>\n#include <OpenMS/KERNEL/ChromatogramPeak.h>\n#include <OpenMS/KERNEL/Peak1D.h>\n#include <OpenMS/SYSTEM/File.h>\n\n#include <algorithm>\n#include <limits>\n#include <unordered_set>\n\nnamespace OpenMS\n{\n /// Constructor\n MSExperiment::MSExperiment() :\n ExperimentalSettings(),\n spectrum_ranges_(),\n chromatogram_ranges_(),\n combined_ranges_()\n {}\n\n /// Copy constructor\n MSExperiment::MSExperiment(const MSExperiment & source) = default;\n\n /// Assignment operator\n MSExperiment & MSExperiment::operator=(const MSExperiment & source)\n {\n if (&source == this)\n {\n return *this;\n }\n ExperimentalSettings::operator=(source);\n\n chromatograms_ = source.chromatograms_;\n spectra_ = source.spectra_;\n \n // Copy the range managers\n spectrum_ranges_ = source.spectrum_ranges_;\n chromatogram_ranges_ = source.chromatogram_ranges_;\n combined_ranges_ = source.combined_ranges_;\n\n return *this;\n }\n\n /// Assignment operator\n MSExperiment& MSExperiment::operator=(const ExperimentalSettings & source)\n {\n ExperimentalSettings::operator=(source);\n return *this;\n }\n\n MSExperiment::~MSExperiment() = default;\n\n /// Equality operator\n bool MSExperiment::operator==(const MSExperiment & rhs) const\n {\n return ExperimentalSettings::operator==(rhs) &&\n chromatograms_ == rhs.chromatograms_ &&\n spectra_ == rhs.spectra_;\n }\n\n /// Equality operator\n bool MSExperiment::operator!=(const MSExperiment & rhs) const\n {\n return !(operator==(rhs));\n }\n\n Size MSExperiment::size() const noexcept\n {\n return spectra_.size();\n }\n\n void MSExperiment::resize(Size n)\n {\n spectra_.resize(n);\n }\n\n bool MSExperiment::empty() const noexcept\n {\n return spectra_.empty();\n }\n\n void MSExperiment::reserve(Size n)\n {\n spectra_.reserve(n);\n }\n\n MSExperiment::SpectrumType& MSExperiment::operator[](Size n)\n {\n return spectra_[n];\n }\n\n const MSExperiment::SpectrumType& MSExperiment::operator[](Size n) const\n {\n return spectra_[n];\n }\n\n MSExperiment::Iterator MSExperiment::begin() noexcept\n {\n return spectra_.begin();\n }\n\n MSExperiment::ConstIterator MSExperiment::begin() const noexcept\n {\n return spectra_.cbegin();\n }\n\n MSExperiment::ConstIterator MSExperiment::cbegin() const noexcept\n {\n return spectra_.cbegin();\n }\n\n MSExperiment::Iterator MSExperiment::end()\n {\n return spectra_.end();\n }\n\n MSExperiment::ConstIterator MSExperiment::end() const noexcept\n {\n return spectra_.cend();\n }\n\n MSExperiment::ConstIterator MSExperiment::cend() const noexcept\n {\n return spectra_.cend();\n }\n\n void MSExperiment::get2DPeakDataPerSpectrum(\n CoordinateType min_rt,\n CoordinateType max_rt,\n CoordinateType min_mz,\n CoordinateType max_mz,\n Size ms_level,\n std::vector<float>& rt,\n std::vector<std::vector<float>>& mz,\n std::vector<std::vector<float>>& intensity) const\n {\n float t = -1.0;\n for (auto it = areaBeginConst(min_rt, max_rt, min_mz, max_mz, ms_level); it != areaEndConst(); ++it)\n {\n if (it.getRT() != t)\n {\n t = (float)it.getRT();\n rt.push_back(t);\n mz.push_back(std::vector<float>());\n intensity.push_back(std::vector<float>());\n }\n mz.back().push_back((float)it->getMZ());\n intensity.back().push_back(it->getIntensity());\n }\n }\n\n void MSExperiment::get2DPeakDataIMPerSpectrum(\n CoordinateType min_rt,\n CoordinateType max_rt,\n CoordinateType min_mz,\n CoordinateType max_mz,\n Size ms_level,\n std::vector<float>& rt,\n std::vector<std::vector<float>>& mz,\n std::vector<std::vector<float>>& intensity,\n std::vector<std::vector<float>>& ion_mobility) const\n {\n DriftTimeUnit unit = DriftTimeUnit::NONE;\n std::vector<float> im;\n float t = -1.0;\n for (auto it = areaBeginConst(min_rt, max_rt, min_mz, max_mz, ms_level); it != areaEndConst(); ++it)\n {\n if (it.getRT() != t)\n {\n t = (float)it.getRT();\n rt.push_back(t);\n std::tie(unit, im) = it.getSpectrum().maybeGetIMData();\n mz.push_back(std::vector<float>());\n intensity.push_back(std::vector<float>());\n ion_mobility.push_back(std::vector<float>());\n }\n\n if (unit != DriftTimeUnit::NONE)\n {\n const Size peak_index = it.getPeakIndex().peak;\n ion_mobility.back().push_back(im[peak_index]);\n }\n else\n {\n ion_mobility.back().push_back(-1.0);\n }\n mz.back().push_back((float)it->getMZ());\n intensity.back().push_back(it->getIntensity());\n }\n }\n\n void MSExperiment::get2DPeakData(\n CoordinateType min_rt,\n CoordinateType max_rt,\n CoordinateType min_mz,\n CoordinateType max_mz,\n Size ms_level,\n std::vector<float>& rt,\n std::vector<float>& mz,\n std::vector<float>& intensity) const\n {\n for (auto it = areaBeginConst(min_rt, max_rt, min_mz, max_mz, ms_level); it != areaEndConst(); ++it)\n {\n rt.push_back((float)it.getRT());\n mz.push_back((float)it->getMZ());\n intensity.push_back(it->getIntensity());\n }\n }\n\n void MSExperiment::get2DPeakDataIM(\n CoordinateType min_rt,\n CoordinateType max_rt,\n CoordinateType min_mz,\n CoordinateType max_mz,\n Size ms_level,\n std::vector<float>& rt,\n std::vector<float>& mz,\n std::vector<float>& intensity,\n std::vector<float>& ion_mobility) const\n {\n for (auto it = areaBeginConst(min_rt, max_rt, min_mz, max_mz, ms_level); it != areaEndConst(); ++it)\n {\n DriftTimeUnit unit = DriftTimeUnit::NONE;\n std::vector<float> im;\n float t = -1.0;\n if (it.getRT() != t)\n {\n t = (float)it.getRT();\n std::tie(unit, im) = it.getSpectrum().maybeGetIMData();\n }\n rt.push_back((float)it.getRT());\n mz.push_back((float)it->getMZ());\n intensity.push_back(it->getIntensity());\n if (unit != DriftTimeUnit::NONE)\n {\n const Size peak_index = it.getPeakIndex().peak;\n ion_mobility.push_back(im[peak_index]);\n }\n else\n {\n ion_mobility.push_back(-1.0);\n }\n }\n }\n\n void MSExperiment::reserveSpaceSpectra(Size s)\n {\n spectra_.reserve(s);\n }\n\n void MSExperiment::reserveSpaceChromatograms(Size s)\n {\n chromatograms_.reserve(s);\n }\n\n ///@name Iterating ranges and areas\n //@{\n /// Returns an area iterator for @p area\n MSExperiment::AreaIterator MSExperiment::areaBegin(CoordinateType min_rt, CoordinateType max_rt, CoordinateType min_mz, CoordinateType max_mz, UInt ms_level)\n {\n OPENMS_PRECONDITION(min_rt <= max_rt, \"Swapped RT range boundaries!\")\n OPENMS_PRECONDITION(min_mz <= max_mz, \"Swapped MZ range boundaries!\")\n OPENMS_PRECONDITION(this->isSorted(true), \"Experiment is not sorted by RT and m/z! Using AreaIterator will give invalid results!\")\n auto [min_im, max_im] = RangeMobility{}.getNonEmptyRange(); // a full range\n auto area = AreaIterator::Param(spectra_.begin(), RTBegin(min_rt), RTEnd(max_rt), ms_level);\n area.lowMZ(min_mz).highMZ(max_mz).lowIM(min_im).highIM(max_im);\n return AreaIterator(area);\n }\n\n MSExperiment::AreaIterator MSExperiment::areaBegin(const RangeManagerType& range, UInt ms_level)\n {\n OPENMS_PRECONDITION(this->isSorted(true), \"Experiment is not sorted by RT and m/z! Using ConstAreaIterator will give invalid results!\")\n auto [min_rt, max_rt] = range.RangeRT::getNonEmptyRange();\n auto [min_mz, max_mz] = range.RangeMZ::getNonEmptyRange();\n auto [min_im, max_im] = range.RangeMobility::getNonEmptyRange();\n auto area = AreaIterator::Param(spectra_.begin(), RTBegin(min_rt), RTEnd(max_rt), ms_level);\n area.lowMZ(min_mz).highMZ(max_mz).lowIM(min_im).highIM(max_im);\n return AreaIterator(area);\n }\n\n /// Returns an invalid area iterator marking the end of an area\n MSExperiment::AreaIterator MSExperiment::areaEnd()\n {\n return AreaIterator();\n }\n\n /// Returns a non-mutable area iterator for @p area\n MSExperiment::ConstAreaIterator MSExperiment::areaBeginConst(CoordinateType min_rt, CoordinateType max_rt, CoordinateType min_mz, CoordinateType max_mz, UInt ms_level) const\n {\n OPENMS_PRECONDITION(min_rt <= max_rt, \"Swapped RT range boundaries!\")\n OPENMS_PRECONDITION(min_mz <= max_mz, \"Swapped MZ range boundaries!\")\n OPENMS_PRECONDITION(this->isSorted(true), \"Experiment is not sorted by RT and m/z! Using ConstAreaIterator will give invalid results!\")\n auto [min_im, max_im] = RangeMobility{}.getNonEmptyRange(); // a full range\n auto area = ConstAreaIterator::Param(spectra_.begin(), RTBegin(min_rt), RTEnd(max_rt), ms_level);\n area.lowMZ(min_mz).highMZ(max_mz).lowIM(min_im).highIM(max_im);\n return ConstAreaIterator(area);\n }\n\n MSExperiment::ConstAreaIterator MSExperiment::areaBeginConst(const RangeManagerType& range, UInt ms_level) const\n {\n OPENMS_PRECONDITION(this->isSorted(true), \"Experiment is not sorted by RT and m/z! Using ConstAreaIterator will give invalid results!\")\n auto [min_rt, max_rt] = range.RangeRT::getNonEmptyRange();\n auto [min_mz, max_mz] = range.RangeMZ::getNonEmptyRange();\n auto [min_im, max_im] = range.RangeMobility::getNonEmptyRange();\n auto area = ConstAreaIterator::Param(spectra_.begin(), RTBegin(min_rt), RTEnd(max_rt), ms_level);\n area.lowMZ(min_mz).highMZ(max_mz).lowIM(min_im).highIM(max_im);\n return ConstAreaIterator(area);\n }\n\n /// Returns an non-mutable invalid area iterator marking the end of an area\n MSExperiment::ConstAreaIterator MSExperiment::areaEndConst() const\n {\n return ConstAreaIterator();\n }\n\n /**\n @brief Fast search for spectrum range begin\n\n Returns the first scan which has equal or higher (>=) RT than @p rt.\n\n @note Make sure the spectra are sorted with respect to retention time! Otherwise the result is undefined.\n */\n MSExperiment::ConstIterator MSExperiment::RTBegin(CoordinateType rt) const\n {\n SpectrumType s;\n s.setRT(rt);\n return lower_bound(spectra_.begin(), spectra_.end(), s, SpectrumType::RTLess());\n }\n\n /**\n @brief Fast search for spectrum range end (returns the past-the-end iterator)\n\n Returns the first scan which has higher (>) RT than @p rt.\n\n @note Make sure the spectra are sorted with respect to retention time! Otherwise the result is undefined.\n */\n MSExperiment::ConstIterator MSExperiment::RTEnd(CoordinateType rt) const\n {\n SpectrumType s;\n s.setRT(rt);\n return upper_bound(spectra_.begin(), spectra_.end(), s, SpectrumType::RTLess());\n }\n\n /**\n @brief Fast search for spectrum range begin\n\n @note Make sure the spectra are sorted with respect to retention time! Otherwise the result is undefined.\n */\n MSExperiment::Iterator MSExperiment::RTBegin(CoordinateType rt)\n {\n SpectrumType s;\n s.setRT(rt);\n return lower_bound(spectra_.begin(), spectra_.end(), s, SpectrumType::RTLess());\n }\n\n /**\n @brief Fast search for spectrum range end (returns the past-the-end iterator)\n\n @note Make sure the spectra are sorted with respect to retention time! Otherwise the result is undefined.\n */\n MSExperiment::Iterator MSExperiment::RTEnd(CoordinateType rt)\n {\n SpectrumType s;\n s.setRT(rt);\n return upper_bound(spectra_.begin(), spectra_.end(), s, SpectrumType::RTLess());\n }\n\n MSExperiment::ConstIterator MSExperiment::IMBegin(CoordinateType im) const\n {\n SpectrumType s;\n s.setDriftTime(im);\n return lower_bound(spectra_.begin(), spectra_.end(), s, SpectrumType::IMLess());\n }\n\n MSExperiment::ConstIterator MSExperiment::IMEnd(CoordinateType im) const\n {\n SpectrumType s;\n s.setDriftTime(im);\n return upper_bound(spectra_.begin(), spectra_.end(), s, SpectrumType::IMLess());\n }\n\n //@}\n\n /**\n @name Range methods\n */\n\n /**\n @brief Updates the m/z, intensity, retention time, ion mobility ranges for all spectra and chromatograms\n */\n void MSExperiment::updateRanges()\n {\n #ifdef OPENMS_ASSERTIONS\n double rt_min = combined_ranges_.RangeRT::isEmpty() ? 0 : combined_ranges_.getMinRT();\n double rt_max = combined_ranges_.RangeRT::isEmpty() ? 0 : combined_ranges_.getMaxRT();\n double mz_min = combined_ranges_.RangeMZ::isEmpty() ? 0 : combined_ranges_.getMinMZ();\n double mz_max = combined_ranges_.RangeMZ::isEmpty() ? 0 : combined_ranges_.getMaxMZ();\n double int_min = combined_ranges_.RangeIntensity::isEmpty() ? 0 : combined_ranges_.getMinIntensity();\n double int_max = combined_ranges_.RangeIntensity::isEmpty() ? 0 : combined_ranges_.getMaxIntensity();\n double im_min = combined_ranges_.RangeMobility::isEmpty() ? 0 : combined_ranges_.getMinMobility();\n double im_max = combined_ranges_.RangeMobility::isEmpty() ? 0 : combined_ranges_.getMaxMobility();\n #endif\n\n // Reset all range managers\n clearRanges();\n\n // Empty experiment\n if (spectra_.empty() && chromatograms_.empty())\n {\n return;\n }\n\n // Update spectrum ranges\n for (Base::iterator it = spectra_.begin(); it != spectra_.end(); ++it)\n { \n // Update ranges for the spectrum itself\n it->updateRanges();\n \n // Update spectrum range manager with this spectrum's ranges\n // Add to both general ranges and MS level-specific ranges\n spectrum_ranges_.extendUnsafe(*it);\n spectrum_ranges_.extendRT(it->getRT()); // RT is not part of the range of an individual spectrum\n \n spectrum_ranges_.extendUnsafe(*it, it->getMSLevel());\n spectrum_ranges_.extendRT(it->getRT(), it->getMSLevel()); // RT is not part of the range of an individual spectrum\n \n }\n\n // Update chromatogram ranges\n if (!chromatograms_.empty())\n {\n for (ChromatogramType& cp : chromatograms_)\n {\n // Update range of EACH chromatogram\n cp.updateRanges();\n \n // Add RT and intensity ranges to the chromatogram manager\n chromatogram_ranges_.extend(cp.getRange());\n chromatogram_ranges_.extendMZ(cp.getMZ()); // MZ is not part of the range of an individual chromatogram\n }\n }\n\n // Update the combined range manager with both spectrum and chromatogram ranges\n combined_ranges_.extendUnsafe(spectrum_ranges_);\n combined_ranges_.extendUnsafe(chromatogram_ranges_);\n\n #ifdef OPENMS_ASSERTIONS\n // check if updateRanges() was necessary to find places where it was not\n double im_min_new = combined_ranges_.RangeMobility::isEmpty() ? 0 : combined_ranges_.getMinMobility();\n double im_max_new = combined_ranges_.RangeMobility::isEmpty() ? 0 : combined_ranges_.getMaxMobility();\n double int_min_new = combined_ranges_.RangeIntensity::isEmpty() ? 0 : combined_ranges_.getMinIntensity();\n double int_max_new = combined_ranges_.RangeIntensity::isEmpty() ? 0 : combined_ranges_.getMaxIntensity();\n double rt_min_new = combined_ranges_.RangeRT::isEmpty() ? 0 : combined_ranges_.getMinRT();\n double rt_max_new = combined_ranges_.RangeRT::isEmpty() ? 0 : combined_ranges_.getMaxRT();\n double mz_min_new = combined_ranges_.RangeMZ::isEmpty() ? 0 : combined_ranges_.getMinMZ();\n double mz_max_new = combined_ranges_.RangeMZ::isEmpty() ? 0 : combined_ranges_.getMaxMZ();\n\n if (im_min_new == im_min && im_max_new == im_max\n && int_min_new == int_min && int_max_new == int_max\n && mz_min_new == mz_min && mz_max_new == mz_max\n && rt_min_new == rt_min && rt_max_new == rt_max\n )\n {\n OPENMS_LOG_WARN << \"Update ranges was called but ranges were already up-to-date\" << std::endl;\n }\n #endif\n }\n\n /// returns the total number of peaks\n UInt64 MSExperiment::getSize() const\n { \n Size total_size{};\n for (const auto& spec : spectra_) total_size += spec.size(); // sum up all peaks in all spectra\n for (const auto& chrom : chromatograms_) total_size += chrom.size(); // sum up all peaks in all chromatograms\n return total_size;\n }\n\n /// returns an array of MS levels (calculated on demand)\n std::vector<UInt> MSExperiment::getMSLevels() const\n {\n std::unordered_set<UInt> level_set;\n for (const auto& spec : spectra_)\n {\n level_set.insert(spec.getMSLevel());\n }\n \n std::vector<UInt> ms_levels(level_set.begin(), level_set.end());\n std::sort(ms_levels.begin(), ms_levels.end());\n return ms_levels;\n }\n\n const String sqMassRunID = \"sqMassRunID\";\n\n UInt64 MSExperiment::getSqlRunID() const\n {\n if (metaValueExists(sqMassRunID))\n {\n return getMetaValue(sqMassRunID);\n }\n return 0;\n }\n\n void MSExperiment::setSqlRunID(UInt64 id)\n {\n setMetaValue(sqMassRunID, id);\n }\n\n ///@}\n\n ///@name Sorting spectra and peaks\n ///@{\n /**\n @brief Sorts the data points by retention time\n\n @param[in] sort_mz if @em true, spectra are sorted by m/z position as well\n */\n void MSExperiment::sortSpectra(bool sort_mz)\n {\n std::sort(spectra_.begin(), spectra_.end(), SpectrumType::RTLess());\n\n if (sort_mz)\n {\n // sort each spectrum by m/z\n for (Iterator iter = spectra_.begin(); iter != spectra_.end(); ++iter)\n {\n iter->sortByPosition();\n }\n }\n }\n\n /**\n @brief Sorts the data points of the chromatograms by m/z\n\n @param[in] sort_rt if @em true, chromatograms are sorted by rt position as well\n */\n void MSExperiment::sortChromatograms(bool sort_rt)\n {\n // sort the chromatograms according to their product m/z\n std::sort(chromatograms_.begin(), chromatograms_.end(), ChromatogramType::MZLess());\n\n if (sort_rt)\n {\n for (ChromatogramType& cp : chromatograms_)\n {\n cp.sortByPosition();\n }\n }\n }\n\n /**\n @brief Checks if all spectra are sorted with respect to ascending RT\n\n @param[in] check_mz if @em true, checks if all peaks are sorted with respect to ascending m/z\n */\n bool MSExperiment::isSorted(bool check_mz) const\n {\n // check RT positions\n for (Size i = 1; i < spectra_.size(); ++i)\n {\n if (spectra_[i - 1].getRT() > spectra_[i].getRT())\n {\n return false;\n }\n }\n // check spectra\n if (check_mz)\n {\n for (Size i = 0; i < spectra_.size(); ++i)\n {\n if (!spectra_[i].isSorted())\n {\n return false;\n }\n }\n }\n // TODO CHROM\n return true;\n }\n\n //@}\n\n /// Resets all internal values\n void MSExperiment::reset()\n {\n spectra_.clear(); //remove data\n clearRanges(); // reset all ranges\n ExperimentalSettings::operator=(ExperimentalSettings()); //reset meta info\n }\n\n /**\n @brief Clears the meta data arrays of all contained spectra (float, integer and string arrays)\n\n @return @em true if meta data arrays were present and removed. @em false otherwise.\n */\n bool MSExperiment::clearMetaDataArrays()\n {\n bool meta_present = false;\n for (Size i = 0; i < spectra_.size(); ++i)\n {\n if (!spectra_[i].getFloatDataArrays().empty() \n || !spectra_[i].getIntegerDataArrays().empty() \n || !spectra_[i].getStringDataArrays().empty())\n {\n meta_present = true;\n }\n spectra_[i].getStringDataArrays().clear();\n spectra_[i].getStringDataArrays().shrink_to_fit();\n spectra_[i].getIntegerDataArrays().clear();\n spectra_[i].getIntegerDataArrays().shrink_to_fit();\n spectra_[i].getFloatDataArrays().clear();\n spectra_[i].getFloatDataArrays().shrink_to_fit();\n }\n return meta_present;\n }\n\n /// returns the meta information of this experiment (const access)\n const ExperimentalSettings& MSExperiment::getExperimentalSettings() const\n {\n return *this;\n }\n\n /// returns the meta information of this experiment (mutable access)\n ExperimentalSettings& MSExperiment::getExperimentalSettings()\n {\n return *this;\n }\n\n /// get the file path to the first MS run\n void MSExperiment::getPrimaryMSRunPath(StringList& toFill) const\n {\n std::vector<SourceFile> sfs(this->getSourceFiles());\n for (const SourceFile& ss : sfs)\n {\n // assemble a single location string from the URI (path to file) and file name\n String path = ss.getPathToFile();\n String filename = ss.getNameOfFile();\n\n if (path.empty() || filename.empty())\n {\n OPENMS_LOG_WARN << \"Path or file name of primary MS run is empty. \"\n << \"This might be the result of incomplete conversion. \"\n << \"Not that tracing back e.g. identification results to the original file might more difficult.\" << std::endl;\n }\n else\n {\n // use Windows or UNIX path separator?\n String actual_path = path.hasPrefix(\"file:///\") ? path.substr(8) : path;\n String sep = (actual_path.has('\\\\') && !actual_path.has('/')) ? \"\\\\\" : \"/\";\n String ms_run_location = path + sep + filename;\n toFill.push_back(ms_run_location);\n }\n }\n }\n\n /**\n @brief Returns the precursor spectrum of the scan pointed to by @p iterator\n\n If there is no precursor scan the past-the-end iterator is returned.\n This assumes that precursors occur somewhere before the current spectrum\n but not necessarily the first one from the last MS level (we double-check with\n the annotated precursorList.\n */\n MSExperiment::ConstIterator MSExperiment::getPrecursorSpectrum(ConstIterator iterator) const\n {\n // if we are after the end or at the beginning where we can't go \"up\"\n if (iterator == spectra_.end() || iterator == spectra_.begin())\n {\n return spectra_.end();\n }\n UInt ms_level = iterator->getMSLevel();\n\n if (ms_level == 1) // assumes there is not level 0\n {\n return spectra_.end();\n }\n\n if (!iterator->getPrecursors().empty())\n {\n //TODO warn about taking first with the blocking LOG_WARN in such a central class?\n //if (iterator->getPrecursors().size() > 1) ...\n\n const auto precursor = iterator->getPrecursors()[0];\n if (precursor.metaValueExists(\"spectrum_ref\"))\n {\n String ref = precursor.getMetaValue(\"spectrum_ref\");\n auto tmp_spec_iter = iterator; // such that we can reiterate later\n do\n {\n --tmp_spec_iter;\n if ((ms_level - tmp_spec_iter->getMSLevel() == 1) && (tmp_spec_iter->getNativeID() == ref))\n {\n return tmp_spec_iter;\n }\n } while (tmp_spec_iter != spectra_.begin());\n }\n }\n\n // if no precursor annotation was found or it did not have a spectrum reference,\n // just\n do\n {\n --iterator;\n if (ms_level - iterator->getMSLevel() == 1)\n {\n return iterator;\n }\n } while (iterator != spectra_.begin());\n\n return spectra_.end();\n }\n\n // same as above but easier to wrap in python\n int MSExperiment::getPrecursorSpectrum(int zero_based_index) const\n {\n auto spec = spectra_.cbegin();\n spec += zero_based_index;\n auto pc_spec = getPrecursorSpectrum(spec);\n if (pc_spec == spectra_.cend()) return -1;\n return pc_spec - spectra_.cbegin(); \n }\n\n MSExperiment::ConstIterator MSExperiment::getFirstProductSpectrum(ConstIterator parent_iterator) const\n {\n // if we are already at or after the end -> there can be no product after it\n if (parent_iterator == spectra_.end() \n || parent_iterator == spectra_.end() - 1)\n {\n return spectra_.end();\n }\n\n UInt parent_ms_level = parent_iterator->getMSLevel();\n const auto& parent_native_id = parent_iterator->getNativeID();\n\n auto it = parent_iterator; // such that we can reiterate later\n it++; // start at the next spectrum\n\n while (it != spectra_.end())\n { \n if (it->getMSLevel() < parent_ms_level) return spectra_.end();\n\n if ((it->getMSLevel() - parent_ms_level) == 1) \n { // it is a potential product spectrum (one level higher than parent)\n\n // does it have precursors referencing the parents?\n if (it->getPrecursors().empty()) \n {\n ++it; // no precursors, so we can't check if it is a product of the parent\n continue;\n } \n\n // warn if there are multiple precursors (should not happen)\n if (it->getPrecursors().size() > 1)\n {\n OPENMS_LOG_WARN << \"Spectrum at index \" << std::distance(spectra_.begin(), it)\n << \" has multiple precursors. Only the first precursor will be considered.\"\n << std::endl;\n }\n\n // check if it has the parent a precursor\n const auto precursor = it->getPrecursors()[0];\n String ref = precursor.getMetaValue(\"spectrum_ref\", \"\"); \n if (!ref.empty() && ref == parent_native_id)\n {\n return it;\n } \n }\n ++it; \n } \n\n return spectra_.end();\n }\n\n // same as above but easier to wrap in python\n int MSExperiment::getFirstProductSpectrum(int zero_based_index) const\n {\n if (zero_based_index < 0 \n || zero_based_index >= static_cast<int>(spectra_.size()))\n {\n return -1;\n }\n \n auto spec = spectra_.cbegin();\n spec += zero_based_index;\n auto pc_spec = getFirstProductSpectrum(spec);\n if (pc_spec == spectra_.cend()) return -1;\n return pc_spec - spectra_.cbegin();\n }\n\n /// Swaps the content of this map with the content of @p from\n void MSExperiment::swap(MSExperiment & from)\n {\n // Swap range managers\n std::swap(spectrum_ranges_, from.spectrum_ranges_);\n std::swap(chromatogram_ranges_, from.chromatogram_ranges_);\n std::swap(combined_ranges_, from.combined_ranges_);\n\n // Swap experimental settings\n ExperimentalSettings tmp;\n tmp.ExperimentalSettings::operator=(*this);\n this->ExperimentalSettings::operator=(from);\n from.ExperimentalSettings::operator=(tmp);\n\n // Swap chromatograms\n std::swap(chromatograms_, from.chromatograms_);\n\n // Swap spectra\n spectra_.swap(from.getSpectra());\n }\n\n /// sets the spectrum list\n void MSExperiment::setSpectra(const std::vector<MSSpectrum> & spectra)\n {\n spectra_ = spectra;\n }\n\n void MSExperiment::setSpectra(std::vector<MSSpectrum> && spectra)\n {\n spectra_ = std::move(spectra);\n }\n\n /// adds a spectrum to the list\n void MSExperiment::addSpectrum(const MSSpectrum & spectrum)\n {\n spectra_.push_back(spectrum);\n }\n\n void MSExperiment::addSpectrum(MSSpectrum && spectrum)\n {\n spectra_.push_back(std::move(spectrum));\n }\n\n /// returns the spectrum list\n const std::vector<MSSpectrum>& MSExperiment::getSpectra() const\n {\n return spectra_;\n }\n\n /// returns the spectrum list (mutable)\n std::vector<MSSpectrum>& MSExperiment::getSpectra()\n {\n return spectra_;\n }\n\n /// Returns the closest(=nearest) spectrum in retention time to the given RT\n MSExperiment::ConstIterator MSExperiment::getClosestSpectrumInRT(const double RT) const\n {\n auto above = RTBegin(RT); // the spec above or equal to our RT\n if (above == begin()) return above; // we hit the first element, or no spectra (begin==end)\n if (above == end()) return --above; // queried beyond last spec, but we know there are spectra, so `--above` is safe\n // we are between two spectra\n auto diff_left = RT - (above - 1)->getRT();\n auto diff_right = above->getRT() - RT;\n if (diff_left < diff_right) --above;\n return above;\n }\n MSExperiment::Iterator MSExperiment::getClosestSpectrumInRT(const double RT)\n {\n return begin() + std::distance(cbegin(), const_cast<const MSExperiment*>(this)->getClosestSpectrumInRT(RT));\n }\n\n /// Returns the closest(=nearest) spectrum in retention time to the given RT of a certain MS level\n MSExperiment::ConstIterator MSExperiment::getClosestSpectrumInRT(const double RT, UInt ms_level) const\n {\n auto above = RTBegin(RT); // the spec above or equal to our RT\n auto below = above; // for later\n // search for the next available spec to the right with correct MS level\n while (above != end() && above->getMSLevel() != ms_level)\n {\n ++above;\n }\n if (above == begin()) return above; // we hit the first element; or no spectra at all\n\n // careful: below may be end() at this point, yet below!=begin()\n if (below != begin()) --below; // we need to make one step left, so we are different from `above`\n // we are not at end() (or begin()==end())\n while (below != begin() && below->getMSLevel() != ms_level)\n {\n --below;\n }\n if (below->getMSLevel() != ms_level) return above; // below did not find anything valid; so it must be whatever `above` is (could be end())\n if (above == end()) return below; // queried beyond last spec, but we know there are spectra, so it must be whatever `below` is (which we know is valid)\n // we are between two spectra\n auto diff_left = RT - below->getRT();\n auto diff_right = above->getRT() - RT;\n return (diff_left < diff_right ? below : above);\n }\n\n MSExperiment::Iterator MSExperiment::getClosestSpectrumInRT(const double RT, UInt ms_level)\n {\n return begin() + std::distance(cbegin(), const_cast<const MSExperiment*>(this)->getClosestSpectrumInRT(RT, ms_level));\n }\n\n /// sets the chromatogram list\n void MSExperiment::setChromatograms(const std::vector<MSChromatogram > & chromatograms)\n {\n chromatograms_ = chromatograms;\n }\n\n /// sets the chromatogram list\n void MSExperiment::setChromatograms(std::vector<MSChromatogram> && chromatograms)\n {\n chromatograms_ = std::move(chromatograms);\n }\n\n /// adds a chromatogram to the list\n void MSExperiment::addChromatogram(const MSChromatogram & chromatogram)\n {\n chromatograms_.push_back(chromatogram);\n }\n\n void MSExperiment::addChromatogram(MSChromatogram&& chrom)\n {\n chromatograms_.push_back(std::move(chrom));\n } \n\n /// returns the chromatogram list\n const std::vector<MSChromatogram >& MSExperiment::getChromatograms() const\n {\n return chromatograms_;\n }\n\n /// returns the chromatogram list (mutable)\n std::vector<MSChromatogram >& MSExperiment::getChromatograms()\n {\n return chromatograms_;\n }\n\n /// @name Easy Access interface\n //@{\n /// returns a single chromatogram \n MSChromatogram & MSExperiment::getChromatogram(Size id)\n {\n return chromatograms_[id];\n }\n\n /// returns a single spectrum \n MSSpectrum & MSExperiment::getSpectrum(Size id)\n {\n return spectra_[id];\n }\n\n /// get the total number of spectra available\n Size MSExperiment::getNrSpectra() const\n {\n return spectra_.size();\n }\n\n /// get the total number of chromatograms available\n Size MSExperiment::getNrChromatograms() const\n {\n return chromatograms_.size();\n }\n //@}\n\n /// returns the total ion chromatogram (TIC)\n const MSChromatogram MSExperiment::calculateTIC(float rt_bin_size, UInt ms_level) const\n {\n // The TIC is (re)calculated from the MS spectra with set ms_level (default 1).\n // Even if MSExperiment does not contain a TIC chromatogram explicitly, it can be reported.\n MSChromatogram TIC;\n for (const auto& spec: spectra_)\n {\n if ((spec.getMSLevel() == ms_level) || (ms_level == 0))\n {\n // fill chromatogram\n ChromatogramPeakType peak;\n peak.setRT(spec.getRT());\n peak.setIntensity(spec.calculateTIC());\n TIC.push_back(peak);\n }\n }\n if (rt_bin_size > 0)\n {\n LinearResamplerAlign lra;\n Param param = lra.getParameters();\n param.setValue(\"spacing\", rt_bin_size);\n lra.setParameters(param);\n lra.raster(TIC);\n }\n return TIC;\n }\n\n /**\n @brief Clears all data and meta data\n\n @param[in] clear_meta_data If @em true, all meta data is cleared in addition to the data.\n */\n void MSExperiment::clear(bool clear_meta_data)\n {\n spectra_.clear();\n chromatograms_.clear();\n\n if (clear_meta_data)\n {\n clearRanges(); // reset all ranges\n this->ExperimentalSettings::operator=(ExperimentalSettings()); // no \"clear\" method\n }\n }\n\n // static\n bool MSExperiment::containsScanOfLevel(size_t ms_level) const\n {\n // Check if any spectrum with the specified MS level exists\n return std::any_of(getSpectra().begin(), getSpectra().end(),\n [ms_level](const auto& spec) { return spec.getMSLevel() == ms_level; });\n }\n\n bool MSExperiment::hasZeroIntensities(size_t ms_level) const\n {\n // Check if any spectrum of the specified MS level contains peaks with zero intensity\n return std::any_of(getSpectra().begin(), getSpectra().end(),\n [ms_level](const auto& spec) { \n if (spec.getMSLevel() != ms_level) return false; // Skip spectra that don't match the requested MS level\n \n // Check if this spectrum has any zero intensity peaks\n return std::any_of(spec.begin(), spec.end(),\n [](const auto& peak) { return peak.getIntensity() == 0.0; });\n });\n }\n\n /*\n bool MSExperiment::hasPeptideIdentifications() const\n {\n for (const auto& spec : getSpectra())\n {\n if (!spec.getPeptideIdentifications().empty())\n {\n return true;\n }\n }\n return false;\n }\n */\n\n bool MSExperiment::isIMFrame() const\n {\n if (spectra_.empty()) return false;\n auto rt_start = spectra_[0].getRT();\n auto last_drift = std::numeric_limits<double>::lowest();\n for (const auto& s : spectra_) {\n if (s.getRT() != rt_start) return false; // RT changes...\n if (s.getDriftTime() == last_drift) return false; // IM did not change...\n last_drift = s.getDriftTime();\n }\n return true; // RT stable, IM changing\n }\n\n MSExperiment::SpectrumType* MSExperiment::createSpec_(PeakType::CoordinateType rt)\n {\n spectra_.emplace_back(SpectrumType());\n SpectrumType* spectrum = &(spectra_.back());\n spectrum->setRT(rt);\n spectrum->setMSLevel(1);\n return spectrum;\n }\n\n /*\n @brief Append a spectrum including float data arrays to current MSExperiment\n\n @param[in] rt RT of new spectrum\n @param[in] metadata_names Names of float data arrays attached to this spectrum\n @return Pointer to newly created spectrum\n */\n MSExperiment::SpectrumType* MSExperiment::createSpec_(PeakType::CoordinateType rt, const StringList& metadata_names)\n {\n SpectrumType* spectrum = createSpec_(rt);\n // create metadata arrays\n spectrum->getFloatDataArrays().reserve(metadata_names.size());\n for (StringList::const_iterator itm = metadata_names.begin(); itm != metadata_names.end(); ++itm)\n {\n spectrum->getFloatDataArrays().push_back(MSSpectrum::FloatDataArray());\n spectrum->getFloatDataArrays().back().setName(*itm);\n }\n return spectrum;\n }\n\n /// Print the contents to a stream.\n std::ostream& operator<<(std::ostream & os, const MSExperiment & exp)\n {\n os << \"-- MSEXPERIMENT BEGIN --\" << std::endl;\n\n //experimental settings\n os << static_cast<const ExperimentalSettings &>(exp);\n\n //spectra\n for (const MSSpectrum& spec : exp.getSpectra())\n {\n os << spec;\n }\n\n //chromatograms\n for (const MSChromatogram& chrom : exp.getChromatograms())\n {\n os << chrom;\n }\n\n os << \"-- MSEXPERIMENT END --\" << std::endl;\n\n return os;\n }\n} //namespace OpenMS\n\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9383,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/IONMOBILITY/IMDataConverter.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":13756,"string":"13,756"},"line_count":{"kind":"number","value":374,"string":"374"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Eugen Netz $\n// $Authors: Eugen Netz, Chris Bielow $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/IONMOBILITY/IMDataConverter.h>\n\n#include <OpenMS/METADATA/DataArrays.h>\n#include <OpenMS/CONCEPT/Constants.h>\n#include <OpenMS/CONCEPT/Exception.h>\n#include <OpenMS/CONCEPT/LogStream.h>\n#include <OpenMS/IONMOBILITY/FAIMSHelper.h>\n#include <OpenMS/FORMAT/ControlledVocabulary.h>\n#include <OpenMS/KERNEL/MSExperiment.h>\n\n\n#include <cstddef>\n#include <map>\n#include <OpenMS/PROCESSING/SPECTRAMERGING/SpectraMerger.h>\n\nnamespace OpenMS\n{\n std::vector<std::pair<double, MSExperiment>> IMDataConverter::splitByFAIMSCV(PeakMap&& exp)\n {\n std::vector<std::pair<double, MSExperiment>> result;\n\n std::set<double> CVs = FAIMSHelper::getCompensationVoltages(exp);\n\n if (CVs.empty())\n {\n OPENMS_LOG_INFO << \"Not FAIMS compensation voltages found in the data. Returning PeakMap as CV NaN.\" << std::endl;\n // Represent \"no FAIMS\" as a single-element group that carries the original experiment.\n result.emplace_back(std::numeric_limits<double>::quiet_NaN(), std::move(exp));\n return result;\n }\n\n // use a map internally to accumulate per-CV experiments in ascending CV order\n std::map<double, MSExperiment> split_peakmap;\n for (double cv : CVs)\n {\n MSExperiment pm;\n pm.getExperimentalSettings() = exp.getExperimentalSettings();\n split_peakmap.emplace(cv, std::move(pm));\n }\n\n // fill up the PeakMaps by moving spectra from the input PeakMap\n // Keep MS2 spectra which might not carry a FAIMS CV (typically they do) by assigning them to the last seen FAIMS CV (nearest previous in run order)\n double last_faims_cv = std::numeric_limits<double>::quiet_NaN();\n for (MSSpectrum& spec : exp)\n {\n if (spec.getDriftTimeUnit() == DriftTimeUnit::FAIMS_COMPENSATION_VOLTAGE)\n {\n last_faims_cv = spec.getDriftTime();\n if (const auto map_it = split_peakmap.find(last_faims_cv); map_it == split_peakmap.end())\n {\n OPENMS_LOG_WARN << \"Encountered spectrum with unexpected FAIMS CV (not in detected set): \" << last_faims_cv << std::endl;\n continue;\n }\n else\n {\n map_it->second.addSpectrum(std::move(spec));\n }\n continue;\n }\n\n // No FAIMS CV on spectrum: if it's MS2+ and we have a prior FAIMS CV context, assign it to that bin\n if (!std::isnan(last_faims_cv) && spec.getMSLevel() > 1)\n {\n if (const auto map_it = split_peakmap.find(last_faims_cv); map_it != split_peakmap.end())\n {\n map_it->second.addSpectrum(std::move(spec));\n continue;\n }\n }\n\n // Otherwise skip with a warning\n OPENMS_LOG_WARN << \"Skipping spectrum without FAIMS CV (no prior FAIMS CV context or unexpected layout).\" << std::endl;\n }\n \n exp.clear(true);\n\n // move from map (sorted by CV) into vector of (CV, MSExperiment) pairs\n result.reserve(split_peakmap.size());\n for (auto& kv : split_peakmap)\n {\n result.emplace_back(kv.first, std::move(kv.second));\n }\n return result;\n }\n\n MSExperiment IMDataConverter::reshapeIMFrameToMany(MSSpectrum im_frame)\n {\n MSExperiment out;\n\n if (im_frame.empty())\n {// nothing to split (we do not even check for IM data, for robustness)\n return out;\n }\n\n // check if data is sorted by IM... if not, sort\n if (! im_frame.isSortedByIM())\n { // sorts the spectrum (and its binary data arrays) according to IM\n im_frame.sortByIonMobility();\n }\n\n // can throw if IM float data array is missing\n const auto [im_data_index, im_unit] = im_frame.getIMData();\n // Capture IM array by Ref, because .getIMData() is expensive to call for every peak!\n const auto& im_data = im_frame.getFloatDataArrays()[im_data_index];\n\n // copy meta data (RT, name, ...) without the raw data and without the IM array\n MSSpectrum prototype = im_frame;\n prototype.clear(false);\n\n // adds a new spectrum with drift time to `out`\n auto addSpectrum = [&out, im_unit = im_unit, &prototype](double drift_time_avg) {\n // keeps RT identical for all scans, since they are from the same IM-frame\n // keeps MSlevel\n out.addSpectrum(prototype);\n auto& spec = out.getSpectra().back();\n // copy drift-time unit from parent scan\n spec.setDriftTime(drift_time_avg);\n spec.setDriftTimeUnit(im_unit);\n return &spec;\n };\n\n MSSpectrum* last_spec{};\n // Separate spec for each IM value:\n OPENMS_PRECONDITION(std::is_sorted(im_data.begin(), im_data.end()), \"we sorted it... what happened???\");\n using IMV_t = MSSpectrum::FloatDataArray::value_type;\n IMV_t im_last = std::numeric_limits<IMV_t>::max();\n for (Size i = 0; i < im_data.size(); ++i)// is sorted now!\n {\n const IMV_t im = im_data[i];\n if (im != im_last)\n {\n im_last = im;\n last_spec = addSpectrum(im);\n }\n last_spec->push_back(im_frame[i]);// copy the m/z of the peak\n }\n out.sortSpectra(true);\n out.updateRanges();\n return out;\n }\n\n std::tuple<std::vector<MSExperiment>, Math::BinContainer> IMDataConverter::splitExperimentByIonMobility(MSExperiment&& in,\n UInt number_of_bins,\n double bin_extension_abs,\n double mz_binning_width,\n MZ_UNITS mz_binning_width_unit)\n {\n if (number_of_bins == 0)\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Cannot split into 0 bins.\", String(number_of_bins));\n }\n if (bin_extension_abs < 0)\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Overlap must not be negative.\", String(bin_extension_abs));\n }\n std::vector<MSExperiment> results(number_of_bins);\n in.updateRanges();\n // find the IM range\n const auto range_IM = RangeMobility(in.spectrumRanges());\n if (range_IM.getSpan() / number_of_bins < bin_extension_abs * 2)\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, String(\"Bin size (\") + String(range_IM.getSpan() / number_of_bins) + \") is smaller than the overlap.\", String(bin_extension_abs*2));\n }\n\n // compute the bins\n const auto bins = Math::createBins(range_IM.getMin(), range_IM.getMax(), number_of_bins, bin_extension_abs);\n\n // results for each IM-frame: all spectra per bin, to get merged\n MSExperiment binned_spectra;\n\n SpectraMerger merger;\n auto p = merger.getParameters();\n const auto ms_levels = in.getMSLevels();\n p.setValue(\"block_method:ms_levels\", IntList(ms_levels.begin(), ms_levels.end())); // merge all MS levels\n p.setValue(\"mz_binning_width\", mz_binning_width);\n p.setValue(\"mz_binning_width_unit\", String(MZ_UNIT_NAMES[(int)mz_binning_width_unit]));\n p.setValue(\"block_method:rt_block_size\", INT_MAX);\n p.setValue(\"block_method:rt_max_length\", 10e10);\n\n\n for (auto& frame : in)\n {\n // For data without ion mobility, simply append the result (only\n // collapse for scans that actually have a float data array).\n if (! frame.containsIMData())\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Spectrum does not contain 'wide' IM data.\", frame.getNativeID());\n }\n \n MSExperiment frame_melt = IMDataConverter::reshapeIMFrameToMany(std::move(frame));\n for (size_t i = 0; i < bins.size(); ++i)\n {\n binned_spectra.clear(false);\n // check if spectrum goes into this bin\n for (auto&& spec : frame_melt)\n {\n if (bins[i].contains(spec.getDriftTime()))\n { // spectrum goes into this bin\n binned_spectra.addSpectrum(std::move(spec));\n }\n }\n // collapse spectra in this bin\n if (!binned_spectra.empty())\n {\n merger.setParameters(p);\n merger.mergeSpectraBlockWise(binned_spectra);\n assert(binned_spectra.size() == 1);\n results[i].addSpectrum(std::move(binned_spectra.getSpectra().back()));\n results[i].getSpectra().back().setDriftTime(bins[i].center());\n }\n }\n }\n for (auto& result : results)\n {\n result.ExperimentalSettings::operator=(in);\n result.updateRanges();\n }\n return {std::move(results), std::move(bins)};\n }\n\n void annotateAsIM(OpenMS::DataArrays::FloatDataArray& fda, const DriftTimeUnit unit)\n {\n const auto& cv = ControlledVocabulary::getPSIMSCV();\n const ControlledVocabulary::CVTerm* term;\n switch (unit)\n {\n case DriftTimeUnit::MILLISECOND:\n term = &cv.getTerm(\"MS:1002816\");\n break;\n case DriftTimeUnit::VSSC:\n term = &cv.getTerm(\"MS:1003008\");\n break;\n default:\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Unit cannot be converted into CV term.\", driftTimeUnitToString(unit));\n }\n fda.setName(term->name);\n }\n\n \n /// private: Process a stack of drift time spectra\n void processDriftTimeStack(std::vector<const MSSpectrum*>& stack, MSExperiment& result)\n {\n if (stack.empty()) return;\n\n // copy meta data without the raw data and without the IM array\n MSSpectrum new_spec = *stack[0];\n new_spec.clear(false);\n\n // create new FDA\n OpenMS::DataArrays::FloatDataArray& fda = new_spec.getFloatDataArrays().emplace_back();\n IMDataConverter::setIMUnit(fda, new_spec.getDriftTimeUnit());\n for (const auto& s : stack)\n {\n new_spec.insert(new_spec.end(), s->begin(), s->end()); // append data\n fda.insert(fda.end(), s->size(), s->getDriftTime()); // create IM array\n }\n new_spec.setDriftTime(IMTypes::DRIFTTIME_NOT_SET);// drift time is now encoded in the FloatDataArray\n new_spec.setDriftTimeUnit(DriftTimeUnit::NONE); // drift time is now encoded in the FloatDataArray\n \n // append to PeakMap\n result.getSpectra().push_back(std::move(new_spec));\n\n stack.clear();\n }\n\n\n\n MSExperiment IMDataConverter::reshapeIMFrameToSingle(const MSExperiment& exp)\n {\n MSExperiment result;\n\n if (exp.empty())\n {\n return result;\n } \n\n std::vector<const MSSpectrum*> stack;\n double curr_rt = std::numeric_limits<double>::max();\n for (const auto& spec : exp)\n {\n // copy non-IM or already framed spectra\n // throws Exception if spec has mixed IM format\n if (IMTypes::determineIMFormat(spec) != IMFormat::MULTIPLE_SPECTRA)\n {\n processDriftTimeStack(stack, result); // clear current stack\n result.getSpectra().push_back(spec);\n continue;\n }\n \n // new stack starts here. Process all previous spectra\n if (spec.getRT() != curr_rt)\n {\n processDriftTimeStack(stack, result);\n curr_rt = spec.getRT();\n }\n stack.push_back(&spec);\n }\n \n processDriftTimeStack(stack, result);\n \n return result;\n }\n\n void IMDataConverter::setIMUnit(DataArrays::FloatDataArray& fda, const DriftTimeUnit unit)\n {\n const auto& cv = ControlledVocabulary::getPSIMSCV();\n switch (unit)\n {\n case DriftTimeUnit::MILLISECOND: \n fda.setName(cv.getTerm(\"MS:1002816\").name); // MS:1002816 ! mean ion mobility array\n return;\n case DriftTimeUnit::VSSC:\n fda.setName(cv.getTerm(\"MS:1003008\").name); // MS:1003008 ! raw inverse reduced ion mobility array\n return;\n default:\n // invalid enum ...\n // There is no CV term which can be used to describe the FDA\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Unit is not a valid IM unit for float data arrays\", driftTimeUnitToString(unit));\n }\n }\n\n bool IMDataConverter::getIMUnit(const DataArrays::FloatDataArray& fda, DriftTimeUnit& unit)\n {\n const auto& cv = ControlledVocabulary::getPSIMSCV();\n if (fda.getName().hasPrefix(Constants::UserParam::ION_MOBILITY))\n { // fallback for non-standard IM arrays (as created by Mobi-DIK, or \"Ion Mobility Centroid\" from PeakPickerIM)\n if (fda.getName().hasSubstring(\"MS:1002815\"))\n {\n unit = DriftTimeUnit::VSSC;\n }\n else\n {\n unit = DriftTimeUnit::MILLISECOND;\n }\n return true;\n }\n try\n {\n const auto& cv_term = cv.getTermByName(fda.getName()); // may throw if term is unknown\n\n if (cv.isChildOf(cv_term.id, \"MS:1002893\")) // is child of generic 'ion mobility array'?\n {\n if (cv_term.units.find(\"MS:1002814\") != cv_term.units.end())\n { // MS:1002814 ! volt-second per square centimeter\n unit = DriftTimeUnit::VSSC;\n }\n else if (cv_term.units.find(\"UO:0000028\") != cv_term.units.end())\n { // UO:0000028 ! millisecond\n unit = DriftTimeUnit::MILLISECOND;\n }\n else\n { // fallback\n OPENMS_LOG_WARN << \"Warning: FloatDataArray for IonMobility data '\" << cv_term.id << \" \" << cv_term.name << \"' does not contain proper units!\" << std::endl;\n unit = DriftTimeUnit::NONE;\n }\n return true;\n }\n }\n catch (...)\n {\n }\n return false;\n }\n\n} //end namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9384,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/IONMOBILITY/FAIMSHelper.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":2435,"string":"2,435"},"line_count":{"kind":"number","value":87,"string":"87"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Eugen Netz $\n// $Authors: Eugen Netz $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/IONMOBILITY/FAIMSHelper.h>\n\n#include <OpenMS/CONCEPT/Constants.h>\n#include <OpenMS/CONCEPT/LogStream.h>\n#include <OpenMS/IONMOBILITY/IMTypes.h>\n#include <OpenMS/KERNEL/MSExperiment.h>\n#include <algorithm>\n#include <cmath>\n\nnamespace OpenMS\n{\n std::set<double> FAIMSHelper::getCompensationVoltages(const PeakMap& exp)\n {\n std::set<double> CVs;\n\n if (exp.getSpectra().empty())\n {\n return CVs;\n }\n\n // Determine if this dataset actually contains FAIMS spectra (scan all; do not rely on the first spectrum)\n const bool has_faims = std::any_of(exp.begin(), exp.end(), [](const MSSpectrum& s)\n {\n return s.getDriftTimeUnit() == DriftTimeUnit::FAIMS_COMPENSATION_VOLTAGE;\n });\n\n if (!has_faims)\n {\n return CVs;\n }\n\n // Collect compensation voltages from spectra that actually carry FAIMS CVs\n for (const auto& spec : exp)\n {\n if (spec.getDriftTimeUnit() == DriftTimeUnit::FAIMS_COMPENSATION_VOLTAGE)\n {\n CVs.insert(spec.getDriftTime());\n }\n }\n\n // Remove placeholder/sentinel values while warning the user\n if (CVs.erase(IMTypes::DRIFTTIME_NOT_SET) > 0)\n {\n OPENMS_LOG_WARN << \"Warning: FAIMS compensation voltage is missing for at least one spectrum!\" << std::endl;\n }\n\n return CVs;\n }\n\n PeptideIdentificationList FAIMSHelper::filterPeptidesByFAIMSCV(\n const PeptideIdentificationList& peptides,\n double target_cv,\n double cv_tolerance)\n {\n PeptideIdentificationList filtered;\n filtered.reserve(peptides.size()); // Optimistic reservation\n\n for (const auto& pep : peptides)\n {\n if (pep.metaValueExists(Constants::UserParam::FAIMS_CV))\n {\n double pep_cv = pep.getMetaValue(Constants::UserParam::FAIMS_CV);\n if (std::abs(pep_cv - target_cv) < cv_tolerance)\n {\n filtered.push_back(pep);\n }\n }\n else\n {\n // IDs without FAIMS_CV annotation - include in all groups (backward compatibility)\n filtered.push_back(pep);\n }\n }\n\n return filtered;\n }\n\n} //end namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9385,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/IONMOBILITY/IMTypes.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":4663,"string":"4,663"},"line_count":{"kind":"number","value":143,"string":"143"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Chris Bielow $\n// $Authors: Chris Bielow $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/IONMOBILITY/IMTypes.h>\n\n#include <OpenMS/CONCEPT/Exception.h>\n#include <OpenMS/CONCEPT/LogStream.h>\n#include <OpenMS/KERNEL/MSExperiment.h>\n\nnamespace OpenMS\n{\n\n const std::string NamesOfDriftTimeUnit[] = {\"<NONE>\", \"ms\", \"1/K0\", \"FAIMS_CV\"};\n const std::string NamesOfIMFormat[] = {\"none\", \"concatenated\", \"multiple_spectra\", \"mixed\", \"centroided\", \"unknown\"};\n\n\n DriftTimeUnit toDriftTimeUnit(const std::string& dtu_string)\n {\n auto first = &NamesOfDriftTimeUnit[0];\n auto last = &NamesOfDriftTimeUnit[(size_t) DriftTimeUnit::SIZE_OF_DRIFTTIMEUNIT];\n const auto it = std::find(first, last, dtu_string);\n if (it == last)\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Value unknown\", dtu_string);\n }\n return DriftTimeUnit(it - first);\n }\n\n const std::string& driftTimeUnitToString(const DriftTimeUnit value)\n {\n if (value == DriftTimeUnit::SIZE_OF_DRIFTTIMEUNIT)\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Value not allowed\", \"SIZE_OF_DRIFTTIMEUNIT\");\n }\n return NamesOfDriftTimeUnit[(size_t) value];\n }\n\n IMFormat toIMFormat(const std::string& IM_format)\n {\n auto first = &NamesOfIMFormat[0];\n auto last = &NamesOfIMFormat[(size_t) IMFormat::SIZE_OF_IMFORMAT];\n const auto it = std::find(first, last, IM_format);\n if (it == last)\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Value unknown\", IM_format);\n }\n return IMFormat(it - first);\n }\n\n const std::string& imFormatToString(const IMFormat value)\n {\n if (value == IMFormat::SIZE_OF_IMFORMAT)\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Value not allowed\", \"SIZE_OF_IMFORMAT\");\n }\n return NamesOfIMFormat[(size_t)value];\n }\n\n IMFormat IMTypes::determineIMFormat(const MSExperiment& exp)\n {\n std::set<IMFormat> occs;\n for (const auto& spec : exp.getSpectra())\n {\n occs.insert(determineIMFormat(spec));\n }\n occs.erase(IMFormat::NONE); // ignore NONE (i.e. normal spectra)\n\n if (occs.empty())\n {\n return IMFormat::NONE;\n } \n\n if (occs.size() == 1) \n {\n auto format = *occs.begin();\n if (format != IMFormat::CONCATENATED\n && format != IMFormat::MULTIPLE_SPECTRA\n && format != IMFormat::CENTROIDED)\n {\n throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"subfunction returned invalid value(s)\", \"Number of different values: \" + String(occs.size()));\n }\n return format;\n }\n else \n {\n return IMFormat::MIXED;\n } \n }\n\n IMFormat IMTypes::determineIMFormat(const MSSpectrum& spec)\n {\n // First check if format is already set and not UNKNOWN\n IMFormat current_format = spec.getIMFormat();\n if (current_format != IMFormat::UNKNOWN)\n {\n // note: if we picked the spectrum already, the IMType should be already correctly set to CENTROIDED\n return current_format;\n }\n \n // If format is UNKNOWN, determine it\n bool has_float_data = spec.containsIMData(); // cache value; query is 'expensive'\n bool has_drift_time = spec.getDriftTime() != DRIFTTIME_NOT_SET;\n\n if (has_float_data)\n {\n if (has_drift_time)\n {\n OPENMS_LOG_DEBUG << \"both drift time and IM data array found in spectrum \" << spec.getNativeID() << \"\\n. Support for both is experimental.\" << std::endl;\n }\n return IMFormat::CONCATENATED;\n }\n else if (has_drift_time)\n {\n if (spec.getDriftTimeUnit() == DriftTimeUnit::NONE)\n {\n OPENMS_LOG_WARN << \"Warning: no drift time unit set for spectrum \" << spec.getNativeID() << \"\\n\";\n }\n return IMFormat::MULTIPLE_SPECTRA;\n }\n return IMFormat::NONE;\n }\n\n DIM_UNIT IMTypes::fromIMUnit(const DriftTimeUnit from)\n {\n switch (from)\n {\n case DriftTimeUnit::FAIMS_COMPENSATION_VOLTAGE:\n return DIM_UNIT::FAIMS_CV;\n case DriftTimeUnit::MILLISECOND:\n return DIM_UNIT::IM_MS;\n case DriftTimeUnit::VSSC:\n return DIM_UNIT::IM_VSSC;\n default:\n throw Exception::ConversionError(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Cannot convert from \" + driftTimeUnitToString(from) + \" to a DIM_UNIT.\");\n }\n }\n}// namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9386,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/QC/FragmentMassError.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":13739,"string":"13,739"},"line_count":{"kind":"number","value":328,"string":"328"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Chris Bielow$\n// $Authors: Patricia Scheil, Swenja Wagner$\n// --------------------------------------------------------------------------\n\n#include <OpenMS/CHEMISTRY/TheoreticalSpectrumGenerator.h>\n#include <OpenMS/CONCEPT/Exception.h>\n#include <OpenMS/CONCEPT/LogStream.h>\n#include <OpenMS/CONCEPT/Types.h>\n#include <OpenMS/DATASTRUCTURES/DataValue.h>\n#include <OpenMS/DATASTRUCTURES/MatchedIterator.h>\n#include <OpenMS/PROCESSING/FILTERING/WindowMower.h>\n#include <OpenMS/KERNEL/FeatureMap.h>\n#include <OpenMS/KERNEL/MSExperiment.h>\n#include <OpenMS/MATH/MathFunctions.h>\n#include <OpenMS/MATH/STATISTICS/BasicStatistics.h>\n#include <OpenMS/MATH/StatisticFunctions.h>\n#include <OpenMS/QC/FragmentMassError.h>\n#include <cassert>\n#include <string>\n\nnamespace OpenMS\n{\n // Using matched iterator for aligned spectra calculate mz errors\n template<typename MIV>\n void twoSpecErrors(MIV& mi, std::vector<double>& ppms, std::vector<double>& dalton, double& accumulator_ppm, UInt32& counter_ppm)\n {\n while (mi != mi.end())\n {\n // difference between peaks\n auto dalt_diff = mi->getMZ() - mi.ref().getMZ();\n auto ppm_diff = Math::getPPM(mi->getMZ(), mi.ref().getMZ());\n\n ppms.push_back(ppm_diff);\n dalton.push_back(dalt_diff);\n\n // for statistics\n accumulator_ppm += ppm_diff;\n ++counter_ppm;\n ++mi;\n }\n }\n\n void FragmentMassError::calculateFME_(PeptideIdentification& pep_id, const MSExperiment& exp, const QCBase::SpectraMap& map_to_spectrum, bool& print_warning, double tolerance,\n FragmentMassError::ToleranceUnit tolerance_unit, double& accumulator_ppm, UInt32& counter_ppm, WindowMower& window_mower_filter)\n {\n if (pep_id.getHits().empty())\n {\n OPENMS_LOG_WARN << \"PeptideHits of PeptideIdentification with RT: \" << pep_id.getRT() << \" and MZ: \" << pep_id.getMZ() << \" is empty.\";\n return;\n }\n\n //---------------------------------------------------------------------\n // FIND DATA FOR THEORETICAL SPECTRUM\n //---------------------------------------------------------------------\n\n // sequence\n const AASequence& seq = pep_id.getHits()[0].getSequence();\n\n // charge: re-calculated from masses since much more robust this way (PepID annotation of pep_id.getHits()[0].getCharge() could be wrong)\n Int charge = static_cast<Int>(round(seq.getMonoWeight() / pep_id.getMZ()));\n\n //-----------------------------------------------------------------------\n // GET EXPERIMENTAL SPECTRUM MATCHING TO PEPTIDEIDENTIFICATION\n //-----------------------------------------------------------------------\n\n if (!pep_id.metaValueExists(\"spectrum_reference\"))\n {\n throw Exception::InvalidParameter(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No spectrum reference annotated at peptide identifiction!\");\n }\n const MSSpectrum& exp_spectrum = exp[map_to_spectrum.at(pep_id.getSpectrumReference())];\n\n if (exp_spectrum.getMSLevel() != 2)\n {\n throw Exception::IllegalArgument(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Spectrum with wrong MS level provided. MS2 expected.\");\n }\n Precursor::ActivationMethod act_method;\n if (exp_spectrum.getPrecursors().empty())\n {\n if (print_warning)\n {\n OPENMS_LOG_WARN << \"No MS2 activation method provided. Using CID as fallback to compute fragment mass errors.\" << std::endl;\n }\n print_warning = false; // only print it once\n act_method = Precursor::ActivationMethod::CID;\n }\n else\n {\n if (exp_spectrum.getPrecursors()[0].getActivationMethods().empty())\n {\n if (print_warning)\n {\n OPENMS_LOG_WARN << \"No MS2 activation method provided. Using CID as fallback to compute fragment mass errors.\" << std::endl;\n }\n print_warning = false; // only print it once\n act_method = Precursor::ActivationMethod::CID;\n }\n act_method = *exp_spectrum.getPrecursors()[0].getActivationMethods().begin();\n }\n\n //---------------------------------------------------------------------\n // CREATE THEORETICAL SPECTRUM\n //---------------------------------------------------------------------\n PeakSpectrum theo_spectrum = TheoreticalSpectrumGenerator::generateSpectrum(act_method, seq, charge);\n\n //-----------------------------------------------------------------------\n // COMPARE THEORETICAL AND EXPERIMENTAL SPECTRUM\n //-----------------------------------------------------------------------\n if (exp_spectrum.empty() || theo_spectrum.empty())\n {\n OPENMS_LOG_WARN << \"The spectrum with RT: \" + String(exp_spectrum.getRT()) + \" is empty.\"\n << \"\\n\";\n return;\n }\n\n auto exp_spectrum_filtered(exp_spectrum);\n window_mower_filter.filterPeakSpectrum(exp_spectrum_filtered);\n\n // stores ppms for one spectrum\n DoubleList ppms {};\n DoubleList dalton {};\n\n // iterator, finds nearest peak of a target container to a given peak in a reference container\n if (tolerance_unit == FragmentMassError::ToleranceUnit::DA)\n {\n using MIV = MatchedIterator<MSSpectrum, DaTrait, true>;\n MIV mi(theo_spectrum, exp_spectrum_filtered, tolerance);\n twoSpecErrors(mi, ppms, dalton, accumulator_ppm, counter_ppm);\n }\n else\n {\n using MIV = MatchedIterator<MSSpectrum, PpmTrait, true>;\n MIV mi(theo_spectrum, exp_spectrum_filtered, tolerance);\n twoSpecErrors(mi, ppms, dalton, accumulator_ppm, counter_ppm);\n }\n\n //-----------------------------------------------------------------------\n // WRITE PPM ERROR IN PEPTIDEHIT\n //-----------------------------------------------------------------------\n pep_id.getHits()[0].setMetaValue(Constants::UserParam::FRAGMENT_ERROR_PPM_USERPARAM, ppms);\n pep_id.getHits()[0].setMetaValue(Constants::UserParam::FRAGMENT_ERROR_DA_USERPARAM, dalton);\n if (ppms.size() > 1)\n {\n pep_id.getHits()[0].setMetaValue(Constants::UserParam::FRAGMENT_ERROR_PPM_USERPARAM + \"_variance\", Math::variance(ppms.begin(), ppms.end()));\n }\n if (dalton.size() > 1)\n {\n pep_id.getHits()[0].setMetaValue(Constants::UserParam::FRAGMENT_ERROR_DA_USERPARAM + \"_variance\", Math::variance(dalton.begin(), dalton.end()));\n }\n }\n\n void FragmentMassError::calculateVariance_(FragmentMassError::Statistics& result, const PeptideIdentification& pep_id, const UInt num_ppm)\n {\n if (pep_id.getHits().empty())\n {\n OPENMS_LOG_WARN << \"There is a Peptideidentification(RT: \" << pep_id.getRT() << \", MZ: \" << pep_id.getMZ() << \") without PeptideHits. \"\n << \"\\n\";\n return;\n }\n for (const auto& ppm : (pep_id.getHits()[0].getMetaValue(\"fragment_mass_error_ppm\")).toDoubleList())\n {\n double tmp = ppm - result.average_ppm;\n result.variance_ppm += (tmp * tmp / num_ppm);\n }\n }\n\n void FragmentMassError::compute(FeatureMap& fmap, const MSExperiment& exp, const QCBase::SpectraMap& map_to_spectrum, ToleranceUnit tolerance_unit, double tolerance)\n {\n Statistics result;\n\n bool has_pepIDs = QCBase::hasPepID(fmap);\n // if there are no matching peaks, the counter is zero and it is not possible to find ppms\n if (!has_pepIDs)\n {\n results_.push_back(result);\n return;\n }\n // accumulates ppm errors over all first PeptideHits\n double accumulator_ppm {};\n\n // counts number of ppm errors\n UInt32 counter_ppm {};\n\n //---------------------------------------------------------------------\n // Prepare MSExperiment\n //---------------------------------------------------------------------\n\n // filter settings\n WindowMower window_mower_filter;\n Param filter_param = window_mower_filter.getParameters();\n filter_param.setValue(\"windowsize\", 100.0, \"The size of the sliding window along the m/z axis.\");\n filter_param.setValue(\"peakcount\", 6, \"The number of peaks that should be kept.\");\n filter_param.setValue(\"movetype\", \"jump\", \"Whether sliding window (one peak steps) or jumping window (window size steps) should be used.\");\n window_mower_filter.setParameters(filter_param);\n\n //-------------------------------------------------------------------\n // find tolerance unit and value\n //------------------------------------------------------------------\n if (tolerance_unit == ToleranceUnit::AUTO)\n {\n if (fmap.getProteinIdentifications().empty())\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION,\n \"No information about fragment mass tolerance given in the FeatureMap. Please choose a fragment_mass_unit and tolerance manually.\");\n }\n tolerance_unit = fmap.getProteinIdentifications()[0].getSearchParameters().fragment_mass_tolerance_ppm ? ToleranceUnit::PPM : ToleranceUnit::DA;\n tolerance = fmap.getProteinIdentifications()[0].getSearchParameters().fragment_mass_tolerance;\n if (tolerance <= 0.0)\n { // some engines, e.g. MSGF+ have no fragment tolerance parameter. It will be 0.0.\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION,\n \"No information about fragment mass tolerance given in the FeatureMap. Please choose a fragment_mass_unit and tolerance manually.\");\n }\n }\n\n bool print_warning {false};\n\n // computes the FragmentMassError\n std::function<void(PeptideIdentification&)> fCompPPM = [&exp, &map_to_spectrum, &print_warning, tolerance, tolerance_unit, &accumulator_ppm, &counter_ppm,\n &window_mower_filter](PeptideIdentification& pep_id) {\n calculateFME_(pep_id, exp, map_to_spectrum, print_warning, tolerance, tolerance_unit, accumulator_ppm, counter_ppm, window_mower_filter);\n };\n\n auto fVar = [&result, &counter_ppm](const PeptideIdentification& pep_id) { calculateVariance_(result, pep_id, counter_ppm); };\n\n // computation of ppms\n fmap.applyFunctionOnPeptideIDs(fCompPPM);\n // if there are no matching peaks, the counter is zero and it is not possible to find ppms\n if (counter_ppm == 0)\n {\n results_.push_back(result);\n return;\n }\n\n // computes average\n result.average_ppm = accumulator_ppm / counter_ppm;\n\n // computes variance\n fmap.applyFunctionOnPeptideIDs(fVar);\n\n results_.push_back(result);\n }\n\n void FragmentMassError::compute(PeptideIdentificationList& pep_ids, const ProteinIdentification::SearchParameters& search_params, const MSExperiment& exp,\n const QCBase::SpectraMap& map_to_spectrum, ToleranceUnit tolerance_unit, double tolerance)\n {\n Statistics result;\n\n if (pep_ids.empty())\n {\n results_.push_back(result);\n return;\n }\n // accumulates ppm errors over all first PeptideHits\n double accumulator_ppm {};\n\n // counts number of ppm errors\n UInt32 counter_ppm {};\n\n //---------------------------------------------------------------------\n // Prepare MSExperiment\n //---------------------------------------------------------------------\n\n // filter settings\n WindowMower window_mower_filter;\n Param filter_param = window_mower_filter.getParameters();\n filter_param.setValue(\"windowsize\", 100.0, \"The size of the sliding window along the m/z axis.\");\n filter_param.setValue(\"peakcount\", 6, \"The number of peaks that should be kept.\");\n filter_param.setValue(\"movetype\", \"jump\", \"Whether sliding window (one peak steps) or jumping window (window size steps) should be used.\");\n window_mower_filter.setParameters(filter_param);\n\n //-------------------------------------------------------------------\n // find tolerance unit and value\n //------------------------------------------------------------------\n if (tolerance_unit == ToleranceUnit::AUTO)\n {\n tolerance_unit = search_params.fragment_mass_tolerance_ppm ? ToleranceUnit::PPM : ToleranceUnit::DA;\n tolerance = search_params.fragment_mass_tolerance;\n if (tolerance <= 0.0)\n { // some engines, e.g. MSGF+ have no fragment tolerance parameter. It will be 0.0.\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION,\n \"No information about fragment mass tolerance given. Please choose a fragment_mass_unit and tolerance manually.\");\n }\n }\n\n bool print_warning {false};\n\n // computation of ppms\n // computes the FragmentMassError\n for (auto& pep_id : pep_ids)\n {\n calculateFME_(pep_id, exp, map_to_spectrum, print_warning, tolerance, tolerance_unit, accumulator_ppm, counter_ppm, window_mower_filter);\n\n // if there are no matching peaks, the counter is zero and it is not possible to find ppms\n if (counter_ppm == 0)\n {\n results_.push_back(result);\n return;\n }\n // computes average\n result.average_ppm = accumulator_ppm / counter_ppm;\n\n calculateVariance_(result, pep_id, counter_ppm);\n }\n\n results_.push_back(result);\n }\n\n const String& FragmentMassError::getName() const\n {\n static const String& name = \"FragmentMassError\";\n return name;\n }\n\n const std::vector<FragmentMassError::Statistics>& FragmentMassError::getResults() const\n {\n return results_;\n }\n\n\n QCBase::Status FragmentMassError::requirements() const\n {\n return QCBase::Status() | QCBase::Requires::RAWMZML | QCBase::Requires::POSTFDRFEAT;\n }\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9387,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/QC/Ms2IdentificationRate.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":4794,"string":"4,794"},"line_count":{"kind":"number","value":150,"string":"150"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Chris Bielow$\n// $Authors: Patricia Scheil, Swenja Wagner$\n// --------------------------------------------------------------------------\n\n#include <OpenMS/CONCEPT/Exception.h>\n#include <OpenMS/CONCEPT/LogStream.h>\n#include <OpenMS/FORMAT/MzTab.h>\n#include <OpenMS/KERNEL/FeatureMap.h>\n#include <OpenMS/KERNEL/MSExperiment.h>\n#include <OpenMS/METADATA/PeptideIdentification.h>\n#include <OpenMS/QC/Ms2IdentificationRate.h>\n#include <algorithm>\n\n\nnamespace OpenMS\n{\n // computes number of peptide identifications, number of ms2 spectra and ratio\n // data is stored in vector of structs\n void Ms2IdentificationRate::compute(const FeatureMap& feature_map, const MSExperiment& exp, bool assume_all_target)\n {\n // count ms2 spectra\n Size ms2_level_counter = getMS2Count_(exp);\n\n // count peptideIdentifications\n Size peptide_identification_counter {};\n\n auto f = [assume_all_target, &peptide_identification_counter](const PeptideIdentification& id) { peptide_identification_counter += isTargetPeptide_(id, assume_all_target); };\n\n // iterates through all PeptideIdentifications in FeatureMap, applies function f to all of them\n feature_map.applyFunctionOnPeptideIDs(f, true);\n\n writeResults_(peptide_identification_counter, ms2_level_counter);\n }\n\n void Ms2IdentificationRate::compute(const PeptideIdentificationList& pep_ids, const MSExperiment& exp, bool assume_all_target)\n {\n // count ms2 spectra\n Size ms2_level_counter = getMS2Count_(exp);\n\n // count peptideIdentifications\n Size peptide_identification_counter {};\n\n for (const auto& id : pep_ids)\n {\n peptide_identification_counter += isTargetPeptide_(id, assume_all_target);\n }\n\n writeResults_(peptide_identification_counter, ms2_level_counter);\n }\n\n\n const String& Ms2IdentificationRate::getName() const\n {\n return name_;\n }\n\n\n const std::vector<OpenMS::Ms2IdentificationRate::IdentificationRateData>& Ms2IdentificationRate::getResults() const\n {\n return rate_result_;\n }\n\n\n QCBase::Status Ms2IdentificationRate::requirements() const\n {\n return QCBase::Status() | QCBase::Requires::RAWMZML | QCBase::Requires::POSTFDRFEAT;\n }\n\n void Ms2IdentificationRate::addMetaDataMetricsToMzTab(MzTabMetaData& meta) const\n {\n // Adding MS2_ID_Rate to meta data\n const auto& ms2_irs = this->getResults();\n for (Size i = 0; i < ms2_irs.size(); ++i)\n {\n MzTabParameter ms2_ir {};\n ms2_ir.setCVLabel(\"MS2 identification rate\");\n ms2_ir.setAccession(\"null\");\n ms2_ir.setName(\"MS2_ID_Rate_\" + String(i + 1));\n ms2_ir.setValue(String(100 * ms2_irs[i].identification_rate));\n meta.custom[meta.custom.size()] = ms2_ir;\n }\n }\n Size Ms2IdentificationRate::getMS2Count_(const MSExperiment& exp)\n {\n if (exp.empty())\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"MSExperiment is empty\");\n }\n\n Size ms2_counter {};\n for (auto const& spec : exp.getSpectra())\n {\n if (spec.getMSLevel() == 2)\n {\n ++ms2_counter;\n }\n }\n\n if (ms2_counter == 0)\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No MS2 spectra found\");\n }\n\n return ms2_counter;\n }\n\n bool Ms2IdentificationRate::isTargetPeptide_(const PeptideIdentification& id, bool all_targets)\n {\n if (id.getHits().empty())\n {\n return false;\n }\n if (all_targets)\n {\n return true;\n }\n if (id.getHits()[0].getTargetDecoyType() == PeptideHit::TargetDecoyType::UNKNOWN)\n {\n throw Exception::Precondition(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No target/decoy annotation found. If you want to continue regardless use -MS2_id_rate:assume_all_target\");\n }\n // check for 'target' information, also allow \"target+decoy\" value\n return !id.getHits()[0].isDecoy();\n }\n\n void Ms2IdentificationRate::writeResults_(Size pep_ids_count, Size ms2_spectra_count)\n {\n if (ms2_spectra_count < pep_ids_count)\n {\n throw Exception::Precondition(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"There are more Identifications than MS2 spectra. Please check your data.\");\n }\n\n // compute ratio\n double ratio = (double)pep_ids_count / ms2_spectra_count;\n\n // struct to store results\n IdentificationRateData id_rate_data {};\n\n // store results\n id_rate_data.num_peptide_identification = pep_ids_count;\n id_rate_data.num_ms2_spectra = ms2_spectra_count;\n id_rate_data.identification_rate = ratio;\n\n rate_result_.push_back(id_rate_data);\n }\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9388,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/QC/MQMsmsExporter.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":10078,"string":"10,078"},"line_count":{"kind":"number","value":279,"string":"279"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Chris Bielow$\n// $Authors: Hendrik Beschorner, Lenny Kovac, Virginia Rossow$\n// --------------------------------------------------------------------------\n\n#include <OpenMS/QC/MQMsmsExporter.h>\n\n#include <OpenMS/CONCEPT/LogStream.h>\n#include <OpenMS/KERNEL/Feature.h>\n#include <OpenMS/KERNEL/FeatureMap.h>\n#include <OpenMS/MATH/MathFunctions.h>\n#include <OpenMS/SYSTEM/File.h>\n#include <OpenMS/KERNEL/MSExperiment.h>\n\n#include <QtCore/QDir>\n#include <cmath> // isnan\n#include <fstream>\n//#include <vector>\n\nusing namespace OpenMS;\n\n\nMQMsms::MQMsms(const String& path)\n{\n if (path.empty())\n {\n return;\n }\n filename_ = path + \"/msms.txt\";\n try\n {\n QString msms_path = QString::fromStdString(path);\n QDir().mkpath(msms_path);\n file_ = std::fstream(filename_, std::fstream::out);\n }\n catch (...)\n {\n OPENMS_LOG_FATAL_ERROR << filename_ << \" wasn’t created\" << std::endl;\n throw Exception::FileNotWritable(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"out_msms\");\n }\n exportHeader_();\n}\n\n\nMQMsms::~MQMsms()\n{\n file_.close();\n}\n\n\nvoid MQMsms::exportHeader_()\n{\n\n file_ << \"Raw file\" << \"\\t\";\n file_ << \"Scan number\" << \"\\t\"; // NA\n file_ << \"Scan index\" << \"\\t\"; // NA\n file_ << \"Sequence\" << \"\\t\";\n file_ << \"Length\" << \"\\t\";\n file_ << \"Missed cleavages\" << \"\\t\";\n file_ << \"Modifications\" << \"\\t\";\n file_ << \"Modified sequence\" << \"\\t\";\n //file_ << \"Oxidation (M) Probabilities\" << \"\\t\"; --> not supported by OpenMS\n //file_ << \"Oxidation (M) Score diffs\" << \"\\t\"; --> not supported by OpenMS\n file_ << \"Acetyl (Protein N-term)\" << \"\\t\";\n file_ << \"Oxidation (M)\" << \"\\t\";\n file_ << \"Proteins\" << \"\\t\";\n file_ << \"Charge\" << \"\\t\";\n file_ << \"Fragmentation\" << \"\\t\"; // NA\n file_ << \"Mass analyzer\" << \"\\t\"; // NA\n file_ << \"Type\" << \"\\t\";\n file_ << \"Scan event number\" << \"\\t\"; // NA\n file_ << \"Isotope index\" << \"\\t\"; // NA\n file_ << \"m/z\" << \"\\t\";\n file_ << \"Mass\" << \"\\t\";\n file_ << \"Mass error [ppm]\" << \"\\t\";\n file_ << \"Mass error [Da]\" << \"\\t\";\n file_ << \"Simple mass error [ppm]\" << \"\\t\"; // NA\n file_ << \"Retention time\" << \"\\t\";\n file_ << \"PEP\" << \"\\t\";\n file_ << \"Score\" << \"\\t\";\n file_ << \"Delta score\" << \"\\t\";\n file_ << \"Score diff\" << \"\\t\";\n file_ << \"Localization prob\" << \"\\t\";\n //file_ << \"Combinatorics\" << \"\\t\"; --> not supported by OpenMS\n //file_ << \"PIF\" << \"\\t\"; --> not practical to implement\n file_ << \"Fraction of total spectrum\" << \"\\t\";\n file_ << \"Base peak fraction\" << \"\\t\";\n file_ << \"Precursor full scan number\" << \"\\t\"; // NA\n file_ << \"Precursor Intensity\" << \"\\t\"; // NA\n file_ << \"Precursor apex fraction\" << \"\\t\"; // NA\n file_ << \"Precursor apex offset\" << \"\\t\"; // NA\n file_ << \"Precursor apex offset time\" << \"\\t\"; // NA\n file_ << \"Matches Intensities\" << \"\\t\"; // NA\n file_ << \"Mass deviations [Da]\" << \"\\t\"; // NA\n file_ << \"Mass deviations [ppm]\" << \"\\t\"; // NA\n file_ << \"Masses\" << \"\\t\"; // NA\n file_ << \"Number of matches\" << \"\\t\"; // NA\n file_ << \"Intensity coverage\" << \"\\t\"; // NA\n file_ << \"Peak coverage\" << \"\\t\"; // NA\n file_ << \"Neutral loss level\" << \"\\t\"; // NA\n file_ << \"ETD identification type\" << \"\\t\"; // NA\n file_ << \"Reverse\" << \"\\t\"; // NA\n file_ << \"All scores\" << \"\\t\"; // NA\n file_ << \"All sequences\" << \"\\t\"; // NA\n file_ << \"All modified sequences\" << \"\\t\"; // NA\n //file_ << \"Reporter PIF\" << \"\\t\"; --> not supported by OpenMS\n //file_ << \"Reporter fraction\" << \"\\t\"; --> not supported by OpenMS\n file_ << \"id\" << \"\\t\";\n file_ << \"Protein group IDs\" << \"\\n\";\n //file_ << \"Peptide ID\" << \"\\t\"; --> not useful without the other MQ files\n //file_ << \"Mod. peptide ID\" << \"\\t\"; --> not useful without the other MQ files\n //file_ << \"Evidence ID\" << \"\\t\"; // --> in evidence.txt\n //file_ << \"Oxidation (M) site IDs\" << \"\\n\"; --> not useful without the other MQ files\n\n}\n\nvoid MQMsms::exportRowFromFeature_(\n const Feature& f,\n const ConsensusMap& cmap,\n const Size c_feature_number,\n const String& raw_file,\n const std::multimap<String, std::pair<Size, Size>>& UIDs,\n const ProteinIdentification::Mapping& mp_f,\n const MSExperiment& exp,\n const std::map<String,String>& prot_mapper)\n{\n\n // use struct common_outpots from the ExporterHelper\n MQExporterHelper::MQCommonOutputs common_outputs{f, cmap, c_feature_number, UIDs, mp_f, exp, prot_mapper};\n\n const PeptideHit* ptr_best_hit = nullptr; // the best hit referring to score\n const PeptideIdentification* ptr_best_id = nullptr;\n const ConsensusFeature& cf = cmap[c_feature_number];\n\n String type;\n if (MQExporterHelper::hasValidPepID_(f, c_feature_number, UIDs, mp_f))\n {\n type = \"MULTI-MSMS\";\n ptr_best_hit = &f.getPeptideIdentifications()[0].getHits()[0];\n ptr_best_id = &f.getPeptideIdentifications()[0];\n }\n else if (MQExporterHelper::hasPeptideIdentifications_(cf))\n {\n type = \"MULTI-MATCH\";\n ptr_best_hit = &cf.getPeptideIdentifications()[0].getHits()[0];\n ptr_best_id = &cf.getPeptideIdentifications()[0];\n }\n else\n {\n return; // no valid PepID; nothing to export\n }\n\n //const double& max_score = ptr_best_hit->getScore();\n const AASequence& pep_seq = ptr_best_hit->getSequence();\n\n if (pep_seq.empty())\n {\n return;\n }\n\n\n // what is written in the file in this exact order\n\n file_ << raw_file << \"\\t\"; // raw file\n file_ << \"NA\" << \"\\t\"; // Scan number\n file_ << \"NA\" << \"\\t\"; // Scan index\n file_ << pep_seq.toUnmodifiedString() << \"\\t\"; // Sequence\n file_ << pep_seq.size() << \"\\t\"; // Length\n file_ << ptr_best_hit->getMetaValue(\"missed_cleavages\", \"NA\") << \"\\t\"; // missed cleavages\n\n\n file_ << common_outputs.modifications.str() << \"\\t\"; // Modifications\n file_ << \"_\" << pep_seq << \"_\" << \"\\t\"; // Modified Sequence\n file_ << common_outputs.acetyl << \"\\t\"; // Acetyl (Protein N-term)\n file_ << common_outputs.oxidation.str() << \"\\t\"; // Oxidation (M)\n\n const std::set<String>& accessions = ptr_best_hit->extractProteinAccessionsSet();\n file_ << ListUtils::concatenate(accessions, \";\") << \"\\t\"; // Proteins\n\n file_ << f.getCharge() << \"\\t\"; // Charge\n\n file_ << ptr_best_id->getMetaValue(\"activation_method\", \"NA\") << \"\\t\"; // Fragmentation\n\n file_ << \"NA\" << \"\\t\"; // Mass analyzer\n file_ << type << \"\\t\"; // type\n\n file_ << ptr_best_id->getMetaValue(\"ScanEventNumber\", \"NA\") << \"\\t\"; // Scan event number\n\n file_ << \"NA\" << \"\\t\"; // Isotope index\n file_ << f.getMZ() << \"\\t\"; // M/Z\n file_ << pep_seq.getMonoWeight() << \"\\t\"; // Mass\n file_ << common_outputs.mass_error_ppm.str() << \"\\t\"; // Mass Error [ppm]\n file_ << common_outputs.mass_error_da.str() << \"\\t\"; // Mass error [Da]\n\n file_ << \"NA\" << \"\\t\"; // Simple mass error [ppm]\n\n f.metaValueExists(\"rt_raw_end\") && f.metaValueExists(\"rt_raw_start\") ?\n file_ << (double(f.getMetaValue(\"rt_raw_end\")) - double(f.getMetaValue(\"rt_raw_start\"))) / 60 << \"\\t\" : file_\n << \"NA\" << \"\\t\"; // Retention time\n\n ptr_best_hit->metaValueExists(\"PEP\")? file_ << ptr_best_hit->getMetaValue(\"PEP\") << \"\\t\" : file_ << \"\\t\"; // PEP\n file_ << ptr_best_hit->getScore() << \"\\t\"; // Score\n f.metaValueExists(\"delta\") ? file_ << (f.getMetaValue(\"delta\")) << \"\\t\" : file_ << \"\\t\"; // Delta score\n\n file_ << \"NA\" << \"\\t\"; // Score diff\n file_ << \"NA\" << \"\\t\"; // Localization prob\n\n f.metaValueExists(Constants::UserParam::PSM_EXPLAINED_ION_CURRENT_USERPARAM) ? file_ << (f.getMetaValue(Constants::UserParam::PSM_EXPLAINED_ION_CURRENT_USERPARAM)) << \"\\t\": file_ << \"\\t\"; // Fraction of total spectrum\n\n file_ << common_outputs.base_peak_fraction.str() << \"\\t\"; // Base peak fraction\n\n file_ << \"NA\" << \"\\t\"; // Precursor full scan number\n file_ << \"NA\" << \"\\t\"; // Precursor Intensity\n file_ << \"NA\" << \"\\t\"; // Precursor apex fraction\n file_ << \"NA\" << \"\\t\"; // Precursor apex offset\n file_ << \"NA\" << \"\\t\"; // Precursor apex offset time\n file_ << \"NA\" << \"\\t\"; // Matches Intensities\n file_ << \"NA\" << \"\\t\"; // Mass deviations [Da]\n file_ << \"NA\" << \"\\t\"; // Mass deviations [ppm]\n file_ << \"NA\" << \"\\t\"; // Masses\n file_ << \"NA\" << \"\\t\"; // Number of matches\n file_ << \"NA\" << \"\\t\"; // Intensity coverage\n file_ << \"NA\" << \"\\t\"; // Peak coverage\n file_ << \"NA\" << \"\\t\"; // Neutral loss level\n file_ << \"NA\" << \"\\t\"; // ETD identification type\n\n ptr_best_hit->isDecoy() ? file_ << \"1\\t\" : file_ << \"\\t\"; // reverse\n\n file_ << \"NA\" << \"\\t\"; // All scores\n file_ << \"NA\" << \"\\t\"; // All sequences\n file_ << \"NA\" << \"\\t\"; // All modified sequences\n\n file_ << id_ << \"\\t\"; // ID\n ++id_;\n\n file_ << ListUtils::concatenate(accessions, \";\") << \"\\n\"; // Protein group IDs\n\n\n}\n\nvoid MQMsms::exportFeatureMap(const FeatureMap& feature_map, const ConsensusMap& cmap, const MSExperiment& exp, const std::map<String,String>& prot_mapper)\n{\n if (!MQExporterHelper::isValid(filename_))\n {\n OPENMS_LOG_ERROR << \"MqMsms object is not valid.\" << std::endl;\n throw Exception::FileNotWritable(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, filename_);\n }\n const std::map<Size, Size>& fTc = MQExporterHelper::makeFeatureUIDtoConsensusMapIndex_(cmap);\n StringList spectra_data;\n feature_map.getPrimaryMSRunPath(spectra_data);\n String raw_file = File::basename(spectra_data.empty() ? feature_map.getLoadedFilePath() : spectra_data[0]);\n\n ProteinIdentification::Mapping mp_f;\n mp_f.create(feature_map.getProteinIdentifications());\n\n std::multimap<String, std::pair<Size, Size>> UIDs = PeptideIdentification::buildUIDsFromAllPepIDs(cmap);\n\n for (const Feature& f : feature_map)\n {\n const Size& f_id = f.getUniqueId();\n const auto& c_id = fTc.find(f_id);\n if (c_id != fTc.end())\n {\n exportRowFromFeature_(f, cmap, c_id->second, raw_file, UIDs, mp_f, exp, prot_mapper);\n }\n else\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Feature in FeatureMap has no associated ConsensusFeature.\");\n }\n }\n file_.flush();\n}\n\n\n\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9389,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/QC/MissedCleavages.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":4952,"string":"4,952"},"line_count":{"kind":"number","value":144,"string":"144"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Chris Bielow $\n// $Authors: Swenja Wagner, Patricia Scheil $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/CONCEPT/Exception.h>\n#include <OpenMS/CONCEPT/LogStream.h>\n#include <OpenMS/KERNEL/FeatureMap.h>\n#include <OpenMS/QC/MissedCleavages.h>\n#include <iostream>\n\nnamespace OpenMS\n{\n typedef std::map<UInt32, UInt32> MapU32;\n // digests the Sequence in PeptideHit and counts the number of missed cleavages\n void MissedCleavages::get_missed_cleavages_from_peptide_identification_(const ProteaseDigestion& digestor, MapU32& result, const UInt32& max_mc, PeptideIdentification& pep_id)\n {\n if (pep_id.getHits().empty())\n {\n OPENMS_LOG_WARN << \"There is a Peptideidentification(RT: \" << pep_id.getRT() << \", MZ: \" << pep_id.getMZ() << \") without PeptideHits.\\n\";\n return;\n }\n std::vector<AASequence> digest_output;\n digestor.digest(pep_id.getHits()[0].getSequence(), digest_output);\n UInt32 num_mc = UInt32(digest_output.size() - 1);\n\n // warn if number of missed cleavages is greater than allowed maximum number of missed cleavages\n if (num_mc > max_mc)\n {\n OPENMS_LOG_WARN << \"Observed number of missed cleavages: \" << num_mc << \" is greater than: \" << max_mc\n << \" the allowed maximum number of missed cleavages during MS2-Search in: \" << pep_id.getHits()[0].getSequence() << \"\\n\";\n }\n\n ++result[num_mc];\n\n pep_id.getHits()[0].setMetaValue(\"missed_cleavages\", num_mc);\n };\n\n void MissedCleavages::compute(std::vector<ProteinIdentification>& prot_ids, PeptideIdentificationList& pep_ids)\n {\n MapU32 result {};\n\n // Exception if ProteinIdentification is empty\n if (prot_ids.empty())\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Missing information in ProteinIdentifications.\");\n }\n\n String enzyme = prot_ids[0].getSearchParameters().digestion_enzyme.getName();\n auto max_mc = prot_ids[0].getSearchParameters().missed_cleavages;\n\n // Exception if digestion enzyme is not given\n if (enzyme == \"unknown_enzyme\")\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No digestion enzyme in ID data detected. No computation possible.\");\n }\n\n // create a digestor, which doesn't allow any missed cleavages\n ProteaseDigestion digestor;\n digestor.setEnzyme(enzyme);\n digestor.setMissedCleavages(0);\n\n for (PeptideIdentification& pep_id : pep_ids)\n {\n get_missed_cleavages_from_peptide_identification_(digestor, result, max_mc, pep_id);\n }\n\n mc_result_.push_back(result);\n }\n\n\n void MissedCleavages::compute(FeatureMap& fmap)\n {\n MapU32 result {};\n\n bool has_pepIDs = QCBase::hasPepID(fmap);\n if (!has_pepIDs)\n {\n mc_result_.push_back(result);\n return;\n }\n\n // if the FeatureMap is empty, result is 0\n if (fmap.empty())\n {\n OPENMS_LOG_WARN << \"FeatureXML is empty.\\n\";\n mc_result_.push_back(result);\n return;\n }\n\n // Exception if ProteinIdentification is empty\n if (fmap.getProteinIdentifications().empty())\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Missing information in ProteinIdentifications.\");\n }\n\n String enzyme = fmap.getProteinIdentifications()[0].getSearchParameters().digestion_enzyme.getName();\n auto max_mc = fmap.getProteinIdentifications()[0].getSearchParameters().missed_cleavages;\n\n // Exception if digestion enzyme is not given\n if (enzyme == \"unknown_enzyme\")\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No digestion enzyme in FeatureMap detected. No computation possible.\");\n }\n\n // create a digestor, which doesn't allow any missed cleavages\n ProteaseDigestion digestor;\n digestor.setEnzyme(enzyme);\n digestor.setMissedCleavages(0);\n\n // small lambda function to apply get_missed_cleavages_from_peptide_identification on pep_ids\n auto l = [&](PeptideIdentification& pep_id) {\n get_missed_cleavages_from_peptide_identification_(digestor, result, max_mc, pep_id);\n return;\n };\n // iterate through all PeptideIdentifications of a given FeatureMap and applies the given lambda function\n fmap.applyFunctionOnPeptideIDs(l);\n\n mc_result_.push_back(result);\n }\n\n\n const String& MissedCleavages::getName() const\n {\n static const String& name = \"MissedCleavages\";\n return name;\n }\n\n\n const std::vector<MapU32>& MissedCleavages::getResults() const\n {\n return mc_result_;\n }\n\n\n QCBase::Status MissedCleavages::requirements() const\n {\n return QCBase::Status() | QCBase::Requires::POSTFDRFEAT;\n }\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9390,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/QC/FWHM.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":1581,"string":"1,581"},"line_count":{"kind":"number","value":51,"string":"51"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Chris Bielow $\n// $Authors: Chris Bielow $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/KERNEL/FeatureMap.h>\n#include <OpenMS/QC/FWHM.h>\n\nnamespace OpenMS\n{\n void FWHM::compute(FeatureMap& features)\n {\n for (auto& f : features)\n {\n if (f.metaValueExists(\"FWHM\")) // from FF-Centroided\n {\n for (auto& pi : f.getPeptideIdentifications())\n {\n pi.setMetaValue(\"FWHM\", f.getMetaValue(\"FWHM\"));\n }\n }\n else if (f.metaValueExists(\"model_FWHM\")) // from FF-Identification\n {\n for (auto& pi : f.getPeptideIdentifications())\n {\n pi.setMetaValue(\"FWHM\", f.getMetaValue(\"model_FWHM\")); // use 'FWHM' as target to make the name unique for downstream processing\n }\n }\n else\n {\n // throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Metavalue 'FWHM' or 'model_FWHM' is missing for a feature in a FeatureMap. Please check your FeatureFinder\n // reports FWHM using these metavalues or add a new mapping here.\");\n }\n }\n }\n\n const String& FWHM::getName() const\n {\n static const String& name = \"FWHM\";\n return name;\n }\n\n QCBase::Status FWHM::requirements() const\n {\n return QCBase::Status() | QCBase::Requires::POSTFDRFEAT;\n }\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9391,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/QC/PSMExplainedIonCurrent.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":11449,"string":"11,449"},"line_count":{"kind":"number","value":271,"string":"271"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Tom Waschischeck$\n// $Authors: Tom Waschischeck$\n// --------------------------------------------------------------------------\n\n#include <OpenMS/CHEMISTRY/TheoreticalSpectrumGenerator.h>\n#include <OpenMS/CONCEPT/LogStream.h>\n#include <OpenMS/DATASTRUCTURES/MatchedIterator.h>\n#include <OpenMS/PROCESSING/FILTERING/WindowMower.h>\n#include <OpenMS/KERNEL/FeatureMap.h>\n#include <OpenMS/KERNEL/MSExperiment.h>\n#include <OpenMS/MATH/StatisticFunctions.h>\n#include <OpenMS/QC/PSMExplainedIonCurrent.h>\n#include <cfloat>\n#include <numeric>\n\nnamespace OpenMS\n{\n template<typename MIV>\n double sumOfMatchedIntensities(MIV& mi)\n {\n double sum = 0;\n while (mi != mi.end())\n {\n sum += mi->getIntensity();\n ++mi;\n }\n return sum;\n }\n\n double PSMExplainedIonCurrent::annotatePSMExplainedIonCurrent_(PeptideIdentification& pep_id, const MSExperiment& exp, const QCBase::SpectraMap& map_to_spectrum, WindowMower& filter,\n PSMExplainedIonCurrent::ToleranceUnit tolerance_unit, double tolerance)\n {\n if (pep_id.getHits().empty())\n {\n OPENMS_LOG_DEBUG << \"PeptideHits of PeptideIdentification with RT: \" << pep_id.getRT() << \" and MZ: \" << pep_id.getMZ() << \" is empty.\";\n return DBL_MAX;\n }\n\n //---------------------------------------------------------------------\n // FIND DATA FOR THEORETICAL SPECTRUM\n //---------------------------------------------------------------------\n\n // sequence\n const AASequence& seq = pep_id.getHits()[0].getSequence();\n\n // charge: re-calculated from masses since much more robust this way (PepID annotation of pep_id.getHits()[0].getCharge() could be wrong)\n Int charge = static_cast<Int>(round(seq.getMonoWeight() / pep_id.getMZ()));\n\n //-----------------------------------------------------------------------\n // GET EXPERIMENTAL SPECTRUM MATCHING TO PEPTIDEIDENTIFICATION\n //-----------------------------------------------------------------------\n\n if (!pep_id.metaValueExists(\"spectrum_reference\"))\n {\n throw Exception::InvalidParameter(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No spectrum reference annotated at peptide identifiction!\");\n }\n const MSSpectrum& exp_spectrum = exp[map_to_spectrum.at(pep_id.getSpectrumReference())];\n\n if (exp_spectrum.getMSLevel() != 2)\n {\n throw Exception::IllegalArgument(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"The matching spectrum of the mzML is not an MS2 Spectrum.\");\n }\n Precursor::ActivationMethod act_method;\n if (exp_spectrum.getPrecursors().empty() || exp_spectrum.getPrecursors()[0].getActivationMethods().empty())\n {\n OPENMS_LOG_DEBUG << \"No MS2 activation method provided. Using CID as fallback to compute fragment mass errors.\" << std::endl;\n act_method = Precursor::ActivationMethod::CID;\n }\n else\n {\n act_method = *exp_spectrum.getPrecursors()[0].getActivationMethods().begin();\n }\n\n //---------------------------------------------------------------------\n // CREATE THEORETICAL SPECTRUM\n //---------------------------------------------------------------------\n PeakSpectrum theo_spectrum = TheoreticalSpectrumGenerator::generateSpectrum(act_method, seq, charge);\n\n //-----------------------------------------------------------------------\n // COMPARE THEORETICAL AND EXPERIMENTAL SPECTRUM\n //-----------------------------------------------------------------------\n if (exp_spectrum.empty() || theo_spectrum.empty())\n {\n OPENMS_LOG_WARN << \"The spectrum with RT: \" + String(exp_spectrum.getRT()) + \" is empty.\"\n << \"\\n\";\n return DBL_MAX;\n }\n\n // filter the spectrum\n PeakSpectrum filtered_spec(exp_spectrum);\n filter.filterPeakSpectrum(filtered_spec);\n\n double sum_of_intensities = 0;\n for (const auto& peak : filtered_spec)\n {\n sum_of_intensities += peak.getIntensity();\n }\n\n if (sum_of_intensities <= 0)\n {\n OPENMS_LOG_WARN << \"The spectrum with RT: \" + String(exp_spectrum.getRT()) + \" has only peaks with intensity 0.\"\n << \"\\n\";\n return DBL_MAX;\n }\n\n double correctness = 0;\n // iterator, finds nearest peak of a target container to a given peak in a reference container\n if (tolerance_unit == PSMExplainedIonCurrent::ToleranceUnit::DA)\n {\n using MIV = MatchedIterator<MSSpectrum, DaTrait, true>;\n MIV mi(theo_spectrum, filtered_spec, tolerance);\n correctness = sumOfMatchedIntensities(mi) / sum_of_intensities;\n }\n else\n {\n using MIV = MatchedIterator<MSSpectrum, PpmTrait, true>;\n MIV mi(theo_spectrum, filtered_spec, tolerance);\n correctness = sumOfMatchedIntensities(mi) / sum_of_intensities;\n }\n\n pep_id.getHits()[0].setMetaValue(Constants::UserParam::PSM_EXPLAINED_ION_CURRENT_USERPARAM, correctness);\n\n return correctness;\n }\n\n void PSMExplainedIonCurrent::compute(FeatureMap& fmap, const MSExperiment& exp, const QCBase::SpectraMap& map_to_spectrum, ToleranceUnit tolerance_unit, double tolerance)\n {\n Statistics result;\n\n bool has_pepIDs = QCBase::hasPepID(fmap);\n // if there are no matching peaks, the counter is zero and it is not possible to find ppms\n if (!has_pepIDs)\n {\n results_.push_back(result);\n return;\n }\n\n //---------------------------------------------------------------------\n // Prepare Spectrum Filter\n //---------------------------------------------------------------------\n\n WindowMower wm_filter;\n Param filter_param = wm_filter.getParameters();\n filter_param.setValue(\"windowsize\", 100.0, \"The size of the sliding window along the m/z axis.\");\n filter_param.setValue(\"peakcount\", 6, \"The number of peaks that should be kept.\");\n filter_param.setValue(\"movetype\", \"jump\", \"Whether sliding window (one peak steps) or jumping window (window size steps) should be used.\");\n wm_filter.setParameters(filter_param);\n\n //-------------------------------------------------------------------\n // find tolerance unit and value\n //------------------------------------------------------------------\n if (tolerance_unit == ToleranceUnit::AUTO)\n {\n if (fmap.getProteinIdentifications().empty())\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION,\n \"No information about fragment mass tolerance given in the FeatureMap. Please choose a fragment_mass_unit and tolerance manually.\");\n }\n tolerance_unit = fmap.getProteinIdentifications()[0].getSearchParameters().fragment_mass_tolerance_ppm ? ToleranceUnit::PPM : ToleranceUnit::DA;\n tolerance = fmap.getProteinIdentifications()[0].getSearchParameters().fragment_mass_tolerance;\n if (tolerance <= 0.0)\n { // some engines, e.g. MSGF+ have no fragment tolerance parameter. It will be 0.0.\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION,\n \"No information about fragment mass tolerance given in the FeatureMap. Please choose a fragment_mass_unit and tolerance manually.\");\n }\n }\n\n std::vector<double> correctnesses;\n\n std::function<void(PeptideIdentification&)> fCorrectness = [&exp, &map_to_spectrum, &correctnesses, &wm_filter, tolerance, tolerance_unit](PeptideIdentification& pep_id) {\n double correctness = annotatePSMExplainedIonCurrent_(pep_id, exp, map_to_spectrum, wm_filter, tolerance_unit, tolerance);\n if (correctness != DBL_MAX)\n {\n correctnesses.push_back(correctness);\n }\n };\n\n fmap.applyFunctionOnPeptideIDs(fCorrectness);\n\n if (correctnesses.empty())\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Couldn't calculate PSM correctness for any spectra! Check log for more information.\");\n }\n\n result.average_correctness = Math::mean(correctnesses.begin(), correctnesses.end());\n result.variance_correctness = Math::variance(correctnesses.begin(), correctnesses.end(), result.average_correctness);\n\n results_.push_back(result);\n }\n\n void PSMExplainedIonCurrent::compute(PeptideIdentificationList& pep_ids, const ProteinIdentification::SearchParameters& search_params, const MSExperiment& exp,\n const QCBase::SpectraMap& map_to_spectrum, ToleranceUnit tolerance_unit, double tolerance)\n {\n Statistics result;\n\n if (pep_ids.empty())\n {\n results_.push_back(result);\n return;\n }\n\n //---------------------------------------------------------------------\n // Prepare Spectrum Filter\n //---------------------------------------------------------------------\n\n WindowMower wm_filter;\n Param filter_param = wm_filter.getParameters();\n filter_param.setValue(\"windowsize\", 100.0, \"The size of the sliding window along the m/z axis.\");\n filter_param.setValue(\"peakcount\", 6, \"The number of peaks that should be kept.\");\n filter_param.setValue(\"movetype\", \"jump\", \"Whether sliding window (one peak steps) or jumping window (window size steps) should be used.\");\n wm_filter.setParameters(filter_param);\n\n //-------------------------------------------------------------------\n // find tolerance unit and value\n //------------------------------------------------------------------\n if (tolerance_unit == ToleranceUnit::AUTO)\n {\n tolerance_unit = search_params.fragment_mass_tolerance_ppm ? ToleranceUnit::PPM : ToleranceUnit::DA;\n tolerance = search_params.fragment_mass_tolerance;\n if (tolerance <= 0.0)\n { // some engines, e.g. MSGF+ have no fragment tolerance parameter. It will be 0.0.\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION,\n \"No information about fragment mass tolerance given. Please choose a fragment_mass_unit and tolerance manually.\");\n }\n }\n\n std::vector<double> correctnesses;\n\n for (auto& pep_id : pep_ids)\n {\n double correctness = annotatePSMExplainedIonCurrent_(pep_id, exp, map_to_spectrum, wm_filter, tolerance_unit, tolerance);\n if (correctness != DBL_MAX)\n {\n correctnesses.push_back(correctness);\n }\n }\n\n if (correctnesses.empty())\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Couldn't calculate PSM correctness for any spectra! Check log for more information.\");\n }\n\n result.average_correctness = Math::mean(correctnesses.begin(), correctnesses.end());\n result.variance_correctness = Math::variance(correctnesses.begin(), correctnesses.end(), result.average_correctness);\n\n results_.push_back(result);\n }\n\n const String& PSMExplainedIonCurrent::getName() const\n {\n static const String& name = \"PSMExplainedIonCurrent\";\n return name;\n }\n\n const std::vector<PSMExplainedIonCurrent::Statistics>& PSMExplainedIonCurrent::getResults() const\n {\n return results_;\n }\n\n\n QCBase::Status PSMExplainedIonCurrent::requirements() const\n {\n return QCBase::Status() | QCBase::Requires::RAWMZML | QCBase::Requires::POSTFDRFEAT;\n }\n\n}; // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9392,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/QC/FeatureSummary.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":1570,"string":"1,570"},"line_count":{"kind":"number","value":62,"string":"62"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Axel Walter $\n// $Authors: Axel Walter $\n// --------------------------------------------------------------------------\n\n\n#include <OpenMS/QC/FeatureSummary.h>\n\nusing namespace std;\n\nnamespace OpenMS\n{\n FeatureSummary::Result FeatureSummary::compute(const FeatureMap& feature_map)\n {\n FeatureSummary::Result result;\n float sum_rt_deviations = 0;\n UInt rt_count = 0;\n result.feature_count = feature_map.size();\n for (const auto& f : feature_map)\n {\n if (f.metaValueExists(\"rt_deviation\"))\n {\n sum_rt_deviations += (float)f.getMetaValue(\"rt_deviation\");\n rt_count += 1;\n }\n }\n\n // calculate mean rt shift (sec)\n if (rt_count != 0)\n {\n result.rt_shift_mean = sum_rt_deviations / rt_count;\n }\n else\n {\n result.rt_shift_mean = 0;\n }\n\n return result;\n }\n\n bool FeatureSummary::Result::operator==(const Result& rhs) const\n {\n return feature_count == rhs.feature_count && rt_shift_mean == rhs.rt_shift_mean;\n }\n\n /// Returns the name of the metric\n const String& FeatureSummary::getName() const\n {\n return name_;\n }\n\n /// Returns required file input i.e. MzML.\n /// This is encoded as a bit in a Status object.\n QCBase::Status FeatureSummary::requirements() const\n {\n return QCBase::Status(QCBase::Requires::PREFDRFEAT);\n }\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9393,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/QC/QCBase.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":2814,"string":"2,814"},"line_count":{"kind":"number","value":91,"string":"91"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Chris Bielow $\n// $Authors: Chris Bielow, Tom Waschischeck $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/CONCEPT/LogStream.h>\n#include <OpenMS/KERNEL/ConsensusMap.h>\n#include <OpenMS/KERNEL/MSExperiment.h>\n#include <OpenMS/QC/QCBase.h>\n\nnamespace OpenMS\n{\n const std::string QCBase::names_of_requires[] = {\"fail\", \"raw.mzML\", \"postFDR.featureXML\", \"preFDR.featureXML\", \"contaminants.fasta\", \"trafoAlign.trafoXML\"};\n\n const std::string QCBase::names_of_toleranceUnit[] = {\"auto\", \"ppm\", \"da\"};\n\n QCBase::SpectraMap::SpectraMap(const MSExperiment& exp)\n {\n calculateMap(exp);\n }\n\n void QCBase::SpectraMap::calculateMap(const MSExperiment& exp)\n {\n nativeid_to_index_.clear();\n for (Size i = 0; i < exp.size(); ++i)\n {\n nativeid_to_index_[exp[i].getNativeID()] = i;\n }\n }\n\n UInt64 QCBase::SpectraMap::at(const String& identifier) const\n {\n if (const auto& it = nativeid_to_index_.find(identifier); it == nativeid_to_index_.end())\n {\n throw Exception::ElementNotFound(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, String(\"No spectrum with identifier '\") + identifier + \"' in MSExperiment!\");\n }\n else\n {\n return it->second;\n }\n }\n\n void QCBase::SpectraMap::clear()\n {\n nativeid_to_index_.clear();\n }\n\n bool QCBase::SpectraMap::empty() const\n {\n return nativeid_to_index_.empty();\n }\n\n Size QCBase::SpectraMap::size() const\n {\n return nativeid_to_index_.size();\n }\n\n // function tests if a metric has the required input files\n // gives a warning with the name of the metric that can not be performed\n bool QCBase::isRunnable(const Status& s) const\n {\n if (s.isSuperSetOf(this->requirements()))\n {\n return true;\n }\n for (Size i = 0; i < (UInt64)QCBase::Requires::SIZE_OF_REQUIRES; ++i)\n {\n if (this->requirements().isSuperSetOf(QCBase::Requires(i)) && !s.isSuperSetOf(QCBase::Requires(i)))\n {\n OPENMS_LOG_WARN << \"Note: Metric '\" << this->getName() << \"' cannot run because input data '\" << QCBase::names_of_requires[i] << \"' is missing!\\n\";\n }\n }\n return false;\n }\n\n bool QCBase::isLabeledExperiment(const ConsensusMap& cm)\n {\n bool iso_analyze = true;\n auto cm_dp = cm.getDataProcessing(); // get a copy to avoid calling .begin() and .end() on two different temporaries\n if (all_of(cm_dp.begin(), cm_dp.end(), [](const OpenMS::DataProcessing& dp) { return (dp.getSoftware().getName() != \"IsobaricAnalyzer\"); }))\n {\n iso_analyze = false;\n }\n return iso_analyze;\n }\n\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9394,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/QC/DBSuitability.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":28184,"string":"28,184"},"line_count":{"kind":"number","value":751,"string":"751"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Tom Waschischeck $\n// $Authors: Tom Waschischeck $\n// --------------------------------------------------------------------------\n\n\n#include <OpenMS/ANALYSIS/ID/FalseDiscoveryRate.h>\n#include <OpenMS/ANALYSIS/ID/PeptideIndexing.h>\n#include <OpenMS/ANALYSIS/OPENSWATH/MRMDecoy.h>\n#include <OpenMS/CONCEPT/Constants.h>\n#include <OpenMS/CONCEPT/LogStream.h>\n#include <OpenMS/CONCEPT/UniqueIdGenerator.h>\n#include <OpenMS/PROCESSING/ID/IDFilter.h>\n#include <OpenMS/FORMAT/FileHandler.h>\n#include <OpenMS/FORMAT/ParamXMLFile.h>\n#include <OpenMS/KERNEL/MSExperiment.h>\n#include <OpenMS/MATH/StatisticFunctions.h>\n#include <OpenMS/METADATA/PeptideIdentification.h>\n#include <OpenMS/METADATA/PeptideHit.h>\n#include <OpenMS/QC/DBSuitability.h>\n#include <OpenMS/SYSTEM/ExternalProcess.h>\n#include <OpenMS/SYSTEM/File.h>\n\n#include <random>\n\nusing namespace std;\n\nnamespace OpenMS\n{\n DBSuitability::DBSuitability()\n : DefaultParamHandler(\"DBSuitability\"), results_{}, decoy_pattern_(string(DecoyHelper::regexstr_prefix + \"|\" + DecoyHelper::regexstr_suffix))\n {\n defaults_.setValue(\"no_rerank\", \"false\", \"Use this flag if you want to disable re-ranking. Cases, where a de novo peptide scores just higher than the database peptide, are overlooked and counted as a de novo hit. This might underestimate the database quality.\");\n defaults_.setValidStrings(\"no_rerank\", { \"true\", \"false\" });\n defaults_.setValue(\"reranking_cutoff_percentile\", 0.01, \"Swap a top-scoring deNovo hit with a lower scoring DB hit if their xcorr score difference is in the given percentile of all score differences between the first two decoy hits of a PSM. The lower the value the lower the decoy cut-off will be. Therefore it will be harder for a lower scoring DB hit to be re-ranked to the top.\");\n defaults_.setMinFloat(\"reranking_cutoff_percentile\", 0.);\n defaults_.setMaxFloat(\"reranking_cutoff_percentile\", 1.);\n defaults_.setValue(\"FDR\", 0.01, \"Filter peptide hits based on this q-value. (e.g., 0.05 = 5 % FDR)\");\n defaults_.setMinFloat(\"FDR\", 0.);\n defaults_.setMaxFloat(\"FDR\", 1.);\n defaults_.setValue(\"number_of_subsampled_runs\", 1, \"Controls how many runs should be done for calculating corrected suitability. (0 : number of runs will be estimated automaticly) ATTENTION: For each run a seperate ID-search is performed. This can result in some serious run time.\");\n defaults_.setMinInt(\"number_of_subsampled_runs\", 0);\n defaults_.setValue(\"keep_search_files\", \"false\", \"Set this flag if you wish to keep the files used by and produced by the internal ID search.\");\n defaults_.setValidStrings(\"keep_search_files\", { \"true\", \"false\" });\n defaults_.setValue(\"disable_correction\", \"false\", \"Set this flag to disable the calculation of the corrected suitability.\");\n defaults_.setValidStrings(\"disable_correction\", { \"true\", \"false\" });\n defaults_.setValue(\"force\", \"false\", \"Set this flag to enforce re-ranking when no cross correlation score is present. For re-ranking the default score found at each peptide hit is used. Use with care!\");\n defaults_.setValidStrings(\"force\", { \"true\", \"false\" });\n defaultsToParam_();\n }\n \n void DBSuitability::compute(PeptideIdentificationList&& pep_ids, const MSExperiment& exp, const vector<FASTAFile::FASTAEntry>& original_fasta, const std::vector<FASTAFile::FASTAEntry>& novo_fasta, const ProteinIdentification::SearchParameters& search_params)\n {\n for (const auto& id : pep_ids)\n {\n if (id.getScoreType() == \"q-value\") // q-value as score?\n {\n throw Exception::Precondition(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"q-value found at PeptideIdentifications. That is not allowed! Please make sure FDR did not run previously.\");\n }\n if (id.getHits().empty()) continue;\n if (id.getHits()[0].metaValueExists(\"q-value\")) // q-value at meta values?\n {\n throw Exception::Precondition(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"q-value found at PeptideIdentifications. That is not allowed! Please make sure FDR did not run previously.\");\n }\n\n if (!id.getHits()[0].metaValueExists(\"MS:1002252\")) // no xcorr at meta values?\n {\n if (!param_.getValue(\"force\").toBool())\n {\n OPENMS_LOG_WARN << \"No cross correlation score found. Comet is recommended for identification search. Re-ranking will be turned off. Set the 'force' flag to re-enable re-ranking. Use with care!\" << endl;\n param_.setValue(\"no_rerank\", \"true\");\n }\n else\n {\n OPENMS_LOG_WARN << \"'force' flag is set. Re-ranking (if not disabled) will be done with the default score. Be aware that this may result in undefined behaviour.\" << endl;\n }\n }\n break;\n }\n\n // calculate suitability\n results_.emplace_back();\n SuitabilityData& suitability_data_full = results_.back();\n\n // make sure pep_ids are sorted\n for (auto& pep_id : pep_ids)\n {\n pep_id.sort();\n }\n calculateSuitability_(pep_ids, suitability_data_full);\n\n if(!param_.getValue(\"disable_correction\").toBool())\n {\n pair<String, Param> search_info = extractSearchAdapterInfoFromMetaValues_(search_params);\n \n // calculate correction of suitability with extrapolation\n UInt number_of_runs = param_.getValue(\"number_of_subsampled_runs\");\n if (number_of_runs == 0)\n {\n number_of_runs = ceil(original_fasta.size() / double(numberOfUniqueProteins_(pep_ids)));\n }\n\n // sampled run(s)\n // TODO: maybe multiple runs? could be controlled with a parameter\n double subsampling_rate = 0.5;\n vector<SuitabilityData> subsampled_results;\n\n UInt current_run = 0;\n while (current_run < number_of_runs)\n {\n ++current_run;\n vector<FASTAFile::FASTAEntry> sampled_db = getSubsampledFasta_(original_fasta, subsampling_rate);\n sampled_db.insert(sampled_db.end(), novo_fasta.begin(), novo_fasta.end());\n appendDecoys_(sampled_db);\n PeptideIdentificationList subsampled_ids = runIdentificationSearch_(exp, sampled_db, search_info.first, search_info.second);\n // make sure pep_ids are sorted\n for (auto& pep_id : subsampled_ids)\n {\n pep_id.sort();\n }\n\n SuitabilityData suitability_data_sampled;\n calculateSuitability_(subsampled_ids, suitability_data_sampled);\n subsampled_results.push_back(suitability_data_sampled);\n }\n\n SuitabilityData median_sampled_data = subsampled_results[getIndexWithMedianNovoHits_(subsampled_results)];\n\n suitability_data_full.setCorrectionFactor(calculateCorrectionFactor_(suitability_data_full, median_sampled_data, subsampling_rate));\n\n // fill in theoretical suitability if re-ranking hadn't happen\n SuitabilityData no_rerank = suitability_data_full.simulateNoReRanking();\n SuitabilityData no_rerank_sampled = median_sampled_data.simulateNoReRanking();\n\n double factor_no_rerank = calculateCorrectionFactor_(no_rerank, {no_rerank_sampled}, subsampling_rate);\n\n suitability_data_full.suitability_corr_no_rerank = double(no_rerank.num_top_db) / (no_rerank.num_top_novo * factor_no_rerank + no_rerank.num_top_db);\n }\n }\n\n const std::vector<DBSuitability::SuitabilityData>& DBSuitability::getResults() const\n {\n return results_;\n }\n\n double DBSuitability::getDecoyDiff_(const PeptideIdentification& pep_id) const\n {\n double diff = DBL_MAX;\n\n // get the score of the first two decoy hits\n double decoy_1 = DBL_MAX;\n double decoy_2 = DBL_MAX;\n\n for (const auto& hit : pep_id.getHits())\n {\n if (hit.getTargetDecoyType() == PeptideHit::TargetDecoyType::UNKNOWN)\n {\n throw(Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No target/decoy information found! Make sure 'PeptideIndexer' is run beforehand.\"));\n }\n\n if (decoy_1 == DBL_MAX && hit.isDecoy())\n {\n decoy_1 = extractScore_(hit);\n continue;\n }\n if (decoy_1 < DBL_MAX && hit.isDecoy())\n {\n decoy_2 = extractScore_(hit);\n break;\n }\n }\n\n if (decoy_2 < DBL_MAX) // if there are two decoy hits\n {\n diff = abs(decoy_1 - decoy_2);\n }\n\n // if there aren't two decoy hits DBL_MAX is returned\n return diff;\n }\n\n double DBSuitability::getDecoyCutOff_(const PeptideIdentificationList& pep_ids, double reranking_cutoff_percentile) const\n {\n if (reranking_cutoff_percentile < 0 || reranking_cutoff_percentile > 1)\n {\n throw Exception::IllegalArgument(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"'reranking_cutoff_percentile' is not within its allowed range [0,1]. Please select a valid value.\");\n }\n\n // get all decoy diffs of peptide ids with at least two decoy hits\n vector<double> diffs;\n for (const auto& pep_id : pep_ids)\n {\n double diff = getDecoyDiff_(pep_id);\n if (diff < DBL_MAX)\n {\n diffs.push_back(diff);\n }\n }\n\n if (double(diffs.size()) / pep_ids.size() < 0.2)\n {\n throw(Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Under 20 % of peptide identifications have two decoy hits. This is not enough for re-ranking. Use the 'no_rerank' flag to still compute a suitability score.\"));\n }\n\n // sort the diffs decreasing and get the nth-percentile diff\n UInt index = round(reranking_cutoff_percentile * diffs.size());\n \n if (index >= diffs.size())\n {\n return *max_element(diffs.begin(), diffs.end());\n }\n\n nth_element(diffs.begin(), diffs.begin() + index, diffs.end());\n\n return diffs[index];\n }\n\n bool DBSuitability::isNovoHit_(const PeptideHit& hit) const\n {\n const set<String>& accessions = hit.extractProteinAccessionsSet();\n for (const String& acc : accessions)\n {\n if (acc.find(Constants::UserParam::CONCAT_PEPTIDE) == String::npos && !boost::regex_search(String(acc).toLower(), decoy_pattern_))\n {\n return false;\n }\n }\n return true;\n }\n\n bool DBSuitability::checkScoreBetterThanThreshold_(const PeptideHit& hit, double threshold, bool higher_score_better) const\n {\n if (higher_score_better)\n {\n if (hit.getScore() < threshold)\n return false;\n return true;\n }\n if (hit.getScore() > threshold)\n return false;\n return true;\n }\n\n pair<String, Param> DBSuitability::extractSearchAdapterInfoFromMetaValues_(const ProteinIdentification::SearchParameters& search_params) const\n {\n Param p;\n // list of all allowed adapters\n vector<String> working_adapters{ \"CometAdapter\", \"MSGFPlusAdapter\", \"MSFraggerAdapter\" };\n\n vector<String> keys;\n search_params.getKeys(keys);\n\n // find adapter name\n String adapter;\n for (const String& key : keys)\n {\n for (const String& a : working_adapters)\n {\n // look for adapter name as a prefix of a search parameter\n if (key.compare(0, a.size() + 1, a + \":\") == 0)\n {\n // used adapter found\n adapter = a;\n break;\n }\n }\n if (!adapter.empty())\n {\n break;\n }\n }\n\n if (adapter.empty()) // non of the allowed adapter names where found in the meta values\n {\n String message;\n message = \"No parameters found for any of the allowed adapters in the given meta values. Allowed are:\\n\";\n message += ListUtils::concatenate(working_adapters, \", \");\n message = \"\\n\";\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, message);\n }\n\n // extract parameters\n for (const String& key : keys)\n {\n if (key.compare(0, adapter.size(), adapter) != 0) continue; // does adapter appear in meta value key?\n p.setValue(key, search_params.getMetaValue(key));\n }\n\n OPENMS_LOG_DEBUG << \"Parameters for the following adapter were found: \" << adapter << endl;\n\n return make_pair(adapter, p);\n }\n\n void DBSuitability::writeIniFile_(const Param& parameters, const String& filename) const\n {\n ParamXMLFile param_file;\n param_file.store(filename, parameters);\n }\n\n PeptideIdentificationList DBSuitability::runIdentificationSearch_(const MSExperiment& exp, const vector<FASTAFile::FASTAEntry>& fasta_data, const String& adapter_name, Param& parameters) const\n {\n if (adapter_name.empty())\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No adapter name given. Aborting!\");\n }\n\n // temporary folder for search in- und output files\n bool keep_files = param_.getValue(\"keep_search_files\").toBool();\n File::TempDir tmp_dir(keep_files);\n String mzml_path = tmp_dir.getPath() + \"spectra.mzML\";\n String db_path = tmp_dir.getPath() + \"database.FASTA\";\n String out_path = tmp_dir.getPath() + \"out.idXML\";\n\n // override the in- and output files in the parameters\n if (!parameters.exists(adapter_name + \":1:in\") || !parameters.exists(adapter_name + \":1:database\") || !parameters.exists(adapter_name + \":1:out\"))\n {\n throw Exception::InvalidParameter(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"'in', 'out' or 'database' parameter not found! The search adapter is probably not supported anymore.\");\n }\n parameters.setValue(adapter_name + \":1:in\", mzml_path);\n parameters.setValue(adapter_name + \":1:database\", db_path);\n parameters.setValue(adapter_name + \":1:out\", out_path);\n\n // store data in temporary files\n FileHandler spectra_file;\n spectra_file.storeExperiment(mzml_path, exp,{FileTypes::MZML});\n FASTAFile database;\n database.store(db_path, fasta_data);\n\n String ini_path = tmp_dir.getPath() + \"parameters.INI\";\n writeIniFile_(parameters, ini_path);\n\n // run identification search\n String proc_stdout;\n String proc_stderr;\n auto lam_out = [&](const String& out) { proc_stdout += out; };\n auto lam_err = [&](const String& out) { proc_stderr += out; };\n\n ExternalProcess ep(lam_out, lam_err);\n OPENMS_LOG_DEBUG << \"Running \" << adapter_name << \"...\" << endl << endl;\n const auto& rt = ep.run(adapter_name.toQString(), QStringList() << \"-ini\" << ini_path.toQString(), tmp_dir.getPath().toQString(), true);\n if (rt != ExternalProcess::RETURNSTATE::SUCCESS)\n { // error occurred\n OPENMS_LOG_ERROR << \"An error occurred while running \" << adapter_name << \".\" << endl;\n OPENMS_LOG_ERROR << \"Standard output: \" << proc_stdout << endl;\n OPENMS_LOG_ERROR << \"Standard error: \" << proc_stderr << endl;\n throw Exception::InternalToolError(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Return state was: \" + String(static_cast<Int>(rt)));\n }\n // search was successful\n\n // load result\n vector<ProteinIdentification> prot_ids;\n PeptideIdentificationList pep_ids;\n FileHandler id_file;\n id_file.loadIdentifications(out_path, prot_ids, pep_ids, {FileTypes::IDXML});\n\n // annotate target/decoy information\n PeptideIndexing indexer;\n FASTAContainer<TFI_Vector> proteins(fasta_data);\n OPENMS_LOG_DEBUG << \"Running PeptideIndexer functionalities ...\" << endl << endl;\n OPENMS_LOG_INFO.remove(cout); // prevent indexer from writing statistic\n PeptideIndexing::ExitCodes indexer_exit = indexer.run(proteins, prot_ids, pep_ids);\n OPENMS_LOG_INFO.insert(cout); // revert logging change\n if (indexer_exit != PeptideIndexing::ExitCodes::EXECUTION_OK)\n {\n OPENMS_LOG_ERROR << \"An error occurred while trying to index the search results.\" << endl;\n throw Exception::InternalToolError(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Return state was: \" + String(static_cast<Int>(indexer_exit)));\n }\n\n if (keep_files)\n {\n id_file.storeIdentifications(tmp_dir.getPath() + \"indexed_pre_FDR.idXML\", prot_ids, pep_ids, {FileTypes::IDXML});\n }\n\n return pep_ids;\n }\n\n std::vector<FASTAFile::FASTAEntry> DBSuitability::getSubsampledFasta_(const std::vector<FASTAFile::FASTAEntry>& fasta_data, double subsampling_rate) const\n {\n if (subsampling_rate < 0 || subsampling_rate > 1)\n {\n throw Exception::IllegalArgument(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Subsampling rate has to be between 0 and 1. Aborting!\");\n }\n Size num_AA{};\n for (const auto& entry : fasta_data)\n {\n num_AA += entry.sequence.size();\n }\n double num_AS_written = num_AA * subsampling_rate;\n\n Math::RandomShuffler shuffler;\n shuffler.seed(UniqueIdGenerator::getUniqueId());\n std::vector<int> rnd_indices(fasta_data.size());\n std::iota(std::begin(rnd_indices), std::end(rnd_indices), 0);\n shuffler.portable_random_shuffle(rnd_indices.begin(), rnd_indices.end());\n\n Size curr_AA{};\n vector<FASTAFile::FASTAEntry> sampled_fasta;\n for (const int i : rnd_indices)\n {\n if (curr_AA >= num_AS_written) break;\n sampled_fasta.push_back(fasta_data[i]);\n curr_AA += fasta_data[i].sequence.size();\n }\n return sampled_fasta;\n }\n\n void DBSuitability::calculateSuitability_(const PeptideIdentificationList& pep_ids, SuitabilityData& data) const\n {\n // make sure no old data messes up the calculations\n data.clear();\n\n bool no_re_rank = param_.getValue(\"no_rerank\").toBool();\n double cut_off_fract = param_.getValue(\"reranking_cutoff_percentile\");\n\n if (pep_ids.empty())\n {\n OPENMS_LOG_WARN << \"No peptide identifications found in given idXML! No calculations performed.\" << endl;\n return;\n }\n\n bool hsb = pep_ids[0].isHigherScoreBetter();\n\n // calculate score that corresponds to the FDR cut-off\n double score_cut_off;\n {\n PeptideIdentificationList ids_copy(pep_ids);\n\n FalseDiscoveryRate fdr;\n fdr.apply(ids_copy);\n\n score_cut_off = getScoreMatchingFDR_(ids_copy, param_.getValue(\"FDR\"), pep_ids[0].getScoreType(), hsb);\n }\n\n if (!no_re_rank)\n {\n data.cut_off = getDecoyCutOff_(pep_ids, cut_off_fract);\n }\n\n for (const PeptideIdentification& pep_id : pep_ids)\n {\n const vector<PeptideHit>& hits = pep_id.getHits();\n\n if (hits.empty())\n {\n continue;\n }\n const PeptideHit& top_hit = hits[0];\n\n // skip if the top hit is a decoy hit\n if (top_hit.getTargetDecoyType() == PeptideHit::TargetDecoyType::UNKNOWN)\n {\n throw(Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No target/decoy information found! Make sure 'PeptideIndexer' is run beforehand.\"));\n }\n if (top_hit.isDecoy()) continue;\n\n // skip if top hit is out ouf FDR\n if (!checkScoreBetterThanThreshold_(top_hit, score_cut_off, hsb)) continue;\n\n // check if top hit is found in de novo protein\n if (!isNovoHit_(top_hit)) // top hit is db hit\n {\n ++data.num_top_db;\n continue;\n }\n\n // find the second target hit, skip all decoy or novo hits inbetween\n const PeptideHit* second_hit_ptr = nullptr;\n for (UInt i = 1; i < hits.size(); ++i)\n {\n // check for FDR\n if (!checkScoreBetterThanThreshold_(hits[i], score_cut_off, hsb)) break;\n\n // check if target, also check for \"target+decoy\" value\n String td_info(hits[i].getMetaValue(\"target_decoy\"));\n if (td_info.find(\"target\") != 0)\n {\n continue;\n }\n // check if hit is novo hit\n if (isNovoHit_(hits[i])) continue;\n\n second_hit_ptr = &hits[i];\n break;\n }\n if (second_hit_ptr == nullptr) // no second target hit with given FDR found\n {\n ++data.num_top_novo;\n continue;\n }\n\n const PeptideHit second_hit(*second_hit_ptr);\n\n // second hit is db hit\n ++data.num_interest;\n\n // check for re-ranking\n if (no_re_rank)\n {\n ++data.num_top_novo;\n continue;\n }\n\n // re-ranking\n // score difference smaller than cut-off or scores equal using floating point precision\n // ('getMonoWeight()' can sometimes have a float error, was unable to fix it (maybe the error happens while reading the input idXML))\n if (extractScore_(top_hit) - extractScore_(second_hit) < data.cut_off || abs(extractScore_(top_hit) - extractScore_(second_hit)) < std::numeric_limits<float>::epsilon())\n {\n ++data.num_top_db;\n ++data.num_re_ranked;\n }\n else\n {\n ++data.num_top_novo;\n }\n }\n\n if (data.num_top_db == 0 && data.num_top_novo == 0)\n {\n OPENMS_LOG_WARN << \"Identifications could not be assigned to either the database or the deNovo protein. Probably your FDR threshold is too strict.\" << endl;\n data.suitability = DBL_MAX;\n return;\n }\n\n data.suitability = double(data.num_top_db) / (data.num_top_db + data.num_top_novo);\n\n data.suitability_no_rerank = double(data.num_top_db - data.num_re_ranked) / (data.num_top_db + data.num_top_novo);\n }\n\n void DBSuitability::appendDecoys_(std::vector<FASTAFile::FASTAEntry>& fasta) const\n {\n fasta.reserve(fasta.size() * 2);\n\n for (auto& entry : fasta)\n {\n ProteaseDigestion digestion;\n digestion.setEnzyme(\"Trypsin\");\n std::vector<AASequence> peptides;\n digestion.digest(AASequence::fromString(entry.sequence), peptides);\n String new_sequence = \"\";\n for (auto const& peptide : peptides)\n {\n OpenMS::TargetedExperiment::Peptide p;\n p.sequence = peptide.toString();\n OpenMS::TargetedExperiment::Peptide decoy_p = MRMDecoy::reversePeptide(p, true, true, \"\");\n new_sequence += decoy_p.sequence;\n }\n FASTAFile::FASTAEntry decoy_entry;\n decoy_entry.sequence = new_sequence;\n decoy_entry.identifier = \"DECOY_\" + entry.identifier;\n fasta.push_back(decoy_entry);\n }\n }\n\n double DBSuitability::extractScore_(const PeptideHit& pep_hit) const\n {\n if (pep_hit.metaValueExists(\"MS:1002252\")) // use xcorr\n {\n return double(pep_hit.getMetaValue(\"MS:1002252\")) / pep_hit.getSequence().getMonoWeight(); // normalized by mw\n }\n else\n {\n if (!param_.getValue(\"force\").toBool()) // without xcorr, need to force re-ranking\n {\n throw(Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No cross correlation score found at peptide hit. Only Comet search engine is supported for re-ranking. Set 'force' flag to use the default score for this. This may result in undefined behaviour and is not advised.\"));\n }\n\n return pep_hit.getScore(); // uses q-value from FDR\n }\n }\n\n double DBSuitability::calculateCorrectionFactor_(const SuitabilityData& data_full, const SuitabilityData& data_sampled, double sampling_rate) const\n {\n if (sampling_rate >= 1 || sampling_rate < 0)\n {\n throw Exception::Precondition(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"The sampling rate has to be element of [0,1).\");\n }\n\n double db_slope = (int(data_sampled.num_top_db) - int(data_full.num_top_db)) / (sampling_rate - 1);\n double deNovo_slope = (int(data_sampled.num_top_novo) - int(data_full.num_top_novo)) / (sampling_rate - 1);\n return -(db_slope) / (deNovo_slope);\n }\n\n UInt DBSuitability::numberOfUniqueProteins_(const PeptideIdentificationList& peps, UInt number_of_hits) const\n {\n set<String> proteins;\n\n for (const auto& pep : peps)\n {\n vector<PeptideHit> hits = pep.getHits();\n if (hits.empty())\n continue;\n\n for (Size i = 0; (i < number_of_hits && i < hits.size()); ++i)\n {\n const PeptideHit& hit = hits[i];\n\n if (hit.getTargetDecoyType() == PeptideHit::TargetDecoyType::UNKNOWN)\n {\n throw(Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No target/decoy information found! Make sure 'PeptideIndexer' is run beforehand.\"));\n }\n\n if (hit.isDecoy()) continue;// skip if the hit is a decoy hit\n\n // insert protein accessions\n const set<String> accessions = hit.extractProteinAccessionsSet();\n for (const String& acc : accessions)\n {\n if (acc.find(Constants::UserParam::CONCAT_PEPTIDE) != String::npos)// skip novo accessions\n {\n continue;\n }\n if (boost::regex_search(String(acc).toLower(), decoy_pattern_))// skip decoy accessions (this can happen if the hit is 'target+decoy'.)\n {\n continue;\n }\n\n proteins.insert(acc);// insert the rest\n }\n }\n }\n\n return proteins.size();\n }\n\n Size DBSuitability::getIndexWithMedianNovoHits_(const vector<SuitabilityData>& data) const\n {\n if (data.empty())\n {\n throw(Exception::IllegalArgument(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No suitability data given!\"));\n }\n\n vector<Size> novo_data;\n map<Size, Size> novo_hits_to_data;\n for (size_t i = 0; i < data.size(); ++i)\n {\n const Size num_top_novo = data[i].num_top_novo;\n novo_data.push_back(num_top_novo);\n novo_hits_to_data[num_top_novo] = i;\n }\n \n std::sort(novo_data.begin(), novo_data.end());\n\n return novo_hits_to_data.at(novo_data[ceil(novo_data.size() / 2)]);\n }\n\n double DBSuitability::getScoreMatchingFDR_(const PeptideIdentificationList& pep_ids, double FDR, const String& score_name, bool higher_score_better) const\n {\n double worst_score = DBL_MAX;\n if (!higher_score_better)\n {\n worst_score = -DBL_MAX;\n }\n\n for (const auto& id: pep_ids)\n {\n const vector<PeptideHit>& hits = id.getHits();\n\n if (hits.empty()) continue;\n\n if (id.getScoreType() != \"q-value\") // did FDR run?\n {\n throw Exception::Precondition(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No q-value found at peptide identification.\");\n }\n\n const PeptideHit& top_hit = hits[0]; // get first hit\n\n if (!checkScoreBetterThanThreshold_(top_hit, FDR, false)) continue; // does this hit make the FDR?\n\n // extract score from metavalues\n double score;\n bool score_found = false;\n\n vector<String> meta_keys;\n top_hit.getKeys(meta_keys);\n for (const String& key : meta_keys)\n {\n if (key.find(score_name) != String::npos)\n {\n score = top_hit.getMetaValue(key);\n score_found = true;\n break;\n }\n }\n\n if (!score_found)\n {\n throw Exception::IllegalArgument(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"'\" + score_name + \"' not found. The given score name has to exist as a meta value.\");\n }\n\n \n // is this score the worst score yet?\n if (higher_score_better)\n {\n if (score < worst_score)\n {\n worst_score = score;\n }\n continue;\n }\n if (score > worst_score)\n {\n worst_score = score;\n }\n continue;\n }\n return worst_score;\n }\n\n void DBSuitability::SuitabilityData::clear()\n {\n *this = SuitabilityData();\n }\n\n void DBSuitability::SuitabilityData::setCorrectionFactor(double factor)\n {\n if (num_top_db == 0 && num_top_novo == 0)\n {\n throw(Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No suitability data found. Can't apply correction factor.\"));\n }\n corr_factor = factor;\n num_top_novo_corr = num_top_novo * factor;\n suitability_corr = num_top_db / (num_top_db + num_top_novo_corr);\n }\n\n double DBSuitability::SuitabilityData::getCorrectionFactor() const\n {\n return this->corr_factor;\n }\n\n double DBSuitability::SuitabilityData::getCorrectedNovoHits() const\n {\n return this->num_top_novo_corr;\n }\n\n double DBSuitability::SuitabilityData::getCorrectedSuitability() const\n {\n return this->suitability_corr;\n }\n\n DBSuitability::SuitabilityData DBSuitability::SuitabilityData::simulateNoReRanking() const\n {\n SuitabilityData simulated_data;\n simulated_data.num_top_db = num_top_db - num_re_ranked;\n simulated_data.num_top_novo = num_top_novo + num_re_ranked;\n return simulated_data;\n }\n}// namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9395,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/QC/Contaminants.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":6018,"string":"6,018"},"line_count":{"kind":"number","value":180,"string":"180"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Chris Bielow $\n// $Authors: Dominik Schmitz, Chris Bielow$\n// --------------------------------------------------------------------------\n\n#include <OpenMS/CONCEPT/LogStream.h>\n#include <OpenMS/QC/Contaminants.h>\n#include <algorithm>\n#include <include/OpenMS/CHEMISTRY/ProteaseDigestion.h>\n#include <include/OpenMS/METADATA/ProteinIdentification.h>\n\nusing namespace std;\n\nnamespace OpenMS\n{\n\n void Contaminants::compute(FeatureMap& features, const std::vector<FASTAFile::FASTAEntry>& contaminants)\n {\n // empty FeatureMap\n if (features.empty())\n {\n OPENMS_LOG_WARN << \"FeatureMap is empty\"\n << \"\\n\";\n }\n // empty contaminants database\n if (contaminants.empty())\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No contaminants provided.\");\n }\n // fill the unordered set once with the digested contaminants database\n if (digested_db_.empty())\n {\n if (features.getProteinIdentifications().empty())\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No proteinidentifications in FeatureMap.\");\n }\n ProteaseDigestion digestor;\n String enzyme = features.getProteinIdentifications()[0].getSearchParameters().digestion_enzyme.getName();\n\n // no enzyme is given\n if (enzyme == \"unknown_enzyme\")\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No digestion enzyme in FeatureMap detected. No computation possible.\");\n }\n\n digestor.setEnzyme(enzyme);\n\n // get the missed cleavages for the digestor. If none are given, its default is 0.\n UInt missed_cleavages(features.getProteinIdentifications()[0].getSearchParameters().missed_cleavages);\n digestor.setMissedCleavages(missed_cleavages);\n\n // digest the contaminants database and add the peptides into the unordered set\n for (const FASTAFile::FASTAEntry& fe : contaminants)\n {\n vector<AASequence> current_digest;\n digestor.digest(AASequence::fromString(fe.sequence), current_digest);\n\n // fill unordered set digested_db_ with digested sequences\n for (auto const& s : current_digest)\n {\n digested_db_.insert(s.toUnmodifiedString());\n }\n }\n }\n Int64 total = 0;\n Int64 cont = 0;\n double sum_total = 0.0;\n double sum_cont = 0.0;\n Int64 feature_has_no_sequence = 0;\n\n // Check if peptides of featureMap are contaminants or not and add is_contaminant = 0/1 to the first hit of the peptideidentification.\n // If so, raise contaminants ratio.\n for (auto& f : features)\n {\n if (f.getPeptideIdentifications().empty())\n {\n ++feature_has_no_sequence;\n continue;\n }\n for (auto& id : f.getPeptideIdentifications())\n {\n // peptideidentifications in feature f is not empty\n if (id.getHits().empty())\n {\n ++feature_has_no_sequence;\n continue;\n }\n\n // the one existing peptideidentification has at least one getHits entry\n PeptideHit& pep_hit = id.getHits()[0];\n String key = (pep_hit.getSequence().toUnmodifiedString());\n this->compare_(key, pep_hit, total, cont, sum_total, sum_cont, f.getIntensity());\n }\n }\n // save the contaminants ratio in object before searching through the unassigned peptideidentifications\n ContaminantsSummary final;\n final.assigned_contaminants_ratio = (cont / double(total));\n\n final.empty_features.first = feature_has_no_sequence;\n final.empty_features.second = features.size();\n\n UInt64 utotal = 0;\n UInt64 ucont = 0;\n\n // Change the assigned contaminants ratio to total contaminants ratio by adding the unassigned.\n // Additionally save the unassigned contaminants ratio and add the is_contaminant = 0/1 to the first hit of the unassigned peptideidentifications.\n for (auto& fu : features.getUnassignedPeptideIdentifications())\n {\n if (fu.getHits().empty())\n {\n continue;\n }\n auto& fu_hit = fu.getHits()[0];\n String key = (fu_hit.getSequence().toUnmodifiedString());\n ++utotal;\n\n // peptide is not in contaminant database\n if (!digested_db_.count(key))\n {\n fu_hit.setMetaValue(\"is_contaminant\", 0);\n continue;\n }\n\n // peptide is contaminant\n ++ucont;\n fu_hit.setMetaValue(\"is_contaminant\", 1);\n }\n total += utotal;\n cont += ucont;\n\n // save all ratios and the intensity to the object\n final.all_contaminants_ratio = (cont / double(total));\n final.unassigned_contaminants_ratio = (ucont / double(utotal));\n final.assigned_contaminants_intensity_ratio = (sum_cont / sum_total);\n\n\n // add the object to the results vector\n results_.push_back(final);\n }\n\n const String& Contaminants::getName() const\n {\n return name_;\n }\n\n const std::vector<Contaminants::ContaminantsSummary>& Contaminants::getResults()\n {\n return results_;\n }\n\n\n // Check if peptide is in contaminants database or not and add the is_contaminant = 0/1.\n // If so, raise the contaminant ratio.\n void Contaminants::compare_(const String& key, PeptideHit& pep_hit, Int64& total, Int64& cont, double& sum_total, double& sum_cont, double intensity)\n {\n ++total;\n sum_total += intensity;\n // peptide is not in contaminant database\n if (!digested_db_.count(key))\n {\n pep_hit.setMetaValue(\"is_contaminant\", 0);\n return;\n }\n // peptide is contaminant\n ++cont;\n sum_cont += intensity;\n pep_hit.setMetaValue(\"is_contaminant\", 1);\n }\n\n QCBase::Status Contaminants::requirements() const\n {\n return (QCBase::Status(QCBase::Requires::POSTFDRFEAT) | QCBase::Requires::CONTAMINANTS);\n }\n\n\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9396,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/QC/MzCalibration.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":4673,"string":"4,673"},"line_count":{"kind":"number","value":126,"string":"126"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Chris Bielow $\n// $Authors: Juliane Schmachtenberg $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/CONCEPT/Exception.h>\n#include <OpenMS/CONCEPT/LogStream.h>\n#include <OpenMS/CONCEPT/Types.h>\n#include <OpenMS/FORMAT/IdXMLFile.h>\n#include <OpenMS/KERNEL/FeatureMap.h>\n#include <OpenMS/KERNEL/MSExperiment.h>\n#include <OpenMS/MATH/MathFunctions.h>\n#include <OpenMS/METADATA/DataProcessing.h>\n#include <OpenMS/QC/MzCalibration.h>\n\nusing namespace std;\n\nnamespace OpenMS\n{\n MzCalibration::MzCalibration() : mz_raw_ {}, mz_ref_ {}, no_mzml_(false)\n {\n }\n\n // find original m/z Value, set meta value \"mz_raw\" and set meta value \"mz_ref\"\n void MzCalibration::compute(FeatureMap& features, const MSExperiment& exp, const QCBase::SpectraMap& map_to_spectrum)\n {\n if (exp.empty())\n {\n no_mzml_ = true;\n OPENMS_LOG_WARN << \"Metric MzCalibration received an empty mzml file. Only reporting uncalibrated mz error.\\n\";\n }\n else\n {\n no_mzml_ = false;\n // check for Calibration\n auto is_not_elem = [](const std::shared_ptr<const OpenMS::DataProcessing>& dp) { return (dp->getProcessingActions().count(DataProcessing::CALIBRATION) == 0); };\n auto vdp = exp[0].getDataProcessing(); // get a copy to avoid calling .begin() and .end() on two different temporaries\n if (all_of(vdp.begin(), vdp.end(), is_not_elem))\n {\n no_mzml_ = true;\n OPENMS_LOG_WARN << \"Metric MzCalibration received an mzml file which did not undergo InternalCalibration. Only reporting uncalibrated mz error.\\n\";\n }\n }\n\n // set meta values for the first hit of all PeptideIdentifications of all features\n for (Feature& feature : features)\n {\n if (feature.getPeptideIdentifications().empty())\n {\n continue;\n }\n\n for (PeptideIdentification& peptide_ID : feature.getPeptideIdentifications())\n {\n addMzMetaValues_(peptide_ID, exp, map_to_spectrum);\n }\n }\n // set meta values for the first hit of all unasssigned PeptideIdentifications\n for (PeptideIdentification& unassigned_ID : features.getUnassignedPeptideIdentifications())\n {\n addMzMetaValues_(unassigned_ID, exp, map_to_spectrum);\n }\n }\n\n void MzCalibration::addMzMetaValues_(PeptideIdentification& peptide_ID, const PeakMap& exp, const QCBase::SpectraMap& map_to_spectrum)\n {\n if (peptide_ID.getHits().empty())\n {\n return;\n }\n\n mz_ref_ = peptide_ID.getHits()[0].getSequence().getMZ(peptide_ID.getHits()[0].getCharge());\n\n if (no_mzml_)\n {\n peptide_ID.getHits()[0].setMetaValue(\"uncalibrated_mz_error_ppm\", Math::getPPM(peptide_ID.getMZ(), mz_ref_));\n }\n else\n {\n if (!peptide_ID.metaValueExists(\"spectrum_reference\"))\n {\n throw Exception::InvalidParameter(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No spectrum reference annotated at peptide identification!\");\n }\n\n // get spectrum from mapping and meta value\n MSSpectrum spectrum = exp[map_to_spectrum.at(peptide_ID.getSpectrumReference())];\n\n // check if spectrum fulfills all requirements\n if (spectrum.getMSLevel() == 2)\n {\n // meta value has to be there, because InternalCalibration had to be called to get here\n if (!spectrum.getPrecursors()[0].metaValueExists(\"mz_raw\"))\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Expected meta value 'mz_raw' at MSSpectrum, but could not find it.\");\n }\n mz_raw_ = spectrum.getPrecursors()[0].getMetaValue(\"mz_raw\");\n }\n else\n {\n throw Exception::IllegalArgument(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"The matching spectrum of the mzML is not an MS2 Spectrum.\");\n }\n\n // set meta values\n peptide_ID.getHits()[0].setMetaValue(\"mz_raw\", mz_raw_);\n peptide_ID.getHits()[0].setMetaValue(\"mz_ref\", mz_ref_);\n peptide_ID.getHits()[0].setMetaValue(\"uncalibrated_mz_error_ppm\", Math::getPPM(mz_raw_, mz_ref_));\n peptide_ID.getHits()[0].setMetaValue(\"calibrated_mz_error_ppm\", Math::getPPM(peptide_ID.getMZ(), mz_ref_));\n }\n }\n\n // required input files\n QCBase::Status MzCalibration::requirements() const\n {\n return QCBase::Status() | QCBase::Requires::POSTFDRFEAT;\n }\n\n const String& MzCalibration::getName() const\n {\n static const String& name = \"MzCalibration\";\n return name;\n }\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9397,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/QC/RTAlignment.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":3452,"string":"3,452"},"line_count":{"kind":"number","value":82,"string":"82"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Chris Bielow $\n// $Authors: Juliane Schmachtenberg, Chris Bielow $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/ANALYSIS/MAPMATCHING/TransformationDescription.h>\n#include <OpenMS/CONCEPT/Exception.h>\n#include <OpenMS/CONCEPT/LogStream.h>\n#include <OpenMS/KERNEL/FeatureMap.h>\n#include <OpenMS/METADATA/DataProcessing.h>\n#include <OpenMS/METADATA/PeptideIdentification.h>\n#include <OpenMS/QC/QCBase.h>\n#include <OpenMS/QC/RTAlignment.h>\n#include <algorithm>\n\nusing namespace std;\n\nnamespace OpenMS\n{\n // take the original retention time before map alignment and use the transformation information of the post alignment trafoXML\n // for calculation of the post map alignment retention times.\n void RTAlignment::compute(FeatureMap& features, const TransformationDescription& trafo) const\n {\n if (features.empty())\n {\n OPENMS_LOG_WARN << \"The FeatureMap is empty.\\n\";\n }\n\n // if featureMap after map alignment was handed, return Exception\n auto vdp = features.getDataProcessing(); // get a copy to avoid calling .begin() and .end() on two different temporaries\n if (any_of(vdp.begin(), vdp.end(), [](const DataProcessing& dp) {\n return (find(dp.getProcessingActions().begin(), dp.getProcessingActions().end(), DataProcessing::ProcessingAction::ALIGNMENT) != dp.getProcessingActions().end());\n }))\n {\n throw Exception::IllegalArgument(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"Metric RTAlignment received a featureXML AFTER map alignment, but needs a featureXML BEFORE map alignment!\");\n }\n\n // set meta values for original retention time and aligned retention time (after map alignment)\n for (Feature& feature : features)\n {\n for (PeptideIdentification& peptide_ID : feature.getPeptideIdentifications())\n {\n peptide_ID.setMetaValue(\"rt_align\", trafo.apply(peptide_ID.getRT()));\n peptide_ID.setMetaValue(\"rt_raw\", peptide_ID.getRT());\n }\n feature.setMetaValue(\"rt_align\", trafo.apply(feature.getRT()));\n feature.setMetaValue(\"rt_raw\", feature.getRT());\n feature.setMetaValue(\"rt_align_start\", trafo.apply(feature.getConvexHull().getBoundingBox().minX()));\n feature.setMetaValue(\"rt_align_end\", trafo.apply(feature.getConvexHull().getBoundingBox().maxX()));\n feature.setMetaValue(\"rt_raw_start\", feature.getConvexHull().getBoundingBox().minX());\n feature.setMetaValue(\"rt_raw_end\", feature.getConvexHull().getBoundingBox().maxX());\n }\n\n // same for unassigned PepIDs\n compute(features.getUnassignedPeptideIdentifications(), trafo);\n }\n\n void RTAlignment::compute(PeptideIdentificationList& ids, const TransformationDescription& trafo) const\n {\n // set meta values for all unasssigned PeptideIdentifications\n for (PeptideIdentification& id : ids)\n {\n id.setMetaValue(\"rt_align\", trafo.apply(id.getRT()));\n id.setMetaValue(\"rt_raw\", id.getRT());\n }\n }\n\n const String& RTAlignment::getName() const\n {\n return name_;\n }\n\n // required input files\n QCBase::Status RTAlignment::requirements() const\n {\n return QCBase::Status() | QCBase::Requires::TRAFOALIGN | QCBase::Requires::POSTFDRFEAT;\n }\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9398,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/QC/Ms2SpectrumStats.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":5721,"string":"5,721"},"line_count":{"kind":"number","value":145,"string":"145"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Chris Bielow $\n// $Authors: Juliane Schmachtenberg, Chris Bielow $\n// --------------------------------------------------------------------------\n\n#include <OpenMS/CONCEPT/Exception.h>\n#include <OpenMS/KERNEL/FeatureMap.h>\n#include <OpenMS/KERNEL/MSExperiment.h>\n#include <OpenMS/QC/Ms2SpectrumStats.h>\n#include <OpenMS/QC/QCBase.h>\n\nusing namespace std;\n\nnamespace OpenMS\n{\n // check which MS2-Spectra of a mzml-file (MSExperiment) are identified (and therefor have a entry in the featureMap)\n // MS2 spectra without mate are returned as vector of unassigned PeptideIdentifications (with empty sequence but some metavalue)\n PeptideIdentificationList Ms2SpectrumStats::compute(const MSExperiment& exp, FeatureMap& features, const QCBase::SpectraMap& map_to_spectrum)\n {\n if (exp.empty())\n {\n throw Exception::MissingInformation(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"The mzml file / MSExperiment must not be empty.\\n\");\n }\n\n setScanEventNumber_(exp);\n // if MS2-spectrum PeptideIdentifications found -> ms2_included_ nullptr to PepID pointer\n std::function<void(PeptideIdentification&)> l_f = [&exp, this, &map_to_spectrum](PeptideIdentification& pep_id) { setPresenceAndScanEventNumber_(pep_id, exp, map_to_spectrum); };\n features.applyFunctionOnPeptideIDs(l_f);\n\n // if Ms2-spectrum not identified, add to unassigned PeptideIdentification without ID, contains only RT, mz and some meta values\n return getUnassignedPeptideIdentifications_(exp);\n }\n\n\n void Ms2SpectrumStats::setScanEventNumber_(const MSExperiment& exp)\n {\n ms2_included_.clear();\n ms2_included_.reserve(exp.size());\n UInt32 scan_event_number {0};\n for (const MSSpectrum& spec : exp.getSpectra())\n {\n if (spec.getMSLevel() == 1)\n { // reset\n scan_event_number = 0;\n ms2_included_.emplace_back(scan_event_number, false);\n }\n else if (spec.getMSLevel() == 2)\n {\n ++scan_event_number;\n ms2_included_.emplace_back(scan_event_number, false);\n }\n }\n }\n\n void annotatePepIDfromSpectrum_(const MSSpectrum& spectrum, PeptideIdentification& peptide_ID)\n {\n if (!spectrum.getAcquisitionInfo().empty() && spectrum.getAcquisitionInfo()[0].metaValueExists(\"MS:1000927\"))\n {\n peptide_ID.setMetaValue(\"ion_injection_time\", spectrum.getAcquisitionInfo()[0].getMetaValue(\"MS:1000927\"));\n }\n if (!spectrum.getPrecursors().empty() && !spectrum.getPrecursors()[0].getActivationMethods().empty())\n {\n peptide_ID.setMetaValue(\"activation_method\", Precursor::NamesOfActivationMethodShort[static_cast<size_t>(*spectrum.getPrecursors()[0].getActivationMethods().begin())]);\n }\n }\n\n // marks all seen (unassigned-)PeptideIdentifications in vector ms2_included\n void Ms2SpectrumStats::setPresenceAndScanEventNumber_(PeptideIdentification& peptide_ID, const MSExperiment& exp, const QCBase::SpectraMap& map_to_spectrum)\n {\n if (!peptide_ID.metaValueExists(\"spectrum_reference\"))\n {\n throw Exception::InvalidParameter(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, \"No spectrum reference annotated at peptide identification!\");\n }\n\n UInt64 index = map_to_spectrum.at(peptide_ID.getSpectrumReference());\n const MSSpectrum& spectrum = exp[index];\n\n if (spectrum.getMSLevel() == 2)\n {\n ms2_included_[index].ms2_presence = true;\n peptide_ID.setMetaValue(\"ScanEventNumber\", ms2_included_[index].scan_event_number);\n peptide_ID.setMetaValue(\"identified\", 1);\n peptide_ID.setMetaValue(\"total_ion_count\", spectrum.calculateTIC());\n peptide_ID.setMetaValue(\"base_peak_intensity\", getBPI_(spectrum));\n annotatePepIDfromSpectrum_(spectrum, peptide_ID); // ion_injection_time and activation_method\n }\n }\n\n PeptideIdentificationList Ms2SpectrumStats::getUnassignedPeptideIdentifications_(const MSExperiment& exp)\n {\n PeptideIdentificationList result;\n for (auto it = ms2_included_.begin(); it != ms2_included_.end(); ++it)\n {\n if (it->ms2_presence)\n {\n continue;\n }\n const MSSpectrum& spec = exp.getSpectra()[distance(ms2_included_.begin(), it)];\n if (spec.getMSLevel() != 2)\n {\n continue;\n }\n PeptideIdentification unidentified_MS2;\n unidentified_MS2.setRT(spec.getRT());\n unidentified_MS2.setMetaValue(\"ScanEventNumber\", (*it).scan_event_number);\n unidentified_MS2.setMetaValue(\"identified\", 0);\n unidentified_MS2.setMZ(spec.getPrecursors()[0].getMZ());\n unidentified_MS2.setMetaValue(\"total_ion_count\", spec.calculateTIC());\n unidentified_MS2.setMetaValue(\"base_peak_intensity\", getBPI_(spec));\n unidentified_MS2.setSpectrumReference( spec.getNativeID());\n annotatePepIDfromSpectrum_(spec, unidentified_MS2); // ion_injection_time and activation_method\n result.push_back(unidentified_MS2);\n }\n return result;\n }\n\n // calculate maximal and summed intensity\n MSSpectrum::PeakType::IntensityType Ms2SpectrumStats::getBPI_(const MSSpectrum& spec)\n {\n PeakSpectrum::PeakType::IntensityType bpi {0};\n auto it = spec.getBasePeak();\n if (it != spec.end())\n {\n bpi = it->getIntensity();\n }\n return bpi;\n }\n\n // returns the name of the metric\n const String& Ms2SpectrumStats::getName() const\n {\n return name_;\n }\n\n // required input files\n QCBase::Status Ms2SpectrumStats::requirements() const\n {\n return QCBase::Status() | QCBase::Requires::RAWMZML | QCBase::Requires::POSTFDRFEAT;\n }\n\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}},{"rowIdx":9399,"cells":{"keyword":{"kind":"string","value":"3D"},"repo_name":{"kind":"string","value":"OpenMS/OpenMS"},"file_path":{"kind":"string","value":"src/openms/source/QC/SpectrumCount.cpp"},"file_extension":{"kind":"string","value":".cpp"},"file_size":{"kind":"number","value":1069,"string":"1,069"},"line_count":{"kind":"number","value":41,"string":"41"},"content":{"kind":"string","value":"// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin\n// SPDX-License-Identifier: BSD-3-Clause\n//\n// --------------------------------------------------------------------------\n// $Maintainer: Axel Walter $\n// $Authors: Axel Walter $\n// --------------------------------------------------------------------------\n\n\n#include <OpenMS/KERNEL/MSExperiment.h>\n#include <OpenMS/QC/SpectrumCount.h>\nusing namespace std;\n\nnamespace OpenMS\n{\n\n map<Size, UInt> SpectrumCount::compute(const MSExperiment& exp)\n {\n map<Size, UInt> counts;\n for (const auto& spectrum : exp)\n {\n const Size level = spectrum.getMSLevel();\n ++counts[level]; // count MS level\n }\n return counts;\n }\n\n /// Returns the name of the metric\n const String& SpectrumCount::getName() const\n {\n return name_;\n }\n\n /// Returns required file input i.e. MzML.\n /// This is encoded as a bit in a Status object.\n QCBase::Status SpectrumCount::requirements() const\n {\n return QCBase::Status(QCBase::Requires::RAWMZML);\n }\n} // namespace OpenMS\n"},"language":{"kind":"string","value":"C++"}}}],"truncated":false,"partial":true},"paginationData":{"pageIndex":93,"numItemsPerPage":100,"numTotalItems":155855,"offset":9300,"length":100}},"jwt":"eyJhbGciOiJFZERTQSJ9.eyJyZWFkIjp0cnVlLCJwZXJtaXNzaW9ucyI6eyJyZXBvLmNvbnRlbnQucmVhZCI6dHJ1ZX0sImlhdCI6MTc3NzE1NDMzNywic3ViIjoiL2RhdGFzZXRzL1NjaUNvZGVQaWxlL1NjaUNvZGUtRG9tYWluLUNvZGUiLCJleHAiOjE3NzcxNTc5MzcsImlzcyI6Imh0dHBzOi8vaHVnZ2luZ2ZhY2UuY28ifQ.n9eXFOM90NqCbhPy2YaFrwzTJ5HWV3aOBwP0vtDWL79kRHoAtSaMhk-huBjVeZgfdZ8X0E6woUD2WcadZSzFDQ","displayUrls":true,"splitSizeSummaries":[{"config":"default","split":"train","numRows":155855,"numBytesParquet":3439589881}]},"discussionsStats":{"closed":0,"open":0,"total":0},"fullWidth":true,"hasGatedAccess":true,"hasFullAccess":true,"isEmbedded":false,"savedQueries":{"community":[],"user":[]}}">
keyword stringclasses 7
values | repo_name stringlengths 8 98 | file_path stringlengths 4 244 | file_extension stringclasses 29
values | file_size int64 0 84.1M | line_count int64 0 1.6M | content stringlengths 1 84.1M ⌀ | language stringclasses 14
values |
|---|---|---|---|---|---|---|---|
3D | OpenMS/OpenMS | src/openms/extern/IsoSpec/IsoSpec/tabulator.cpp | .cpp | 164 | 9 | #include "tabulator.h"
namespace IsoSpec
{
template class Tabulator<IsoThresholdGenerator>;
template class Tabulator<IsoLayeredGenerator>;
} // namespace IsoSpec
| C++ |
3D | OpenMS/OpenMS | src/openms/extern/IsoSpec/IsoSpec/cwrapper.cpp | .cpp | 10,555 | 354 | /*
* Copyright (C) 2015-2020 Mateusz Łącki and Michał Startek.
*
* This file is part of IsoSpec.
*
* IsoSpec is free software: you can redistribute it and/or modify
* it under the terms of the Simplified ("2-clause") BSD licence.
*
* IsoSpec is distributed in the hope that it will be useful,
* but ... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/IsoSpec/IsoSpec/test.cpp | .cpp | 194 | 12 | #include <iostream>
#include "allocator.cpp"
#include "dirtyAllocator.cpp"
#include "isoSpec++.cpp"
int main(int argc, const char ** argv)
{
std::cout << "here " << std::endl;
return 0;
}
| C++ |
3D | OpenMS/OpenMS | src/openms/extern/IsoSpec/IsoSpec/marginalTrek++.h | .h | 16,659 | 421 | /*
* Copyright (C) 2015-2020 Mateusz Łącki and Michał Startek.
*
* This file is part of IsoSpec.
*
* IsoSpec is free software: you can redistribute it and/or modify
* it under the terms of the Simplified ("2-clause") BSD licence.
*
* IsoSpec is distributed in the hope that it will be useful,
* but ... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/IsoSpec/IsoSpec/mman.cpp | .cpp | 4,606 | 201 | /*
* NOLINT(legal/copyright) - the original authors did not slap a (C) notice in here,
* for whatever reason, and I'm in no position to do that for them.
*
* This file has been included as a part of IsoSpec project, under a MIT licence. It
* comes from the repository:
*
* https://github.com/witwall/mman-win32
*... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/IsoSpec/IsoSpec/fasta.h | .h | 1,276 | 46 | /*
* Copyright (C) 2015-2020 Mateusz Łącki and Michał Startek.
*
* This file is part of IsoSpec.
*
* IsoSpec is free software: you can redistribute it and/or modify
* it under the terms of the Simplified ("2-clause") BSD licence.
*
* IsoSpec is distributed in the hope that it will be useful,
* but ... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/IsoSpec/IsoSpec/operators.cpp | .cpp | 1,044 | 39 | /*
* Copyright (C) 2015-2020 Mateusz Łącki and Michał Startek.
*
* This file is part of IsoSpec.
*
* IsoSpec is free software: you can redistribute it and/or modify
* it under the terms of the Simplified ("2-clause") BSD licence.
*
* IsoSpec is distributed in the hope that it will be useful,
* but ... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/CHANGELOG.md | .md | 14,570 | 292 | 2012 Mar 30
- Start of a new thin C++ SQLite wrapper
2012 Apr 2
- The wrapper is functional
- Added documentation and examples
- Publication on GitHub
Version 0.1.0 - 2012 Apr 4
- Added a Database::exec() method to execute simple SQL statement
- Added a version number like in sqlite3.h, starting with 0.1.0
Version 0... | Markdown |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/build.sh | .sh | 897 | 26 | #!/bin/sh
# Copyright (c) 2012-2025 Sébastien Rombauts (sebastien.rombauts@gmail.com)
#
# Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
# or copy at http://opensource.org/licenses/MIT)
# exit on first error
set -e
mkdir -p build
cd build
# Generate a Makefile for GCC (or Clang, depending... | Shell |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/cpplint.py | .py | 185,074 | 4,808 | #!/usr/bin/python
#
# Copyright (c) 2009 Google Inc. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of ... | Python |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/include/SQLiteCpp/Backup.h | .h | 4,907 | 132 | /**
* @file Backup.h
* @ingroup SQLiteCpp
* @brief Backup is used to backup a database file in a safe and online way.
*
* Copyright (c) 2015 Shibao HONG (shibaohong@outlook.com)
* Copyright (c) 2015-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See acco... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/include/SQLiteCpp/SQLiteCppExport.h | .h | 1,103 | 39 | /**
* @file SQLiteCppExport.h
* @ingroup SQLiteCpp
* @brief File with macros needed in the generation of Windows DLLs
*
*
* Copyright (c) 2012-2023 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or copy at http://opensourc... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/include/SQLiteCpp/Exception.h | .h | 2,769 | 92 | /**
* @file Exception.h
* @ingroup SQLiteCpp
* @brief Encapsulation of the error message from SQLite3 on a std::runtime_error.
*
* Copyright (c) 2012-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or copy at http://ope... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/include/SQLiteCpp/Transaction.h | .h | 3,250 | 99 | /**
* @file Transaction.h
* @ingroup SQLiteCpp
* @brief A Transaction is way to group multiple SQL statements into an atomic secured operation.
*
* Copyright (c) 2012-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or c... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/include/SQLiteCpp/Statement.h | .h | 30,813 | 726 | /**
* @file Statement.h
* @ingroup SQLiteCpp
* @brief A prepared SQLite Statement is a compiled SQL query ready to be executed, pointing to a row of result.
*
* Copyright (c) 2012-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENS... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/include/SQLiteCpp/Assertion.h | .h | 1,496 | 48 | /**
* @file Assertion.h
* @ingroup SQLiteCpp
* @brief Definition of the SQLITECPP_ASSERT() macro.
*
* Copyright (c) 2012-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or copy at http://opensource.org/licenses/MIT)
*/... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/include/SQLiteCpp/Utils.h | .h | 1,048 | 32 | /**
* @file Utils.h
* @ingroup SQLiteCpp
* @brief Definition of the SQLITECPP_PURE_FUNC macro.
*
* Copyright (c) 2012-2023 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or copy at http://opensource.org/licenses/MIT)
*/
#p... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/include/SQLiteCpp/SQLiteCpp.h | .h | 1,691 | 47 | /**
* @file SQLiteCpp.h
* @ingroup SQLiteCpp
* @brief SQLiteC++ is a smart and simple C++ SQLite3 wrapper. This file is only "easy include" for other files.
*
* Include this main header file in your project to gain access to all functionality provided by the wrapper.
*
* Copyright (c) 2012-2025 Sebastien Ro... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/include/SQLiteCpp/ExecuteMany.h | .h | 2,466 | 92 | /**
* @file ExecuteMany.h
* @ingroup SQLiteCpp
* @brief Convenience function to execute a Statement with multiple Parameter sets
*
* Copyright (c) 2019 Maximilian Bachmann (contact@maxbachmann.de)
* Copyright (c) 2019-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT Lice... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/include/SQLiteCpp/VariadicBind.h | .h | 2,891 | 99 | /**
* @file VariadicBind.h
* @ingroup SQLiteCpp
* @brief Convenience function for Statement::bind(...)
*
* Copyright (c) 2016 Paul Dreik (github@pauldreik.se)
* Copyright (c) 2016-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
* Copyright (c) 2019 Maximilian Bachmann (contact@maxbachmann.de)
*
* D... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/include/SQLiteCpp/Database.h | .h | 27,084 | 625 | /**
* @file Database.h
* @ingroup SQLiteCpp
* @brief Management of a SQLite Database Connection.
*
* Copyright (c) 2012-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or copy at http://opensource.org/licenses/MIT)
*/
... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/include/SQLiteCpp/Column.h | .h | 8,991 | 268 | /**
* @file Column.h
* @ingroup SQLiteCpp
* @brief Encapsulation of a Column in a row of the result pointed by the prepared SQLite::Statement.
*
* Copyright (c) 2012-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or co... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/include/SQLiteCpp/Savepoint.h | .h | 3,360 | 99 | /**
* @file Savepoint.h
* @ingroup SQLiteCpp
* @brief A Savepoint is a way to group multiple SQL statements into an atomic
* secured operation. Similar to a transaction while allowing child savepoints.
*
* Copyright (c) 2020 Kelvin Hammond (hammond.kelvin@gmail.com)
* Copyright (c) 2020-2025 Sebastien Romba... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/src/Statement.cpp | .cpp | 12,302 | 386 | /**
* @file Statement.cpp
* @ingroup SQLiteCpp
* @brief A prepared SQLite Statement is a compiled SQL query ready to be executed, pointing to a row of result.
*
* Copyright (c) 2012-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICE... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/src/Column.cpp | .cpp | 4,066 | 124 | /**
* @file Column.cpp
* @ingroup SQLiteCpp
* @brief Encapsulation of a Column in a row of the result pointed by the prepared SQLite::Statement.
*
* Copyright (c) 2012-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or ... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/src/Exception.cpp | .cpp | 1,120 | 46 | /**
* @file Exception.cpp
* @ingroup SQLiteCpp
* @brief Encapsulation of the error message from SQLite3 on a std::runtime_error.
*
* Copyright (c) 2012-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or copy at http://o... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/src/Transaction.cpp | .cpp | 2,214 | 93 | /**
* @file Transaction.cpp
* @ingroup SQLiteCpp
* @brief A Transaction is way to group multiple SQL statements into an atomic secured operation.
*
* Copyright (c) 2012-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/src/Savepoint.cpp | .cpp | 2,048 | 82 | /**
* @file Savepoint.cpp
* @ingroup SQLiteCpp
* @brief A Savepoint is a way to group multiple SQL statements into an atomic
* secured operation. Similar to a transaction while allowing child savepoints.
*
* Copyright (c) 2020 Kelvin Hammond (hammond.kelvin@gmail.com)
* Copyright (c) 2020-2025 Sebastien Rom... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/src/Database.cpp | .cpp | 14,397 | 440 | /**
* @file Database.cpp
* @ingroup SQLiteCpp
* @brief Management of a SQLite Database Connection.
*
* Copyright (c) 2012-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or copy at http://opensource.org/licenses/MIT)
*... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/src/Backup.cpp | .cpp | 2,624 | 84 | /**
* @file Backup.cpp
* @ingroup SQLiteCpp
* @brief Backup is used to backup a database file in a safe and online way.
*
* Copyright (c) 2015 Shibao HONG (shibaohong@outlook.com)
* Copyright (c) 2015-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See ac... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/sqlite3/sqlite3.c | .c | 9,233,181 | 261,464 | /******************************************************************************
** This file is an amalgamation of many separate C source files from SQLite
** version 3.49.2. By combining all the individual C code files into this
** single large file, the entire code can be compiled as a single translation
** unit. T... | C |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/sqlite3/sqlite3.h | .h | 658,960 | 13,716 | /*
** 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.
**
**************************... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/examples/example1/main.cpp | .cpp | 22,649 | 508 | /**
* @file main.cpp
* @brief A few short examples in a row.
*
* Demonstrates how-to use the SQLite++ wrapper
*
* Copyright (c) 2012-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or copy at http://opensource.org/license... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/examples/example2/build.sh | .sh | 412 | 19 | #!/bin/sh
# Copyright (c) 2012-2023 Sébastien Rombauts (sebastien.rombauts@gmail.com)
#
# Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
# or copy at http://opensource.org/licenses/MIT)
# exit on first error
set -e
mkdir -p build
cd build
# Generate a Makefile for GCC (or Clang, depanding... | Shell |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/examples/example2/src/main.cpp | .cpp | 3,224 | 85 | /**
* @file main.cpp
* @brief A few short examples in a row.
*
* Demonstrates how-to use the SQLite++ wrapper
*
* Copyright (c) 2012-2023 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or copy at http://opensource.org/license... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/tests/Exception_test.cpp | .cpp | 2,537 | 90 | /**
* @file Transaction_test.cpp
* @ingroup tests
* @brief Test of a SQLite Transaction.
*
* Copyright (c) 2012-2020 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or copy at http://opensource.org/licenses/MIT)
*/
#includ... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/tests/Column_test.cpp | .cpp | 13,220 | 300 | /**
* @file Column_test.cpp
* @ingroup tests
* @brief Test of a SQLiteCpp Column.
*
* Copyright (c) 2012-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or copy at http://opensource.org/licenses/MIT)
*/
#include <SQLi... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/tests/VariadicBind_test.cpp | .cpp | 4,076 | 110 | /**
* @file VariadicBind_test.cpp
* @ingroup tests
* @brief Test of variadic bind
*
* Copyright (c) 2016 Paul Dreik (github@pauldreik.se)
* Copyright (c) 2016-2020 Sebastien Rombauts (sebastien.rombauts@gmail.com)
* Copyright (c) 2019 Maximilian Bachmann (github@maxbachmann)
*
* Distributed under the MIT ... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/tests/Database_test.cpp | .cpp | 26,240 | 645 | /**
* @file Database_test.cpp
* @ingroup tests
* @brief Test of a SQLiteCpp Database.
*
* Copyright (c) 2012-2025 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or copy at http://opensource.org/licenses/MIT)
*/
#include <... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/tests/Savepoint_test.cpp | .cpp | 3,331 | 107 | /**
* @file Savepoint_test.cpp
* @ingroup tests
* @brief Test of a SQLite Savepoint.
*
* Copyright (c) 2020 Kelvin Hammond (hammond.kelvin@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt or
* copy at http://opensource.org/licenses/MIT)
*/
#include <SQLiteCpp/Data... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/tests/Backup_test.cpp | .cpp | 5,191 | 128 | /**
* @file Backup_test.cpp
* @ingroup tests
* @brief Test of a SQLite Backup.
*
* Copyright (c) 2015 Shibao HONG (shibaohong@outlook.com)
* Copyright (c) 2015-2020 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or copy at... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/tests/Statement_test.cpp | .cpp | 38,576 | 1,029 | /**
* @file Statement_test.cpp
* @ingroup tests
* @brief Test of a SQLiteCpp Statement.
*
* Copyright (c) 2012-2020 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or copy at http://opensource.org/licenses/MIT)
*/
#include... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/tests/Transaction_test.cpp | .cpp | 3,731 | 119 | /**
* @file Transaction_test.cpp
* @ingroup tests
* @brief Test of a SQLite Transaction.
*
* Copyright (c) 2012-2020 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
* or copy at http://opensource.org/licenses/MIT)
*/
#includ... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/SQLiteCpp/tests/ExecuteMany_test.cpp | .cpp | 1,835 | 55 | /**
* @file VariadicBind_test.cpp
* @ingroup tests
* @brief Test of variadic bind
*
* Copyright (c) 2019 Maximilian Bachmann (contact@maxbachmann.de)
* Copyright (c) 2019-2020 Sebastien Rombauts (sebastien.rombauts@gmail.com)
*
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
*... | C++ |
3D | OpenMS/OpenMS | src/openms/extern/tool_description_lib/Example00.cpp.md | .md | 2,851 | 60 | <!-- SPDX-FileCopyrightText: 2006-2023, Knut Reinert & Freie Universität Berlin -->
<!-- SPDX-FileCopyrightText: 2016-2023, Knut Reinert & MPI für molekulare Genetik -->
<!-- SPDX-License-Identifier: CC0-1.0 -->
```
#include <tdl/tdl.h>
int main(int argc, char** argv) {
auto toolInfo = tdl::ToolInfo {
.meta = {... | Markdown |
3D | OpenMS/OpenMS | src/openms/extern/tool_description_lib/Example01.cpp.md | .md | 2,264 | 57 | <!-- SPDX-FileCopyrightText: 2006-2023, Knut Reinert & Freie Universität Berlin -->
<!-- SPDX-FileCopyrightText: 2016-2023, Knut Reinert & MPI für molekulare Genetik -->
<!-- SPDX-License-Identifier: CC0-1.0 -->
##### Include library
You will need to include `tdl/tdl.h` to use this library:
```
#include <tdl/tdl.h>
```... | Markdown |
3D | OpenMS/OpenMS | src/openms/extern/tool_description_lib/src/tdl/convertToCWL.h | .h | 14,798 | 382 | // SPDX-FileCopyrightText: 2006-2023, Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2023, Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: BSD-3-Clause
#pragma once
#include "ToolInfo.h"
#include "cwl_v1_2.h"
#include <cassert>
#include <filesystem>
#include <functional>... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/tool_description_lib/src/tdl/convertToCTD.h | .h | 13,490 | 360 | // SPDX-FileCopyrightText: 2006-2023, Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2023, Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: BSD-3-Clause
#pragma once
#include "ToolInfo.h"
#include <cassert>
#include <iomanip>
#include <limits>
#include <map>
#include <sst... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/tool_description_lib/src/tdl/ToolInfo.h | .h | 5,541 | 161 | // SPDX-FileCopyrightText: 2006-2023, Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2023, Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: BSD-3-Clause
#pragma once
#include <numeric>
#include <optional>
#include <set>
#include <string>
#include <tuple>
#include <variant>... | Unknown |
3D | OpenMS/OpenMS | src/openms/extern/tool_description_lib/src/tdl/tdl.h | .h | 290 | 10 | // SPDX-FileCopyrightText: 2006-2023, Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2023, Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: BSD-3-Clause
#pragma once
#include "ToolInfo.h"
#include "convertToCTD.h"
#include "convertToCWL.h"
| Unknown |
3D | OpenMS/OpenMS | src/openms/extern/tool_description_lib/src/tdl/cwl_v1_2.h | .h | 244,006 | 5,964 | // SPDX-FileCopyrightText: Copyright 2016-2023 CWL Project Contributors
// SPDX-License-Identifier: Apache-2.0
#pragma once
/* This file was generated using schema-salad code generator.
*
* The embedded document is subject to the license of the original schema.
*/
#include <any>
#include <cassert>
#include <cstdde... | Unknown |
3D | OpenMS/OpenMS | src/openms/source/INTERFACES_IMPL/MockImplementation.cpp | .cpp | 4,168 | 132 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Hannes Roest $
// $Authors: Hannes Roest $
// -------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/ConsensusFeature.cpp | .cpp | 11,984 | 419 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: $
// ----------------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/ChromatogramPeak.cpp | .cpp | 632 | 20 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Andreas Bertsch $
// ------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/SpectrumHelper.cpp | .cpp | 903 | 29 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Hannes Roest g$
// $Authors: Hannes Roest $
// ------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/Feature.cpp | .cpp | 6,151 | 219 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: $
// ----------------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/PeakIndex.cpp | .cpp | 370 | 13 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg$
// $Authors: Marc Sturm $
// ------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/MobilityPeak1D.cpp | .cpp | 1,786 | 74 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Chris Bielow $
// -------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/DPeak.cpp | .cpp | 527 | 18 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: $
// ----------------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/ConsensusMap.cpp | .cpp | 27,942 | 840 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: $
// ----------------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/BinnedSpectrum.cpp | .cpp | 5,434 | 194 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Mathias Walzer $
// $Authors: Timo Sachsenberg $
// -------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/Peak1D.cpp | .cpp | 569 | 20 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg$
// $Authors: Marc Sturm $
// ------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/MobilityPeak2D.cpp | .cpp | 2,282 | 104 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Chris Bielow $
// -------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/Peak2D.cpp | .cpp | 2,143 | 104 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg$
// $Authors: Marc Sturm $
// ------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/Mobilogram.cpp | .cpp | 10,941 | 414 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Chris Bielow $
// -------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/ChromatogramTools.cpp | .cpp | 514 | 18 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Andreas Bertsch $
// ------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/MSChromatogram.cpp | .cpp | 14,344 | 498 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Andreas Bertsch $
// ------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/BaseFeature.cpp | .cpp | 6,976 | 262 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Hendrik Weisser $
// $Authors: Hendrik Weisser, Chris Bielow $
// -----------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/RichPeak2D.cpp | .cpp | 370 | 13 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg$
// $Authors: Marc Sturm $
// ------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/AreaIterator.cpp | .cpp | 370 | 13 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg$
// $Authors: Marc Sturm $
// ------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/MRMFeature.cpp | .cpp | 7,015 | 194 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Hannes Roest $
// $Authors: Hannes Roest $
// -------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/ConversionHelper.cpp | .cpp | 3,419 | 111 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: $
// ----------------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/FeatureHandle.cpp | .cpp | 2,526 | 104 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: $
// ----------------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/MSSpectrum.cpp | .cpp | 24,429 | 819 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Marc Sturm $
// -----------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/FeatureMap.cpp | .cpp | 15,290 | 499 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Marc Sturm, Chris Bielow, Clemens Groepl $
// ---------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/MRMTransitionGroup.cpp | .cpp | 416 | 15 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Hannes Roest $
// $Authors: Hannes Roest $
// -------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/RangeManager.cpp | .cpp | 1,787 | 78 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Chris Bielow $
// -------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/OnDiscMSExperiment.cpp | .cpp | 7,558 | 233 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Hannes Roest $
// $Authors: Hannes Roest $
// -------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/ChromatogramRangeManager.cpp | .cpp | 496 | 14 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Administrator $
// --------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/MassTrace.cpp | .cpp | 20,322 | 668 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Erhan Kenar, Holger Franken, Chris Bielow $
// ----------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/SpectrumRangeManager.cpp | .cpp | 492 | 14 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Administrator $
// --------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/DimMapper.cpp | .cpp | 1,556 | 58 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Chris Bielow $
// -------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/KERNEL/MSExperiment.cpp | .cpp | 35,753 | 1,116 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg$
// $Authors: Marc Sturm, Tom Waschischeck $
// ------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/IONMOBILITY/IMDataConverter.cpp | .cpp | 13,756 | 374 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Eugen Netz $
// $Authors: Eugen Netz, Chris Bielow $
// ---------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/IONMOBILITY/FAIMSHelper.cpp | .cpp | 2,435 | 87 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Eugen Netz $
// $Authors: Eugen Netz $
// -----------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/IONMOBILITY/IMTypes.cpp | .cpp | 4,663 | 143 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Chris Bielow $
// -------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/QC/FragmentMassError.cpp | .cpp | 13,739 | 328 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow$
// $Authors: Patricia Scheil, Swenja Wagner$
// ---------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/QC/Ms2IdentificationRate.cpp | .cpp | 4,794 | 150 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow$
// $Authors: Patricia Scheil, Swenja Wagner$
// ---------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/QC/MQMsmsExporter.cpp | .cpp | 10,078 | 279 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow$
// $Authors: Hendrik Beschorner, Lenny Kovac, Virginia Rossow$
// ---------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/QC/MissedCleavages.cpp | .cpp | 4,952 | 144 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Swenja Wagner, Patricia Scheil $
// -------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/QC/FWHM.cpp | .cpp | 1,581 | 51 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Chris Bielow $
// -------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/QC/PSMExplainedIonCurrent.cpp | .cpp | 11,449 | 271 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Tom Waschischeck$
// $Authors: Tom Waschischeck$
// -------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/QC/FeatureSummary.cpp | .cpp | 1,570 | 62 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Axel Walter $
// $Authors: Axel Walter $
// ---------------------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/QC/QCBase.cpp | .cpp | 2,814 | 91 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Chris Bielow, Tom Waschischeck $
// -------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/QC/DBSuitability.cpp | .cpp | 28,184 | 751 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Tom Waschischeck $
// $Authors: Tom Waschischeck $
// -----------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/QC/Contaminants.cpp | .cpp | 6,018 | 180 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Dominik Schmitz, Chris Bielow$
// ---------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/QC/MzCalibration.cpp | .cpp | 4,673 | 126 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Juliane Schmachtenberg $
// ---------------------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/QC/RTAlignment.cpp | .cpp | 3,452 | 82 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Juliane Schmachtenberg, Chris Bielow $
// -------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/QC/Ms2SpectrumStats.cpp | .cpp | 5,721 | 145 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Juliane Schmachtenberg, Chris Bielow $
// -------------------------... | C++ |
3D | OpenMS/OpenMS | src/openms/source/QC/SpectrumCount.cpp | .cpp | 1,069 | 41 | // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Axel Walter $
// $Authors: Axel Walter $
// ---------------------------------------------------... | C++ |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.