#
# This file is encoded in (so called) SHIFT-JIS,
# line delimitor is CR.
#
Code Review
Goodies for Squeak 1.31, 2.0

Broken English description

This goodies is a modification for Squeak from Mr. AOKI''s
Code Review
Goodies for VisualWorks 2.5 and VisualWave 1.0
Copyright (C) 1997-1998 AOKI Atsushi
1998/01/05
http://www.sra.co.jp/people/aoki/SmalltalkGoodies/VisualWorks/CodeRevw.st
http://www.sra.co.jp/people/aoki/SmalltalkGoodies/VisualWorks/CodeRevw.txt


Summary:

This goodies produces useful information to review program code.

Variables:
check not declared, not used, not assigned variables, and 
used variables list made from special, argument, temporary
instance, class, pool and global variables.  You can check 
using suitable variable name.

messages:
check not implemented, empty categories, and output list of 
receiver type (variables, literals or so).  This list is 
classified "sending messages to me" and "sending messages 
to them", so you can get information of delegation message .

other:
check used literals, number of assignments, number of blocks, 
number of cascades, number of returns, number of statements.

The output report made from items below.  You can output this 
report as html file which is used to varioud report.

MethodReview: 
    not declared variables: 
    not used variables: 
    not assigned variables: 
    used variables: 
        special variables: 
        argument variables: 
        temporary variables: (including block temporary made from Compiler)
        instance variables:
        class variables: 
        pool variables: 
        global variables: 
    sending messages: 
        to self: 
        to super: 
        to thisContext: 
        to literals: 
        to blocks: 
        to variables: 
            to argument variables: 
            to temporary variables: 
            to instance variables: 
            to class variables: 
            to pool variables: 
            to global variables: 
        to expressions: 
    used literals: 
    number of assignments: 
    number of blocks: 
    number of cascades: 
    number of returns: 
    number of statements: 
    main family percentage: 
    branch family percentage: 

ClassReview: 
    not declared variables: 
    not used instance variables: 
    not used class variables: 
    not used variables: 
    not assigned variables: 
    not implemented sendings: 
    empty categories: 
    used special variables: 
    used argument variables: 
    used temporary variables: (including block temporary made from Compiler)
    used instance variables: 
    used class variables: 
    used pool variables: 
    used global variables: 
    implemented messages: 
    sending messages to me: 
    sending messages to them: 
    used literals: 
    number of sending messages: 
    number of assignments: 
    number of blocks: 
    number of cascades: 
    number of returns: 
    number of statements: 
    main family percentage: 
    branch family percentage: 


How to install:

FileIn this goodies and makes classes below in a category 
"Goodies-Review". 

ClassReview
CodeReview
MethodReview

and a category 
"Goodies-Support"

MethodNodeEnumerator

This source adds no change to existing classes or methods.
It completes within self.

When you want to restore your image, please remove these categories 
"Goodies-Review" and "Goodies-Support" from your system.


how to use:

| methodReview |
methodReview := MethodReview class: String selector: #displayOn:at:.
methodReview report.
^methodReview

| classReview |
classReview := ClassReview class: ClassReview.
classReview report.
^classReview

| codeReview |
codeReview := CodeReview classCollection: (Array
                                with: MethodReview
                                with: ClassReview
                                with: CodeReview).
codeReview report.
^codeReview


##########################################################

青木さんの
http://www.sra.co.jp/people/aoki/SmalltalkGoodies/VisualWorks/CodeRevw.st
を Squeak 用にいじったものです。
ドキュメントは
http://www.sra.co.jp/people/aoki/SmalltalkGoodies/VisualWorks/CodeRevw.txt
を参照してください。

----------------------------------------------------------
西原聡士 (NISHIHARA Satoshi)
e-mail: mailto:nishis@zephyr.dti.ne.jp
URL:    http://www.zephyr.dti.ne.jp/~nishis/
----------------------------------------------------------