| 1 | {{{#!comment |
| 2 | This page lists the names of initial selectors, selectors and properties available in the semantic query language along with their possible abbreviations and synonyms. |
| 3 | For examples of usage, see [SemanticQuery/Examples this page]. |
| 4 | |
| 5 | Every selector returns entites of any of the following types. See the linked pages for a detailed description of the selectors and properties of various entites. |
| 6 | * [SemanticQuery/FileEntity File] |
| 7 | * [SemanticQuery/FunctionEntity Function] |
| 8 | * [SemanticQuery/FunctionClauseEntity Function clause] |
| 9 | * [SemanticQuery/ExpressionEntity Expression] |
| 10 | * [SemanticQuery/VariableEntity Variable] |
| 11 | * [SemanticQuery/RecordEntity Record] |
| 12 | * [SemanticQuery/RecordFieldEntity Record field] |
| 13 | * [SemanticQuery/MacroEntity Macro] |
| 14 | |
| 15 | == Cheat sheet of query componens |
| 16 | |
| 17 | |||| '''Initial selectors''' || |
| 18 | ||''Name'' ||''Synonyms'' || |
| 19 | ||{{{files}}} || {{{-}}} || |
| 20 | ||{{{@file}}} || {{{-}}} || |
| 21 | ||{{{modules}}} || {{{mods}}} || |
| 22 | ||{{{@module}}} || {{{@mod}}} || |
| 23 | ||{{{@clause}}} || {{{-}}} || |
| 24 | ||{{{@function}}} || {{{@fun}}} || |
| 25 | ||{{{@definition}}} || {{{@def}}} || |
| 26 | ||{{{@expression}}} || {{{@expr}}} || |
| 27 | ||{{{@variable}}} || {{{@var}}} || |
| 28 | ||{{{@record}}} || {{{@rec}}} || |
| 29 | ||{{{@recfield}}} || {{{@field}}} || |
| 30 | ||{{{@macro}}} || {{{-}}} || |
| 31 | \\ |
| 32 | |||||||| [wiki:SemanticQuery/FileEntity File entity] || |
| 33 | |||| '''Selectors''' |||| '''Properties''' || |
| 34 | ||''Name'' ||''Synonyms'' ||''Name'' ||''Synonyms'' || |
| 35 | ||{{{function}}} || {{{functions, fun, funs}}} || {{{module}}} || {{{is_module, mod, is_mod}}} || |
| 36 | ||{{{record}}} || {{{records, rec, recs}}} || {{{header}}} || {{{is_header}}} || |
| 37 | ||{{{macro}}} || {{{macros}}} || {{{name}}} || {{{-}}} || |
| 38 | ||{{{includes}}} || {{{-}}} || {{{directory}}} || {{{dir}}} || |
| 39 | ||{{{included_by}}} || {{{-}}} || {{{path}}} || {{{-}}} || |
| 40 | ||{{{imports}}} || {{{-}}} || || || |
| 41 | ||{{{exports}}} || {{{-}}} || || || |
| 42 | \\ |
| 43 | |||||||| [wiki:SemanticQuery/FunctionEntity Function entity] || |
| 44 | |||| '''Selectors''' |||| '''Properties''' || |
| 45 | ||''Name'' || ''Synonyms'' || ''Name'' || ''Synonyms'' || |
| 46 | ||{{{references}}} || {{{refs, ref, reference}}} || {{{exported}}} || {{{-}}} || |
| 47 | ||{{{calls}}} || {{{-}}} || {{{name}}} || {{{-}}} || |
| 48 | ||{{{called_by}}} || {{{-}}} || {{{arity}}} || {{{-}}} || |
| 49 | ||{{{arguments}}} || {{{args}}} || {{{bif}}} || {{{-}}} || |
| 50 | ||{{{body}}} || {{{-}}} || {{{pure}}} || {{{-}}} || |
| 51 | ||{{{expressions}}} || {{{exprs, expr, expression}}} || {{{defined}}} || {{{-}}} || |
| 52 | ||{{{variables}}} || {{{vars, var, variable}}} || {{{module}}} || {{{mod}}} |
| 53 | ||{{{file}}} || {{{-}}} || {{{dirty}}} || {{{-}}} || |
| 54 | ||{{{dynamic_calls}}} || {{{dynref, dynrefs}}} || {{{spec}}} || {{{-}}} || |
| 55 | ||{{{dynamic_calls}}} || {{{dyncall, dyncalls}}} || || || |
| 56 | ||{{{dynamic_called_by}}} || {{{dyncalled_by}}} || || || |
| 57 | \\ |
| 58 | |||||||| [wiki:SemanticQuery/FunctionClauseEntity Function clause entity] || |
| 59 | |||| '''Selectors''' |||| '''Properties''' || |
| 60 | ||''Name'' || ''Synonyms'' || ''Name'' || ''Synonyms'' || |
| 61 | ||{{{calls}}} || {{{-}}} || {{{name}}} || {{{-}}} || |
| 62 | ||{{{arguments}}} || {{{args}}} || {{{module}}} || {{{mod}}} || |
| 63 | ||{{{body}}} || {{{-}}} || arity || {{{-}}} || |
| 64 | ||{{{expressions}}} || {{{exprs, expr, expression}}} || {{{spec}}} ||{{{-}}} || |
| 65 | ||{{{variables}}} || {{{vars, var, variable}}} || {{{index}}} || {{{-}}} || |
| 66 | ||{{{file}}} || {{{-}}} || || || |
| 67 | ||{{{function}}} || {{{func}}} || || || |
| 68 | ||{{{dynamic_calls}}} || {{{dyncall, dyncalls}}} || || || |
| 69 | \\ |
| 70 | |||||||| [wiki:SemanticQuery/ExpressionEntity Expression entity] || |
| 71 | |||| '''Selectors''' |||| '''Properties''' || |
| 72 | ||''Name'' ||''Synonyms'' ||''Name'' ||''Synonyms'' || |
| 73 | ||{{{fundef}}} || {{{-}}} || {{{type}}} || {{{-}}} || |
| 74 | ||{{{functions}}} || {{{function, fun, funs}}} || {{{value}}} || {{{val}}} || |
| 75 | ||{{{variables}}} || {{{vars, var, variable}}} || {{{class}}} || {{{-}}} || |
| 76 | ||{{{records}}} || {{{record, rec, recs}}} || {{{last}}} || {{{is_last}}} || |
| 77 | ||{{{macro}}} || {{{macros}}} || {{{index}}} || {{{-}}} || |
| 78 | ||{{{subexpression}}} || {{{sub, esub, subexpr}}} || {{{tailcall}}} || {{{is_tailcall}}} || |
| 79 | ||{{{parameter}}} || {{{param}}} || {{{has_side_effect}}} || {{{dirty}}} || |
| 80 | ||{{{top_expression}}} || {{{top, top_expr}}} || || || |
| 81 | ||{{{file}}} || {{{-}}} || || || |
| 82 | ||{{{dynamic_ functions}}} || {{{dynfun, dynfuns}}} || || || |
| 83 | \\ |
| 84 | |||||||| [wiki:SemanticQuery/VariableEntity Variable entity] || |
| 85 | |||| '''Selectors''' |||| '''Properties''' || |
| 86 | ||''Name'' || ''Synonyms'' || ''Name'' || ''Synonyms'' || |
| 87 | ||{{{references}}} || {{{refs, ref, reference}}} || {{{name}}} || {{{-}}} || |
| 88 | ||{{{bindings}}} || {{{-}}} || || || |
| 89 | ||{{{fundef}}} || {{{-}}} || || || |
| 90 | \\ |
| 91 | |||||||| [wiki:SemanticQuery/RecordEntity Record entity] || |
| 92 | |||| '''Selectors''' |||| '''Properties''' || |
| 93 | ||''Name'' ||''Synonyms'' ||''Name'' ||''Synonyms'' || |
| 94 | ||{{{references}}} || {{{refs, ref, reference}}} || {{{name}}} || {{{-}}} || |
| 95 | ||{{{fields}}} || {{{-}}} || || || |
| 96 | ||{{{file}}} || {{{-}}} || || || |
| 97 | \\ |
| 98 | |||||||| [wiki:SemanticQuery/RecordFieldEntity Record field entity] || |
| 99 | |||| '''Selectors''' |||| '''Properties''' || |
| 100 | ||''Name'' ||''Synonyms'' ||''Name'' ||''Synonyms'' || |
| 101 | ||{{{references}}} || {{{refs, ref, reference}}} || {{{name}}} || {{{-}}} || |
| 102 | ||{{{record}}} || {{{rec}}} || || || |
| 103 | ||{{{file}}} || {{{-}}} || || || |
| 104 | \\ |
| 105 | |||||||| [wiki:SemanticQuery/MacroEntity Macro entity] || |
| 106 | |||| '''Selectors''' |||| '''Properties''' || |
| 107 | ||''Name'' ||''Synonyms'' ||''Name'' ||''Synonyms'' || |
| 108 | ||{{{references}}} || {{{refs, ref, reference}}} || {{{name}}} || {{{-}}} || |
| 109 | ||{{{file}}} || {{{-}}} || {{{arity}}} || {{{-}}} || |
| 110 | || || || {{{const}}} || {{{-}}} || |
| 111 | \\ |
| 112 | |||||||| [wiki:MetricQuery Metrics for files, functions and function clauses (as properties)] || |
| 113 | ||''Name'' || ''Synonyms'' || ''File'' || ''Function'' || ''Function Clause'' || |
| 114 | ||[wiki:MetricQuery#module_sum module_sum] || {{{mod_sum}}} || ok || - || - || |
| 115 | ||[wiki:MetricQuery#function_sum function_sum] || {{{fun_sum}}} || - || ok || ok || |
| 116 | ||[wiki:MetricQuery#line_of_code line_of_code] || {{{loc}}} || ok || ok || ok || |
| 117 | ||[wiki:MetricQuery#char_of_code char_of_code] || {{{choc}}} || ok || ok || ok || |
| 118 | ||[wiki:MetricQuery#number_of_fun number_of_fun] || {{{num_of_fun, num_of_functions, number_of_functions}}} || ok || - || - || |
| 119 | ||[wiki:MetricQuery#number_of_macros number_of_macros] || {{{num_of_macros, num_of_macr}}} || ok || - || - || |
| 120 | ||[wiki:MetricQuery#number_of_records number_of_records] || {{{num_of_records, num_of_rec}}} || ok || - || - || |
| 121 | ||[wiki:MetricQuery#included_files included_files] || {{{inc_files}}} || ok || - || - || |
| 122 | ||[wiki:MetricQuery#imported_modules imported_modules] || {{{imp_modules, imported_mod, imp_mod}}} || ok || - || - || |
| 123 | ||[wiki:MetricQuery#number_of_funpath number_of_funpath] || {{{number_of_funpaths, num_of_funpath, num_of_funpaths}}} || ok || - || - || |
| 124 | ||[wiki:MetricQuery#function_calls_in function_calls_in] || {{{fun_calls_in}}} || ok || - || - || |
| 125 | ||[wiki:MetricQuery#function_calls_out function_calls_out] || {{{fun_calls_out}}} || ok || - || - || |
| 126 | ||[wiki:MetricQuery#calls_for_function calls_for_function] || {{{calls_for_fun, call_for_function, call_for_fun}}} || - || ok || ok || |
| 127 | ||[wiki:MetricQuery#calls_from_function calls_from_function] || {{{calls_from_fun, call_from_function, call_from_fun}}} || - || ok || ok || |
| 128 | ||[wiki:MetricQuery#cohesion cohesion] || {{{coh}}} || ok || - || - || |
| 129 | ||[wiki:MetricQuery#otp_used otp_used] || {{{otp}}} || ok || - || - || |
| 130 | ||{{{max_application_depth}}} || {{{max_app_depth}}} || ok || ok || ok || |
| 131 | ||[wiki:MetricQuery#max_depth_of_calling max_depth_of_calling] || {{{max_depth_calling, max_depth_of_call, max_depth_call}}} || ok || ok || ok || |
| 132 | ||{{{min_depth_of_calling}}} || {{{min_depth_calling, min_depth_of_call, min_depth_call}}} || ok || - || ok || |
| 133 | ||[wiki:MetricQuery#max_depth_of_cases max_depth_of_cases] || {{{max_depth_cases}}} || ok || ok || ok || |
| 134 | ||[wiki:MetricQuery#max_depth_of_structs max_depth_of_structs] || {{{-}}} || ok || ok || ok || |
| 135 | ||[wiki:MetricQuery#number_of_funclauses number_of_funclauses] || {{{num_of_funclauses, number_of_funclaus, num_of_funclaus}}} || ok || ok || ok || |
| 136 | ||[wiki:MetricQuery#branches_of_recursion branches_of_recursion] || {{{branches_of_rec, branch_of_recursion, branch_of_rec}}} || ok || ok || ok || |
| 137 | ||[wiki:MetricQuery#mcCabe mcCabe] || {{{mccabe}}} || ok || ok || ok || |
| 138 | ||[wiki:MetricQuery#number_of_funexpr number_of_funexpr] || {{{num_of_funexpr}}} || ok || ok || ok || |
| 139 | ||[wiki:MetricQuery#number_of_messpass number_of_messpass] || {{{num_of_messpass}}} || ok || ok || ok || |
| 140 | ||[wiki:MetricQuery#fun_return_points fun_return_points] || {{{fun_return_point, function_return_points, function_return_point}}} || ok || ok || ok || |
| 141 | ||[wiki:MetricQuery#max_length_of_line max_length_of_line] || {{{-}}} || ok || ok || ok || |
| 142 | ||[wiki:MetricQuery#average_length_of_line average_length_of_line] || {{{avg_length_of_line}}} || ok || ok || ok || |
| 143 | ||[wiki:MetricQuery#no_space_after_comma no_space_after_comma] || {{{-}}} || ok || ok || ok || |
| 144 | ||[wiki:MetricQuery#is_tail_recursive is_tail_recursive] || {{{-}}} || - || ok || ok || |
| 145 | \\ |
| 146 | |||| '''Statistics''' || |
| 147 | || ''Name'' || ''Synonyms'' || |
| 148 | ||{{{minimum}}} || {{{min}}} || |
| 149 | ||{{{maximum}}} || {{{max}}} || |
| 150 | ||{{{sum}}} || {{{-}}} || |
| 151 | ||{{{mean}}} || {{{average, avg}}} || |
| 152 | ||{{{median}}} || {{{med}}} || |
| 153 | ||{{{variance}}} || {{{var}}} || |
| 154 | ||{{{standard_deviation}}} || {{{sd}}} || |
| 155 | |
| 156 | }}} |
| 157 | |