Squeak-dev June 2022

squeak-dev@lists.squeakfoundation.org

30 participants
309 discussions

veryDeepCopy, ImageSegments, and actionMaps
by Ned Konz 17 Aug '23

17 Aug '23

Any Object can have dependents whether or not it has an instance variable to keep track of them (these are kept in the DependentsFields class variable of Object). The only class that keeps its own dependents is Model. Any Object can have an actionMap. These are supplied by EventManager class by default, and are stored in the ActionMaps class variable of EventManager. The only class that keeps its own action maps is Morph. When we veryDeepCopy an object we also copy the global dependents (see DeepCopier>>fixDependents). However, we don't copy the actionMap in those cases where it's held by the EventManager class. When we file out an object that uses DependentsFields out into an ImageSegment, we also file out the dependents (see ImageSegment>>dependentsSave:) if it's in a project. We do this by adding a project parameter called #GlobalDependentsInProject. However, we don't file out the actionMap in those cases where it's held by the EventManager class. My question is this: should we fix these behaviors (copying and serialization) to include these "global action maps" just like we already include the "global dependents"? Or should we discourage the use of the "global action maps"? -- Ned Konz http://bike-nomad.com GPG key ID: BEEA7EFE

3 2

The Inbox: Tools-ct.1032.mcz
by commits＠source.squeak.org 15 Aug '23

15 Aug '23

A new version of Tools was added to project The Inbox: http://source.squeak.org/inbox/Tools-ct.1032.mcz ==================== Summary ==================== Name: Tools-ct.1032 Author: ct Time: 10 March 2021, 6:51:33.356304 pm UUID: 897e4ea2-3740-6a45-a054-d7da65105568 Ancestors: Tools-mt.1030 In the Message Names tool, show definition, comment, and hierarchy for class hits. In particular helpful to find out efficiently whether a selector belongs to a binding or to an actual class. =============== Diff against Tools-mt.1030 =============== Item was changed: ----- Method: MessageNames>>computeMessageList (in category 'search') ----- computeMessageList + | selector | + selectorListIndex = 0 ifTrue: [^ #()]. + + selector := selectorList at: selectorListIndex. + ^ (selector first isUppercase ifTrue: [Smalltalk classNamed: selector]) + ifNotNil: [:class | + class := Smalltalk classNamed: selector. + #(Definition Comment Hierarchy) collect: [:sel | + MethodReference class: class selector: sel] ] + ifNil: [self systemNavigation allImplementorsOf: selector]! - ^ selectorListIndex = 0 - ifTrue: [#()] - ifFalse: [self systemNavigation - allImplementorsOf: (selectorList at: selectorListIndex)]! Item was changed: ----- Method: MessageNames>>selectedMessageName (in category 'message list') ----- selectedMessageName selectorList basicSize = 0 ifTrue: [^ nil]. "Deals with selectorList nil or empty" + ^super selectedMessageName ifNil: [ + "only message name selected" + selectorList at: (selectorListIndex max: 1) ifAbsent: [nil] "If no selection we can still find a selector"]! - ^selectorList at: (selectorListIndex max: 1) ifAbsent: [nil] "If no selection we can still find a selector"! Item was changed: ----- Method: MessageSet>>aboutToStyle: (in category 'code pane') ----- + aboutToStyle: aStyler + "This is a notification that aStyler is about to re-style its text. + Set the classOrMetaClass in aStyler, so that identifiers will be resolved correctly. - aboutToStyle: aPluggableShoutMorphOrView - "This is a notification that aPluggableShoutMorphOrView is about to re-style its text. - Set the classOrMetaClass in aPluggableShoutMorphOrView, so that identifiers - will be resolved correctly. Answer true to allow styling to proceed, or false to veto the styling" | selectedMessageName showingMethod | self showingSource ifFalse: [^false]. selectedMessageName := self selectedMessageName. showingMethod := (#(Comment Definition Hierarchy) includes: selectedMessageName) not. + aStyler parseAMethod: showingMethod. "Hack!! setting classOrMetaClass: to nil allows doit or class definition colouring." + aStyler classOrMetaClass: (showingMethod ifTrue: [self selectedClassOrMetaClass]). - aPluggableShoutMorphOrView classOrMetaClass: (showingMethod ifTrue: [self selectedClassOrMetaClass]). ^(#(Comment Hierarchy) includes: selectedMessageName) not! Item was changed: ----- Method: MessageSet>>selectedMessage (in category 'message list') ----- selectedMessage "Answer the source method for the currently selected message." - self setClassAndSelectorIn: [:class :selector | | source | class ifNil: [^ 'Class vanished']. selector first isUppercase ifTrue: [selector == #Comment ifTrue: + ["currentCompiledMethod := class organization commentRemoteStr." - [currentCompiledMethod := class organization commentRemoteStr. ^ class comment]. selector == #Definition ifTrue: [^ class definition]. selector == #Hierarchy ifTrue: [^ class printHierarchy]]. source := class sourceMethodAt: selector ifAbsent: [currentCompiledMethod := nil. ^ 'Missing']. self showingDecompile ifTrue: [^ self decompiledSourceIntoContents]. currentCompiledMethod := class compiledMethodAt: selector ifAbsent: [nil]. self showingDocumentation ifTrue: [^ self commentContents]. source := self sourceStringPrettifiedAndDiffed. ^ source asText makeSelectorBoldIn: class]!

3 2

Review Request: mcSlips
by christoph.thiede＠student.hpi.uni-potsdam.de 21 May '23

21 May '23

Any fundamental objections before I would merge this into the Trunk? :-) =============== Summary =============== Change Set: mcSlips Date: 16 January 2022 Author: Christoph Thiede This changeset integrates the slip detection mechanism, previously only known from the domain of changesets, into the Monticello system. When users save a new version, it will automatically notify them about any possible slips and let them decide whether to browse them first or proceed the saving. Users can also scan their patch for slips manually by invocating the item from the patch list menu. The value of the preference #checkForSlips is still honored for the automatic detection, and the description of that preference is updated to mention the new usage. =============== Postscript =============== "Postscript:" (Preferences preferenceAt: #checkForSlips) helpString: 'If true, then whenever you file out a change set or save a Monticello version, it is checked for ''slips'' and if any are found, you are so informed and given a chance to open a browser on them.'. =============== Diff =============== CompiledMethod>>hasReportableSlip {testing} · ct 1/15/2022 22:32 (changed) hasReportableSlip "Answer whether the receiver contains anything that should be brought to the attention of the author when filing out. Customize the lists here to suit your preferences. If slips do not get reported in spite of your best efforts here, make certain that the Preference 'checkForSlips' is set to true." - #(#doOnlyOnce: #halt #halt: #hottest #printDirectlyToDisplay #toRemove #personal #urgent #haltOnce #haltOnce: #haltIf: ) + #(#doOnlyOnce: #halt #halt: #hottest #printDirectlyToDisplay #toRemove #personal #urgent #haltOnce #haltOnce: #haltIf: #haltIfNil #haltOnCount: #halt:onCount: #break ) do: [:aLit | (self hasLiteral: aLit) ifTrue: [^ true]]. #(#Transcript #AA #BB #CC #DD #EE ) do: [:aSymbol | | assoc | (assoc := Smalltalk globals associationAt: aSymbol ifAbsent: []) ifNotNil: [(self hasLiteral: assoc) ifTrue: [^ true]]]. ^ false MCChangeSelector>>select {actions} · ct 1/15/2022 22:46 (changed) select + + (Preferences checkForSlips ==> [self lookForSlips]) ifFalse: [^ self]. + self answer: (MCPatch operations: kept) MCDefinition>>hasReportableSlip {testing} · ct 1/15/2022 22:49 + hasReportableSlip + + ^ false MCMethodDefinition (changed) MCDefinition subclass: #MCMethodDefinition - instanceVariableNames: 'classIsMeta source category selector className timeStamp' + instanceVariableNames: 'classIsMeta source category selector className timeStamp hasReportableSlip' classVariableNames: '' poolDictionaries: '' category: 'Monticello-Modeling' MCMethodDefinition class instanceVariableNames: 'definitions' "" MCMethodDefinition class>>forMethodReference: {create} · ct 1/15/2022 22:53 (changed) forMethodReference: aMethodReference | definition | definition := self cachedDefinitions at: aMethodReference compiledMethod ifAbsent: []. (definition isNil or: [definition selector ~= aMethodReference methodSymbol or: [definition className ~= aMethodReference classSymbol or: [definition classIsMeta ~= aMethodReference classIsMeta or: [definition category ~= aMethodReference category]]]]) ifTrue: [definition := self className: aMethodReference classSymbol classIsMeta: aMethodReference classIsMeta selector: aMethodReference methodSymbol category: aMethodReference category timeStamp: aMethodReference timeStamp source: aMethodReference source. + definition hasReportableSlip: aMethodReference compiledMethod hasReportableSlip. self cachedDefinitions at: aMethodReference compiledMethod put: definition]. ^ definition MCMethodDefinition>>hasReportableSlip {accessing} · ct 1/15/2022 22:54 + hasReportableSlip + + ^ hasReportableSlip ifNil: [false] MCMethodDefinition>>hasReportableSlip: {accessing} · ct 1/15/2022 22:53 + hasReportableSlip: aBoolean + + hasReportableSlip := aBoolean. MCPatchBrowser>>checkForSlips {actions} · ct 1/15/2022 23:12 + checkForSlips + + ^ self checkForSlipsIn: self items MCPatchBrowser>>checkForSlipsIn: {actions} · ct 1/15/2022 23:07 + checkForSlipsIn: patchItems + + ^ patchItems select: [:ea | ea hasReportableSlip] MCPatchBrowser>>lookForSlips {actions} · ct 1/15/2022 23:11 + lookForSlips + "Look for slips in all changes. If there are any, ask the user how to treat them. Answer true if the operation should go on, or false if it should be canceled." + + | slips | + slips := self checkForSlips ifEmpty: [^ true]. + (Project uiManager + chooseFromLabeledValues: (OrderedDictionary new + at: 'Browse slips' translated put: [self systemNavigation + browseMessageList: (slips collect: [:ea | ea definition asMethodReference]) + name: 'Possible slips in new version' translated]; + at: 'Ignore slips and continue' translated put: [^ true]; + at: 'Cancel' translated put: [^ false]; + yourself) + title: ('This patch contains {1} halts, Transcript sends, or other possible slips.\\Save the new version anyway?' withCRs translated format: {slips size})) value. + ^ false MCPatchBrowser>>methodListMenu: {menus} · ct 1/15/2022 23:01 + methodListMenu: aMenu + + super methodListMenu: aMenu. + + aMenu add: 'check for slips' translated help: 'Check all changes for possible slips such as forgotten breakpoints or logging statements.' translated action: #reportSlips. + + ^ aMenu MCPatchBrowser>>reportSlips {actions} · ct 1/15/2022 23:05 + reportSlips + "Look for slips in all changes and report to the user what was found." + + | slips | + slips := self checkForSlips ifEmpty: [^ self inform: 'There were no obvious slips in this patch' translated]. + self systemNavigation + browseMessageList: (slips collect: [:ea | ea definition asMethodReference]) + name: 'Possible slips in new version' translated. MCPatchOperation>>hasReportableSlip {testing} · ct 1/15/2022 22:49 + hasReportableSlip + + ^ self targetDefinition + ifNil: [false] + ifNotNil: [:def | def hasReportableSlip] MCSaveVersionDialog>>accept {actions} · ct 1/15/2022 23:06 (changed) accept | logMessage logMessageWidget | self updateItems. + + (Preferences checkForSlips ==> [self lookForSlips]) ifFalse: [^ self]. + logMessage := (logMessageWidget := self findTextMorph: #logMessage) text asString. (logMessage isEmpty or: [logMessage beginsWith: 'empty log message']) ifTrue: - [(UIManager confirm: 'the log message is empty; are you sure you want to commit') ifFalse: [^ self]] + [(self confirm: 'The log message is empty; are you sure you want to commit?' translated) ifFalse: [^ self]] ifFalse: [logMessageWidget accept]. + self answer: { (self findTextMorph: #versionName) text asString. logMessage. ignore } MCSaveVersionDialog>>checkForSlips {actions} · ct 1/15/2022 23:12 + checkForSlips + + ^ super checkForSlipsIn: (self items copyWithoutAll: self ignore) Preference>>helpString: {menu} · ct 1/16/2022 01:31 + helpString: aString + + helpString := aString --- Sent from Squeak Inbox Talk ["mcSlips.1.cs"] ["mcSlips.png"]

4 10

The Inbox: Morphic-ct.1641.mcz
by commits＠source.squeak.org 20 May '23

20 May '23

Christoph Thiede uploaded a new version of Morphic to project The Inbox: http://source.squeak.org/inbox/Morphic-ct.1641.mcz ==================== Summary ==================== Name: Morphic-ct.1641 Author: ct Time: 7 June 2020, 2:45:17.536284 pm UUID: b90e23e1-ce70-3d49-a8e4-f09af148ef97 Ancestors: Morphic-ct.1638 Refine #isHighFrequentEvent implementation for further event types. Fixes one possible cause of the "color depth = 0" bug. See http://forum.world.st/Image-not-startable-after-save-td5117084.html. Depends indeed on Morphic-ct.1638. =============== Diff against Morphic-ct.1638 =============== Item was added: + ----- Method: DropEvent>>isHighFrequentEvent (in category 'testing') ----- + isHighFrequentEvent + + ^ false! Item was added: + ----- Method: WindowEvent>>isHighFrequentEvent (in category 'testing') ----- + isHighFrequentEvent + + ^ (#(windowClose) includes: self type) not! Item was changed: ----- Method: WorldState>>doSafely:onErrorThat:setErrorFlag:ifFatal:afterErrorDo: (in category 'update cycle') ----- doSafely: aBlock onErrorThat: errorPredicate setErrorFlag: errorFlag ifFatal: fatalErrorBlock afterErrorDo: postErrorBlock "Evaluate aBlock and keep track of errors during morph invocations." | finished classesWithErrors | finished := false. classesWithErrors := IdentitySet new. [finished] whileFalse: [ [aBlock value. finished := true] on: Error, Halt, Warning do: [:ex | | err rcvr errCtxt errMorph | (errorPredicate cull: ex) ifFalse: [ex pass]. err := ex description. rcvr := ex receiver. errCtxt := thisContext. [ errCtxt := errCtxt sender. "Search the sender chain to find the morph causing the problem" [errCtxt notNil and: [(errCtxt receiver isMorph) not]] whileTrue: [errCtxt := errCtxt sender]. "If we're at the root of the context chain then we have a fatal problem" errCtxt ifNil: [^ fatalErrorBlock cull: err]. + errMorph := errCtxt receiver + ] doWhileTrue: [ - errMorph := errCtxt receiver. "If the morph causing the problem has already the error flag set, then search for the next morph above in the caller chain." errMorph hasProperty: errorFlag + ]. - ] whileTrue. errMorph setProperty: errorFlag toValue: true; changed. "Catch all errors, one for each receiver class." (classesWithErrors includes: rcvr class) ifFalse: [ classesWithErrors add: rcvr class. ToolSet debugException: ex]. postErrorBlock cull: err. ]].! Item was changed: ----- Method: WorldState>>processEventsSafely: (in category 'update cycle') ----- processEventsSafely: aHandMorph ^ self doSafely: [aHandMorph processEvents] + onErrorThat: [:error | self currentEvent ifNil: [true] ifNotNil: [:evt | evt isHighFrequentEvent]] - onErrorThat: [:error | ActiveEvent isNil or: [ActiveEvent isHighFrequentEvent]] setErrorFlag: #errorOnEvent ifFatal: [:error | Project current fatalEventHandlingError: error] afterErrorDo: []!

5 6

Review Request: stylePackageScripts.2.cs
by christoph.thiede＠student.hpi.uni-potsdam.de 18 May '23

18 May '23

Please give me a short feedback on whether you agree with the idea of this change (PackageInfo scripts are no longer instances of StringHolder). If there is no objection, I will try to merge this into the Trunk after a week or so. :-) ["stylePackageScripts.png"] Best, Christoph =============== Summary =============== Change Set: stylePackageScripts Date: 22 November 2021 Author: Christoph Thiede This change set enables syntax highlighting for package scripts ({preamble,postscript}{, of removal}). To achieve this, the instance variables in PackageInfo are converted to hold plain strings or texts rather than StringHolders, and the client (Monticello) is reponsible itself for displaying them to the user and storing them back into the package. Note the postscript which converts all PackageInfo instances in the image. =============== Postscript =============== "Postscript: Eliminate StringHolder script in PackageInfos" PackageInfo allSubInstancesDo: [:packageInfo | #(preamble postscript preambleOfRemoval postscriptOfRemoval) do: [:sel | (packageInfo instVarNamed: sel) ifNotNil: [:stringHolder | packageInfo instVarNamed: sel put: stringHolder contents]]]. =============== Diff =============== MCWorkingCopyBrowser>>editLoadScripts {morphic ui} · ct 11/22/2021 16:05 (changed) editLoadScripts | arg | self hasWorkingCopy ifFalse: [^self]. arg := UIManager default - chooseFrom: #('edit preamble' 'edit postscript' 'edit preambleOfRemoval' 'edit postscriptOfRemoval') + chooseFrom: {'edit preamble' translated. 'edit postscript' translated. 'edit preambleOfRemoval' translated. 'edit postscriptOfRemoval' translated} values: #(#preamble #postscript #preambleOfRemoval #postscriptOfRemoval). arg ifNotNil: [ self editScript: arg]. MCWorkingCopyBrowser>>editScript: {morphic ui} · ct 11/22/2021 15:59 (changed) editScript: scriptSymbol - | script | - script := workingCopy packageInfo perform: scriptSymbol. - script openLabel: scriptSymbol asString, ' of the Package ', workingCopy package name. + | script | + script := workingCopy packageInfo perform: scriptSymbol. + Project uiManager + edit: script + label: ('{1} of the Package {2}' translated format: {scriptSymbol asString capitalized. workingCopy package name}) + shouldStyle: true + accept: [:result | workingCopy packageInfo + perform: scriptSymbol asSimpleSetter + with: result] PackageInfo>>isScript:not: {preamble/postscript} · ct 11/22/2021 15:53 (changed) isScript: script not: default ^ script notNil and: [ | contents | - contents := script contents asString withBlanksTrimmed. + contents := script asString withBlanksTrimmed. contents notEmpty and: [contents ~= default and: [contents ~= 'nil']]] PackageInfo>>postscript {preamble/postscript} · ct 11/22/2021 15:53 (changed) postscript + ^ postscript ifNil: [ - postscript := StringHolder new contents: self postscriptDefault] + postscript := self postscriptDefault] PackageInfo>>postscript: {preamble/postscript} · ct 11/22/2021 15:57 (changed) postscript: aString - postscript := StringHolder new contents: aString + postscript := aString PackageInfo>>postscriptOfRemoval {preamble/postscript} · ct 11/22/2021 15:53 (changed) postscriptOfRemoval ^ postscriptOfRemoval ifNil: [ - postscriptOfRemoval := StringHolder new contents: self postscriptOfRemovalDefault] + postscriptOfRemoval := self postscriptOfRemovalDefault] PackageInfo>>postscriptOfRemoval: {preamble/postscript} · ct 11/22/2021 15:57 (changed) postscriptOfRemoval: aString - postscriptOfRemoval := StringHolder new contents: aString + postscriptOfRemoval := aString PackageInfo>>preamble {preamble/postscript} · ct 11/22/2021 15:54 (changed) preamble ^ preamble ifNil: [ - preamble := StringHolder new contents: self preambleDefault] + preamble := self preambleDefault] PackageInfo>>preamble: {preamble/postscript} · ct 11/22/2021 15:56 (changed) preamble: aString - preamble := StringHolder new contents: aString + preamble := aString PackageInfo>>preambleOfRemoval {preamble/postscript} · ct 11/22/2021 15:54 (changed) preambleOfRemoval ^ preambleOfRemoval ifNil: [ - preambleOfRemoval := StringHolder new contents: self preambleOfRemovalDefault] + preambleOfRemoval := self preambleOfRemovalDefault] PackageInfo>>preambleOfRemoval: {preamble/postscript} · ct 11/22/2021 15:56 (changed) preambleOfRemoval: aString - preambleOfRemoval := StringHolder new contents: aString + preambleOfRemoval := aString ["stylePackageScripts.2.cs"]

2 5

Exception reraiseFrom: (needs review)
by Eliot Miranda 02 Feb '23

02 Feb '23

Hi All, Hi Levente, Jaromir, and Context hackers, find attached a change set which supports re-raising a fatal exception, caught inside a critical section, outside the critical section. This is a key facility for debugging systems such as Croquet. I expect it'll also be useful in delimited continuation contexts such as Seaside. The facility is closely related to Context>>copyTo: and Context>>copyTo:bottomContextDo:. The main method is Exception>>copyForReraiseTo: aContext. This implementation is higher quality than Context>>copyTo:[bottomContextDo:]. It copies the stack and it also copies blocks that are created on the copied stack. So the copied stack correctly copies blocks, and hence exception handlers. I'm thinking of adding this to trunk. I would like it to be reviewed carefully before I do so. Both implementation and selector names need reviewing, and tests and more use cases would be nice (I have a use case in Virtend/Croquet). Here's an example usage: | sender error | sender := thisContext sender. Mutex new critical: [[nil new] on: Error do: [:ex| error := ex copyForReraiseTo: sender]]. error reraiseFrom: thisContext A simpler usage would be | home error | home := thisContext. Mutex new critical: [[nil new] on: Error do: [:ex| error := ex copyForReraiseTo: home]]. error outer This doesn't work because ProcessorScheduler>>#debugContext:title:full:contents: (et al) contains self assert: [thisContext hasSender: aContext] and hence we have to stitch the copied stack into the current stack via aContext privSender: signalContext. thisContext privSender: aContext. self outer inside Exception>>reraiseFrom: aContext Maybe adding a flag to Exception and avoiding that assert when the exception is "in reraise mode" is better. I don't know. Given that the main worker method, Context>>#copyTo:atEachStep:, is better than Context>>copyTo:[bottomContextDo:]., these two could be reimplemented in terms of it, e.g.: Context>>copyTo: aContext ^self copyTo: aContext atEachStep: [:originalContext :copiedContext| originalContext sender == aContext ifTrue: [copiedContext privSender: nil]] Context>>copyTo: aContext bottomContextDo: aBlock ^self copyTo: aContext atEachStep: [:originalContext :copiedContext| originalContext sender == aContext ifTrue: [copiedContext privSender: nil. aBlock value: copiedContext]] _,,,^..^,,,_ best, Eliot

3 4

FormInspector, or also: Text>>#= and its consequences
by Thiede, Christoph 12 Jan '23

12 Jan '23

Hi all, is there any old thread about the design discussion of how Text>>#= works? (It does not consider attributes for quality.) Has this decision ever been questioned? Naively and without an overview of any existing components that could rely on this implementation, I would like to question it. Why should 'foo' asText allBold be equal to 'foo' asText addAttribute: TextURL new? With the same logic, we could also say that two dictionaries are equal iff they have got the same keys ... There is even a concrete client in the Trunk suffering from this design decision: Marcel's new FormInspector (and analogously, MorphInspector). It uses TextFontReference with a FormSetFont to display a screenshot right in the inspector pane. Unfortunately, the pane is never updated automatically because even if the screenshot changes, the text morph thinks the old text would equal the new one. I'd like to fix that without hacking any workaround into the inspectors. Even though this inspector implementation is a bit unusual, in my opinion, it shows that the current Text >> #= implementation might not be a perfect solution. I'm looking forward to your opinions. Best, Christoph

8 11

Should I put my unofficial V3 versions of Squeak 5.2 and 5.3 on files.squeak.org?
by David T. Lewis 28 Dec '22

28 Dec '22

A couple of years ago, I put a copy of a Squeak 5.2 image in V3 object memory format on the squeakvm.org server, and I linked to it from the project page at http://www.squeaksource.com/TrunkUpdateStreamV3. That link has gone dead, and I think I recall someone noticing it a recently. I still have the files, should I put them somewhere on files.squeak.org? I was thinking of putting them under the "various_images" folder: files.squeak.org/various_images/squeak_V3_images/ I also have a V3 image that is up to date with the Squeak 5.3 release, so I could put that on line as well. These images will run under an up-to-date interpreter VM or a Cog VM. They may be of interest to people doing VM work, benchmarking, or as a reference to understand the image-side differences between Spur and V3. Dave

4 5

The Inbox: Help-Squeak-Project-ct.94.mcz
by commits＠source.squeak.org 14 Oct '22

14 Oct '22

A new version of Help-Squeak-Project was added to project The Inbox: http://source.squeak.org/inbox/Help-Squeak-Project-ct.94.mcz ==================== Summary ==================== Name: Help-Squeak-Project-ct.94 Author: ct Time: 21 June 2022, 10:59:45.096176 pm UUID: e922e850-4074-764e-bb2d-a7754075a639 Ancestors: Help-Squeak-Project-ct.93 Proposal: Adds help on how to contribute to Squeak. Short description of the community model, the development process, and some required/recommended tools. Updates the URLs in the page 'Squeak Resources Online' and adds a link to the new tutorial. Reorders project pages. Adds a very simple way to include figures to the new help book. =============== Diff against Help-Squeak-Project-ct.93 =============== Item was added: + SqueakProjectHelp subclass: #SqueakContributionHelp + instanceVariableNames: '' + classVariableNames: '' + poolDictionaries: '' + category: 'Help-Squeak-Project'! Item was added: + ----- Method: SqueakContributionHelp class>>bookBlurb (in category 'accessing') ----- + bookBlurb + + self flag: #moveUpstream. + ^ (self perform: self defaultPage) contents! Item was added: + ----- Method: SqueakContributionHelp class>>bookName (in category 'accessing') ----- + bookName + + ^ 'Contributing to Squeak'! Item was added: + ----- Method: SqueakContributionHelp class>>communityModel (in category 'pages') ----- (excessive size, no diff calculated) Item was added: + ----- Method: SqueakContributionHelp class>>contributingToSqueak (in category 'pages') ----- + contributingToSqueak + "This method was automatically generated. Edit it using:" + "SqueakContributionHelp edit: #contributingToSqueak" + <generated> + ^(HelpTopic + title: 'Contributing' + contents: + 'Contributing To Squeak + + As you might have noticed, Squeak is a completely open system, which makes it very easy not only to explore every interesting detail in the image but also to customize everything at your will. Whether you would like to adjust some colors, fix a bug you have stumbled upon, or add a new feature, everything is flexible and under your control. + + Squeak lives from your contributions!!!! Squeak is powered to 100% by volunteer open-source contributions. Whenever you make an adjustment to the base system, you might ask yourself: could others benefit from this change, too?, and if the answer is yes, we invite you to consider contributing back to the community. Also, if you just discovered a bug, have a question, or would like to discuss an idea, our forums are open!!!!!! + ]style[(24 39 22 158 18 8 3 28 17 50 37 143 43 197)a0b,a0,a0i,a0,Rcode:// SqueakTheme class>>#addSyntaxHighlighting:;,a0,Rcode:// + self systemNavigation browseAllImplementorsOf: #expectedFailures;,a0,,a0,a0i,a0,a0i,a0!!' readStream nextChunkText) + key: #contributingToSqueak; + shouldStyle: false; + yourself! Item was added: + ----- Method: SqueakContributionHelp class>>defaultPage (in category 'accessing') ----- + defaultPage + + ^ #contributingToSqueak! Item was added: + ----- Method: SqueakContributionHelp class>>firstContribution (in category 'pages') ----- + firstContribution + "This method was automatically generated. Edit it using:" + "SqueakContributionHelp edit: #firstContribution" + <generated> + ^(HelpTopic + title: 'First Contribution' + contents: + 'Making your first contribution + + * Install the latest Trunk updates + * Make your change, preferably from a clean image (to avoid configuration drift) + * Open the Monticello Browser: + * On the left, select the package you have changed (denoted with a *star). + * On the right, select the inbox repository. + * On the top, press save. + * Review your changes, enter a meaningful version message, and accept the new version to upload it. + * That''s it!!!! Your contribution has arrived in the inbox and soon you will receive feedback from the community through the mailing list. Keep an eye on your mailbox!!!!!! + ]style[(30 4 32 84 27 5 12 12 7 34 5 6 13 12 5 34 5 64 6 33 10 152)a0b,a0,Rcode:// + SqueakContributionHelp + openDockingBarMenuThat: [:m | (m owner submorphIndexOf: m) = 1] + filterItem: ''Update'';,a0,Rcode:// + SqueakContributionHelp + openDockingBarMenuThat: [:m | m contents = ''Tools''] + filterItem: ''Monticello Browser'';,,a0b,a0,a0b,a0,a0i,a0,a0b,a0,a0b,a0,a0b,a0,a0b,a0,a0i,a0!!' readStream nextChunkText) + key: #firstContribution; + shouldStyle: false; + yourself! Item was added: + ----- Method: SqueakContributionHelp class>>furtherConcepts (in category 'pages') ----- + furtherConcepts + "This method was automatically generated. Edit it using:" + "SqueakContributionHelp edit: #furtherConcepts" + <generated> + ^(HelpTopic + title: 'Further Concepts' + contents: + 'Further Concepts + + * Change sets: Usually, new proposals are best exchanged through an inbox version. However, some ideas consist of changes to multiple packages, when it becomes tricky to work with multiple inbox versions. In this case, a change set is a good alternative. You can open a dual change sorter from the Tools and Changes menus in the docking bar and make a yellow click on the change set list on the left to bring up some options. Create a new change set and copy or move all relevant changes to it. Add a preamble to the change set to add an explaining message and finally file out or mail to list it directly. To install a change set, you can file in it from the file list or by dragging it into the image. + * Preambles and postscripts: Some changes make it necessary to run some scripts before or after loading the new code to perform any migrations or changes to the object graph. This is possible through preambles and postscripts. To add or edit a script for a Monticello package, select it in the Monticello browser and press the Scripts button. Add your logic to the code, test it, accept it, and include it in your next inbox version. Note that preambles and postscripts in Trunk packages are required to be idempotent and may be evaluated multiple times. For changesets, you can add a preamble and a postscript as well from the yellow-button menu of the change set list in the change sorter. + * If you identify any other contribution-related concepts that should be mentioned or explained in greater detail here, please feel free to add them here. This would make an ideal first contribution. :-)!! + ]style[(16 4 12 256 18 10 5 5 7 111 23 5 4 4 4 29 14 60 8 4 12 47 7 13 9 37 26 266 18 15 7 561)a0b,a0,a0b,a0,a0i,a0,Rcode:// + SqueakContributionHelp + openDockingBarMenuThat: [:m | m contents = ''Tools''] + filterItem: ''Dual Change Sorter'';,a0,Rcode:// + SqueakContributionHelp + openDockingBarMenuThat: [:item | (item respondsTo: #updateContents) and: [(item instVarNamed: ''wordingSelector'') = #browseChangesLabel]] + filterItem: ''Dual Change Sorter'';,a0,a0i,a0,a0i,a0,a0i,a0,a0i,a0,a0i,a0,a0i,a0,a0i,a0,Rcode:// + SqueakContributionHelp + openDockingBarMenuThat: [:m | m contents = ''Tools''] + filterItem: ''File List'';,a0,a0b,a0,Rcode:// + SqueakContributionHelp + openDockingBarMenuThat: [:m | m contents = ''Tools''] + filterItem: ''Monticello Browser'';,a0,a0i,a0!!' readStream nextChunkText) + key: #furtherConcepts; + shouldStyle: false; + yourself! Item was added: + ----- Method: SqueakContributionHelp class>>openDockingBarMenuThat:filterItem: (in category 'support') ----- + openDockingBarMenuThat: menuBlock filterItem: filterString + + | dockingBar menu | + dockingBar := (self currentWorld mainDockingBars ifEmpty: [^ self]) first. + menu := (dockingBar submorphs select: #isMenuItemMorph) detect: menuBlock ifNone: [^ self]. + dockingBar selectItem: menu event: self currentEvent. + menu subMenu setProperty: #matchString toValue: filterString. + menu subMenu displayFiltered: self currentEvent. + ^ nil "do not answer a Behavior here, which would trigger another browser when sending this message from a TextURL"! Item was added: + ----- Method: SqueakContributionHelp class>>pages (in category 'accessing') ----- + pages + + ^ #(contributingToSqueak communityModel firstContribution squeakInboxTalk furtherConcepts)! Item was added: + ----- Method: SqueakContributionHelp class>>squeakInboxTalk (in category 'pages') ----- (excessive size, no diff calculated) Item was added: + TextAnchor subclass: #SqueakHelpTextImage + instanceVariableNames: '' + classVariableNames: '' + poolDictionaries: '' + category: 'Help-Squeak-Project'! + + !SqueakHelpTextImage commentStamp: 'ct 6/21/2022 22:54' prior: 0! + I embed a form into a text as a text anchor. I add support for fileIn/fileOut by storing the form as a base64 string. In the future, I'd like to make a great carrier and be moved "upstream" to a real Trunk package. For now, I still provide my humble service to some pages in the Squeak help.! Item was added: + ----- Method: SqueakHelpTextImage class>>forForm: (in category 'instance creation') ----- + forForm: aForm + + ^ self new + form: aForm; + yourself! Item was added: + ----- Method: SqueakHelpTextImage class>>scanCharacter (in category 'fileIn/Out') ----- + scanCharacter + + ^ $m! Item was added: + ----- Method: SqueakHelpTextImage class>>scanFrom: (in category 'fileIn/Out') ----- + scanFrom: aStream + + | base64 data form | + base64 := aStream upTo: $;. + data := Base64MimeConverter mimeDecodeToBytes: base64 readStream. + form := ImageReadWriter formFromStream: data. + ^ self forForm: form! Item was added: + ----- Method: SqueakHelpTextImage>>exportBase64 (in category 'fileIn/fileOut') ----- + exportBase64 + + ^ (ByteArray streamContents: [:stream | + PNGReadWriter putForm: self form onStream: stream]) + base64Encoded + ! Item was added: + ----- Method: SqueakHelpTextImage>>form (in category 'accessing') ----- + form + + ^ self anchoredMorph image! Item was added: + ----- Method: SqueakHelpTextImage>>form: (in category 'accessing') ----- + form: aForm + + self anchoredMorph: aForm asMorph.! Item was added: + ----- Method: SqueakHelpTextImage>>writeScanOn: (in category 'fileIn/fileOut') ----- + writeScanOn: aStream + + aStream + nextPut: self class scanCharacter; + nextPutAll: self exportBase64; + nextPut: $;.! Item was changed: ----- Method: SqueakProjectHelp class>>pages (in category 'accessing') ----- pages + ^#(workingWithSqueak squeakUserInterface extendingTheSystem squeakResourcesOnline)! - ^#(extendingTheSystem squeakResourcesOnline squeakUserInterface workingWithSqueak)! Item was changed: ----- Method: SqueakProjectHelp class>>squeakResourcesOnline (in category 'pages') ----- squeakResourcesOnline "This method was automatically generated. Edit it using:" "SqueakProjectHelp edit: #squeakResourcesOnline" + <generated> ^(HelpTopic title: 'Squeak Resources Online' contents: 'Web sites Main site of Squeak http://www.squeak.org Weekly Squeak http://news.squeak.org Downloads for many versions http://www.squeak.org/downloads Main site of OpenSmalltalk VM https://github.com/OpenSmalltalk/opensmalltalk-vm + GitHub Issue Tracker + https://github.com/squeak-smalltalk/squeak-object-memory/issues Mailing lists beginners This is the place to ask even the most basic questions. Don''t be afraid. Just ask. The community will help you get started with Squeak. http://lists.squeakfoundation.org/mailman/listinfo/beginners + http://forum.world.st/Squeak-Beginners-f107673.html (currently defect) - http://forum.world.st/Squeak-Beginners-f107673.html squeak-dev This is the main Squeak mailing list. Join that list to be part in the community. Subscribe to the mail server or read on a forum. + For more information on the community and the contribution process, check out the tutorial Contributing to Squeak in the following pages. http://lists.squeakfoundation.org/mailman/listinfo/squeak-dev + http://forum.world.st/Squeak-Dev-f45488.html (currently defect) - http://forum.world.st/Squeak-Dev-f45488.html vm-beginners This is the entry point for people who want to learn more about how Squeak runs on your operating system. You may ask even basic questions. :-) http://lists.squeakfoundation.org/mailman/listinfo/vm-beginners + http://forum.world.st/Smalltalk-VM-Beginners-f3068605.html (currently defect) - http://forum.world.st/Smalltalk-VM-Beginners-f3068605.html vm-dev This is the place where discussions about the OpenSmalltalk virtual machine happen. Join that list the be a part of the community. http://lists.squeakfoundation.org/mailman/listinfo/vm-dev + http://forum.world.st/Squeak-VM-f104410.html (currently defect) - http://forum.world.st/Squeak-VM-f104410.html Books Squeak By Example A beginners textbook, based on Squeak 3.9 and so a little out of date in some visual aspects and some details. Still a valuable resource. The content is maintained in github at https://github.com/SquareBracketAssociates/SqueakByExample-english but a prepared and ready to read pdf version can be found at https://pdxscholar.library.pdx.edu/cgi/viewcontent.cgi?article=1112&context… Other books Many books about Squeak and Smalltalk in general have been made available and are hosted at http://stephane.ducasse.free.fr/FreeBooks.html!! + ]style[(11 19 2 21 1 15 22 1 27 2 31 1 29 2 49 1 20 2 63 2 13 1 1 11 135 2 60 2 51 21 10 2 223 22 26 61 2 44 21 14 145 63 2 58 21 6 134 57 2 44 21 5 2 17 2 177 66 62 87 2 11 94 46)b,I0i,I0,Rhttp://www.squeak.org;,I0,I0i,Rhttp://news.squeak.org;,I0,I0i,… HelpBrowser openOn: SqueakContributionHelp;,,Rhttp://lists.squeakfoundation.org/mailman/listinf… ://github.com/SquareBracketAssociates/SqueakByExample-english;I1,,Rhttps://pdxscholar.library.pdx.edu/cgi/viewcontent.cgi?article=1112&context=compsci_fac;I1,,i,,Rhttp://stephane.ducasse.free.fr/FreeBooks.html;I1!!' readStream nextChunkText) - ]style[(11 19 2 21 1 15 22 1 27 2 31 32 49 2 13 1 1 11 135 2 60 2 51 2 10 2 132 61 2 44 2 14 145 63 2 58 2 6 134 57 2 44 2 5 2 17 2 177 66 62 87 2 11 94 46)b,I0i,I0,Rhttp://www.squeak.org;,I0,I0i,Rhttp://news.squeak.org;,I0,I0i,… tp://stephane.ducasse.free.fr/FreeBooks.html;I1!!' readStream nextChunkText) key: #squeakResourcesOnline; shouldStyle: false; yourself!

11 32

The Trunk: Regex-Help-pre.1.mcz
by commits＠source.squeak.org 12 Oct '22

12 Oct '22

Patrick Rein uploaded a new version of Regex-Help to project The Trunk: http://source.squeak.org/trunk/Regex-Help-pre.1.mcz ==================== Summary ==================== Name: Regex-Help-pre.1 Author: pre Time: 6 July 2018, 5:14:56.533269 pm UUID: 476b203d-1709-a54e-9a96-f0dfc3a93dfd Ancestors: Converts the regex documentation from class methods to a full help topic. ==================== Snapshot ==================== SystemOrganization addCategory: #'Regex-Help'! CustomHelp subclass: #RegexHelp instanceVariableNames: '' classVariableNames: '' poolDictionaries: '' category: 'Regex-Help'! ----- Method: RegexHelp class>>bookName (in category 'as yet unclassified') ----- bookName ^ 'Regex'! ----- Method: RegexHelp class>>changelog (in category 'as yet unclassified') ----- changelog "This method was automatically generated. Edit it using:" "RegexHelp edit: #changelog" ^(HelpTopic title: 'Changelog' contents: 'VERSION 1.3.1 (September 2008) 1. Updated documentation of character classes, making clear the problems of locale - an area for future improvement VERSION 1.3 (September 2008) 1. \w now matches underscore as well as alphanumerics, in line with most other regex libraries (and our documentation!!!!). 2. \W rejects underscore as well as alphanumerics 3. added tests for this at end of testSuite 4. updated documentation and added note to old incorrect comments in version 1.1 below VERSION 1.2.3 (November 2007) 1. Regexs with ^ or $ applied to copy empty strings caused infinite loops, e.g. ('''' copyWithRegex: ''^.*$'' matchesReplacedWith: ''foo''). Applied a similar correction to that from version 1.1c, to #copyStream:to:(replacingMatchesWith:|translatingMatchesUsing:). 2. Extended RxParser testing to run each test for #copy:translatingMatchesUsing: as well as #search:. 3. Corrected #testSuite test that a dot does not match a null, which was passing by luck with Smalltalk code in a literal array. 4. Added test to end of test suite for fix 1 above. VERSION 1.2.2 (November 2006) There was no way to specify a backslash in a character set. Now [\\] is accepted. VERSION 1.2.1 (August 2006) 1. Support for returning all ranges (startIndex to: stopIndex) matching a regex - #allRangesOfRegexMatches:, #matchingRangesIn: 2. Added hint to usage documentation on how to get more information about matches when enumerating 3. Syntax description of dot corrected: matches anything but NUL since 1.1a VERSION 1.2 (May 2006) Fixed case-insensitive search for character sets. VERSION 1.1c (December 2004) Fixed the issue with #matchesOnStream:do: which caused infinite loops for matches that matched empty strings. VERSION 1.1b (November 2001) Changes valueNowOrOnUnwindDo: to ensure:, plus incorporates some earlier fixes. VERSION 1.1a (May 2001) 1. Support for keeping track of multiple subexpressions. 2. Dot (.) matches anything but NUL character, as it should per POSIX spec. 3. Some bug fixes. VERSION 1.1 (October 1999) Regular expression syntax corrections and enhancements: 1. Backslash escapes similar to those in Perl are allowed in patterns: \w any word constituent character (equivalent to [a-zA-Z0-9_]) *** underscore only since 1.3 *** \W any character but a word constituent (equivalent to [^a-xA-Z0-9_] *** underscore only since 1.3 *** \d a digit (same as [0-9]) \D anything but a digit \s a whitespace character \S anything but a whitespace character \b an empty string at a word boundary \B an empty string not at a word boundary \< an empty string at the beginning of a word \> an empty string at the end of a word For example, ''\w+'' is now a valid expression matching any word. 2. The following backslash escapes are also allowed in character sets (between square brackets): \w, \W, \d, \D, \s, and \S. 3. The following grep(1)-compatible named character classes are recognized in character sets as well: [:alnum:] [:alpha:] [:cntrl:] [:digit:] [:graph:] [:lower:] [:print:] [:punct:] [:space:] [:upper:] [:xdigit:] For example, the following patterns are equivalent: ''[[:alnum:]_]+'' ''\w+'' ''[\w]+'' ''[a-zA-Z0-9_]+'' *** underscore only since 1.3 *** 4. Some non-printable characters can be represented in regular expressions using a common backslash notation: \t tab (Character tab) \n newline (Character lf) \r carriage return (Character cr) \f form feed (Character newPage) \e escape (Character esc) 5. A dot is corectly interpreted as ''any character but a newline'' instead of ''anything but whitespace''. 6. Case-insensitive matching. The easiest access to it are new messages CharacterArray understands: #asRegexIgnoringCase, #matchesRegexIgnoringCase:, #prefixMatchesRegexIgnoringCase:. 7. The matcher (an instance of RxMatcher, the result of String>>asRegex) now provides a collection-like interface to matches in a particular string or on a particular stream, as well as substitution protocol. The interface includes the following messages: matchesIn: aString matchesIn: aString collect: aBlock matchesIn: aString do: aBlock matchesOnStream: aStream matchesOnStream: aStream collect: aBlock matchesOnStream: aStream do: aBlock copy: aString translatingMatchesUsing: aBlock copy: aString replacingMatchesWith: replacementString copyStream: aStream to: writeStream translatingMatchesUsing: aBlock copyStream: aStream to: writeStream replacingMatchesWith: aString Examples: ''\w+'' asRegex matchesIn: ''now is the time'' returns an OrderedCollection containing four strings: ''now'', ''is'', ''the'', and ''time''. ''\<t\w+'' asRegexIgnoringCase copy: ''now is the Time'' translatingMatchesUsing: [:match | match asUppercase] returns ''now is THE TIME'' (the regular expression matches words beginning with either an uppercase or a lowercase T). ACKNOWLEDGEMENTS Since the first release of the matcher, thanks to the input from several fellow Smalltalkers, I became convinced a native Smalltalk regular expression matcher was worth the effort to keep it alive. For the contributions, suggestions, and bug reports that made this release possible, I want to thank: Felix Hack Peter Hatch Alan Knight Eliot Miranda Thomas Muhr Robb Shecter David N. Smith Francis Wolinski and anyone whom I haven''t yet met or heard from, but who agrees this has not been a complete waste of time.!!' readStream nextChunkText) key: #changelog! ----- Method: RegexHelp class>>examples (in category 'as yet unclassified') ----- examples "This method was automatically generated. Edit it using:" "RegexHelp edit: #examples" ^(HelpTopic title: 'Examples' contents: 'As the introductions said, a great use for regular expressions is userinput validation. Following are a few examples of regular expressionsthat might be handy in checking input entered by the user in an inputfield. Try them out by entering something between the quotes andprint-iting. (Also, try to imagine Smalltalk code that each validationwould require if coded by hand). Most example expressions could havebeen written in alternative ways. Checking if aString may represent a nonnegative integer number: '''' matchesRegex: '':isDigit:+''or '''' matchesRegex: ''[0-9]+''or '''' matchesRegex: ''\d+'' Checking if aString may represent an integer number with an optionalsign in front: '''' matchesRegex: ''(\+|-)?\d+'' Checking if aString is a fixed-point number, with at least one digitis required after a dot: '''' matchesRegex: ''(\+|-)?\d+(\.\d+)?'' The same, but allow notation like `123.'': '''' matchesRegex: ''(\+|-)?\d+(\.\d*)?'' Recognizer for a string that might be a name: one word with firstcapital letter, no blanks, no digits. More traditional: '''' matchesRegex: ''[A-Z][A-Za-z]*'' more Smalltalkish: '''' matchesRegex: '':isUppercase::isAlphabetic:*'' A date in format MMM DD, YYYY with any number of spaces in between, inXX century: '''' matchesRegex: ''(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)[ ]+(\d\d?)[ ]*,[ ]*19(\d\d)'' Note parentheses around some components of the expression above. As`Usage'' section shows, they will allow us to obtain the actual stringsthat have matched them (i.e. month name, day number, and year number). For dessert, coming back to numbers: here is a recognizer for ageneral number format: anything like 999, or 999.999, or -999.999e+21. '''' matchesRegex: ''(\+|-)?\d+(\.\d*)?((e|E)(\+|-)?\d+)?''!!!!!!' readStream nextChunkText) key: #examples! ----- Method: RegexHelp class>>implementationNotes (in category 'as yet unclassified') ----- implementationNotes "This method was automatically generated. Edit it using:" "RegexHelp edit: #implementationNotes" ^(HelpTopic title: 'Implementation Notes' contents: 'WHAT TO LOOK AT FIRST String>>matchesRegex: -- in 90% cases this method is all you need to access the package. RxParser -- accepts a string or a stream of characters with a regular expression, and produces a syntax tree corresponding to the expression. The tree is made of instances of Rxs<whatever> classes. RxMatcher -- accepts a syntax tree of a regular expression built by the parser and compiles it into a matcher: a structure made of instances of Rxm<whatever> classes. The RxMatcher instance can test whether a string or a positionable stream of characters matches the original regular expression, or search a string or a stream for substrings matching the expression. After a match is found, the matcher can report a specific string that matched the whole expression, or any parenthesized subexpression of it. All other classes support the above functionality and are used by RxParser, RxMatcher, or both. CAVEATS The matcher is similar in spirit, but NOT in the design--let alone the code--to the original Henry Spencer''s regular expression implementation in C. The focus is on simplicity, not on efficiency. I didn''t optimize or profile anything. I may in future--or I may not: I do this in my spare time and I don''t promise anything. The matcher passes H. Spencer''s test suite (see ''test suite'' protocol), with quite a few extra tests added, so chances are good there are not too many bugs. But watch out anyway. EXTENSIONS, FUTURE, ETC. With the existing separation between the parser, the syntax tree, and the matcher, it is easy to extend the system with other matchers based on other algorithms. In fact, I have a DFA-based matcher right now, but I don''t feel it is good enough to include it here. I might add automata-based matchers later, but again I don''t promise anything. HOW TO REACH ME As of today (December 20, 2000), you can contact me at <vassili(a)parcplace.com>. If this doesn''t work, look around comp.lang.smalltalk or comp.lang.lisp. !!' readStream nextChunkText) key: #implementationNotes! ----- Method: RegexHelp class>>introduction (in category 'as yet unclassified') ----- introduction "This method was automatically generated. Edit it using:" "RegexHelp edit: #introduction" ^(HelpTopic title: 'Introduction' contents: 'A regular expression is a template specifying a class of strings. A regular expression matcher is an tool that determines whether a string belongs to a class specified by a regular expression. This is a common task of a user input validation code, and the use of regular expressions can GREATLY simplify and speed up development of such code. As an example, here is how to verify that a string is a valid hexadecimal number in Smalltalk notation, using this matcher package: aString matchesRegex: ''16r[[:xdigit:]]+'' (Coding the same "the hard way'''' is an exercise to a curious reader). This matcher is offered to the Smalltalk community in hope it will be useful. It is free in terms of money, and to a large extent -- in terms of rights of use. Refer to the "Boring Stuff" section for legalese. The "Syntax" section explains the recognized syntax of regular expressions. The "Usage" section explains matcher capabilities that go beyond what String>>matchesRegex: method offers. The "Implementation Notes" sections says a few words about what is under the hood. The "Changelog" section describes the functionality introduced in 1.1 release. Happy hacking, --Vassili Bykov <vassili(a)objectpeople.com> <vassili(a)magma.ca> !! ]style[(479 40 712),daString matchesRegex: ''16r[[:xdigit:]]+'';;,!!' readStream nextChunkText) key: #introduction! ----- Method: RegexHelp class>>license (in category 'as yet unclassified') ----- license "This method was automatically generated. Edit it using:" "RegexHelp edit: #license" ^(HelpTopic title: 'License' contents: 'The Regular Expression Matcher (``The Software'''') is Copyright (C) 1996, 1999 Vassili Bykov. It is provided to the Smalltalk community in hope it will be useful. 1. This license applies to the package as a whole, as well as to any component of it. By performing any of the activities described below, you accept the terms of this agreement. 2. The software is provided free of charge, and "as is'''', in hope that it will be useful, with ABSOLUTELY NO WARRANTY. The entire risk and all responsibility for the use of the software is with you. Under no circumstances the author may be held responsible for loss of data, loss of profit, or any other damage resulting directly or indirectly from the use of the software, even if the damage is caused by defects in the software. 3. You may use this software in any applications you build. 4. You may distribute this software provided that the software documentation and copyright notices are included and intact. 5. You may create and distribute modified versions of the software, such as ports to other Smalltalk dialects or derived work, provided that: a. any modified version is expressly marked as such and is not misrepresented as the original software; b. credit is given to the original software in the source code and documentation of the derived work; c. the copyright notice at the top of this document accompanies copyright notices of any modified version.!!' readStream nextChunkText) key: #license! ----- Method: RegexHelp class>>pages (in category 'as yet unclassified') ----- pages ^ #(introduction syntax examples usage implementationNotes license changelog)! ----- Method: RegexHelp class>>syntax (in category 'as yet unclassified') ----- syntax "This method was automatically generated. Edit it using:" "RegexHelp edit: #syntax" ^(HelpTopic title: 'Syntax' contents: 'The simplest regular expression is a single character. It matchesexactly that character. A sequence of characters matches a string withexactly the same sequence of characters: ''a'' matchesRegex: ''a'' -- true ''foobar'' matchesRegex: ''foobar'' -- true ''blorple'' matchesRegex: ''foobar'' -- false The above paragraph introduced a primitive regular expression (acharacter), and an operator (sequencing). Operators are applied toregular expressions to produce more complex regular expressions.Sequencing (placing expressions one after another) as an operator is,in a certain sense, ''invisible''--yet it is arguably the most common. A more ''visible'' operator is Kleene closure, more often simplyreferred to as ''a star''. A regular expression followed by an asteriskmatches any number (including 0) of matches of the originalexpression. For example: ''ab'' matchesRegex: ''a*b'' -- true ''aaaaab'' matchesRegex: ''a*b'' -- true ''b'' matchesRegex: ''a*b'' -- true ''aac'' matchesRegex: ''a*b'' -- false: b does not match A star''s precedence is higher than that of sequencing. A star appliesto the shortest possible subexpression that precedes it. For example,''ab*'' means ''a followed by zero or more occurrences of b'', not ''zeroor more occurrences of ab'': ''abbb'' matchesRegex: ''ab*'' -- true ''abab'' matchesRegex: ''ab*'' -- false To actually make a regex matching ''zero or more occurrences of ab'',''ab'' is enclosed in parentheses: ''abab'' matchesRegex: ''(ab)*'' -- true ''abcab'' matchesRegex: ''(ab)*'' -- false: c spoils the fun Two other operators similar to ''*'' are ''+'' and ''?''. ''+'' (positiveclosure, or simply ''plus'') matches one or more occurrences of theoriginal expression. ''?'' (''optional'') matches zero or one, but nevermore, occurrences. ''ac'' matchesRegex: ''ab*c'' -- true ''ac'' matchesRegex: ''ab+c'' -- false: need at least one b ''abbc'' matchesRegex: ''ab+c'' -- true ''abbc'' matchesRegex: ''ab?c'' -- false: too many b''s As we have seen, characters ''*'', ''+'', ''?'', ''('', and '')'' have specialmeaning in regular expressions. If one of them is to be usedliterally, it should be quoted: preceded with a backslash. (Thus,backslash is also special character, and needs to be quoted for aliteral match--as well as any other special character describedfurther). ''ab*'' matchesRegex: ''ab*'' -- false: star in the right string is special ''ab*'' matchesRegex: ''ab\*'' -- true ''a\c'' matchesRegex: ''a\\c'' -- true The last operator is ''|'' meaning ''or''. It is placed between tworegular expressions, and the resulting expression matches if one ofthe expressions matches. It has the lowest possible precedence (lowerthan sequencing). For example, ''ab*|ba*'' means ''a followed by anynumber of b''s, or b followed by any number of a''s'': ''abb'' matchesRegex: ''ab*|ba*'' -- true ''baa'' matchesRegex: ''ab*|ba*'' -- true ''baab'' matchesRegex: ''ab*|ba*'' -- false A bit more complex example is the following expression, matching thename of any of the Lisp-style ''car'', ''cdr'', ''caar'', ''cadr'',... functions: c(a|d)+r It is possible to write an expression matching an empty string, forexample: ''a|''. However, it is an error to apply ''*'', ''+'', or ''?'' tosuch expression: ''(a|)*'' is an invalid expression. So far, we have used only characters as the ''smallest'' components ofregular expressions. There are other, more ''interesting'', components. A character set is a string of characters enclosed in squarebrackets. It matches any single character if it appears between thebrackets. For example, ''[01]'' matches either ''0'' or ''1'': ''0'' matchesRegex: ''[01]'' -- true ''3'' matchesRegex: ''[01]'' -- false ''11'' matchesRegex: ''[01]'' -- false: a set matches only one character Using plus operator, we can build the following binary numberrecognizer: ''10010100'' matchesRegex: ''[01]+'' -- true ''10001210'' matchesRegex: ''[01]+'' -- false If the first character after the opening bracket is ''^'', the set isinverted: it matches any single character *not* appearing between thebrackets: ''0'' matchesRegex: ''[^01]'' -- false ''3'' matchesRegex: ''[^01]'' -- true For convenience, a set may include ranges: pairs of charactersseparated with ''-''. This is equivalent to listing all charactersbetween them: ''[0-9]'' is the same as ''[0123456789]''. Special characters within a set are ''^'', ''-'', and '']'' that closes theset. Below are the examples of how to literally use them in a set: [01^] -- put the caret anywhere except the beginning [01-] -- put the dash as the last character []01] -- put the closing bracket as the first character [^]01] (thus, empty and universal sets cannot be specified) Regular expressions can also include the following backquote escapesto refer to popular classes of characters: \w any word constituent character (same as [a-zA-Z0-9_]) \W any character but a word constituent \d a digit (same as [0-9]) \D anything but a digit \s a whitespace character (same as [:space:] below) \S anything but a whitespace character These escapes are also allowed in character classes: ''[\w+-]'' means''any character that is either a word constituent, or a plus, or aminus''. Character classes can also include the following grep(1)-compatibleelements to refer to: [:alnum:] any alphanumeric character (same as [a-zA-Z0-9]) [:alpha:] any alphabetic character (same as [a-zA-Z]) [:cntrl:] any control character. (any character with code < 32) [:digit:] any decimal digit (same as [0-9]) [:graph:] any graphical character. (any character with code >= 32). [:lower:] any lowercase character (including non-ASCII lowercase characters) [:print:] any printable character. In this version, this is the same as [:graph:] [:punct:] any punctuation character: . , !!!!!!!! ? ; : '' - ( ) '' and double quotes [:space:] any whitespace character (space, tab, CR, LF, null, form feed, Ctrl-Z, 16r2000-16r200B, 16r3000) [:upper:] any uppercase character (including non-ASCII uppercase characters) [:xdigit:] any hexadecimal character (same as [a-fA-F0-9]). Note that many of these are only as consistent or inconsistent on issuesof locale as the underlying Smalltalk implementation. Values shown hereare for VisualWorks 7.6. Note that these elements are components of the character classes,i.e. they have to be enclosed in an extra set of square brackets toform a valid regular expression. For example, a non-empty string ofdigits would be represented as ''[[:digit:]]+''. The above primitive expressions and operators are common to manyimplementations of regular expressions. The next primitive expressionis unique to this Smalltalk implementation. A sequence of characters between colons is treated as a unary selectorwhich is supposed to be understood by Characters. A character matchessuch an expression if it answers true to a message with thatselector. This allows a more readable and efficient way of specifyingcharacter classes. For example, ''[0-9]'' is equivalent to '':isDigit:'',but the latter is more efficient. Analogously to character sets,character classes can be negated: '':^isDigit:'' matches a Characterthat answers false to #isDigit, and is therefore equivalent to''[^0-9]''. As an example, so far we have seen the following equivalent ways towrite a regular expression that matches a non-empty string of digits: ''[0-9]+'' ''\d+'' ''[\d]+'' ''[[:digit:]]+'' '':isDigit:+'' The last group of special primitive expressions includes: . matching any character except a NULL; ^ matching an empty string at the beginning of a line; $ matching an empty string at the end of a line. \b an empty string at a word boundary \B an empty string not at a word boundary \< an empty string at the beginning of a word \> an empty string at the end of a word ''axyzb'' matchesRegex: ''a.+b'' -- true ''ax zb'' matchesRegex: ''a.+b'' -- true (space is matched by ''.'') ''axzb'' matchesRegex: ''a.+b'' -- true (carriage return is matched by ''.'') Again, the dot ., caret ^ and dollar $ characters are special and should be quotedto be matched literally.!! ]style[(179 21 7851),f5,!!' readStream nextChunkText) key: #syntax! ----- Method: RegexHelp class>>usage (in category 'as yet unclassified') ----- usage "This method was automatically generated. Edit it using:" "RegexHelp edit: #usage" ^(HelpTopic title: 'Usage' contents: 'The preceding section covered the syntax of regular expressions. It used the simplest possible interface to the matcher: sending #matchesRegex: message to the sample string, with regular expression string as the argument. This section explains hairier ways of using the matcher. PREFIX MATCHING AND CASE-INSENSITIVE MATCHING A CharacterArray (an EsString in VA) also understands these messages: #prefixMatchesRegex: regexString #matchesRegexIgnoringCase: regexString #prefixMatchesRegexIgnoringCase: regexString #prefixMatchesRegex: is just like #matchesRegex, except that the whole receiver is not expected to match the regular expression passed as the argument; matching just a prefix of it is enough. For example: ''abcde'' matchesRegex: ''(a|b)+'' -- false ''abcde'' prefixMatchesRegex: ''(a|b)+'' -- true The last two messages are case-insensitive versions of matching. ENUMERATION INTERFACE An application can be interested in all matches of a certain regular expression within a String. The matches are accessible using a protocol modelled after the familiar Collection-like enumeration protocol: #regex: regexString matchesDo: aBlock Evaluates a one-argument <aBlock> for every match of the regular expression within the receiver string. #regex: regexString matchesCollect: aBlock Evaluates a one-argument <aBlock> for every match of the regular expression within the receiver string. Collects results of evaluations and anwers them as a SequenceableCollection. #allRegexMatches: regexString Returns a collection of all matches (substrings of the receiver string) of the regular expression. It is an equivalent of <aString regex: regexString matchesCollect: [:each | each]>. #allRangesOfRegexMatches: regexString Returns a collection of all character ranges (startIndex to: stopIndex) that match the regular expression. REPLACEMENT AND TRANSLATION It is possible to replace all matches of a regular expression with a certain string using the message: #copyWithRegex: regexString matchesReplacedWith: aString For example: ''ab cd ab'' copyWithRegex: ''(a|b)+'' matchesReplacedWith: ''foo'' A more general substitution is match translation: #copyWithRegex: regexString matchesTranslatedUsing: aBlock This message evaluates a block passing it each match of the regular expression in the receiver string and answers a copy of the receiver with the block results spliced into it in place of the respective matches. For example: ''ab cd ab'' copyWithRegex: ''(a|b)+'' matchesTranslatedUsing: [:each | each asUppercase] All messages of enumeration and replacement protocols perform a case-sensitive match. Case-insensitive versions are not provided as part of a CharacterArray protocol. Instead, they are accessible using the lower-level matching interface. LOWER-LEVEL INTERFACE Internally, #matchesRegex: works as follows: 1. A fresh instance of RxParser is created, and the regular expression string is passed to it, yielding the expression''s syntax tree. 2. The syntax tree is passed as an initialization parameter to an instance of RxMatcher. The instance sets up some data structure that will work as a recognizer for the regular expression described by the tree. 3. The original string is passed to the matcher, and the matcher checks for a match. THE MATCHER If you repeatedly match a number of strings against the same regular expression using one of the messages defined in CharacterArray, the regular expression string is parsed and a matcher is created anew for every match. You can avoid this overhead by building a matcher for the regular expression, and then reusing the matcher over and over again. You can, for example, create a matcher at a class or instance initialization stage, and store it in a variable for future use. You can create a matcher using one of the following methods: - Sending #forString:ignoreCase: message to RxMatcher class, with the regular expression string and a Boolean indicating whether case is ignored as arguments. - Sending #forString: message. It is equivalent to <... forString: regexString ignoreCase: false>. A more convenient way is using one of the two matcher-created messages understood by CharacterArray. - <regexString asRegex> is equivalent to <RxMatcher forString: regexString>. - <regexString asRegexIgnoringCase> is equivalent to <RxMatcher forString: regexString ignoreCase: true>. Here are four examples of creating a matcher: hexRecognizer := RxMatcher forString: ''16r[0-9A-Fa-f]+'' hexRecognizer := RxMatcher forString: ''16r[0-9A-Fa-f]+'' ignoreCase: false hexRecognizer := ''16r[0-9A-Fa-f]+'' asRegex hexRecognizer := ''16r[0-9A-F]+'' asRegexIgnoringCase MATCHING The matcher understands these messages (all of them return true to indicate successful match or search, and false otherwise): matches: aString True if the whole target string (aString) matches. matchesPrefix: aString True if some prefix of the string (not necessarily the whole string) matches. search: aString Search the string for the first occurrence of a matching substring. (Note that the first two methods only try matching from the very beginning of the string). Using the above example with a matcher for `a+'', this method would answer success given a string `baaa'', while the previous two would fail. matchesStream: aStream matchesStreamPrefix: aStream searchStream: aStream Respective analogs of the first three methods, taking input from a stream instead of a string. The stream must be positionable and peekable. All these methods answer a boolean indicating success. The matcher also stores the outcome of the last match attempt and can report it: lastResult Answers a Boolean -- the outcome of the most recent match attempt. If no matches were attempted, the answer is unspecified. SUBEXPRESSION MATCHES After a successful match attempt, you can query the specifics of which part of the original string has matched which part of the whole expression. A subexpression is a parenthesized part of a regular expression, or the whole expression. When a regular expression is compiled, its subexpressions are assigned indices starting from 1, depth-first, left-to-right. For example, `((ab)+(c|d))?ef'' includes the following subexpressions with these indices: 1: ((ab)+(c|d))?ef 2: (ab)+(c|d) 3: ab 4: c|d After a successful match, the matcher can report what part of the original string matched what subexpression. It understandards these messages: subexpressionCount Answers the total number of subexpressions: the highest value that can be used as a subexpression index with this matcher. This value is available immediately after initialization and never changes. subexpression: anIndex An index must be a valid subexpression index, and this message must be sent only after a successful match attempt. The method answers a substring of the original string the corresponding subexpression has matched to. subBeginning: anIndex subEnd: anIndex Answer positions within the original string or stream where the match of a subexpression with the given index has started and ended, respectively. This facility provides a convenient way of extracting parts of input strings of complex format. For example, the following piece of code uses the ''MMM DD, YYYY'' date format recognizer example from the `Syntax'' section to convert a date to a three-element array with year, month, and day strings (you can select and evaluate it right here): | matcher | matcher := RxMatcher forString: ''(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)[ ]+(:isDigit::isDigit:?)[ ]*,[ ]*(19|20)(:isDigit::isDigit:)''. (matcher matches: ''Aug 6, 1996'') ifTrue: [Array with: (matcher subexpression: 5) with: (matcher subexpression: 2) with: (matcher subexpression: 3)] ifFalse: [''no match''] (should answer ` #(''96'' ''Aug'' ''6'')''). ENUMERATION AND REPLACEMENT The enumeration and replacement protocols exposed in CharacterArray are actually implemented by the matcher. The following messages are understood: #matchesIn: aString #matchesIn: aString do: aBlock #matchesIn: aString collect: aBlock #copy: aString replacingMatchesWith: replacementString #copy: aString translatingMatchesUsing: aBlock #matchingRangesIn: aString #matchesOnStream: aStream #matchesOnStream: aStream do: aBlock #matchesOnStream: aStream collect: aBlock #copy: sourceStream to: targetStream replacingMatchesWith: replacementString #copy: sourceStream to: targetStream translatingMatchesWith: aBlock Note that in those methods that take a block, the block may refer to the rxMatcher itself, e.g. to collect information about the position the match occurred at, or the subexpressions of the match. An example can be seen in #matchingRangesIn: ERROR HANDLING Exception signaling objects (Signals in VisualWorks, Exceptions in VisualAge) are accessible through RxParser class protocol. To handle possible errors, use the protocol described below to obtain the exception objects and use the protocol of the native Smalltalk implementation to handle them. If a syntax error is detected while parsing expression, RxParser>>syntaxErrorSignal is raised/signaled. If an error is detected while building a matcher, RxParser>>compilationErrorSignal is raised/signaled. If an error is detected while matching (for example, if a bad selector was specified using `:<selector>:'' syntax, or because of the matcher''s internal error), RxParser>>matchErrorSignal is raised RxParser>>regexErrorSignal is the parent of all three. Since any of the three signals can be raised within a call to #matchesRegex:, it is handy if you want to catch them all. For example: VisualWorks: RxParser regexErrorSignal handle: [:ex | ex returnWith: nil] do: [''abc'' matchesRegex: ''))garbage[''] VisualAge: [''abc'' matchesRegex: ''))garbage[''] when: RxParser regexErrorSignal do: [:signal | signal exitWith: nil]!!' readStream nextChunkText) key: #usage!

2 1

Jump to page: