semmlecode.cpp.dbscheme

/**
 * An invocation of the compiler. Note that more than one file may be
 * compiled per invocation. For example, this command compiles three
 * source files:
 *
 *   gcc -c f1.c f2.c f3.c
 *
 * The `id` simply identifies the invocation, while `cwd` is the working
 * directory from which the compiler was invoked.
 */
compilations(
    /**
     * An invocation of the compiler. Note that more than one file may
     * be compiled per invocation. For example, this command compiles
     * three source files:
     *
     *   gcc -c f1.c f2.c f3.c
     */
    unique int id : @compilation,
    string cwd : string ref
);

/**
 * The arguments that were passed to the extractor for a compiler
 * invocation. If `id` is for the compiler invocation
 *
 *   gcc -c f1.c f2.c f3.c
 *
 * then typically there will be rows for
 *
 * num | arg
 * --- | ---
 * 0   | *path to extractor*
 * 1   | `--mimic`
 * 2   | `/usr/bin/gcc`
 * 3   | `-c`
 * 4   | f1.c
 * 5   | f2.c
 * 6   | f3.c
 */
#keyset[id, num]
compilation_args(
    int id : @compilation ref,
    int num : int ref,
    string arg : string ref
);

/**
 * The source files that are compiled by a compiler invocation.
 * If `id` is for the compiler invocation
 *
 *   gcc -c f1.c f2.c f3.c
 *
 * then there will be rows for
 *
 * num | arg
 * --- | ---
 * 0   | f1.c
 * 1   | f2.c
 * 2   | f3.c
 *
 * Note that even if those files `#include` headers, those headers
 * do not appear as rows.
 */
#keyset[id, num]
compilation_compiling_files(
    int id : @compilation ref,
    int num : int ref,
    int file : @file ref
);

/**
 * The time taken by the extractor for a compiler invocation.
 *
 * For each file `num`, there will be rows for
 *
 * kind | seconds
 * ---- | ---
 * 1    | CPU seconds used by the extractor frontend
 * 2    | Elapsed seconds during the extractor frontend
 * 3    | CPU seconds used by the extractor backend
 * 4    | Elapsed seconds during the extractor backend
 */
#keyset[id, num, kind]
compilation_time(
    int id : @compilation ref,
    int num : int ref,
    /* kind:
       1 = frontend_cpu_seconds
       2 = frontend_elapsed_seconds
       3 = extractor_cpu_seconds
       4 = extractor_elapsed_seconds
    */
    int kind : int ref,
    float seconds : float ref
);

/**
 * An error or warning generated by the extractor.
 * The diagnostic message `diagnostic` was generated during compiler
 * invocation `compilation`, and is the `file_number_diagnostic_number`th
 * message generated while extracting the `file_number`th file of that
 * invocation.
 */
#keyset[compilation, file_number, file_number_diagnostic_number]
diagnostic_for(
    int diagnostic : @diagnostic ref,
    int compilation : @compilation ref,
    int file_number : int ref,
    int file_number_diagnostic_number : int ref
);

/**
 * If extraction was successful, then `cpu_seconds` and
 * `elapsed_seconds` are the CPU time and elapsed time (respectively)
 * that extraction took for compiler invocation `id`.
 */
compilation_finished(
    unique int id : @compilation ref,
    float cpu_seconds : float ref,
    float elapsed_seconds : float ref
);


/**
 * External data, loaded from CSV files during snapshot creation. See
 * [Tutorial: Incorporating external data](https://help.semmle.com/wiki/display/SD/Tutorial%3A+Incorporating+external+data)
 * for more information.
 */
externalData(
    int id : @externalDataElement,
    string path : string ref,
    int column: int ref,
    string value : string ref
);

/**
 * The date of the snapshot.
 */
snapshotDate(unique date snapshotDate : date ref);

/**
 * The source location of the snapshot.
 */
sourceLocationPrefix(string prefix : string ref);

/**
 * Data used by the 'duplicate code' detection.
 */
duplicateCode(
    unique int id : @duplication,
    string relativePath : string ref,
    int equivClass : int ref
);

/**
 * Data used by the 'similar code' detection.
 */
similarCode(
    unique int id : @similarity,
    string relativePath : string ref,
    int equivClass : int ref
);

/**
 * Data used by the 'duplicate code' and 'similar code' detection.
 */
@duplication_or_similarity = @duplication | @similarity

/**
 * Data used by the 'duplicate code' and 'similar code' detection.
 */
#keyset[id, offset]
tokens(
    int id : @duplication_or_similarity ref,
    int offset : int ref,
    int beginLine : int ref,
    int beginColumn : int ref,
    int endLine : int ref,
    int endColumn : int ref
);

/**
 * Information about packages that provide code used during compilation.
 * The `id` is just a unique identifier.
 * The `namespace` is typically the name of the package manager that
 * provided the package (e.g. "dpkg" or "yum").
 * The `package_name` is the name of the package, and `version` is its
 * version (as a string).
 */
external_packages(
    unique int id: @external_package,
    string namespace : string ref,
    string package_name : string ref,
    string version : string ref
);

/**
 * Holds if File `fileid` was provided by package `package`.
 */
header_to_external_package(
    int fileid : @file ref,
    int package : @external_package ref
);

/*
 * Version history
 */

svnentries(
    unique int id : @svnentry,
    string revision : string ref,
    string author : string ref,
    date revisionDate : date ref,
    int changeSize : int ref
)

svnaffectedfiles(
    int id : @svnentry ref,
    int file : @file ref,
    string action : string ref
)

svnentrymsg(
    unique int id : @svnentry ref,
    string message : string ref
)

svnchurn(
    int commit : @svnentry ref,
    int file : @file ref,
    int addedLines : int ref,
    int deletedLines : int ref
)

/*
 * C++ dbscheme
 */

@location = @location_stmt | @location_expr | @location_default ;

/**
 * The location of an element that is not an expression or a statement.
 * The location spans column `startcolumn` of line `startline` to
 * column `endcolumn` of line `endline` in file `file`.
 * For more information, see
 * [Locations](https://help.semmle.com/QL/learn-ql/ql/locations.html).
 */
locations_default(
    /** The location of an element that is not an expression or a statement. */
    unique int id: @location_default,
    int container: @container ref,
    int startLine: int ref,
    int startColumn: int ref,
    int endLine: int ref,
    int endColumn: int ref
);

/**
 * The location of a statement.
 * The location spans column `startcolumn` of line `startline` to
 * column `endcolumn` of line `endline` in file `file`.
 * For more information, see
 * [Locations](https://help.semmle.com/QL/learn-ql/ql/locations.html).
 */
locations_stmt(
    /** The location of a statement. */
    unique int id: @location_stmt,
    int container: @container ref,
    int startLine: int ref,
    int startColumn: int ref,
    int endLine: int ref,
    int endColumn: int ref
);

/**
 * The location of an expression.
 * The location spans column `startcolumn` of line `startline` to
 * column `endcolumn` of line `endline` in file `file`.
 * For more information, see
 * [Locations](https://help.semmle.com/QL/learn-ql/ql/locations.html).
 */
locations_expr(
    /** The location of an expression. */
    unique int id: @location_expr,
    int container: @container ref,
    int startLine: int ref,
    int startColumn: int ref,
    int endLine: int ref,
    int endColumn: int ref
);

/** An element for which line-count information is available. */
@sourceline = @file | @function | @variable | @enumconstant | @xmllocatable;

numlines(
    int element_id: @sourceline ref,
    int num_lines: int ref,
    int num_code: int ref,
    int num_comment: int ref
);

diagnostics(
    unique int id: @diagnostic,
    int severity: int ref,
    string error_tag: string ref,
    string error_message: string ref,
    string full_error_message: string ref,
    int location: @location_default ref
);

/*
  fromSource(0) = unknown,
  fromSource(1) = from source,
  fromSource(2) = from library
*/
files(
    unique int id: @file,
    string name: string ref,
    string simple: string ref,
    string ext: string ref,
    int fromSource: int ref
);

folders(
    unique int id: @folder,
    string name: string ref,
    string simple: string ref
);

@container = @folder | @file

containerparent(
    int parent: @container ref,
    unique int child: @container ref
);

fileannotations(
    int id: @file ref,
    int kind: int ref,
    string name: string ref,
    string value: string ref
);

inmacroexpansion(
    int id: @element ref,
    int inv: @macroinvocation ref
);

affectedbymacroexpansion(
    int id: @element ref,
    int inv: @macroinvocation ref
);

/*
  case @macroinvocations.kind of
    1 = macro expansion
  | 2 = other macro reference
  ;
*/
macroinvocations(
    unique int id: @macroinvocation,
    int macro_id: @ppd_define ref,
    int location: @location_default ref,
    int kind: int ref
);

macroparent(
    unique int id: @macroinvocation ref,
    int parent_id: @macroinvocation ref
);

// a macroinvocation may be part of another location
// the way to find a constant expression that uses a macro
// is thus to find a constant expression that has a location
// to which a macro invocation is bound
macrolocationbind(
    int id: @macroinvocation ref,
    int location: @location ref
);

#keyset[invocation, argument_index]
macro_argument_unexpanded(
    int invocation: @macroinvocation ref,
    int argument_index: int ref,
    string text: string ref
);

#keyset[invocation, argument_index]
macro_argument_expanded(
    int invocation: @macroinvocation ref,
    int argument_index: int ref,
    string text: string ref
);

/*
  case @function.kind of
    1 = normal
  | 2 = constructor
  | 3 = destructor
  | 4 = conversion
  | 5 = operator
  | 6 = builtin     // GCC built-in functions, e.g. __builtin___memcpy_chk
  ;
*/
functions(
    unique int id: @function,
    string name: string ref,
    int kind: int ref
);

function_entry_point(int id: @function ref, unique int entry_point: @stmt ref);

function_return_type(int id: @function ref, int return_type: @type ref);

purefunctions(unique int id: @function ref);

function_deleted(unique int id: @function ref);

function_defaulted(unique int id: @function ref);



#keyset[id, type_id]
fun_decls(
    int id: @fun_decl,
    int function: @function ref,
    int type_id: @type ref,
    string name: string ref,
    int location: @location_default ref
);
fun_def(unique int id: @fun_decl ref);
fun_specialized(unique int id: @fun_decl ref);
fun_implicit(unique int id: @fun_decl ref);
fun_decl_specifiers(
    int id: @fun_decl ref,
    string name: string ref
)
#keyset[fun_decl, index]
fun_decl_throws(
    int fun_decl: @fun_decl ref,
    int index: int ref,
    int type_id: @type ref
);
/* an empty throw specification is different from none */
fun_decl_empty_throws(unique int fun_decl: @fun_decl ref);
fun_decl_noexcept(
    int fun_decl: @fun_decl ref,
    int constant: @expr ref
);
fun_decl_empty_noexcept(int fun_decl: @fun_decl ref);
fun_decl_typedef_type(
    unique int fun_decl: @fun_decl ref,
    int typedeftype_id: @usertype ref
);

param_decl_bind(
    unique int id: @var_decl ref,
    int index: int ref,
    int fun_decl: @fun_decl ref
);

#keyset[id, type_id]
var_decls(
    int id: @var_decl,
    int variable: @variable ref,
    int type_id: @type ref,
    string name: string ref,
    int location: @location_default ref
);
var_def(unique int id: @var_decl ref);
var_decl_specifiers(
    int id: @var_decl ref,
    string name: string ref
)

type_decls(
    unique int id: @type_decl,
    int type_id: @type ref,
    int location: @location_default ref
);
type_def(unique int id: @type_decl ref);
type_decl_top(
    unique int type_decl: @type_decl ref
);

namespace_decls(
    unique int id: @namespace_decl,
    int namespace_id: @namespace ref,
    int location: @location_default ref,
    int bodylocation: @location_default ref
);

usings(
    unique int id: @using,
    int element_id: @element ref,
    int location: @location_default ref
);

/** The element which contains the `using` declaration. */
using_container(
    int parent: @element ref,
    int child: @using ref
);

static_asserts(
    unique int id: @static_assert,
    int condition : @expr ref,
    string message : string ref,
    int location: @location_default ref
);

// each function has an ordered list of parameters
#keyset[id, type_id]
#keyset[function, index, type_id]
params(
    int id: @parameter,
    int function: @functionorblock ref,
    int index: int ref,
    int type_id: @type ref
);

overrides(int new: @function ref, int old: @function ref);

#keyset[id, type_id]
membervariables(
    int id: @membervariable,
    int type_id: @type ref,
    string name: string ref
);

#keyset[id, type_id]
globalvariables(
    int id: @globalvariable,
    int type_id: @type ref,
    string name: string ref
);

#keyset[id, type_id]
localvariables(
    int id: @localvariable,
    int type_id: @type ref,
    string name: string ref
);

autoderivation(
    unique int var: @variable ref,
    int derivation_type: @type ref
);

enumconstants(
    unique int id: @enumconstant,
    int parent: @usertype ref,
    int index: int ref,
    int type_id: @type ref,
    string name: string ref,
    int location: @location_default ref
);

@variable = @localscopevariable | @globalvariable | @membervariable;

@localscopevariable = @localvariable | @parameter;

/*
  Built-in types are the fundamental types, e.g., integral, floating, and void.

  case @builtintype.kind of
    1 = error
  | 2 = unknown
  | 3 = void
  | 4 = boolean
  | 5 = char
  | 6 = unsigned_char
  | 7 = signed_char
  | 8 = short
  | 9 = unsigned_short
  | 10 = signed_short
  | 11 = int
  | 12 = unsigned_int
  | 13 = signed_int
  | 14 = long
  | 15 = unsigned_long
  | 16 = signed_long
  | 17 = long_long
  | 18 = unsigned_long_long
  | 19 = signed_long_long
  | 20 = __int8                 // Microsoft-specific
  | 21 = __int16                // Microsoft-specific
  | 22 = __int32                // Microsoft-specific
  | 23 = __int64                // Microsoft-specific
  | 24 = float
  | 25 = double
  | 26 = long_double
  | 27 = _Complex_float         // C99-specific
  | 28 = _Complex_double        // C99-specific
  | 29 = _Complex_long double   // C99-specific
  | 30 = _Imaginary_float       // C99-specific
  | 31 = _Imaginary_double      // C99-specific
  | 32 = _Imaginary_long_double // C99-specific
  | 33 = wchar_t                // Microsoft-specific
  | 34 = decltype_nullptr       // C++11
  | 35 = __int128
  | 36 = unsigned___int128
  | 37 = signed___int128
  | 38 = __float128
  | 39 = _Complex___float128
  | 40 = _Decimal32
  | 41 = _Decimal64
  | 42 = _Decimal128
  | 43 = char16_t
  | 44 = char32_t
  | 45 = _Float32
  | 46 = _Float32x
  | 47 = _Float64
  | 48 = _Float64x
  | 49 = _Float128
  | 50 = _Float128x
  ;
*/
builtintypes(
    unique int id: @builtintype,
    string name: string ref,
    int kind: int ref,
    int size: int ref,
    int sign: int ref,
    int alignment: int ref
);

/*
  Derived types are types that are directly derived from existing types and
  point to, refer to, transform type data to return a new type.

  case @derivedtype.kind of
    1 = pointer
  | 2 = reference
  | 3 = type_with_specifiers
  | 4 = array
  | 5 = gnu_vector
  | 6 = routineptr
  | 7 = routinereference
  | 8 = rvalue_reference // C++11
// ... 9 type_conforming_to_protocols deprecated
  | 10 = block
  ;
*/
derivedtypes(
    unique int id: @derivedtype,
    string name: string ref,
    int kind: int ref,
    int type_id: @type ref
);

pointerishsize(unique int id: @derivedtype ref,
    int size: int ref,
    int alignment: int ref);

arraysizes(
    unique int id: @derivedtype ref,
    int num_elements: int ref,
    int bytesize: int ref,
    int alignment: int ref
);

typedefbase(
    unique int id: @usertype ref,
    int type_id: @type ref
);

decltypes(
    unique int id: @decltype,
    int expr: @expr ref,
    int base_type: @type ref,
    boolean parentheses_would_change_meaning: boolean ref
);

/*
  case @usertype.kind of
    1 = struct
  | 2 = class
  | 3 = union
  | 4 = enum
  | 5 = typedef                       // classic C: typedef typedef type name
  | 6 = template
  | 7 = template_parameter
  | 8 = template_template_parameter
  | 9 = proxy_class                   // a proxy class associated with a template parameter
// ... 10 objc_class deprecated
// ... 11 objc_protocol deprecated
// ... 12 objc_category deprecated
  | 13 = scoped_enum
  | 14 = using_alias                  // a using name = type style typedef
  ;
*/
usertypes(
    unique int id: @usertype,
    string name: string ref,
    int kind: int ref
);

usertypesize(
    unique int id: @usertype ref,
    int size: int ref,
    int alignment: int ref
);

usertype_final(unique int id: @usertype ref);

usertype_uuid(
    unique int id: @usertype ref,
    unique string uuid: string ref
);

mangled_name(
    unique int id: @declaration ref,
    int mangled_name : @mangledname
);

is_pod_class(unique int id: @usertype ref);
is_standard_layout_class(unique int id: @usertype ref);

is_complete(unique int id: @usertype ref);

is_class_template(unique int id: @usertype ref);
class_instantiation(
    int to: @usertype ref,
    int from: @usertype ref
);
class_template_argument(
    int type_id: @usertype ref,
    int index: int ref,
    int arg_type: @type ref
);
class_template_argument_value(
    int type_id: @usertype ref,
    int index: int ref,
    int arg_value: @expr ref
);

is_proxy_class_for(
    unique int id: @usertype ref,
    unique int templ_param_id: @usertype ref
);

type_mentions(
    unique int id: @type_mention,
    int type_id: @type ref,
    int location: @location ref,
    // a_symbol_reference_kind from the EDG frontend.  See symbol_ref.h there.
    int kind: int ref
);

is_function_template(unique int id: @function ref);
function_instantiation(
    unique int to: @function ref,
    int from: @function ref
);
function_template_argument(
    int function_id: @function ref,
    int index: int ref,
    int arg_type: @type ref
);
function_template_argument_value(
    int function_id: @function ref,
    int index: int ref,
    int arg_value: @expr ref
);

is_variable_template(unique int id: @variable ref);
variable_instantiation(
    unique int to: @variable ref,
    int from: @variable ref
);
variable_template_argument(
    int variable_id: @variable ref,
    int index: int ref,
    int arg_type: @type ref
);
variable_template_argument_value(
    int variable_id: @variable ref,
    int index: int ref,
    int arg_value: @expr ref
);

/*
  Fixed point types
  precision(1) = short, precision(2) = default, precision(3) = long
  is_unsigned(1) = unsigned is_unsigned(2) = signed
  is_fract_type(1) = declared with _Fract
  saturating(1) = declared with _Sat
*/
/* TODO
fixedpointtypes(
    unique int id: @fixedpointtype,
    int precision: int ref,
    int is_unsigned: int ref,
    int is_fract_type: int ref,
    int saturating: int ref);
*/

routinetypes(
    unique int id: @routinetype,
    int return_type: @type ref
);

routinetypeargs(
    int routine: @routinetype ref,
    int index: int ref,
    int type_id: @type ref
);

ptrtomembers(
    unique int id: @ptrtomember,
    int type_id: @type ref,
    int class_id: @type ref
);

/*
 specifiers for types, functions, and variables

    "public",
    "protected",
    "private",

    "const",
    "volatile",
    "static",

    "pure",
    "virtual",
    "sealed", // Microsoft
    "__interface", // Microsoft
    "inline",
    "explicit",

    "near", // near far extension
    "far", // near far extension
    "__ptr32", // Microsoft
    "__ptr64", // Microsoft
    "__sptr", // Microsoft
    "__uptr", // Microsoft
    "dllimport", // Microsoft
    "dllexport", // Microsoft
    "thread", // Microsoft
    "naked", // Microsoft
    "microsoft_inline", // Microsoft
    "forceinline", // Microsoft
    "selectany", // Microsoft
    "nothrow", // Microsoft
    "novtable", // Microsoft
    "noreturn", // Microsoft
    "noinline", // Microsoft
    "noalias", // Microsoft
    "restrict", // Microsoft
*/

specifiers(
    unique int id: @specifier,
    unique string str: string ref
);

typespecifiers(
    int type_id: @type ref,
    int spec_id: @specifier ref
);

funspecifiers(
    int func_id: @function ref,
    int spec_id: @specifier ref
);

varspecifiers(
    int var_id: @accessible ref,
    int spec_id: @specifier ref
);

attributes(
    unique int id: @attribute,
    int kind: int ref,
    string name: string ref,
    string name_space: string ref,
    int location: @location_default ref
);

case @attribute.kind of
  0 = @gnuattribute
| 1 = @stdattribute
| 2 = @declspec
| 3 = @msattribute
| 4 = @alignas
// ... 5 @objc_propertyattribute deprecated
;

attribute_args(
    unique int id: @attribute_arg,
    int kind: int ref,
    int attribute: @attribute ref,
    int index: int ref,
    int location: @location_default ref
);

case @attribute_arg.kind of
  0 = @attribute_arg_empty
| 1 = @attribute_arg_token
| 2 = @attribute_arg_constant
| 3 = @attribute_arg_type
;

attribute_arg_value(
    unique int arg: @attribute_arg ref,
    string value: string ref
);
attribute_arg_type(
    unique int arg: @attribute_arg ref,
    int type_id: @type ref
);
attribute_arg_name(
    unique int arg: @attribute_arg ref,
    string name: string ref
);

typeattributes(
    int type_id: @type ref,
    int spec_id: @attribute ref
);

funcattributes(
    int func_id: @function ref,
    int spec_id: @attribute ref
);

varattributes(
    int var_id: @accessible ref,
    int spec_id: @attribute ref
);

stmtattributes(
    int stmt_id: @stmt ref,
    int spec_id: @attribute ref
);

@type = @builtintype
      | @derivedtype
      | @usertype
      /* TODO | @fixedpointtype */
      | @routinetype
      | @ptrtomember
      | @decltype;

unspecifiedtype(
    unique int type_id: @type ref,
    int unspecified_type_id: @type ref
);

member(
    int parent: @type ref,
    int index: int ref,
    int child: @member ref
);

@enclosingfunction_child = @usertype | @variable | @namespace

enclosingfunction(
    unique int child: @enclosingfunction_child ref,
    int parent: @function ref
);

derivations(
    unique int derivation: @derivation,
    int sub: @type ref,
    int index: int ref,
    int super: @type ref,
    int location: @location_default ref
);

derspecifiers(
    int der_id: @derivation ref,
    int spec_id: @specifier ref
);

/**
 * Contains the byte offset of the base class subobject within the derived
 * class. Only holds for non-virtual base classes, but see table
 * `virtual_base_offsets` for offsets of virtual base class subobjects.
 */
direct_base_offsets(
    unique int der_id: @derivation ref,
    int offset: int ref
);

/**
 * Contains the byte offset of the virtual base class subobject for class
 * `super` within a most-derived object of class `sub`. `super` can be either a
 * direct or indirect base class.
 */
#keyset[sub, super]
virtual_base_offsets(
    int sub: @usertype ref,
    int super: @usertype ref,
    int offset: int ref