README.txt

Object Oriented Programming Package for Tcl (TclOO) Version 1.0.4

Copyright 2005-2014 Donal K. Fellows

License
=======

See the file "license.terms" for the license under which this software is
made available. This file must have been part of the distribution under
which you received this file.

Building
========

TclOO 1.0.4 uses the TEA3 build system. These instructions are known to work
on Linux, OSX and Windows (with msys installed).

1) Make sure you have a source distribution of Tcl 8.5 somewhere; you will
   need it to build TclOO. (Note that this functionality is incorporated
   directly into Tcl 8.6; you do not need this package with that version.)

2) Run the configure shell script in this directory. You may well want to
   use the --with-tcl option to tell the script where to find Tcl's build
   descriptor. Using the --prefix option to specify where to install the
   built version is also often useful.

3) Run 'make'.

4) Run 'make test'. There should be no test failures, but some memory stress
   tests are not run under normal conditions as they require a special build
   of Tcl.

5) Run 'make install'. You might need to get elevated privileges to do this
   (e.g. by using 'sudo') to install in a shared area.

Support
=======

Please file bug reports, feature requests and patches on core.tcl.tk under the
Tcl package. <URL:http://core.tcl.tk/tcl/tktnew> To ensure attention from the
relevant maintainer, please use "35. TclOO Package" for the Category field.
Remember, it is better to file a bug report twice than not at all!

Simple Example
==============

oo::class create summation {
    variable v
    constructor {} {
        set v 0
    }
    method add x {
        incr v $x
    }
    method value {} {
        return $v
    }
    destructor {
        puts "Ended with value $v"
    }
}
set sum [summation new]
puts "Start with [$sum value]"
for {set i 1} {$i <= 10} {incr i} {
    puts "Add $i to get [$sum add $i]"
}
summation destroy

Significant Changes from 1.0.2 Release
====================================
* TIP #436 <http://tip.tcl.tk/436.html> was implemented, which makes `info
  object isa` not produce errors when presented with non-objects.
* Various bugs in class destruction were addressed.

For a full description of all changes, see:
 http://core.tcl.tk/tcloo/timeline?from=release-1.0.2&to=release-1.0.4

Note that there were no meaningful changes in 1.0.3.

Compatibility Warnings
======================
Names of classes, methods or variables that begin with a hyphen can now cause
issues with some definitions (i.e., they are reserved to slotted operations).
The fix is to precede the name with a "--" argument in the problem definition;
see the [oo::define] documentation for the affected definitions.

Method names that are proper multi-element lists are reserved for future
functionality.