hpi-swa-lab · LinqLover · Nov 21, 2023 · Nov 21, 2023 · Nov 21, 2023 · Nov 21, 2023
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -135,11 +135,18 @@ jobs:
         run: mv SBE.pdf SBE-${{ matrix.smalltalk }}.pdf
         env:
           SQUEAK_VERSION: ${{ matrix.smalltalk }}
-      - name: 💾 Upload artifact
+      - name: 💾 Upload PDF
         uses: actions/upload-artifact@master
         with:
           name: book-${{ matrix.smalltalk }}
           path: SBE-${{ matrix.smalltalk }}.pdf
+      - name: 💾 Upload figures (for debugging and local builds)
+        # run even if figures failed but only when it has run
+        if: steps.figures.outcome == 'success' || steps.figures.outcome == 'failure'
+        uses: actions/upload-artifact@master
+        with:
+          name: figures-${{ matrix.smalltalk }}
+          path: ./*/**/*.png
       - if: (steps.figures.outcome == 'failure')
         name: Check DEBUG_FIGURES
         run: |

diff --git a/.squot b/.squot
@@ -8,5 +8,8 @@ OrderedDictionary {
 	'SmalltalkSources/SBE-Extract.package' : #SquotCypressCodeSerializer,
 	'SmalltalkSources/BaselineOfSBE.package' : #SquotCypressCodeSerializer,
 	'SmalltalkSources/SBE-Monticello.package' : #SquotCypressCodeSerializer,
-	'SmalltalkSources/SBE-Tests.package' : #SquotCypressCodeSerializer
+	'SmalltalkSources/SBE-Tests.package' : #SquotCypressCodeSerializer,
+	'SmalltalkSources/SBE-Book.package' : #SquotCypressCodeSerializer,
+	'SmalltalkSources/SBE-ExtractBook.package' : #SquotCypressCodeSerializer,
+	'SmalltalkSources/SBE-BookCompatibility-Squeak60.package' : #SquotCypressCodeSerializer
 }
diff --git a/SmalltalkSources/BaselineOfSBE.package/BaselineOfSBE.class/instance/baseline..st b/SmalltalkSources/BaselineOfSBE.package/BaselineOfSBE.class/instance/baseline..st
@@ -5,9 +5,15 @@ baseline: spec
 		spec baseline: 'FileSystem' with: [spec
 			repository: 'github://squeak-smalltalk/squeak-filesystem:master/src';
 			loads: #('default' 'tests')].
+		spec baseline: 'SBTreeSitter' with: [spec
+			repository: 'github://hpi-swa-lab/sb-tree-sitter:master/packages';
+			loads: 'Sandblocks-TreeSitter'].
 		spec
+			package: #'SBE-Book';
 			package: #'SBE-Environment';
 			package: #'SBE-Extract' with: [spec requires: #('FileSystem')];
+			package: #'SBE-ExtractBook' with: [
+				spec requires: #(#'SBE-Book' 'FileSystem' 'SBTreeSitter')];
 			package: #'SBE-Monticello';
 			package: #'SBE-Morphic';
 			package: #'SBE-Quinto';
@@ -24,4 +30,9 @@ baseline: spec
 			#'SBE-QuickTour'
 			#'SBE-Streams'
 			#'SBE-Testing'
-			#'SBE-Tests')].
+			#'SBE-Tests')].
+
+	spec for: #(#'squeak6.0.x.release') do: [
+		spec package: #'SBE-BookCompatibility-Squeak60'.
+		spec package: #'SBE-Book' with: [
+			spec includes: #'SBE-BookCompatibility-Squeak60']].
diff --git a/...talkSources/BaselineOfSBE.package/BaselineOfSBE.class/instance/customProjectAttributes.st b/...talkSources/BaselineOfSBE.package/BaselineOfSBE.class/instance/customProjectAttributes.st
@@ -0,0 +1,12 @@
+accessing
+customProjectAttributes
+
+	| attributes |
+	attributes := super customProjectAttributes.
+	(Smalltalk classNamed: #SystemVersion) ifNotNil: [:versionClass |
+		versionClass current isRelease ifTrue:
+			[attributes := attributes ,
+				(MetacelloPlatform current defaultPlatformAttributes
+					select: [:ea | ea matchesRegex: 'squeak\d.*']
+					thenCollect: [:ea | ea , '.release'])]].
+	^ attributes
diff --git a/SmalltalkSources/BaselineOfSBE.package/BaselineOfSBE.class/instance/projectClass.st b/SmalltalkSources/BaselineOfSBE.package/BaselineOfSBE.class/instance/projectClass.st
@@ -0,0 +1,4 @@
+accessing
+projectClass
+
+	^ (self environment classNamed: #MetacelloCypressBaselineProject) ifNil: [super projectClass]
diff --git a/SmalltalkSources/BaselineOfSBE.package/BaselineOfSBE.class/methodProperties.json b/SmalltalkSources/BaselineOfSBE.package/BaselineOfSBE.class/methodProperties.json
@@ -2,4 +2,6 @@
 	"class" : {
 		 },
 	"instance" : {
-		"baseline:" : "ct 4/26/2021 18:32" } }
+		"baseline:" : "ct 11/21/2023 21:15",
+		"customProjectAttributes" : "ct 11/7/2023 12:22",
+		"projectClass" : "ct 11/21/2023 19:54" } }
diff --git a/SmalltalkSources/SBE-Book.package/.filetree b/SmalltalkSources/SBE-Book.package/.filetree
@@ -0,0 +1,4 @@
+{
+	"noMethodMetaData" : true,
+	"separateMethodMetaAndSource" : false,
+	"useCypressPropertiesFile" : true }
diff --git a/SmalltalkSources/SBE-Book.package/.squot-contents b/SmalltalkSources/SBE-Book.package/.squot-contents
@@ -0,0 +1,6 @@
+SquotTrackedObjectMetadata {
+	#objectClassName : #PackageInfo,
+	#id : UUID [ '6332283563594a83a7e250aeafb5702d' ],
+	#objectsReplacedByNames : true,
+	#serializer : #SquotCypressCodeSerializer
+}
diff --git a/SmalltalkSources/SBE-Book.package/Form.extension/instance/asSbeTextAnchor.st b/SmalltalkSources/SBE-Book.package/Form.extension/instance/asSbeTextAnchor.st
@@ -0,0 +1,5 @@
+*SBE-Book-converting
+asSbeTextAnchor
+
+	^ SBETextAnchor new
+		copySameFrom: self asTextAnchor
diff --git a/SmalltalkSources/SBE-Book.package/Form.extension/instance/asSbeTextAnchorWithExtent..st b/SmalltalkSources/SBE-Book.package/Form.extension/instance/asSbeTextAnchorWithExtent..st
@@ -0,0 +1,6 @@
+*SBE-Book-converting
+asSbeTextAnchorWithExtent: extent
+
+	^ self asSbeTextAnchor
+		extent: extent;
+		yourself
diff --git a/...alkSources/SBE-Book.package/Form.extension/instance/asSbeTextAnchorWithExtent.dyeMode..st b/...alkSources/SBE-Book.package/Form.extension/instance/asSbeTextAnchorWithExtent.dyeMode..st
@@ -0,0 +1,6 @@
+*SBE-Book-converting
+asSbeTextAnchorWithExtent: extent dyeMode: dyeMode
+
+	^ (self asSbeTextAnchorWithExtent: extent)
+		dyeMode: dyeMode;
+		yourself
diff --git a/SmalltalkSources/SBE-Book.package/Form.extension/methodProperties.json b/SmalltalkSources/SBE-Book.package/Form.extension/methodProperties.json
@@ -0,0 +1,7 @@
+{
+	"class" : {
+		 },
+	"instance" : {
+		"asSbeTextAnchor" : "ct 11/15/2023 19:38",
+		"asSbeTextAnchorWithExtent:" : "ct 11/21/2023 18:00",
+		"asSbeTextAnchorWithExtent:dyeMode:" : "ct 11/21/2023 18:16" } }
diff --git a/SmalltalkSources/SBE-Book.package/Form.extension/properties.json b/SmalltalkSources/SBE-Book.package/Form.extension/properties.json
@@ -0,0 +1,2 @@
+{
+	"name" : "Form" }
diff --git a/SmalltalkSources/SBE-Book.package/Object.extension/instance/sbeStoreHtmlString.st b/SmalltalkSources/SBE-Book.package/Object.extension/instance/sbeStoreHtmlString.st
@@ -0,0 +1,4 @@
+*SBE-Book-converting
+sbeStoreHtmlString
+
+	^ self fullPrintString
diff --git a/SmalltalkSources/SBE-Book.package/Object.extension/methodProperties.json b/SmalltalkSources/SBE-Book.package/Object.extension/methodProperties.json
@@ -0,0 +1,5 @@
+{
+	"class" : {
+		 },
+	"instance" : {
+		"sbeStoreHtmlString" : "ct 11/15/2023 20:14" } }
diff --git a/SmalltalkSources/SBE-Book.package/Object.extension/properties.json b/SmalltalkSources/SBE-Book.package/Object.extension/properties.json
@@ -0,0 +1,2 @@
+{
+	"name" : "Object" }
diff --git a/SmalltalkSources/SBE-Book.package/SBEBook.class/README.md b/SmalltalkSources/SBE-Book.package/SBEBook.class/README.md
diff --git a/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/bookIndex..st b/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/bookIndex..st
@@ -0,0 +1,4 @@
+accessing
+bookIndex: aBookIndex
+
+	bookIndex := aBookIndex.
diff --git a/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/bookIndex.st b/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/bookIndex.st
@@ -0,0 +1,4 @@
+accessing
+bookIndex
+
+	^ bookIndex
diff --git a/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/canonicalHierarchyOrder.st b/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/canonicalHierarchyOrder.st
@@ -0,0 +1,4 @@
+accessing
+canonicalHierarchyOrder
+
+	^ 0
diff --git a/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/index..st b/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/index..st
@@ -0,0 +1,4 @@
+accessing
+index: anInteger
+
+	self assert: anInteger isNil.
diff --git a/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/index.st b/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/index.st
@@ -0,0 +1,4 @@
+accessing
+index
+
+	^ nil
diff --git a/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/pdfUrl..st b/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/pdfUrl..st
@@ -0,0 +1,4 @@
+accessing
+pdfUrl: aUrl
+
+	pdfUrl := aUrl asUrl.
diff --git a/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/pdfUrl.st b/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/pdfUrl.st
@@ -0,0 +1,4 @@
+accessing
+pdfUrl
+
+	^ pdfUrl
diff --git a/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/pdfUrlFragment.st b/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/pdfUrlFragment.st
@@ -0,0 +1,4 @@
+accessing
+pdfUrlFragment
+
+	^ nil
diff --git a/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/storeOn..st b/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/storeOn..st
@@ -0,0 +1,11 @@
+converting
+storeOn: aStream
+
+	aStream nextPutAll:
+('({1}
+	pdfUrl: {2};
+	bookIndex: {3};
+	yourself)' format:
+		{String streamContents: [:stream | super storeOn: stream].
+		self pdfUrl storeString.
+		self bookIndex storeString})
diff --git a/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/textForHelp.st b/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/textForHelp.st
@@ -0,0 +1,11 @@
+converting
+textForHelp
+
+	| helpText index |
+	helpText := super textForHelp.
+
+	self flag: #hacked. "There is too much ill-parsed nonsense before the actual title right now."
+	index := helpText findString: self title.
+	index = 0 ifTrue: [^ helpText].
+
+	^ (helpText allButFirst: index + self title size) withBlanksTrimmed
diff --git a/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/type.st b/SmalltalkSources/SBE-Book.package/SBEBook.class/instance/type.st
@@ -0,0 +1,4 @@
+accessing
+type
+
+	^ #book
diff --git a/SmalltalkSources/SBE-Book.package/SBEBook.class/methodProperties.json b/SmalltalkSources/SBE-Book.package/SBEBook.class/methodProperties.json
@@ -0,0 +1,15 @@
+{
+	"class" : {
+		 },
+	"instance" : {
+		"bookIndex" : "ct 11/26/2023 18:00",
+		"bookIndex:" : "ct 11/26/2023 18:00",
+		"canonicalHierarchyOrder" : "ct 11/8/2023 22:38",
+		"index" : "ct 11/25/2023 23:09",
+		"index:" : "ct 11/25/2023 23:09",
+		"pdfUrl" : "ct 11/24/2023 18:38",
+		"pdfUrl:" : "ct 11/24/2023 18:38",
+		"pdfUrlFragment" : "ct 11/24/2023 18:30",
+		"storeOn:" : "ct 11/26/2023 18:01",
+		"textForHelp" : "ct 11/26/2023 18:53",
+		"type" : "ct 11/25/2023 19:50" } }
diff --git a/SmalltalkSources/SBE-Book.package/SBEBook.class/properties.json b/SmalltalkSources/SBE-Book.package/SBEBook.class/properties.json
@@ -0,0 +1,15 @@
+{
+	"category" : "SBE-Book",
+	"classinstvars" : [
+		 ],
+	"classvars" : [
+		 ],
+	"commentStamp" : "",
+	"instvars" : [
+		"pdfUrl",
+		"bookIndex" ],
+	"name" : "SBEBook",
+	"pools" : [
+		 ],
+	"super" : "SBEBookNode",
+	"type" : "normal" }
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookChapter.class/README.md b/SmalltalkSources/SBE-Book.package/SBEBookChapter.class/README.md
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookChapter.class/instance/canonicalHierarchyOrder.st b/SmalltalkSources/SBE-Book.package/SBEBookChapter.class/instance/canonicalHierarchyOrder.st
@@ -0,0 +1,4 @@
+accessing
+canonicalHierarchyOrder
+
+	^ 2
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookChapter.class/instance/pdfUrlFragment.st b/SmalltalkSources/SBE-Book.package/SBEBookChapter.class/instance/pdfUrlFragment.st
@@ -0,0 +1,5 @@
+accessing
+pdfUrlFragment
+
+	^ '{1}.{2}' format:
+		{self typeName. self index}
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookChapter.class/instance/type.st b/SmalltalkSources/SBE-Book.package/SBEBookChapter.class/instance/type.st
@@ -0,0 +1,4 @@
+accessing
+type
+
+	^ #chapter
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookChapter.class/methodProperties.json b/SmalltalkSources/SBE-Book.package/SBEBookChapter.class/methodProperties.json
@@ -0,0 +1,7 @@
+{
+	"class" : {
+		 },
+	"instance" : {
+		"canonicalHierarchyOrder" : "ct 11/8/2023 22:38",
+		"pdfUrlFragment" : "ct 11/25/2023 19:52",
+		"type" : "ct 11/25/2023 19:50" } }
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookChapter.class/properties.json b/SmalltalkSources/SBE-Book.package/SBEBookChapter.class/properties.json
@@ -0,0 +1,14 @@
+{
+	"category" : "SBE-Book",
+	"classinstvars" : [
+		 ],
+	"classvars" : [
+		 ],
+	"commentStamp" : "",
+	"instvars" : [
+		 ],
+	"name" : "SBEBookChapter",
+	"pools" : [
+		 ],
+	"super" : "SBEBookNode",
+	"type" : "normal" }
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/README.md b/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/README.md
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/class/on..st b/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/class/on..st
@@ -0,0 +1,6 @@
+instance creation
+on: aBookNode
+
+	^ self new
+		bookNode: aBookNode;
+		yourself
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/allInvalidLinks.st b/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/allInvalidLinks.st
@@ -0,0 +1,5 @@
+debugging
+allInvalidLinks
+
+	^ self invalidLinks ,
+		(self subtopics gather: [:topic | topic allInvalidLinks])
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/book.st b/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/book.st
@@ -0,0 +1,4 @@
+accessing
+book
+
+	^ self bookNode book
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/bookNode..st b/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/bookNode..st
@@ -0,0 +1,4 @@
+accessing
+bookNode: aBookNode
+
+	bookNode := aBookNode.
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/bookNode.st b/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/bookNode.st
@@ -0,0 +1,4 @@
+accessing
+bookNode
+
+	^ bookNode
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/contents.st b/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/contents.st
@@ -0,0 +1,4 @@
+accessing
+contents
+
+	^ self bookNode fullTextForHelp
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/invalidLinks.st b/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/invalidLinks.st
@@ -0,0 +1,8 @@
+debugging
+invalidLinks
+
+	^ ((self bookNode text ifNil: [^ #()]) sbeAllAttributes
+		select: [:attr | attr isKindOf: SBETextLabelLink]
+		thenCollect: [:attr | attr label])
+			withoutDuplicates
+				select: [:label | (self book pathToLabel: label) isNil]
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/key..st b/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/key..st
@@ -0,0 +1,3 @@
+accessing
+key: anObject
+	"ignore - compatibility for subtopics of ClassBasedHelpTopic"
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/key.st b/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/key.st
@@ -0,0 +1,4 @@
+accessing
+key
+
+	^ self title
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/openInPDF.st b/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/openInPDF.st
@@ -0,0 +1,4 @@
+tools
+openInPDF
+
+	^ self bookNode openInPDF
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/shouldStyle.st b/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/shouldStyle.st
@@ -0,0 +1,4 @@
+testing
+shouldStyle
+
+	^ false
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/subtopics.st b/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/subtopics.st
@@ -0,0 +1,9 @@
+accessing
+subtopics
+
+	^ subtopics ifNil: [subtopics :=
+		self bookNode childrenForHelp
+			withIndexCollect: [:child :index |
+				child asHelpTopic
+					priority: index;
+					yourself]]
diff --git a/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/title.st b/SmalltalkSources/SBE-Book.package/SBEBookHelpTopic.class/instance/title.st
@@ -0,0 +1,4 @@
+accessing
+title
+
+	^ self bookNode title asString