category
Common predicates for generating diagrams.
Paulo Moura
2.0
2014/12/30
static
(no dependencies on other files)
Creates a diagram for a set of libraries using the specified options.
static
libraries(Project,Libraries,Options)
libraries(+atom,+list(atom),+list(compound)) – one
Creates a diagram for a set of libraries using the default options.
static
libraries(Project,Libraries)
libraries(+atom,+list(atom)) – one
Creates a diagram for all loaded libraries using the specified options.
static
all_libraries(Options)
all_libraries(+list(compound)) – one
Creates a diagram for all loaded libraries using default options.
static
all_libraries – one
Creates a diagram for a library and its sub-libraries using the specified options.
static
rlibrary(Library,Options)
rlibrary(+atom,+list(compound)) – one
Creates a diagram for a library and its sub-libraries using default options.
static
rlibrary(Library)
rlibrary(+atom) – one
Creates a diagram for a library using the specified options.
static
library(Library,Options)
library(+atom,+list(compound)) – one
Creates a diagram for a library using default options.
static
library(Library)
library(+atom) – one
Creates a diagram for a set of directories using the specified options.
static
directories(Project,Directories,Options)
directories(+atom,+list(atom),+list(compound)) – one
Creates a diagram for a set of directories using the default options.
static
directories(Project,Directories)
directories(+atom,+list(atom)) – one
Creates a diagram for a directory using the specified options.
static
directory(Project,Directory,Options)
directory(+atom,+atom,+list(compound)) – one
Creates a diagram for a directory using default options.
static
directory(Project,Directory)
directory(+atom,+atom) – one
Creates a diagram for a set of files using the specified options. The file can be specified by name, basename, full path, or using library notation.
static
files(Project,Files,Options)
files(+atom,+list(atom),+list(compound)) – one
Creates a diagram for a set of files using the default options. The file can be specified by name, basename, full path, or using library notation.
static
files(Project,Files)
files(+atom,+list(atom)) – one
Creates a diagram for all loaded files using the specified options.
static
all_files(Options)
all_files(+list(compound)) – one
Creates a diagram for all loaded files using default options.
static
all_files – one
Returns the identifier of the object implementing the graph language currently being used. Fails if none is specified.
static
format_object(Object)
format_object(-object_identifier) – zero_or_one
Enumerates by backtracking the default options used when generating a diagram.
static
default_option(DefaultOption)
default_option(?compound) – zero_or_more
Returns a list of the default options used when generating a diagram.
static
default_options(DefaultOptions)
default_options(-list(compound)) – one
Merges the user options with the default options, returning the list of options used when generating a diagram. Path arguments in options are expanded to full paths. Also ensures that all directory paths end with a slash.
static
merge_options(UserOptions,Options)
merge_options(+list(compound),-list(compound)) – one
Generates diagram output for a library and its sub-libraries using the specified options.
static
output_rlibrary(Library,Path,Options)
output_rlibrary(+atom,+atom,+list(compound)) – one
Generates diagram output for a library using the specified options.
static
output_library(Library,Path,Options)
output_library(+atom,+atom,+list(compound)) – one
Generates diagram output for a list of files using the specified options.
static
output_files(Files,Options)
output_files(+list,+list(compound)) – one
Generates diagram output for a file using the specified options.
static
output_file(Path,Basename,Directory,Options)
output_file(+atom,+atom,+atom,+list(compound)) – one
Outputs external entities using the specified options.
static
output_externals(Options)
output_externals(+list(compound)) – one
Resets all temporary information used when generating a diagram.
static
reset – one
Outputs a graph node.
static
output_node(Identifier,Label,Caption,Contents,Kind,Options)
output_node(+nonvar,+nonvar,+nonvar,+list(nonvar),+atom,+list(compound)) – one
Enumerates, by backtracking, all saved edges.
static
edge(From,To,Labels,Kind,Options)
edge(?nonvar,?nonvar,?list(nonvar),?atom,?list(compound)) – zero_or_more
Outputs all edges.
static
output_edges(Options)
output_edges(+list(compound)) – one
Saves a graph edge.
static
save_edge(From,To,Labels,Kind,Options)
save_edge(+nonvar,+nonvar,+list(nonvar),+atom,+list(compound)) – one
True when the given file is not excluded from the generated output. Excluded files may be specified by full path or by basename and with or without extension.
static
not_excluded_file(ExcludedFiles,Path,Basename)
not_excluded_file(+list(atom),+atom,+atom) – zero_or_one
Returns the diagram name suffix.
static
diagram_name_suffix(Suffix)
diagram_name_suffix(-atom) – one
Returns the output file path.
static
output_file_path(Name,Options,Format,Path)
output_file_path(+atom,+list(atom),+object_identifier,-atom) – one
Locates a file given its name, basename, full path, or library notation representation.
static
locate_file(File,Basename,Extension,Directory,Path)
locate_file(+atom,+atom,+atom,+atom,-atom) – one
Converts an entity identifier to a ground term.
static
ground_entity_identifier(Kind,Identifier,GroundIdentifier)
ground_entity_identifier(+atom,+callable,-callable) – one
Adds urls/2 and tooltip/1 link options (for use by the graph language) based on the specified path to the list of options.
static
add_link_options(Path,Options,GraphOptions)
add_link_options(+atom,+list(compound),-list(compound)) – one
Table of saved edges.
dynamic
edge_(From,To,Labels,Kind,Options)
edge_(?nonvar,?nonvar,?list(nonvar),?atom,?list(compound)) – zero_or_more