Class: ClassChecker (in Tools)

• Inheritance
• Description
• Class protocol
  • queries
• Instance protocol
  • accessing
  • checking
  • checks-individual
  • helpers

Inheritance:

   Object
   |
   +--Tools::ClassChecker

Package:

stx:libtool

Category:

Interface-Browsers-New

Version:

rev: 1.33 date: 2024/03/14 16:21:33

user: cg

file: Tools__ClassChecker.st directory: libtool

module: stx stc-classLibrary: libtool

Description:

embeddable application displaying the class-categories.
Provides an outputGenerator, which enumerates the classes in
the selected categories.

Attention: do not change the method categories 'checks-' into something else.
The 'checks-' prefix is used to detect checks and these are listed in the browsers
lint dialog.

copyright
COPYRIGHT (c) 2004 by eXept Software AG
             All Rights Reserved

This software is furnished under a license and may be used
only in accordance with the terms of that license and with the
inclusion of the above copyright notice.   This software may not
be provided or otherwise made available to, or used by, any
other person.  No title to or ownership of the software is
hereby transferred.

Class protocol:

 individualChecks

return a list of supported checks

Usage example(s):

self individualChecks

Instance protocol:

 badClassInfo

 badMethodInfo

 checkedClass

return the value of the instance variable 'checkedClass' (automatically generated)

 checkedClass: aClass

set the value of the instance variable 'checkedClass' (automatically generated)

 allChecks

 doCheck: whichCheck

 errorChecks

 styleChecks

self doCheck:#guardingClause.

 warningChecks

 checkProtocols

 checkVariableNameConventions

 classInstanceVariablesNeverUsed

 classInstanceVariablesNeverWritten

 classVariablesNeverUsed

 classVariablesNeverWritten

 definesEqualButNotHash

 guardingClause

 instanceVariablesNeverUsed

 instanceVariablesNeverWritten

 invalidKeyInImageResourceMethod

 messageNeverSent

old code: (slow)

 messageNeverSentAndNotUsedAsSymbol

 parseMethod: method in: aClass withParserDo: aBlock onErrorDo: errorBlock

 sendsObsoleteMessages

manually patchup; there are some which should not be considered as bad ...

 sendsObsoleteMethodWarningButNotTaggedAsObsoleteOrViceVersa

 sentNotImplemented

 subclassResponsibilityNotDefined

ok, got one;

 unusedClassVariables

 unusedInstanceVariables

 anyImplementationOf: aSelector

 anyImplementationOf: aSelector in: aCollectionOfClasses

 anyImplementationOf: aSelector inOrAbove: aClass

 anySendsOf: aSelector

 checkProtocolOf: aMethod

 checkUnusedVariables: aMethod rememberReadInstVarsIn: readInstVars writtenInstVarsIn: writtenInstVars readClassVarsIn: readClassVars writtenClassVarsIn: writtenClassVars

 instanceVariablesNeverUsedIn: aClass

 instanceVariablesNeverWrittenIn: aClass

 messagesNeverSentAndNotUsedAsSymbolIn: selectorsOfInterest

start searching in the checkedClass - chances are high, we find some here

 messagesNeverSentIn: selectorsOfInterest

 methodShouldBeIgnoredInSubclassResponsibilityNotDefined: aMethod

a kludge for now - would like to have a pragma, resource or other
way to mark such a method

 rememberBadClass: class info: whatIsWrong

 rememberBadMethod: method key: key info: whatIsWrong

 rememberBadMethods: methods key: key info: whatIsWrong

 removeUsedClassVariablesIn: aClass from: aCollectionOfVariablenames

Modified (format): / 18-09-2023 / 13:01:18 / Stefan_Vogel

 removeUsedInstanceVariablesIn: aClass from: aCollectionOfVariablenames

Modified (format): / 18-09-2023 / 13:01:32 / Stefan_Vogel

 removeWrittenClassVariablesIn: aClass from: aCollectionOfVariablenames

Modified (format): / 18-09-2023 / 13:01:49 / Stefan_Vogel

 removeWrittenInstanceVariablesIn: aClass from: aCollectionOfVariablenames

Modified (format): / 18-09-2023 / 13:01:58 / Stefan_Vogel