Class: MethodRewriter (in Tools)

• Inheritance
• Description
• Class protocol
  • example templates
  • help specs
  • interface specs
  • list specs
• Instance protocol
  • accessing
  • actions
  • aspects
  • change & update
  • drag & drop
  • hooks
  • initialization
  • private
  • testing method
• Examples

Inheritance:

   Object
   |
   +--Model
      |
      +--ApplicationModel
         |
         +--Tools::MethodRewriter

Package:

stx:libtool

Category:

Interface-Tools

Version:

rev: 1.48 date: 2023/11/21 09:43:50

user: cg

file: Tools__MethodRewriter.st directory: libtool

module: stx stc-classLibrary: libtool

Description:

documentation to be added.

class:
    <a short class summary here, describing what instances represent>

responsibilities:    
    <describing what my main role is>

collaborators:    
    <describing with whom and how I talk to>

API:
    <public api and main messages>
    
example:
    <a one-line examples on how to use - can also be in a separate example method>

implementation:
    <implementation points>


[instance variables:]

[class variables:]

copyright
Copyright (c) 2007-2010 Jan Vrany, SWING Research Group, Czech Technical University in Prague
Copyright (c) 2009-2010 eXept Software AG

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the 'Software'), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Class protocol:

 templateReplaceAtIfAbsentByAtAifAbsentPut

automagically added to templates because my name starts with 'template'

 templateReplaceErrorMayProceedByProceedableError

automagically added to templates because my name starts with 'template'

 templateReplaceIfNilByIsNilIfTrue

automagically added to templates because my name starts with 'template'

 templateReplaceIfNotNilByNotNilIfTrue

automagically added to templates because my name starts with 'template'

 templateReplaceIsNilOrEmptyCollectionByIsEmptyOrNil

automagically added to templates because my name starts with 'template'

 templateReplaceSelfHaltBySelfBreakPoint

automagically added to templates because my name starts with 'template'

 templateReplaceSelfHaltBySelfError

automagically added to templates because my name starts with 'template'

 templates

finds all methods here, which start with 'template'

Usage example(s):

self templates

 helpSpec

This resource specification was automatically generated
by the UIHelpTool of ST/X.

 classesSpec

This resource specification was automatically generated
by the UIPainter of ST/X.

Usage example(s):

UIPainter new openOnClass:Tools::MethodRewriter andSelector:#classesSpec Tools::MethodRewriter new openInterface:#classesSpec

 howToUseSpec

This resource specification was automatically generated
by the UIPainter of ST/X.

Usage example(s):

UIPainter new openOnClass:Tools::MethodRewriter andSelector:#howToUseSpec Tools::MethodRewriter new openInterface:#howToUseSpec

 rulesSpec

This resource specification was automatically generated
by the UIPainter of ST/X.

Usage example(s):

UIPainter new openOnClass:Tools::MethodRewriter andSelector:#rulesSpec Tools::MethodRewriter new openInterface:#rulesSpec

 searchAndReplaceSpec

This resource specification was automatically generated
by the UIPainter of ST/X.

Usage example(s):

UIPainter new openOnClass:Tools::MethodRewriter andSelector:#searchAndReplaceSpec Tools::MethodRewriter new openInterface:#searchAndReplaceSpec

 searchPatternHelpSpec

This resource specification was automatically generated
by the UIPainter of ST/X.

Usage example(s):

UIPainter new openOnClass:Tools::MethodRewriter andSelector:#searchPatternHelpSpec Tools::MethodRewriter new openInterface:#searchPatternHelpSpec

 templatesSpec

This resource specification was automatically generated
by the UIPainter of ST/X.

Usage example(s):

UIPainter new openOnClass:Tools::MethodRewriter andSelector:#templatesSpec Tools::MethodRewriter new openInterface:#templatesSpec

 windowSpec

This resource specification was automatically generated
by the UIPainter of ST/X.

Usage example(s):

UIPainter new openOnClass:Tools::MethodRewriter andSelector:#windowSpec Tools::MethodRewriter new openInterface:#windowSpec Tools::MethodRewriter open

 tabList

This resource specification was automatically generated
by the TabListEditor of ST/X.

Usage example(s):

TabListEditor new openOnClass: self andSelector:#tabList

Instance protocol:

 classes

 classes: aCollectionOfClasses

 info: aString

 progress: anInteger

 projects: aCollection

 replacePattern

 replacePattern: pattern

 ruleTemplate

 rules

construct a pseudo list from existing transformation rules

Usage example(s):

self new rules

 searchPattern

 searchPattern: pattern

 selectedClasses

 selectedRule

 selectedRuleSpec

 selectedTemplate

 templates

 addAllPackagesAction

 addAllYourPackagesAction

 addClassAction

 addPackageAction

 doRewrite: methodsMatching

text replace

 doRewriteAction

 doSearchAction

 removeSeletedClassesAction

 useAsRuleAction

 useAsTemplateAction

ad hoc

 actionInProgressHolder

 adHocFindAndReplaceVisibleHolder

 classesInfoTextHolder

 howToUseRewriteToolURL

 infoHolder

 isMethodPatternHolder

 isPlainStringPatternHolder

 progressHolder

 ruleExecutionVisibleHolder

 ruleNameHolder

 ruleNameList

 ruleSearchAndReplacePatternHolder

 searchPatternHelpURL

 selectedClassesHolder

 selectedRuleIndex

 selectedTabIndex

 selectedTemplateIndex

 tabList

Generated by the TabListEditor

 templateNameList

 templateReplacePatternHolder

 templateReplacePatternIsEditable

 templateSearchPatternHolder

 templateSearchPatternIsEditable

 classesChanged

flush

 selectedRuleIndexChanged

entries are:

 selectedTemplateIndexChanged

entries are:

 canDropClasses: dropContext

I accept classes, methods and packages

 doDropClasses: dropContext

I accept classes, methods and packages

 postBuildFindTextView: scrollableView

 postBuildReplaceTextView: scrollableView

 initialize

(comment from inherited method)
nothing done here;
but can be redefined in concrete applications

 actionInProgress: aBoolean

 doSearchPattern: pattern withResultDo: block

regular expression search

 doSearchRule: rule withResultDo: block

searcher computeQuickSearchStrings.

 methods

 methods: aCollection

to explicitly set the set of methods to be processed

 methodsForClasses

 methodsMatchingPattern: searchPattern

 methodsMatchingRule: rule

matches:searchPattern do:[:aNode :answer | matchingMethods add:mth ];

 methodsToSearchOrAbortIfNone

 showMethods: methods title: title

open a browser on matching methods

 withMethods: givenMethods do: methodBlock

 withMethods: methods do: methodBlock finallyDo: finallyBlock

self actionInProgress: false.

 withMethodsDo: methodBlock finallyDo: finallyBlock

 testXXX

Examples:

   Tools::MethodRewriter open

   Tools::MethodRewriter openOn:aModel