category
code_metric¶
Core predicates for computing source code metrics.
staticPublic predicates¶
entity/1¶
Scans an entity and prints its metric score.
staticentity(Entity)entity(+term) - zero_or_onefile/1¶
Prints metric scores for all the entities defined in a loaded source file.
staticfile(File)file(+atom) - zero_or_onedirectory/1¶
Scans a directory and prints metric scores for all entities defined in its loaded source files.
staticdirectory(Directory)directory(+atom) - onerdirectory/1¶
Recursive version of the directory/1 predicate.
staticrdirectory(Directory)rdirectory(+atom) - onelibrary/1¶
Prints metrics scores for all loaded entities from a given library.
staticlibrary(Library)library(+atom) - onerlibrary/1¶
Recursive version of the library/1 predicate.
staticrlibrary(Library)rlibrary(+atom) - oneall/0¶
Scans all loaded entities and prints their metric scores.
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)library_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_oneentity_score//2¶
Pretty prints the entity score.
staticentity_score(Entity,Score)entity_score(@entity_identifier,-ground) - zero_or_oneentity_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/1¶
Processes a source file.
staticprocess_file(Path)process_file(+atom) - oneprocess_directory/1¶
Processes a directory of source files.
staticprocess_directory(Path)process_directory(+atom) - oneprocess_rdirectory/1¶
Recursively process a directory of source files.
staticprocess_rdirectory(Path)process_rdirectory(+atom) - oneprocess_rlibrary/1¶
Recursively process a library of source files.
staticprocess_rlibrary(Path)process_rlibrary(+atom) - oneprocess_all/0¶
Processes all loaded source code.
staticprocess_all - 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-library paths.
staticsub_library(Library,SubLibraryPath)sub_library(+atom,-atom) - onePrivate predicates¶
(see entity ancestors)