LibrarySearch

LibrarySearch Class

The methods in LibrarySearch class perform searches on the Ctalk reference documentation. The documentation is derived from this reference and is formatted to be easily searchable. Ctalk installs the documentation files during the installation process.

These methods are also used in the searchlib program to search the documentation.

Note that these methods raise an exception if they can’t open the documentation file, in which case they return an empty string and leave it up to the calling function or method to handle the exception.

The searchlib program is described in the searchlib(1) man page and the ctalktools Texinfo documentation.

Instance Methods

cAPIFunctionSearch (String docPath, String search_pattern)

Returns a String that contains the results of a search for the C API function or functions that match search_pattern.

methodSearch (String docPath, String search_pattern)

Search the class library’s method prototypes for search_pattern. Returns a String object with the results. Note that this function is designed to be rather inclusive; it searches the entire method prototype for a pattern, which may include the receiver class’s name or any parameter name(s). So including the receiver class name is a search is perfectly valid - the syntax of a method prototype in the documentation is:

<receiver_class>::<method_selector> (param_list)