diff options
Diffstat (limited to 'Lisp')
| -rw-r--r-- | Lisp/data-types.lisp | 20 | ||||
| -rw-r--r-- | Lisp/libobjcl.lisp | 26 | ||||
| -rw-r--r-- | Lisp/method-invocation.lisp | 8 | ||||
| -rw-r--r-- | Lisp/parameters.lisp | 10 | ||||
| -rw-r--r-- | Lisp/reader-syntax.lisp | 10 |
5 files changed, 37 insertions, 37 deletions
diff --git a/Lisp/data-types.lisp b/Lisp/data-types.lisp index 2a6f194..75b1e71 100644 --- a/Lisp/data-types.lisp +++ b/Lisp/data-types.lisp @@ -30,7 +30,7 @@ (defctype char-pointer :pointer) -;;;; (@* "Objective C object wrapper classes") +;;;; (@* "Objective-C object wrapper classes") (defclass c-pointer-wrapper () ((pointer :type c-pointer :reader pointer-to @@ -39,11 +39,11 @@ (defclass selector (c-pointer-wrapper) () - (:documentation "An Objective C method selector. + (:documentation "An Objective-C method selector. ## Description: -Method selectors are Objective C's equivalent to what Common Lisp calls +Method selectors are Objective-C's equivalent to what Common Lisp calls **symbols**. Their use is restricted to retrieving methods by name. __selector__ objects cannot be created by means of __make-instance__. @@ -56,17 +56,17 @@ Use __find-selector__ instead. (defclass id (c-pointer-wrapper) () - (:documentation "An instance of an Objective C class. + (:documentation "An instance of an Objective-C class. ## Description: The class __id__ serves as a general-purpose container for all kinds of -Objective C objects that are instances of some Objective C class, that +Objective-C objects that are instances of some Objective-C class, that is, neither primitive C values nor __selector__, __class__ or __exception__ objects. __id__ objects cannot be created by means of __make-instance__. Use -a suitable class method instead as you would in Objective C. +a suitable class method instead as you would in Objective-C. ## Examples: @@ -106,7 +106,7 @@ a suitable class method instead as you would in Objective C. :initarg :pointer)) (:report (lambda (condition stream) (format stream - "The Objective C runtime has issued an exception of ~ + "The Objective-C runtime has issued an exception of ~ type `~A'.~&~ Reason: ~A." (invoke-by-name @@ -115,17 +115,17 @@ a suitable class method instead as you would in Objective C. (invoke-by-name (invoke-by-name condition "reason") "UTF8String")))) - (:documentation "The condition type for Objective C exceptions. + (:documentation "The condition type for Objective-C exceptions. ## Description: -Whenever an Objective C call made by means of __invoke__ or +Whenever an Objective-C call made by means of __invoke__ or __invoke-by-name__ raises an exception, the exception is propagated to the Lisp side by being encapsulated in an __exception__ object and signaled. Note that it is currently impossible to directly extract the original -Objective C exception from an __exception__ object, although it might +Objective-C exception from an __exception__ object, although it might arguably be desirable to do so. As __exception__ objects behave just like __id__ objects in almost all circumstances, this is not much of a problem, though. If you really do need an __id__ instance rather than diff --git a/Lisp/libobjcl.lisp b/Lisp/libobjcl.lisp index 3d72783..3634cbf 100644 --- a/Lisp/libobjcl.lisp +++ b/Lisp/libobjcl.lisp @@ -102,15 +102,15 @@ (or (%objcl-get-nil) (make-pointer 0))) (defun initialise-runtime () - "Initialise the Objective C runtime. + "Initialise the Objective-C runtime. ## Description: The function __initialise-runtime__ makes all the necessary arrangements for object instantiation and method calls to work. In particular, it -creates an autorelease pool in order to make the use of Objective C's +creates an autorelease pool in order to make the use of Objective-C's semiautomatic reference counting memory management possible, which is -used internally by Objective CL. +used internally by Objective-CL. Note that, as the autorelease pool created by __initialise-runtime__ is currently only deallocated and its containees released when @@ -118,7 +118,7 @@ __shutdown-runtime__ is called, it is generally advisable to make use of AppKit's automatic creation and deletion auf autorelease pools, if possible. Naturally, AppKit-based applications need not worry about this, but be aware that they do need to call __initialise-runtime__ -before making any other Objective C calls. +before making any other Objective-C calls. ## See also: @@ -131,7 +131,7 @@ before making any other Objective C calls. (defun shutdown-runtime () - "Shut the Objective C runtime down. + "Shut the Objective-C runtime down. ## Description: @@ -141,8 +141,8 @@ autorelease pools created by __initialise-runtime__. Note that even if you make use of AppKit, which manages its own autorelease pools, you must call __initialise-runtime__ before making -any Objective C calls, and you should call __shutdown-runtime__ when you -are finished with Objective C, since Objective CL makes use of +any Objective-C calls, and you should call __shutdown-runtime__ when you +are finished with Objective-C, since Objective-CL makes use of autoreleased objects internally before you are even able to retrieve any objects or classes, let alone send messages to them. @@ -159,7 +159,7 @@ objects or classes, let alone send messages to them. (or null objc-class)) find-objc-class)) (defun find-objc-class (class-name &optional errorp) - "Retrieve an Objective C class by name. + "Retrieve an Objective-C class by name. ## Arguments and Values: @@ -173,7 +173,7 @@ C class whose name is *class-name*. ## Description: -If no Objective C class named by *class-name* is found, the behaviour +If no Objective-C class named by *class-name* is found, the behaviour depends on *errorp*: If *errorp* is **true**, an error is signaled. If *errorp* is **false** (which is the default), __nil__ is returned. @@ -206,10 +206,10 @@ __find-objc-class__. ## Rationale: -The first component of an Objective C class name is conventionally +The first component of an Objective-C class name is conventionally thought of as a namespace identifier. It is therefore sensible to expect it to be converted to **uppercase** by default, which is the -conventional case for namespace identifiers in Objective C." +conventional case for namespace identifiers in Objective-C." (let ((class (etypecase class-name @@ -217,7 +217,7 @@ conventional case for namespace identifiers in Objective C." (symbol (find-objc-class-by-name (symbol->objc-class-name class-name)))))) (or class (if errorp - (error "Found no Objective C class named ~S." + (error "Found no Objective-C class named ~S." class-name) nil)))) @@ -241,7 +241,7 @@ conventional case for namespace identifiers in Objective C." (symbol (find-objc-meta-class-by-name (symbol->objc-class-name meta-class-name)))))) (or meta-class (if errorp - (error "Found no Objective C metaclass named ~S." + (error "Found no Objective-C metaclass named ~S." meta-class-name) nil)))) diff --git a/Lisp/method-invocation.lisp b/Lisp/method-invocation.lisp index 1ff9c74..02f3002 100644 --- a/Lisp/method-invocation.lisp +++ b/Lisp/method-invocation.lisp @@ -20,11 +20,11 @@ ;;; (@* "Method invocation") (defun invoke (receiver message-start &rest message-components) - "Send a message to an Objective C instance. + "Send a message to an Objective-C instance. ## Arguments and Values: -*receiver* --- an Objective C wrapper object. +*receiver* --- an Objective-C wrapper object. *message-start* --- a **symbol**. @@ -118,11 +118,11 @@ separating parts by hyphens works nicely in all of the `:INVERT`, (defun invoke-by-name (receiver method-name &rest args) - "Send a message to an Objective C object by the name of the method. + "Send a message to an Objective-C object by the name of the method. ## Arguments and Values: -*receiver* --- an Objective C wrapper object. +*receiver* --- an Objective-C wrapper object. *method-name* --- a *selector designator*. diff --git a/Lisp/parameters.lisp b/Lisp/parameters.lisp index 9e512d7..482d6c6 100644 --- a/Lisp/parameters.lisp +++ b/Lisp/parameters.lisp @@ -27,7 +27,7 @@ ought not be there.") (defvar *trace-method-calls* nil - "Whether to print trace messages of all Objective C method calls. + "Whether to print trace messages of all Objective-C method calls. ## Value Type: @@ -43,9 +43,9 @@ __nil__. Sometimes it is useful to find out exactly which message calls are done in a piece of code that is executed. If __*trace-method-calls*__ is -**true**, Objective CL tries to print trace messages to +**true**, Objective-CL tries to print trace messages to __*terminal-io*__ that can be useful for understanding the behaviour -both of application code and the internals of Objective CL itself. +both of application code and the internals of Objective-CL itself. If __*trace-method-calls*__ is __nil__ (which is the default), no trace messages are printed. @@ -53,7 +53,7 @@ messages are printed. Note that there is currently no way of determining the receivers of messages. As this limitation severely limits the usefulness of the trace messages, it is expected to be lifted in a future version of -Objective CL. +Objective-CL. ## Examples: @@ -78,7 +78,7 @@ Objective CL. (setq *trace-method-calls* nil) \(Note that objects created by a call to `new' are not retained, because -it is the user's (that is, the Objective CL framework's) responsibility +it is the user's (that is, the Objective-CL framework's) responsibility to release them, while convenience constructors such as `string' return objects that have already had `autorelease' called on them and must thus be retained not to be garbage-collected prematurely.) diff --git a/Lisp/reader-syntax.lisp b/Lisp/reader-syntax.lisp index d3e3195..722f79b 100644 --- a/Lisp/reader-syntax.lisp +++ b/Lisp/reader-syntax.lisp @@ -19,14 +19,14 @@ (defun install-reader-syntax () - "Install an Objective-C-like **reader macro** for Objective C method + "Install an Objective-C-like **reader macro** for Objective-C method calls. ## Description: The **reader macro** installed by __install-reader-syntax__ closely -resembles the conventional method call syntax of Objective C. In fact, -any differences between standard Objective C method call syntax and this +resembles the conventional method call syntax of Objective-C. In fact, +any differences between standard Objective-C method call syntax and this **reader macro** that are not documented here are probably bugs and should be reported to the maintainer. @@ -100,7 +100,7 @@ arguments to __invoke-by-name__. ## Rationale: -Objective C method names tend to be relatively verbose and are +Objective-C method names tend to be relatively verbose and are frequently composed of many short words like \"of\" and \"by\". As a result, using __invoke__ can be quite cumbersome at times and waste screen real estate. One need only compare the example call @@ -116,7 +116,7 @@ with its reader macro counterpart to be able to see an improvement in length as well as readability. In any case, it is a matter of taste whether to prefer __invoke__ or -Objective C syntax as it is whether to prefer the standard Common Lisp +Objective-C syntax as it is whether to prefer the standard Common Lisp __loop__ facility or a widespread and well-known alternative called \"Iterate\". In both cases, one can argue that one of the forms sacrifices an elusive quality of \"lispiness\" as well as text editor |