category
code_metric
Core predicates for computing source code metrics.
logtalk_load(code_metrics(loader))staticPublic predicates
entity/1
Scans an entity and prints its metric score.
staticentity(Entity)entity(+term) - zero_or_onefile/2
Prints metric scores for all the entities defined in a loaded source file using the given options.
staticfile(File,Options)file(+atom,+list(compound)) - zero_or_onefile/1
Prints metric scores for all the entities defined in a loaded source file using default options.
staticfile(File)file(+atom) - zero_or_onedirectory/2
Scans a directory and prints metric scores for all entities defined in its loaded source files using the given options.
staticdirectory(Directory,Options)directory(+atom,+list(compound)) - onedirectory/1
Scans a directory and prints metric scores for all entities defined in its loaded source files using default options.
staticdirectory(Directory)directory(+atom) - onerdirectory/2
Recursive version of the directory/1 predicate using the given options.
staticrdirectory(Directory,Options)rdirectory(+atom,+list(compound)) - onerdirectory/1
Recursive version of the directory/1 predicate using default options.
staticrdirectory(Directory)rdirectory(+atom) - onelibrary/2
Prints metrics scores for all loaded entities from a given library using the given options.
staticlibrary(Library,Options)library(+atom,+list(compound)) - onelibrary/1
Prints metrics scores for all loaded entities from a given library using default options.
staticlibrary(Library)library(+atom) - onerlibrary/2
Recursive version of the library/1 predicate using the given options.
staticrlibrary(Library,Options)rlibrary(+atom,+list(compound)) - onerlibrary/1
Recursive version of the library/1 predicate using default options.
staticrlibrary(Library)rlibrary(+atom) - oneall/1
Scans all loaded entities and prints their metric scores using the given options.
staticall(Options)all(+list(compound)) - oneall/0
Scans all loaded entities and prints their metric scores using default options.
staticall - oneentity_score/2
Score is a term that represents the metric score associated with a loaded entity. Fails if the metric does not apply.
staticentity_score(Entity,Score)entity_score(@entity_identifier,-ground) - zero_or_onelibrary_score/2
Score is a term that represents the metric score associated with a loaded library source files. Fails if the metric does not apply.
staticlibrary_score(Library,Score)library_score(@atom,-ground) - zero_or_onerlibrary_score/2
Score is a term that represents the metric score associated with loaded source files from a library and its sub-libraries. Fails if the metric does not apply.
staticrlibrary_score(Library,Score)rlibrary_score(@atom,-ground) - zero_or_onefile_score/2
Score is a term that represents the metric score associated with a loaded source file. Fails if the metric does not apply.
staticfile_score(File,Score)file_score(@atom,-ground) - zero_or_onedirectory_score/2
Score is a term that represents the metric score associated with loaded source files from a directory. Fails if the metric does not apply.
staticdirectory_score(Directory,Score)directory_score(@atom,-ground) - zero_or_onerdirectory_score/2
Score is a term that represents the metric score associated with loaded source files from a directory and its sub-directories. Fails if the metric does not apply.
staticrdirectory_score(Directory,Score)rdirectory_score(@atom,-ground) - zero_or_oneall_score/1
Score is a term that represents the metric score associated with all loaded source files. Fails if the metric does not apply.
staticall_score(Score)all_score(-ground) - zero_or_oneformat_entity_score//2
Formats the entity score for pretty printing.
staticformat_entity_score(Entity,Score)format_entity_score(@entity_identifier,+ground) - oneProtected predicates
process_entity/2
Processes an entity of the given kind.
staticprocess_entity(Kind,Entity)process_entity(+atom,@entity_identifier) - oneprocess_file/2
Processes a source file using the given options.
staticprocess_file(Path,Options)process_file(+atom,+list(compound)) - oneprocess_directory/2
Processes a directory of source files using the given options.
staticprocess_directory(Path,Options)process_directory(+atom,+list(compound)) - oneprocess_rdirectory/2
Recursively process a directory of source files using the given options.
staticprocess_rdirectory(Path,Options)process_rdirectory(+atom,+list(compound)) - oneprocess_library/2
Processes a library of source files using the given options.
staticprocess_library(Library,Options)process_library(+atom,+list(compound)) - oneprocess_rlibrary/2
Recursively process a library of source files using the given options.
staticprocess_rlibrary(Library,Options)process_rlibrary(+atom,+list(compound)) - oneprocess_all/1
Processes all loaded source code using the given options.
staticprocess_all(Options)process_all(+list(compound)) - onesub_directory/2
Enumerates, by backtracking, all directory sub-directories containing loaded files.
staticsub_directory(Directory,SubDirectory)sub_directory(+atom,-atom) - onesub_library/2
Enumerates, by backtracking, all library sub-libraries.
staticsub_library(Library,SubLibrary)sub_library(+atom,-atom) - onePrivate predicates
(no local declarations; see entity ancestors if any)
Operators
(none)