SimpleClass v1.0 

 The Simple Development Library [incr Tcl] classes declaration 

Project: the Simple Development Library.

Table of contents

1. Package description

Synopsis: the Simple Development Library [incr Tcl] classes declaration.

Keywords: object oriented, class, method, [incr Tcl], [incr Tk], widget and megawidget.

1.1 Overview

This package provides a way to declare [incr Tcl] classes and [incr Tk] megawidgets in an homogeneous, easily parseable, fully introspectable way. It allows to substitute the comment block which is usually placed on top of each declaration by Tcl-handled text.

Classes are declared with a single command (declare-class). Every single component needed to either make the class work (such as its attributes or methods) or to document it (metadata, such as the class synopsis) is provided as arguments to that command. Components can be fully introspected, but metadata is only available if The Simple Development Library -storemetadata option is set when the class is declared.

Procedures are provided to declare and delete classes and get information about them.

1.2 Usage

Use declare-class to declare a class. Declared classes metadata can be obtained via the ::Simple::Class::information metadata procedure. Other subcommands of this procedure provide information about declared classes: exists, classes, objects, errors, exportedcommands, aliases, variables, attributes, itkoptions, itkcomponents, commands, methods and api. The ::Simple::ItkOption::information and ::Simple::ItkComponent::information procedures provide subcommand to quet information about the [incr Tk] options and components of an [incr Tk] megawidget, respectively.

Use ::Simple::Class::delete to delete the class.

1.3 Examples

# Install the package
package require SimpleClass
::Simple::Package::require-and-install SimpleClass

# Let's store the metadata
::Simple::configure -storemetadata true

# Declare a class
declare-class {

   Class

} -synopsis {

   This is the class synopsis.

} -variable {

   {
      Variable
   } -description {
      This is a class variable
   } -value 50

} -attribute {

   {
      Attribute
   } -description {
      This is a class attribute
   } -value 50

} -error {

   {
      Error
   } -message {
      Class error
   } -explanation {
      This is a class error.
   }

} -command {

   {

      command

   } -synopsis {

      This is the command synopsis.

   } -arguments {
      {-modify     boolflag   {Whether to modify the class variable}}
      { value      integer    {New class variable value}}
   } -effects {

      * Modifies the class variable if -modify is given.

   } -body {

      # Must modify the class variable
      if {[::Simple::Argument::information flaggiven -modify]} {

         # Modify it
         set ::Class::Variable $value
      }

      # Class variable value too big
      if {$::Class::Variable > 99} {

         # Throw the class error
         ::Simple::Error::throw ::Class::Error

      # Correct class variable value
      } else {

         # Display it
         puts "Class variable = $::Class::Variable"
      }
   }

} -method {

   {

      method

   } -synopsis {

      This is the method synopsis.

   } -arguments {
      {-modify     boolflag   {Whether to modify the object attribute}}
      { value      integer    {New object attribute value}}
   } -effects {

      * Modifies the object attribute if -modify is given.

   } -body {

      # Must modify the object attribute
      if {[::Simple::Argument::information flaggiven -modify]} {

         # Modify it
         set Attribute $value
      }

      # Object attribute value too big
      if {$Attribute > 99} {

         # Throw the class error
         ::Simple::Error::throw ::Class::Error

      # Correct object attribute value
      } else {

         # Display it
         puts "Object $this attribute = $Attribute"
      }
   }
}

# Invoke the class command

# This displays the following:
#   |Class variable = 50
::Class::command 77

# This displays the following:
#   |Class variable = 88
::Class::command -modify 88

# This displays the following:
#   |Class error (::Class::Error)
catch {::Class::command -modify 120} result
puts "$result ($::errorCode)"

# Introspect the class
# This displays the following:
#   |Class errors: ::Class::Error
#   |Class commands: ::Class::command
#   |Class methods: ::Class::method
#   |Class variables: ::Class::Variable
#   |Class attributes: ::Class::Attribute
puts "Class errors: [::Simple::Class::information errors Class]"
puts "Class commands: [::Simple::Class::information commands Class]"
puts "Class methods: [::Simple::Class::information methods Class]"
puts "Class variables: [::Simple::Class::information variables Class]"
puts "Class attributes: [::Simple::Class::information attributes Class]"

# Obtain the class metadata
# This displays the following:
#   |-assumptions = 
#   |  -classtype = 
#   |  -copyright = 
#   |    -details = 
#   |    -effects =
#   |   -examples = 
#   |    -extends = 
#   |    -history = 
#   |   -keywords = 
#   |-limitations = 
#   |   -overview = 
#   |    -project = 
#   | -references = 
#   |    -remarks = 
#   |  -resources = 
#   | -stereotype = 
#   |   -synopsis = This is the command synopsis.
#   |       -todo = 
#   |      -usage = 
#   |    -version = 1.0
array set metadata [::Simple::Class::information metadata Class]
foreach element [lsort [array names metadata]] {
   puts [format {%12s = %s} -$element $metadata($element)]
}

# Create two objects of the class
Class object1
Class object2

# Invoke the first object methods
# This displays the following:
#   |Object ::object1 attribute = 50
#   |Object ::object1 attribute = 88
object1 method 77
object1 method -modify 88

# Invoke the second object methods
# This displays the following:
#   |Object ::object2 attribute = 50
#   |Object ::object2 attribute = 22
object2 method 11
object1 method -modify 22

# This displays the following:
#   |Class error (::Class::Error)
catch {object1 method -modify 120} result
puts "$result ($::errorCode)"

1.4 History

1.5 Copyright

Copyright (C) 1999-2005, Juan C. Gil (jgil@gmv.es).

2. Package public API

Paradigm: procedural.

Requisites: SimpleDeclare 1.0 and Itcl.

2.1 Types

None.

2.2 Options

2.2.1 -debug

Type: extbool.

Value: false.

Description: whether to create a %debug% debug method for every class.

2.3 Namespaces

1. ::Simple::Class

2. ::Simple::Class::Priv

3. ::Simple::ItkOption

4. ::Simple::ItkComponent

2.4 Commands

2.4.1 ::Simple::Class::cget ?-debug?

Synopsis: gets the package options.

Details: see section 4.1.

2.4.2 ::Simple::Class::configure ?-debug extbool?

Synopsis: configures the package options.

Details: see section 4.2.

2.4.3 declare-class class ?-version version? ?-project string? ?-synopsis string? ?-overview string? ?-usage string? ?-api string? ?-keywords list? ?-examples string? ?-classtype type? ?-stereotype choice? ?-extends qualifiedname-list? ?-debug extbool? ?-error declaration? ?-variable declaration? ?-attribute declaration? ?-itkoption declaration? ?-itkcomponent declaration? ?-command declaration? ?-method declaration? ?-assumptions string? ?-resources string? ?-limitations string? ?-effects string? ?-details string? ?-references string? ?-remarks string? ?-todo string? ?-history string? ?-copyright string? ?-body script?

Synopsis: declares a class.

Details: see section 4.3.

2.4.4 ::Simple::Class::delete class

Synopsis: deletes an [incr Tcl] class.

Details: see section 4.4.

2.4.5 ::Simple::Class::information aliases class

Synopsis: returns a class list of aliases.

Details: see section 4.5.

2.4.6 ::Simple::Class::information api class

Synopsis: returns a class public API signature.

Details: see section 4.6.

2.4.7 ::Simple::Class::information attributes class ?-access choice?

Synopsis: returns a class list of attributes matching the given access level.

Details: see section 4.7.

2.4.8 ::Simple::Class::information classes ?pattern?

Synopsis: returns the list of classes matching the pattern.

Details: see section 4.8.

2.4.9 ::Simple::Class::information commands class

Synopsis: returns a class current list of public and exported commands.

Details: see section 4.9.

2.4.10 ::Simple::Class::information errors class

Synopsis: returns a class list of errors.

Details: see section 4.10.

2.4.11 ::Simple::Class::information exists class

Synopsis: returns whether a class exists.

Details: see section 4.11.

2.4.12 ::Simple::Class::information exportedcommands class

Synopsis: returns a class list of exported commands.

Details: see section 4.12.

2.4.13 ::Simple::Class::information itkcomponents class

Synopsis: returns a class list of [incr Tk] components.

Details: see section 4.13.

2.4.14 ::Simple::Class::information itkoptions class

Synopsis: returns a class list of [incr Tk] options.

Details: see section 4.14.

2.4.15 ::Simple::Class::information metadata class

Synopsis: returns a class metadata.

Details: see section 4.15.

2.4.16 ::Simple::Class::information methods class

Synopsis: returns a class current list of public methods.

Details: see section 4.16.

2.4.17 ::Simple::Class::information objects ?-class name? ?-isa name? ?pattern?

Synopsis: returns the list of objects matching the pattern.

Details: see section 4.17.

2.4.18 ::Simple::Class::information variables class ?-access choice?

Synopsis: returns a class list of variables matching the given access level.

Details: see section 4.18.

2.4.19 ::Simple::ItkComponent::information access class itkcomponent

Synopsis: returns an [incr Tk] component access mode.

Details: see section 4.19.

2.4.20 ::Simple::ItkComponent::information description class itkcomponent

Synopsis: returns an [incr Tk] component description.

Details: see section 4.20.

2.4.21 ::Simple::ItkComponent::information ignore class itkcomponent

Synopsis: returns an [incr Tk] component list of ignored options.

Details: see section 4.21.

2.4.22 ::Simple::ItkComponent::information keep class itkcomponent

Synopsis: returns an [incr Tk] component list of kept options.

Details: see section 4.22.

2.4.23 ::Simple::ItkComponent::information rename class itkcomponent

Synopsis: returns an [incr Tk] component list of renamed options.

Details: see section 4.23.

2.4.24 ::Simple::ItkComponent::information resourceclass class itkcomponent

Synopsis: returns an [incr Tk] component resource class.

Details: see section 4.24.

2.4.25 ::Simple::ItkOption::information choices class itkoption

Synopsis: returns an [incr Tk] option choices.

Details: see section 4.25.

2.4.26 ::Simple::ItkOption::information default class itkoption

Synopsis: returns an [incr Tk] option default value.

Details: see section 4.26.

2.4.27 ::Simple::ItkOption::information defaultgiven class itkoption

Synopsis: returns whether an [incr Tk] option has a default value.

Details: see section 4.27.

2.4.28 ::Simple::ItkOption::information description class itkoption

Synopsis: returns an [incr Tk] option description.

Details: see section 4.28.

2.4.29 ::Simple::ItkOption::information monitortype class itkoption

Synopsis: returns whether an [incr Tk] option is being monitored.

Details: see section 4.29.

2.4.30 ::Simple::ItkOption::information resourceclass class itkoption

Synopsis: returns an [incr Tk] option resource class.

Details: see section 4.30.

2.4.31 ::Simple::ItkOption::information resourcename class itkoption

Synopsis: returns an [incr Tk] option resource name.

Details: see section 4.31.

2.4.32 ::Simple::ItkOption::information type class itkoption

Synopsis: returns an [incr Tk] option type.

Details: see section 4.32.

2.5 Errors

2.5.1 ::Simple::Class::CONFIGBODY-FOR-NON-PUBLIC-ATTRIBUTE

Message: -configbody given for non-public attribute "attribute".

Explanation: the declaration of attribute attribute failed because "-configbody" was provided for a non-public attribute, but that is not allowed.

Corrective action: either remove the "-configbody" or make the attribute public.

2.5.2 ::Simple::Class::CONFIGBODY-FOR-ARRAY-ATTRIBUTE

Message: -configbody given for array attribute "attribute".

Explanation: the declaration of attribute attribute failed because "-configbody" was provided for an attribute whose type is a derived array type, but that is not allowed.

Corrective action: either remove the "-configbody" or change the attribute type.

2.5.3 ::Simple::Class::CLASS-COMMAND-CONSTRUCTOR-OR-DESTRUCTOR

Message: class commands can not be named "constructor or destructor".

Explanation: the declaration of a class failed because class command constructor or destructor is named "constructor" or "destructor", but that is not allowed.

Corrective action: use a different name for the class command.

2.5.4 ::Simple::Class::CLASS-COMMAND-AND-METHOD-SHARE-BASE-COMMAND

Message: class command and method share the same base command "base command".

Explanation: the declaration of a class failed because a class command and a method are both subcommands sharing the same base command base command, but that is not allowed.

Corrective action: use different base commands for class commands and methods.

2.5.5 ::Simple::Class::SUBCOMMANDS-WITH-DIFFERENT-ACCESS

Message: class subcommands "class subcommand 1" and "class cubcommand 2" have different access modes.

Explanation: the declaration of a class failed because two class subcommands (class subcommand 1 and class cubcommand 2) corresponding to the same base command have different access modes, but that is not allowed.

Corrective action: declare all subcommands for a given base command with the same access mode.

2.5.6 ::Simple::Class::NON-EXISTING-ITKITEM

Message: class "class" doesn't have an option or a component "bad [incr Tk] option".

Explanation: class class does not have an option or a component named bad [incr Tk] option.

2.5.7 ::Simple::Class::SUBMETHODS-WITH-DIFFERENT-ACCESS

Message: submethods "class" and "submethod 1" of class "submethod 2" have different access modes.

Explanation: the declaration of class class failed because two class submethods (submethod 1 and submethod 2) corresponding to the same base method have different access modes, but that is not allowed.

Corrective action: declare all submethods for a given base method with the same access mode.

2.5.8 ::Simple::Class::SHALL-EXTEND-ITK-ARCHETYPE

Message: class class with option or component shall extend ::itk::Archetype.

Explanation: class class is a megawidget because it has an [incr Tk] option or component, and so shall extend ::itk::Archetype. Notice that ::itk::Widget and ::itk::Toplevel already extend ::itk::Archetype.

2.5.9 ::Simple::Class::MULTIPLE-OBJECTS-FOR-SINGLETON-CLASS

Message: multiple objects for singleton class "class".

Explanation: more than one object is being created for singleton class class, but that is not allowed.

2.5.10 ::Simple::Class::OBJECT-FOR-ABSTRACT-CLASS

Message: object for abstract class "class".

Explanation: an object for abstrac class class is being created, but that is not allowed.

2.5.11 ::Simple::Class::PUBLIC-METHOD-WITH-BODY-FOR-ABSTRACT-CLASS

Message: public method "method" with body for abstract class "class".

Explanation: a public method method with body is being declared for abstract class class, but that is not allowed.

2.5.12 ::Simple::Class::CONSTRUCTOR-OR-DESTRUCTOR-FOR-ABSTRACT-CLASS

Message: constructor or destructor for abstract class "class".

Explanation: a constructor or destructor has been provided for abstract class class, but that is not allowed.

2.5.13 ::Simple::Class::VIRTUAL-METHOD-CALLED

Message: virtual method "method" called.

Explanation: a virtual method method (an abstract class method with no body) has been called, usually from a derived class.

Corrective action: provide an implementation for the method in the derived class.

2.5.14 ::Simple::Class::UNDECLARED

Message: undeclared class "class".

Explanation: class class is undeclared, but a declared class is required.

3. Package further information

None.

4. Package command details

4.1 ::Simple::Class::cget ?-debug?

4.1.1 Command description

Synopsis: gets the package options.

Access mode: public.

4.1.2 Command public API

Arguments: (flag parsing disabled)

Returns: the requested option value or the whole list of options if none specified.

4.2 ::Simple::Class::configure ?-debug extbool?

4.2.1 Command description

Synopsis: configures the package options.

Access mode: public.

4.2.2 Command public API

Arguments: (flag parsing disabled)

Returns: the empty string.

4.3 declare-class class ?-version version? ?-project string? ?-synopsis string? ?-overview string? ?-usage string? ?-api string? ?-keywords list? ?-examples string? ?-classtype type? ?-stereotype choice? ?-extends qualifiedname-list? ?-debug extbool? ?-error declaration? ?-variable declaration? ?-attribute declaration? ?-itkoption declaration? ?-itkcomponent declaration? ?-command declaration? ?-method declaration? ?-assumptions string? ?-resources string? ?-limitations string? ?-effects string? ?-details string? ?-references string? ?-remarks string? ?-todo string? ?-history string? ?-copyright string? ?-body script?

(Exported from ::Simple::Class).

4.3.1 Command description

Synopsis: declares a class.

Access mode: exported.

4.3.1.1 Overview

This procedure provides a way to declare [incr Tcl] classes and [incr Tk] megawidgets.

The -synopsis flag is mandatory.

The -classtype flag specifies a type whose allowed values are objects of the class. This type can then be used whenever a type is required, such as for the arguments of another class commands or methods.

The -stereotype flag specifies the class stereotype among one of multiobject (the default), abstract or singleton. Multiobject classes support an arbitrary number of objects. Abstract classes support no objects (they are intended to be extended). Finally, singleton classes can be instantiated just once.

The -extends flag specifies the list of classes from which this one inherits.

The -variable flag allows to create class variables (class variables in object-oriented parlance; common variables for [incr Tcl]). Its argument is a variable declaration intended to be the arguments of a call to ::Simple::Variable::declare, except for the added argument -access, whose value must be one of public (the default), protected or private; this argument specifies the variable access mode. This flag can be given multiple times.

The -attribute flag allows to create class attributes (class instance variables in object-oriented parlance; variables for [incr Tcl]). Its argument is an attribute declaration intended to be the arguments of a call to ::Simple::Variable::declare, except for the added argument -access, equivalent to that for class variables, and -configbody, valid for public attributes only, used to specify the attribute configuration script (see the configbody [incr Tcl] command). This flag can be given multiple times.

The -error flag allows to declare class errors. Its argument is an error declaration intended to be the arguments of a call to ::Simple::Error::declare. This flag can be given multiple times.

The -command flag allows to declare class commands (class or static functions in object-oriented parlance; common procedures for [incr Tcl]). Its argument is a command declaration intended to be the arguments of a call to ::Simple::Declare::declare-proc, except for the added argument -access, whose value must be one of public (the default), private, or exported; this argument specifies the command access mode. This flag can be given multiple times.

The -method flag allows to declare class methods (class instance functions or methods in object-oriented parlance; methods for [incr Tcl]). Its argument is a method declaration intended to be the arguments of a call to ::Simple::Declare::declare-proc, except for the fact that -alias is not allowed for methods, and the added argument -access, whose value must be one of public (the default), protected or private; this argument specifies the method access mode. This flag can be given multiple times.

If the method name is constructor, it corresponds to the class constructor. In this case, -synopsis is not allowed (it is hardcoded to "Class constructor"), and the added argument -init, the script used invoke base class constructors, can be specified.

If the method name is destructor, it corresponds to the class destructor. In this case, -synopsis is not allowed (it is hardcoded to "Class destructor"). The destructor default access mode is "private".

The -body flag specifies the class body, a script evaluated when the class is declared.

The -debug flag allows to override the package option of the same name for the class being declared. This option controls whether to create a %debug% debug method. This method has a single argument: a script which gets evaluated in the object scope.

The -itkoption and -itkcomponent flags provide support for the definition of [incr Tk] megawidgets as follows.

The -itkoption flag allows to create options for [incr Tk] megawidgets. Its argument is an [incr Tk] option declaration intended to be the arguments of a call to ::Simple::Variable::declare, except for the added argument -configbody, equivalent to that for attributes, and -resourcename and -resourceclass: see the itk_option define [incr Tk] command. This flag can be given multiple times.

The -itkcomponent flag allows to create components for [incr Tk] megawidgets. Its argument is an [incr Tk] component declaration which shall start by the component name and be followed by the following optional flags (see the itk_component add [incr Tk] command):

• -description: the component description.

• -access: the component access mode (one of public, protected or private).

• -ignore: list of options to ignore for the megawidget; see the ignore command within the itk_component add [incr Tk] command.

• -keep: list of options to keep for the megawidget; see the keep command within the itk_component add [incr Tk] command.

• -rename: options to rename for the megawidget. Each option is a four-element list; see the rename command within the itk_component add [incr Tk] command.

• -resourceclass: resource class.

• -body: component body.

The usual command within the itk_component add [incr Tk] command is not supported. The -itkcomponents flag can be given multiple times.

All other arguments are metadata, and are stored or ignored depending on whether The Simple Development Library -storemetadata option is set when the class is declared, but for the -api and -body flags which are never stored.

4.3.1.2 Examples

# The canonical toaster example
declare-class {
   Toaster
} -synopsis {
   A toaster.
} -overview {

      Toaster class with toast and clean methods and a crumb count that
   will burn the toaster if too high

} -error {
   {
      FIRE
   } -message {
      == FIRE! FIRE! ==
   }
} -attribute {
   {
      crumbs
   } -description {
      Number of crumbs in the toaster
   } -type {
      integer
   } -value 0
} -method {
   {
      toast
   } -synopsis {
      Toast a given number of slices
   } -arguments {
      { nSlices          integer        {Number of slices to toast}}
   } -returns {
      The number of crumbs after toasting the slices
   } -body {

      # Too many crumbs
      if {$crumbs > 50} {

         # Catch fire!
         ::Simple::Error::throw FIRE
      }

      # Each toasted slice produces 4 crumbs
      incr crumbs [expr {4 * $nSlices}]

      # Return the number of crumbs after toasting the slices
      return $crumbs
   }
} -method {
   {
      clean
   } -synopsis {
      Cleans the toaster
   } -returns {
      The empty string
   } -body {

      # Remove all the crumbs
      set crumbs 0

      # Return the empty string
      return {}
   }
}

declare-class {
   SmartToaster
} -synopsis {
   A smart toaster
} -overview {

      This toaster has an autoclean feature that automatically cleans the
   toaster when there are lots of crumbs.  How smart!

} -extends {
   ::Toaster
} -method {
   {
      toast
   } -synopsis {
      Performs autoclean if necessary and toast a given number of slices
   } -arguments {
      { nSlices          integer        {Number of slices to toast}}
   } -returns {
      The number of crumbs after toasting the slices
   } -body {

      # Lots of crumbs
      if {$crumbs > 40} {

         # Perform autoclean
         clean
      }

      # Toast the slices
      set answer [::Toaster::toast $nSlices]

      # Return the number of crumbs after toasting the slices
      return $answer
   } 
}

4.3.2 Command public API

Arguments: (flag parsing disabled)

Returns: the empty string.

Effects:

• Creates a class named class.

• Creates the class commands, which may be exported or have an alias.

• Creates a public %debug% debug method if -debug is given or the package option of the same name is set.

• Creates a private create-components method if at least one [incr Tk] component is given. This method should be invoked by each megawidget object (for example from the megawidget constructor) to create the megawidget components.

• Those of the class body.

4.3.3 Command further information

4.3.3.1 Details

• Each declared class metadata is stored in a class private variable named %Metadata%.

• Each declared class list of exported commands is stored in a class private variable named %ExportedCommands%.

• Each declared class list of command aliases is stored in a class private variable named %Aliases%.

4.3.3.2 References

• The ::Simple::Class::delete procedure.

4.3.3.3 Remarks

• The order of the flags is irrelevant.

4.4 ::Simple::Class::delete class

4.4.1 Command description

Synopsis: deletes an [incr Tcl] class.

Access mode: public.

4.4.1.1 Overview

This procedure deletes the given class together with its class type, if any.

4.4.2 Command public API

Arguments:

Returns: the empty string.

Effects:

• Deletes the given class and its class type, if any.

4.4.3 Command further information

4.4.3.1 References

• The declare-class procedure.

4.5 ::Simple::Class::information aliases class

4.5.1 Command description

Synopsis: returns a class list of aliases.

Access mode: public.

4.5.2 Command public API

Arguments:

Returns: the class list of aliases.

4.5.3 Command further information

4.5.3.1 References

• The ::Simple::Package::information aliases command.

4.6 ::Simple::Class::information api class

4.6.1 Command description

Synopsis: returns a class public API signature.

Access mode: public.

4.6.1.1 Overview

This procedure returns a string containing a class public API signatures.

The class public and exported commands are included, as well as the public constructor, public destructor and public methods.

4.6.2 Command public API

Arguments:

Returns: the given class public API signatures as follows:

(extends <class list>)
Class constructor:
   <class 1 constructor API>
Class destructor:
   <class 1 destructor API>
Class commands:
   <class 1 command 1 API>
   <class 1 command 2 API>
   ...
Class methods:
   <class 1 method 1 API>
   <class 1 method 2 API>
   ...

4.6.3 Command further information

4.6.3.1 References

• The ::Simple::Package::information api command.

• The ::Simple::Class::information commands command.

• The ::Simple::Class::information methods command.

4.6.3.2 Remarks

• The returned list does not contain base methods.

• The returned list does not contain methods with a percent sign in its name are those are assumed to be internal to The Simple Development Library.

4.7 ::Simple::Class::information attributes class ?-access choice?

4.7.1 Command description

Synopsis: returns a class list of attributes matching the given access level.

Access mode: public.

4.7.2 Command public API

Arguments:

Returns: the class list of attributes matching the given access level.

4.8 ::Simple::Class::information classes ?pattern?

4.8.1 Command description

Synopsis: returns the list of classes matching the pattern.

Access mode: public.

4.8.1.1 Overview

This procedure wraps the ::itcl::find classes [incr Tcl] command. The following is an excerpt from that command manual page:

This procedure returns a list of classes. Classes in the current namespace are listed first, followed by classes in all other namespaces in the interpreter. If the optional pattern is specified, then only those classes whose name match the pattern are returned.

If a class resides in the current namespace context, this command reports its unqualified. However, if the pattern contains namespace qualifiers, or if the class resides in another context, this command reports its qualified name.

4.8.2 Command public API

Arguments:

Returns: the list of classes matching the pattern.

4.8.3 Command further information

4.8.3.1 References

• The ::itcl::find classes [incr Tcl] command.

• The itcl_info classes [incr Tcl] command.

4.9 ::Simple::Class::information commands class

4.9.1 Command description

Synopsis: returns a class current list of public and exported commands.

Access mode: public.

4.9.2 Command public API

Arguments:

Returns: the class current list of public and exported commands.

4.9.3 Command further information

4.9.3.1 References

• The ::Simple::Package::information api command.

• The ::Simple::Package::information commands command.

• The ::Simple::Class::information methods command.

4.9.3.2 Remarks

• The returned list does not contain base commands.

• The returned list does not contain commands with a percent sign in its name are those are assumed to be internal to The Simple Development Library.

4.10 ::Simple::Class::information errors class

4.10.1 Command description

Synopsis: returns a class list of errors.

Access mode: public.

4.10.2 Command public API

Arguments:

Returns: the class list of errors.

4.11 ::Simple::Class::information exists class

4.11.1 Command description

Synopsis: returns whether a class exists.

Access mode: public.

4.11.2 Command public API

Arguments:

Returns: whether the given class exists.

4.12 ::Simple::Class::information exportedcommands class

4.12.1 Command description

Synopsis: returns a class list of exported commands.

Access mode: public.

4.12.2 Command public API

Arguments:

Returns: the class list of exported commands.

4.12.3 Command further information

4.12.3.1 References

• The ::Simple::Package::information exportedcommands command.

4.13 ::Simple::Class::information itkcomponents class

4.13.1 Command description

Synopsis: returns a class list of [incr Tk] components.

Access mode: public.

4.13.2 Command public API

Arguments:

Returns: the class list of [incr Tk] components.

4.14 ::Simple::Class::information itkoptions class

4.14.1 Command description

Synopsis: returns a class list of [incr Tk] options.

Access mode: public.

4.14.2 Command public API

Arguments:

Returns: the class list of [incr Tk] options.

4.15 ::Simple::Class::information metadata class

4.15.1 Command description

Synopsis: returns a class metadata.

Access mode: public.

4.15.1.1 Overview

This procedure returns a list of pairs suitable to be given as argument to the array set command. Each element is one of the flags given to declare-class upon class declaration (with no hypen), but for the -api and -body flags (which are not stored), and the item declarations (-error, -variable, -attribute, -itkoption, -itkcomponent, -command and -method); these are obtained using the corresponding ::Simple::Class::information subcommand.

Thus, the actual list of flags is: -version, -project, -synopsis, -overview, -usage, -keywords, -examples, -classtype, -stereotype, -extends, -assumptions, -resources, -limitations, -effects, -details, -references, -remarks, -todo, -history and -copyright.

Notice that no data is returned unless The Simple Development Library -storemetadata option is set when the class is declared.

If a particular flag was not given in the class declaration, the empty string is returned as that flag contents.

4.15.2 Command public API

Arguments:

Returns: the class metadata as an item/contents pairs list.

4.16 ::Simple::Class::information methods class

4.16.1 Command description

Synopsis: returns a class current list of public methods.

Access mode: public.

4.16.2 Command public API

Arguments:

Returns: the class current list of public methods.

4.16.3 Command further information

4.16.3.1 References

• The ::Simple::Package::information api command.

• The ::Simple::Package::information commands command.

4.16.3.2 Remarks

• The returned list does not contain base methods.

• The returned list does not contain methods with a percent sign in its name are those are assumed to be internal to The Simple Development Library.

4.17 ::Simple::Class::information objects ?-class name? ?-isa name? ?pattern?

4.17.1 Command description

Synopsis: returns the list of objects matching the pattern.

Access mode: public.

4.17.1.1 Overview

This procedure wraps the ::itcl::find classes [incr Tcl] command. The order of the arguments is different due to a limitation in The Simple Development Library (and Tcl) which forces the optional arguments to be the last ones. The following is an excerpt from that command manual page:

This procedure returns a list of objects. Objects in the current namespace are listed first, followed by objects in all other namespaces in the interpreter. If the optional pattern is specified, then only those objects whose name match the pattern are returned.

If the optional -class flag is given, this list is restricted to objects whose most-specific class is the one given as parameter to that flag. If the -isa flag is given, this list is further restricted to objects having the class given as paramter to that flag anywhere in their heritage.

If an object resides in the current namespace context, this command reports its unqualified name. However, if the pattern contains namespace qualifiers, or if the object resides in another context, this command reports its fully-qualified name.

4.17.2 Command public API

Arguments:

Returns: the list of objects matching the pattern.

4.17.3 Command further information

4.17.3.1 References

• The ::itcl::find objects [incr Tcl] command.

• The itcl_info objects [incr Tcl] command.

4.18 ::Simple::Class::information variables class ?-access choice?

4.18.1 Command description

Synopsis: returns a class list of variables matching the given access level.

Access mode: public.

4.18.2 Command public API

Arguments:

Returns: the class list of variables matching the given access level.

4.19 ::Simple::ItkComponent::information access class itkcomponent

4.19.1 Command description

Synopsis: returns an [incr Tk] component access mode.

Access mode: public.

4.19.2 Command public API

Arguments:

Returns: the [incr Tk] component access mode.

4.20 ::Simple::ItkComponent::information description class itkcomponent

4.20.1 Command description

Synopsis: returns an [incr Tk] component description.

Access mode: public.

4.20.2 Command public API

Arguments:

Returns: the [incr Tk] component description.

4.21 ::Simple::ItkComponent::information ignore class itkcomponent

4.21.1 Command description

Synopsis: returns an [incr Tk] component list of ignored options.

Access mode: public.

4.21.2 Command public API

Arguments:

Returns: the [incr Tk] component list of ignored options.

4.22 ::Simple::ItkComponent::information keep class itkcomponent

4.22.1 Command description

Synopsis: returns an [incr Tk] component list of kept options.

Access mode: public.

4.22.2 Command public API

Arguments:

Returns: the [incr Tk] component list of kept options.

4.23 ::Simple::ItkComponent::information rename class itkcomponent

4.23.1 Command description

Synopsis: returns an [incr Tk] component list of renamed options.

Access mode: public.

4.23.2 Command public API

Arguments:

Returns: the [incr Tk] component list of renamed options.

4.24 ::Simple::ItkComponent::information resourceclass class itkcomponent

4.24.1 Command description

Synopsis: returns an [incr Tk] component resource class.

Access mode: public.

4.24.2 Command public API

Arguments:

Returns: the [incr Tk] component resource class.

4.25 ::Simple::ItkOption::information choices class itkoption

4.25.1 Command description

Synopsis: returns an [incr Tk] option choices.

Access mode: public.

4.25.2 Command public API

Arguments:

Returns: the [incr Tk] option choices.

4.26 ::Simple::ItkOption::information default class itkoption

4.26.1 Command description

Synopsis: returns an [incr Tk] option default value.

Access mode: public.

4.26.2 Command public API

Arguments:

Returns: the [incr Tk] option default value.

4.26.3 Command further information

4.26.3.1 References

• The ::Simple::Variable::information default procedure.

• The ::Simple::Option::information default procedure.

4.27 ::Simple::ItkOption::information defaultgiven class itkoption

4.27.1 Command description

Synopsis: returns whether an [incr Tk] option has a default value.

Access mode: public.

4.27.2 Command public API

Arguments:

Returns: whether the [incr Tk] option has a default value.

4.27.3 Command further information

4.27.3.1 References

• The ::Simple::Variable::information defaultgiven procedure.

• The ::Simple::Option::information defaultgiven procedure.

4.28 ::Simple::ItkOption::information description class itkoption

4.28.1 Command description

Synopsis: returns an [incr Tk] option description.

Access mode: public.

4.28.2 Command public API

Arguments:

Returns: the [incr Tk] option description.

4.29 ::Simple::ItkOption::information monitortype class itkoption

4.29.1 Command description

Synopsis: returns whether an [incr Tk] option is being monitored.

Access mode: public.

4.29.2 Command public API

Arguments:

Returns: whether an [incr Tk] option is being monitored.

4.29.3 Command further information

4.29.3.1 References

• The ::Simple::Variable::information monitortype procedure.

4.30 ::Simple::ItkOption::information resourceclass class itkoption

4.30.1 Command description

Synopsis: returns an [incr Tk] option resource class.

Access mode: public.

4.30.2 Command public API

Arguments:

Returns: the [incr Tk] option resource class.

4.31 ::Simple::ItkOption::information resourcename class itkoption

4.31.1 Command description

Synopsis: returns an [incr Tk] option resource name.

Access mode: public.

4.31.2 Command public API

Arguments:

Returns: the [incr Tk] option resource name.

4.32 ::Simple::ItkOption::information type class itkoption

4.32.1 Command description

Synopsis: returns an [incr Tk] option type.

Access mode: public.

4.32.2 Command public API

Arguments:

Returns: the [incr Tk] option type.