Documentation

API Overview

Classes, Protocols and Categories by Groups

Misc

SCKSyntaxHighlighter

The SCKSyntaxHighlighter class is responsible for mapping from the semantic attributes defined by an SCKSourceFile subclass to (configurable) presentation attributes.

SCKSourceFile

The SCKSyntaxHighlighter class is responsible for performing lexical and syntax highlighting on a single source file. Highlighting involves three steps:

1) Lexical markup. 2) Syntax markup. 3) Presentation markup.

Lexical highlighting is faster than full syntax highlighting, so it can be used more frequently in an editor. For example, you might run the lexical highlighter after every key press but defer the syntax highlighter until after a whitespace character had been entered.

The third step is optional. If you are not using AppKit, then you can ignore it and handle the presentation yourself. This is useful, for example, when generating semantic HTML from a source file.

SCKSourceLocation

Description forthcoming.

SCKFileBrowsingProjectContent

Content class to present the project files.

SCKProject

SCKProject represents an IDE project that tracks several source files usually put together in a directory.

In addition, SCKProject provides access to the program components declared in the project files. See -classes , -functions and -globals .

Custom presentation in the IDE source list (or similar UI) are supported by setting a custom project content class, that implements the collection protocols on the behalf of SCKProject instance. The collection returned by -content depends on the class set with -setContentClass: .

SCKSymbolBrowsingProjectContent

Content class to present the project program components grouped into classes, functions and globals.

<SCKProjectContent>

Protocol to which SCKProject content class must conform to. See -[SCKProject setContentClass:] .

SCKClangSourceFile

SCKSourceFile implementation that uses clang to perform handle Objective C[++] files.

SCKCodeCompletionResult

Description forthcoming.

SCKBundle

Description forthcoming.

SCKCategory

Description forthcoming.

SCKClass

Description forthcoming.

SCKEnumeration

Description forthcoming.

SCKEnumerationValue

Enumerated type value. This encapsulates the name and value of the enumeration value.

SCKFunction

Description forthcoming.

SCKGlobal

Description forthcoming.

SCKIvar

Description forthcoming.

SCKMacro

Description forthcoming.

SCKMethod

Description forthcoming.

SCKProgramComponent

SCKProgramComponent is an abstract class representing properties of some component of a program. This includes classes, functions, methods, and so on.

Program components in SourceCodeKit can be obtained both by runtime introspection and by parsing source code.

SCKProperty

Description forthcoming.

SCKProtocol

Description forthcoming.

SCKTypedProgramComponent

A program component with a type.

SCKSourceCollection

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