category
diagram(Format)¶
Common predicates for generating diagrams.
staticPublic interface¶
libraries/3¶
Creates a diagram for a set of libraries using the specified options. The Project argument is used as a prefix for the diagram file name.
staticlibraries(Project,Libraries,Options)libraries(+atom,+list(atom),+list(compound)) - onelibraries/2¶
Creates a diagram for a set of libraries using the default options. The Project argument is used as a prefix for the diagram file name.
staticlibraries(Project,Libraries)libraries(+atom,+list(atom)) - onelibraries/1¶
Creates a diagram for a set of libraries using the default options. The prefix “libraries” is used for the diagram file name.
staticlibraries(Libraries)libraries(+list(atom)) - oneall_libraries/1¶
Creates a diagram for all loaded libraries using the specified options.
staticall_libraries(Options)all_libraries(+list(compound)) - oneall_libraries/0¶
Creates a diagram for all loaded libraries using default options.
staticall_libraries - onerlibrary/2¶
Creates a diagram for a library and its sub-libraries using the specified options.
staticrlibrary(Library,Options)rlibrary(+atom,+list(compound)) - onerlibrary/1¶
Creates a diagram for a library and its sub-libraries using default options.
staticrlibrary(Library)rlibrary(+atom) - onelibrary/2¶
Creates a diagram for a library using the specified options.
staticlibrary(Library,Options)library(+atom,+list(compound)) - onelibrary/1¶
Creates a diagram for a library using default options.
staticlibrary(Library)library(+atom) - onedirectories/3¶
Creates a diagram for a set of directories using the specified options. The Project argument is used as a prefix for the diagram file name.
staticdirectories(Project,Directories,Options)directories(+atom,+list(atom),+list(compound)) - onedirectories/2¶
Creates a diagram for a set of directories using the default options. The Project argument is used as a prefix for the diagram file name.
staticdirectories(Project,Directories)directories(+atom,+list(atom)) - onedirectory/3¶
Creates a diagram for a directory using the specified options. The Project argument is used as a prefix for the diagram file name.
staticdirectory(Project,Directory,Options)directory(+atom,+atom,+list(compound)) - onedirectory/2¶
Creates a diagram for a directory using default options. The Project argument is used as a prefix for the diagram file name.
staticdirectory(Project,Directory)directory(+atom,+atom) - onedirectory/1¶
Creates a diagram for a directory using default options. The name of the directory is used as a prefix for the diagram file name.
staticdirectory(Directory)directory(+atom) - onefiles/3¶
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. The Project argument is used as a prefix for the diagram file name.
staticfiles(Project,Files,Options)files(+atom,+list(atom),+list(compound)) - onefiles/2¶
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. The Project argument is used as a prefix for the diagram file name.
staticfiles(Project,Files)files(+atom,+list(atom)) - onefiles/1¶
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. The prefix “files” is used for the diagram file name.
staticfiles(Files)files(+list(atom)) - oneall_files/1¶
Creates a diagram for all loaded files using the specified options.
staticall_files(Options)all_files(+list(compound)) - oneall_files/0¶
Creates a diagram for all loaded files using default options.
staticall_files - oneformat_object/1¶
Returns the identifier of the object implementing the graph language currently being used. Fails if none is specified.
staticformat_object(Object)format_object(-object_identifier) - zero_or_onediagram_name_suffix/1¶
Returns the diagram name suffix.
staticdiagram_name_suffix(Suffix)diagram_name_suffix(-atom) - onedefault_option/1¶
Enumerates by backtracking the default options used when generating a diagram.
staticdefault_option(DefaultOption)default_option(?compound) - zero_or_moredefault_options/1¶
Returns a list of the default options used when generating a diagram.
staticdefault_options(DefaultOptions)default_options(-list(compound)) - oneProtected interface¶
merge_options/2¶
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.
staticmerge_options(UserOptions,Options)merge_options(+list(compound),-list(compound)) - oneoutput_rlibrary/3¶
Generates diagram output for a library and its sub-libraries using the specified options.
staticoutput_rlibrary(Library,Path,Options)output_rlibrary(+atom,+atom,+list(compound)) - oneoutput_library/3¶
Generates diagram output for a library using the specified options.
staticoutput_library(Library,Path,Options)output_library(+atom,+atom,+list(compound)) - oneoutput_files/2¶
Generates diagram output for a list of files using the specified options.
staticoutput_files(Files,Options)output_files(+list,+list(compound)) - oneoutput_file/4¶
Generates diagram output for a file using the specified options.
staticoutput_file(Path,Basename,Directory,Options)output_file(+atom,+atom,+atom,+list(compound)) - oneoutput_externals/1¶
Outputs external entities using the specified options.
staticoutput_externals(Options)output_externals(+list(compound)) - onereset/0¶
Resets all temporary information used when generating a diagram.
staticreset - oneoutput_node/6¶
Outputs a graph node.
staticoutput_node(Identifier,Label,Caption,Contents,Kind,Options)output_node(+nonvar,+nonvar,+nonvar,+list(nonvar),+atom,+list(compound)) - oneedge/5¶
Enumerates, by backtracking, all saved edges.
staticedge(From,To,Labels,Kind,Options)edge(?nonvar,?nonvar,?list(nonvar),?atom,?list(compound)) - zero_or_moreoutput_edges/1¶
Outputs all edges.
staticoutput_edges(Options)output_edges(+list(compound)) - onesave_edge/5¶
Saves a graph edge.
staticsave_edge(From,To,Labels,Kind,Options)save_edge(+nonvar,+nonvar,+list(nonvar),+atom,+list(compound)) - onenot_excluded_file/3¶
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.
staticnot_excluded_file(ExcludedFiles,Path,Basename)not_excluded_file(+list(atom),+atom,+atom) - zero_or_oneoutput_file_path/4¶
Returns the output file path.
staticoutput_file_path(Name,Options,Format,Path)output_file_path(+atom,+list(atom),+object_identifier,-atom) - onelocate_file/5¶
Locates a file given its name, basename, full path, or library notation representation.
staticlocate_file(File,Basename,Extension,Directory,Path)locate_file(+atom,+atom,+atom,+atom,-atom) - oneground_entity_identifier/3¶
Converts an entity identifier to a ground term.
staticground_entity_identifier(Kind,Identifier,GroundIdentifier)ground_entity_identifier(+atom,+callable,-callable) - onefilter_file_extension/3¶
Filters the file name extension depending on the file_extensions/1 option.
staticfilter_file_extension(Basename,Options,Name)filter_file_extension(+atom,+list(compound),-atom) - oneadd_link_options/3¶
Adds urls/2 and tooltip/1 link options (for use by the graph language) based on the specified path to the list of options.
staticadd_link_options(Path,Options,GraphOptions)add_link_options(+atom,+list(compound),-list(compound)) - oneomit_path_prefix/3¶
Removes a prefix from a path, returning the relative path, when using the option omit_path_prefixes/1. Used mainly for contructing file node identitifers and captions.
staticomit_path_prefix(Path,Options,Relative)omit_path_prefix(+atom,+list(compound),-atom) - oneadd_node_zoom_option/5¶
Adds node zoom options when using the zoom option.
staticadd_node_zoom_option(Identifier,Suffix,Options,NodeOptions0,NodeOptions)add_node_zoom_option(+atom,+atom,+list(compound),+list(compound),-list(compound)) - onePrivate predicates¶
edge_/5¶
Table of saved edges.
dynamicedge_(From,To,Labels,Kind,Options)edge_(?nonvar,?nonvar,?list(nonvar),?atom,?list(compound)) - zero_or_moreOperators¶
(none)
Remarks¶
(none)