Class: ProjectProblem

• Inheritance
• Description
• Class protocol
  • instance creation
  • queries
• Instance protocol
  • accessing
  • fixing
  • initialization
  • printing & storing
  • utilities-HTML
• Private classes

Inheritance:

   Object
   |
   +--ProjectProblem
      |
      +--ProjectProblem::ClassProblem
      |
      +--ProjectProblem::InvalidPackageName
      |
      +--ProjectProblem::ProjectDefinitionDoesNotExist

Package:

stx:libbasic3

Category:

System-Support-Projects

Version:

rev: 1.74 date: 2024/02/13 20:11:00

user: cg

file: ProjectProblem.st directory: libbasic3

module: stx stc-classLibrary: libbasic3

Description:

I represent a problem as detected by the project consistency checker,
which is optionally executed before committing a package to a repository.
Typically, I find inconsistencies, uncompilable methods or missing prerequisites,
which might lead to trouble when the package is later to be compiled to a dll via stc.

[instance variables:]
    package         - the package in question

    fixes           - a collection of possible fixes
                      (to be shown in the HTML view of the problem browser)

    allProblems     - the collection of problems I am part of
                      (only needed to be able to do the 
                       'fix other problems of this kind' operation,
                       for example in the MethodOnNoPackage problem.)

copyright
COPYRIGHT (c) 2006 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:

 newClass: aClass usesPoolButItDoesNotExist: poolName

 newClassIsCompiledButSuperclassIsAutoloaded

 newClassIsCompiledButSuperclassProjectDefinitionIsMissing

 newClassListedBeforeItsPool

 newClassListedBeforeItsSuperclass

 newClassListedBeforeItsSuperclass: aClass

 newClassListedButDoesNotExist

 newClassListedButInOtherPackage

 newClassListedMultipleTimes

 newClassListedMultipleTimes: aClass

 newClassNotListed

 newClassShouldNotBeInPackage

 newClassUsesPoolButItDoesNotExist

 newClassUsesPoolButItIsNotASharedPool

 newClassUsesPoolInNamespaceButNamespaceIsNotDefined

 newExtensionMethodListedButDoesNotExist

 newExtensionMethodListedButInDifferentPackage

 newExtensionMethodNotListed

 newExtensionMethodsClassDoesNotExist

 newInvalidPackageName

 newMethodCompilabilityIssue1

 newMethodCompilabilityIssue2

 newMethodInNoPackage

 newMethodListedInOtherPackage

 newMethodSourceCorrupted

 newMethodSourceNotAvailable

 newProjectDefinitionDoesNotExist

 isAbstract

Return if this class is an abstract class.
True is returned here for myself only; false for subclasses.
Abstract subclasses must redefine this again.

Instance protocol:

 allProblems: something

 countOtherProblemsOfThisKind

 description

Return a (HTML) describing the problem.

** This method must be redefined in concrete classes (subclassResponsibility) **

 descriptionAndFixes

Return a (HTML) describing the problem plus possible fixes.

 klass

Return the class which is subject of the problem.
To be redefined in problems which are class-related

 label

Return the label (possibly instance if a Text) shortly describing the problem

** This method must be redefined in concrete classes (subclassResponsibility) **

 package

 package: aSymbol

 packageDefinitionClass

 severity

Return a severity - one of #error, #warning, #info

 allUnfixedProblemsOfMyKindDo: aBlock

 alreadyFixed

 doFix: index

 fixes

Return (possibly empty) list of description-action pairs that
the user may take to fix/investigate the problem.
Returned value should be list of pairs (label, action block).
To be overriden in subclasses.

The list should be an array of pairs ( fix label , fix block ).
Fix block should return true, if the fix was successful,
false otherwise

 initializeFixes

super initialize. -- commented since inherited method does nothing

 displayOn: aGCOrStream

what a kludge - Dolphin and Squeak mean: printOn: a stream;

 printOn: aStream

append a printed representation of the receiver to the argument, aStream

 linkToClass: classOrclassName

 linkToClass: classOrclassName selector: selector

 linkToClass: classOrclassName selector: selector omitClassName: omitClassName

 linkToPackage: packageId

Private classes:

    ClassIsCompiledButSuperclassIsAutoloaded
    ClassIsCompiledButSuperclassProjectDefinitionIsMissing
    ClassListedBeforeItsPool
    ClassListedBeforeItsSuperclass
    ClassListedButDoesNotExist
    ClassListedButInOtherPackage
    ClassListedMultipleTimes
    ClassNotListed
    ClassProblem
    ClassShouldNotBeInPackage
    ClassUsesPoolButItDoesNotExist
    ClassUsesPoolButItIsNotASharedPool
    ClassUsesPoolInNamespaceButNamespaceIsNotDefined
    ClassUsesPoolProblem
    ExtensionMethodListedButDoesNotExist
    ExtensionMethodListedButInDifferentPackage
    ExtensionMethodNotListed
    ExtensionMethodsClassDoesNotExist
    InconsistentProjectDefinition
    InvalidPackageName
    MethodCompilabilityIssue1
    MethodCompilabilityIssue2
    MethodInNoPackage
    MethodListedInOtherPackage
    MethodProblem
    MethodSourceCorrupted
    MethodSourceNotAvailable
    ProjectDefinitionDoesNotExist