coops-utils | chickadee

Outdated egg!

This is an egg for CHICKEN 4, the unsupported old release. You're almost certainly looking for the CHICKEN 5 version of this egg, if it exists.

If it does not exist, there may be equivalent functionality provided by another egg; have a look at the egg index. Otherwise, please consider porting this egg to the current version of CHICKEN.

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)

make/copy

(make/copy INSTANCE [INITFORM ...]) --> coops-instanceprocedure: Returns a copy of the object INSTANCE except where an INITFORM overrides an existing SLOT value of the INSTANCE.

describe-object

describe-object INSTANCE #!optional OUT current-output-portprocedure

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.

describe-object-slot

(describe-object-slot INSTANCE SLOT [NAME-MAXLEN 32 [OUT (current-output-port)]])procedure

Prints information about the INSTANCE's SLOT to the output-port OUT. Does not append a (newline).

NAME-MAXLEN is the maximum number of single-width characters in a slotname.

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?

instance-of? OBJECT CLASSprocedure: Is OBJECT an instance of the CLASS>?

class?

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

check-class LOC OBJ #!optional ARGNAMprocedure
error-class LOC OBJ #!optional ARGNAMprocedure

instance?

instance? OBJECTprocedure: Is OBJECT an instance of a basic class. Neither an instance of the <standard-class> or a primitive such as boolean or vector?

check-instance LOC OBJ #!optional ARGNAMprocedure
error-instance LOC OBJ #!optional ARGNAMprocedure

primitive-instance?

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

generic?

generic? OBJECTprocedure: Synonym for generic-procedure?.

check-generic LOC OBJ #!optional ARGNAMprocedure
error-generic LOC OBJ #!optional ARGNAMprocedure

method?

method? OBJECTprocedure

Is OBJECT a method of a generic-procedure?

"Note" that the current implementation of methods does not depend on the type system. This function only validates the form of the argument and can be fooled.

check-method LOC OBJ #!optional ARGNAMprocedure
error-method LOC OBJ #!optional ARGNAMprocedure

class-precedence-list

class-precedence-list CLASSprocedure: Returns the superclasses of CLASS.

class-slots

class-slots CLASSprocedure: Returns the slot names of CLASS.

class-direct-supers

class-direct-supers CLASSprocedure: Returns the uninherited superclasses of CLASS.

class-direct-slots

class-direct-slots CLASSprocedure: Returns the uninherited slot names of CLASS.

generic-anonymous?

generic-anonymous? GENERICprocedure: Is GENERIC an unnamed generic-procedure.

generic-name

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

generic-specialized-arguments

generic-specialized-arguments GENERICprocedure: The arguments that GENERIC is specialized upon.

generic-primary-methods

generic-primary-methods GENERICprocedure: Returns the list of #:primary methods for GENERIC.

generic-before-methods

generic-before-methods GENERICprocedure: Returns the list of #:before methods for GENERIC.

generic-after-methods

generic-after-methods GENERICprocedure: Returns the list of #:after methods for GENERIC.

generic-around-methods

generic-around-methods GENERICprocedure: Returns the list of #:around methods for GENERIC.

method-specializers

method-specializers METHODprocedure: Returns the classes that specialize METHOD.

method-procedure

method-procedure METHODprocedure: Returns the procedure for METHOD.

TinyClos Introspection

TInyCLOS synonyms.

Usage

(require-extension coops-introspection-tinyclos)

class-cpl

class-cpl CLASSprocedure: See coops-introspection#coops-introspection#class-precedence-list.

class-supers

class-supers CLASSprocedure: See coops-introspection#class-precedence-list.

primitive?

primitive? OBJECTprocedure: See coops-introspection#primitive-instance?.

generic-methods

generic-methods GENERICprocedure: See coops-introspection#generic-primary-methods.

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-primary-methods generic)) )

Bugs and Limitations

The introspection API is brittle, especially the generics portion.

Suggested only for use during REPL development with coops.

Version history

1.1.0: Collect TinyCLOS synonyms in own module: coops-introspection-tinyclos; reexport by coops-utils DEPRECATED.
1.0.4: Remove test, remove inlines.
1.0.3: Add test, fix library requirement.
1.0.2: Fix make/copy for objects with uninitialized slots, thanks to Sandra Snan
1.0.1: Fix class-direct-supers and class-direct-slots, minor internal optimization.
1.0.0: Release for coops 1.92
0.0.3: * UNMAINTAINED *
0.0.2
0.0.1

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.

chickadee » coops-utils

Identifier search

TOC »

Contents »