Handle cross-reference files
Operations Summary: | |
__init__(self) [Source] | |
load(self, filename) Loads data from the given filename [Source] | |
get_info(self, name) Retrieves the info for the give name. [Source] | |
get_possible_names(self, name) Returns a list of possible scoped names that end with the given name. [Source] | |
get_page_for(self, name) Returns the number of the page that the xref info for the given name is on, or None if not found. [Source] | |
get_page_info(self) Returns a list of pages, each consisting of a list of names on that page. [Source] | |
get_all_names(self) Returns a list of all names [Source] |
Operation Details: |
Retrieves the info for the give name. The info is returned as a 3-tuple of [list of definitions], [list of calls], [list of other references]. The element of each list is another 3-tuple of (file, line, scope of reference). The last element is the scope in which the reference was made, which is often a function scope, denoted as starting with a backtick, eg: Builder::`add_operation(std::string). Returns None if there is no xref info for the given name.
Returns a list of possible scoped names that end with the given name. These scoped names can be passed to get_info(). Returns None if there is no scoped name ending with the given name.
Returns a list of pages, each consisting of a list of names on that page. This method is intended to be used by whatever generates the files...