coops-utils

  1. coops-utils
  2. Documentation
    1. Extras
      1. Argument Conventions
      2. Usage
      3. slot@
      4. make/copy
      5. describe-object
    2. Introspection
      1. Argument Conventions
      2. Usage
      3. instance-of?
      4. class?
      5. instance?
      6. primitive-instance?
      7. generic?
      8. method?
      9. class-precedence-list
      10. class-slots
      11. class-direct-supers
      12. class-direct-slots
      13. generic-anonymous?
      14. generic-name
      15. generic-specialized-arguments
      16. generic-primary-methods
      17. generic-before-methods
      18. generic-after-methods
      19. generic-around-methods
      20. method-specializers
      21. method-procedure
  3. Usage
  4. Examples
  5. Notes
  6. Requirements
  7. Bugs and Limitations
  8. Author
  9. Version history
  10. License

Documentation

Some coops stuff.

Extras

Miscellaneous coops extensions.

Argument Conventions

INSTANCE is a coops-instance.

SLOT is a symbol.

INITFORM is 'SLOT OBJECT.

Usage

(require-extension coops-extras)

slot@

The slot accessor recursion.

[syntax] (slot@ INSTANCE SLOT ...) => *

Returns the slot value of the N'th named slot from INSTANCE.

[syntax] (slot@ INSTANCE SLOT ... [= OBJECT])

Sets the slot value of the N'th named slot of INSTANCE to OBJECT.

Example:

(use coops coops-extras)

; Needlessly complex for example

(define-class <first> () (next))
(define-class <second> (<first>) ())
(define-class <third> (<second>) ())

(define 1st (make <first> 'next (make <second> 'next (make <third> 'next "the end"))))

(slot@ 1st next next next) ;=> "the end"

(slot@ 1st next next next = "still the end")
(slot@ 1st next next next) ;=> "still the end"

(From '@' macro by Dan Muresan.)

make/copy

[procedure] (make/copy INSTANCE [INITFORM ...]) => coops-instance

Returns a copy of the object INSTANCE except where an INITFORM overrides an existing SLOT value of the INSTANCE.

describe-object

[procedure] (describe-object INSTANCE [OUT (current-output-port)])

Prints information about the INSTANCE to the output-port OUT.

describe-object is a generic-procedure specializing the first argument.

A more detailed print-object for use in a REPL.

Introspection

Some TInyCLOS inspired property readers.

Argument Conventions

Provides predicates and read accessors for coops objects.

OBJECT is a Scheme object.

CLASS is a coops class.

GENERIC is a coops generic-procedure.

METHOD is a coops generic-procedure method. Do not apply any but the supplied API to instances of this type!

Usage

(require-extension coops-introspection)

instance-of?

[procedure] (instance-of? OBJECT CLASS) => boolean

Is OBJECT an instance of the CLASS>?

class?

[procedure] (class? OBJECT) => boolean

Is OBJECT an instance of the <standard-class>?

[procedure] (check-class LOC OBJ [ARGNAM]) => *
[procedure] (error-class LOC OBJ [ARGNAM])

instance?

[procedure] (instance? OBJECT) => boolean

Is OBJECT not an instance of the <standard-class>?

[procedure] (check-instance LOC OBJ [ARGNAM]) => *
[procedure] (error-instance LOC OBJ [ARGNAM])

primitive-instance?

[procedure] (primitive-instance? OBJECT) => boolean
[procedure] (primitive? OBJECT) => boolean

Is OBJECT an instance of the <primitive-object> class?

generic?

[procedure] (generic? OBJECT) => boolean

Synonym for generic-procedure?.

[procedure] (check-generic LOC OBJ [ARGNAM]) => *
[procedure] (error-generic LOC OBJ [ARGNAM])

method?

[procedure] (method? OBJECT) => boolean

Is OBJECT a method of a generic-procedure?

[procedure] (check-method LOC OBJ [ARGNAM]) => *
[procedure] (error-method LOC OBJ [ARGNAM])

class-precedence-list

[procedure] (class-precedence-list CLASS) => (list-of class)
[procedure] (class-cpl CLASS) => (list-of class)
[procedure] (class-supers CLASS) => (list-of class)

Returns the superclasses of CLASS.

class-slots

[procedure] (class-slots CLASS) => (list-of symbol)

Returns the slot names of CLASS.

class-direct-supers

[procedure] (class-direct-supers CLASS) => (list-of class)

Returns the uninherited superclasses of CLASS.

class-direct-slots

[procedure] (class-direct-slots CLASS) => (list-of symbol)

Returns the uninherited slot names of CLASS.

generic-anonymous?

[procedure] (generic-anonymous? GENERIC) => boolean

Is GENERIC an unnamed generic-procedure.

generic-name

[procedure] (generic-name GENERIC) => (union #f symbol)

Returns the name of GENERIC. The name is #f for an anonymous generic procedure.

generic-specialized-arguments

[procedure] (generic-specialized-arguments GENERIC) => (list-of symbol)

The arguments that GENERIC is specialized upon.

generic-primary-methods

[procedure] (generic-primary-methods GENERIC) => (list-of method)
[procedure] (generic-methods GENERIC) => (list-of method)

Returns the list of primary: methods for GENERIC.

generic-before-methods

[procedure] (generic-before-methods GENERIC) => (list-of method)

Returns the list ofbefore: methods for GENERIC.

generic-after-methods

[procedure] (generic-after-methods GENERIC) => (list-of method)

Returns the list of after: methods for GENERIC.

generic-around-methods

[procedure] (generic-around-methods GENERIC) => (list-of method)

Returns the list of around: methods for GENERIC.

method-specializers

[procedure] (method-specializers METHOD) => (list-of class)

Returns the classes that specialize METHOD.

method-procedure

[procedure] (method-procedure METHOD) => procedure

Returns the procedure for METHOD.

Usage

(require-extension coops-utils)

Examples

(use coops coops-introspection)

(define (print-methods generic)
  (for-each
    (lambda (m)
      (print
        (generic-name generic)
        " specialized by " (method-specializers m)
        " as " (method-procedure m)))
    (generic-methods generic)) )

Notes

While useful it relies on knowledge of the internals of the coops implementation and Chicken. It is very brittle, especially the generics portion.

Suggested only for use during REPL development with coops.

Requirements

coops type-checks

Bugs and Limitations

Author

Kon Lovett

Version history

1.0.0
Release for coops 1.92
0.0.3
* UNMAINTAINED *
0.0.2
0.0.1

License

Copyright (C) 2010 Kon Lovett. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the Software), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ASIS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.