Documentation

SCKSourceCollection class documentation

SCKSourceCollection : NSObject

AuthorsGenerated by builder
Declared inSCKSourceCollection.h

Overview

A source collection encapsulates a group of (potentially cross-referenced) source code files.


Default

- (SCKClass *) classForName: (NSString *)aName

Returns an existing class if one was already parsed under the same name in some other files, otherwise returns a new one.

If a new SCKClass object is returned, subsequent uses will return the same instance until -clear is called.

    - (SCKProtocol *) protocolForName: (NSString *)aName

    Returns an existing protocol if one was already parsed under the same name in some other files, otherwise returns a new one.

    If a new SCKProtocol object is returned, subsequent uses will return the same instance until -clear is called.

      - (SCKFunction *) functionForName: (NSString *)aName

      Returns an existing global function if one was already parsed under the same name in some other files, otherwise returns a new one.

      If a new SCKFunction object is returned, subsequent uses will return the same instance until -clear is called.

      C static functions are available per file through -[SCKClangSourceFile functions] .

        - (SCKGlobal *) globalForName: (NSString *)aName

        Returns an existing global variable if one was already parsed under the same name in some other files, otherwise returns a new one.

        If a new SCKGlobal object is returned, subsequent uses will return the same instance until -clear is called.

          - (SCKSourceFile *) sourceFileForPath: (NSString *)aPath

          Generates a new source file object corresponding to the specified on-disk file. The returned object is not guaranteed to be unique - subsequent calls with the same argument will return the same object.

            - (SCKIndex *) indexForFileExtension: (NSString *)extension
            Description forthcoming.
              - (void) clear
              Description forthcoming.