richard@brainstorm.co.uk
)Copyright: (C) 2001 Free Software Foundation, Inc.
- Declared in:
- AGSIndex.h
Standards:
- MacOS-X
- OpenStep
- GNUstep
This class is used to build and manipulate a dictionary
of cross-reference information.
The references are
held in a nested dictionary with strings at the leaves
(persisted to 'projectName'.igsdoc) -
method : method-name - {class-name file-name}
method : method-name - {protocol-name file-name}
ivariable : variable-name - {class-name
file-name}
class : class-name - file-name
category : category-name - file-name
protocol : protocol-name - file-name
function
: function-name - file-name
type : type-name -
file-name
constant : constant-name -
file-name
variable : variable-name -
file-name
entry : entry-name - {file-name
ref}
label : label-name - {file-name ref}
contents : ref - text
super : class-name -
superclass-name
categories :
class-name - {category-name file-name}
unitmethods : unit-name - method-name
classvars : class-name - variables-name
title : file-name - text
source : file-name -
array-of-source-files
Informal protocols are not explicitly marked in source, but are inferred to be those categories of NSObject that receive no implementation. AGSOutput finds and accumulates them; autogsdoc passes them here, where each entry is found in the 'category' section of our refs and copied over to the protocol section.
Description forthcoming.
Given the root node of a gsdoc document, we traverse the tree looking for interesting nodes, and recording their names in a dictionary of references.
Merge a dictionary containing references into the current index. The flag may be used to specify that references being merged in should override any pre-existing values.
Description forthcoming.
Return a list of output files for the header
Description forthcoming.
Description forthcoming.
Description forthcoming.
Set up an array listing the output files for a particular header.
Description forthcoming.
Set up an array listing the source files for a particular header.
Set up a reference for something inside a unit (class, category or protocol) We store 'method' and 'ivariable' by ref then unit (class), but we store 'unitmethods' * and 'classvars' by unit then ref.
Return a list of source files for the header.
Return a dictionary containing info on all the units containing the specified method or instance variable.
Return the name of the file containing the
ref and return the unit name in which it
was found. If not found, return nil
for
both.
If ref does not occur in the
index, this method returns nil
.
If the method was given no unit to look in, then it will
succeed and return a value if (and only if) the
required reference is defined only in one unit.
If ref exists in the unit
specified, the method will succeed and return
the name of the file in which the reference is located.
If the unit that the method has been asked to
look in is a category or protocol which is not found,
the lookup must fail.
If the unit is a class,
and ref was not found in it, then this
method will succeed if ref can be found
in any superclass of the class.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.