wiki:SemanticQuery/Components

Version 8 (modified by manualwiki, 10 years ago) (diff)

mostly sq-type related changes

This page lists the names of initial selectors, selectors and properties available in the semantic query language along with their possible abbreviations and synonyms. For examples of usage, see this page.

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.

Cheat sheet of query componens

Initial selectors
Name Synonyms
files -
@file -
modules mods
@module @mod
@clause -
@function @fun
@definition @def
@expression @expr
@variable @var
@record @rec
@recfield @field
@macro -
@spec -
@type -


File entity
Selectors Properties
Name Synonyms Name Synonyms
function functions, fun, funs module is_module, mod, is_mod
record records, rec, recs header is_header
macro macros name -
includes - directory dir
included_by - path -
imports -
exports -
specs spec
types typedef, typedefs, type
typerefs -


Function entity
Selectors Properties
Name Synonyms Name Synonyms
references refs, ref, reference exported -
calls - name -
called_by - arity -
arguments args, parameters, params bif -
body - pure -
expressions exprs, expr, expression defined -
variables vars, var, variable module mod
file - dirty -
dynamic_calls dynref, dynrefs spec -
dynamic_calls dyncall, dyncalls
dynamic_called_by dyncalled_by
clause -
spec -
returntype returntypes, rettype


Function clause entity
Selectors Properties
Name Synonyms Name Synonyms
calls - name -
arguments args, parameters, params module mod
body - arity -
expressions exprs, expr, expression spec -
variables vars, var, variable index -
file - macro_value mac_val, macrovalue, macval
function func
dynamic_calls dyncall, dyncalls
spec -
returntype returntypes, rettype


Expression entity
Selectors Properties
Name Synonyms Name Synonyms
fundef - type -
functions function, fun, funs value val
variables vars, var, variable class -
records record, rec, recs last is_last
macro macros index -
subexpression sub, esub, subexpr tailcall is_tailcall
parameter param has_side_effect dirty
top_expression top, top_expr
file - macro_value macro_val, macrovalue, macval
dynamic_ functions dynfun, dynfuns


Function parameter entity
Selectors Properties
Name Synonyms Name Synonyms
fundef - type -
functions function, fun, funs value val
variables vars, var, variable class -
records record, rec, recs last is_last
macro macros index -
subexpression sub, esub, subexpr tailcall is_tailcall
parameter param has_side_effect dirty
top_expression top, top_expr
file - macro_value macro_val, macrovalue, macval
dynamic_ functions dynfun, dynfuns
type -


Variable entity
Selectors Properties
Name Synonyms Name Synonyms
references refs, ref, reference name -
bindings -
fundef -


Record entity
Selectors Properties
Name Synonyms Name Synonyms
references refs, ref, reference name -
fields -
file -


Record field entity
Selectors Properties
Name Synonyms Name Synonyms
references refs, ref, reference name -
record rec
file -
type types


Macro entity
Selectors Properties
Name Synonyms Name Synonyms
references refs, ref, reference name -
file - arity -
clause_references clause_reference, clause_refs, clause_ref const -
all_references all_reference, all_refs, all_ref body -


Spec entity
Selectors Properties
Name Synonyms Name Synonyms
function 'fun', func name funname
file deffile arity -
refmod modref text -
returntype returntypes returntext -
guardtype guardtypes guardtext -
arguments args, parameters, params


Spec-param entity
Selectors Properties
Name Synonyms Name Synonyms
type - name -
index -
text -


Type entity
Selectors Properties
Name Synonyms Name Synonyms
file - name -
subtypes subtype, sub arity number_of_parameters
arguments args, parameters, params exported remote_type
specref specrefs, refspec, refspecs opaque isopaque, is_opaque
references refs, ref builtin isbuiltin, is_builtin, is_built_in
paramsref paramsrefs


Metrics for files, functions and function clauses (as properties)
Name Synonyms File Function Function Clause
module_sum mod_sum ok - -
function_sum fun_sum - ok ok
line_of_code loc ok ok ok
char_of_code choc ok ok ok
number_of_fun num_of_fun, num_of_functions, number_of_functions ok - -
number_of_macros num_of_macros, num_of_macr ok - -
number_of_records num_of_records, num_of_rec ok - -
included_files inc_files ok - -
imported_modules imp_modules, imported_mod, imp_mod ok - -
number_of_funpath number_of_funpaths, num_of_funpath, num_of_funpaths ok - -
function_calls_in fun_calls_in ok - -
function_calls_out fun_calls_out ok - -
calls_for_function calls_for_fun, call_for_function, call_for_fun - ok ok
calls_from_function calls_from_fun, call_from_function, call_from_fun - ok ok
cohesion coh ok - -
otp_used otp ok - -
max_application_depth max_app_depth ok ok ok
max_depth_of_calling max_depth_calling, max_depth_of_call, max_depth_call ok ok ok
min_depth_of_calling min_depth_calling, min_depth_of_call, min_depth_call ok - ok
max_depth_of_cases max_depth_cases ok ok ok
max_depth_of_structs - ok ok ok
number_of_funclauses num_of_funclauses, number_of_funclaus, num_of_funclaus ok ok ok
branches_of_recursion branches_of_rec, branch_of_recursion, branch_of_rec ok ok ok
mcCabe mccabe ok ok ok
number_of_funexpr num_of_funexpr ok ok ok
number_of_messpass num_of_messpass ok ok ok
fun_return_points fun_return_point, function_return_points, function_return_point ok ok ok
max_length_of_line - ok ok ok
average_length_of_line avg_length_of_line ok ok ok
no_space_after_comma - ok ok ok
is_tail_recursive - - ok ok


Statistics
Name Synonyms
minimum min
maximum max
sum -
mean average, avg
median med
variance var
standard_deviation sd