Merge pull request #186 from ator-dev/hierarchy-improve

Improve organisation of the src/ hierarchy
searchmarkers · Sep 12, 2024 · 8abbeb8 · 8abbeb8
2 parents 5518cc4 + 2e22b5f
commit 8abbeb8
Show file tree

Hide file tree

Showing 33 changed files with 126 additions and 116 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -34,7 +34,7 @@ jobs:
         run: |
           git clone https://user:[email protected]/$GITHUB_REPOSITORY
           cd ${{ env.REPO_NAME }}
-          version=$( cat manifest/firefox.json | jq --raw-output '.version' )
+          version=$( cat platform/firefox/manifest.json | jq --raw-output '.version' )
           tag_name=v$version
           git config user.name "searchmarkers"
           git config user.email "[email protected]"

diff --git a/package.json b/package.json
@@ -5,8 +5,8 @@
 	"scripts": {
 		"icons-convert": "bash -c 'mkdir -p icons/dist; SIZES=(16 32 48 64 96 128 240 300); for SIZE in ${SIZES[@]}; do inkscape icons/mms.svg -w $SIZE -h $SIZE -o icons/dist/mms-${SIZE}.png; done; SIZES=(32); for SIZE in ${SIZES[@]}; do inkscape icons/mms-off.svg -w $SIZE -h $SIZE -o icons/dist/mms-off-${SIZE}.png; done'",
 		"scripts-build": "rm --recursive dist; tsc --project tsconfig.json",
-		"prepare-firefox": "ln --force --symbolic manifest/firefox.json manifest.json",
-		"prepare-chromium": "ln --force --symbolic manifest/chromium.json manifest.json",
+		"prepare-firefox": "ln --force --symbolic platform/firefox/manifest.json manifest.json",
+		"prepare-chromium": "ln --force --symbolic platform/chromium/manifest.json manifest.json",
 		"pack-firefox": "rm --force pack/mark_my_search-firefox.zip; npm run scripts-build; npm run prepare-firefox; mkdir --parents pack; zip pack/mark_my_search-firefox.zip * -ri dist/**\\* icons/**\\* pages/**\\* lib/**\\* manifest.json",
 		"pack-chromium": "rm --force pack/mark_my_search-chromium.zip; npm run scripts-build; npm run prepare-chromium; mkdir --parents pack; zip pack/mark_my_search-chromium.zip * -ri dist/**\\* icons/**\\* pages/**\\* lib/**\\* manifest.json"
 	},

diff --git a/manifest/chromium.json → platform/chromium/manifest.json b/manifest/chromium.json → platform/chromium/manifest.json
@@ -54,7 +54,6 @@
 		{
 			"resources": [
 				"/icons/*.svg",
-				"/dist/paint.js",
 				"/dist/content.mjs",
 				"/dist/modules/*.mjs"
 			],

diff --git a/manifest/firefox.json → platform/firefox/manifest.json b/manifest/firefox.json → platform/firefox/manifest.json
@@ -55,7 +55,6 @@
 		{
 			"resources": [
 				"/icons/*.svg",
-				"/dist/paint.js",
 				"/dist/content.mjs",
 				"/dist/modules/*.mjs"
 			],

diff --git a/src/content-entry.ts → src/entrypoints/content.ts b/src/content-entry.ts → src/entrypoints/content.ts
diff --git a/src/modules/highlight/container-blocks.mts → ...les/highlight/common/container-blocks.mts b/src/modules/highlight/container-blocks.mts → ...les/highlight/common/container-blocks.mts
@@ -4,7 +4,7 @@
  * Licensed under the EUPL-1.2-or-later.
  */
 
-import { highlightTags } from "/dist/modules/highlight/highlight-tags.mjs";
+import { highlightTags } from "/dist/modules/highlight/common/highlight-tags.mjs";
 
 /**
  * A selector string for the container block of an element.

diff --git a/...es/highlight/flow-mutation-observer.d.mts → ...les/highlight/common/flow-mutations.d.mts b/...es/highlight/flow-mutation-observer.d.mts → ...les/highlight/common/flow-mutations.d.mts
diff --git a/src/modules/highlight/highlight-tags.mts → ...dules/highlight/common/highlight-tags.mts b/src/modules/highlight/highlight-tags.mts → ...dules/highlight/common/highlight-tags.mts
diff --git a/src/modules/highlight/common/matching.d.mts b/src/modules/highlight/common/matching.d.mts
@@ -0,0 +1,23 @@
+/*
+ * This file is part of Mark My Search.
+ * Copyright © 2021-present ‘ator-dev’, Mark My Search contributors.
+ * Licensed under the EUPL-1.2-or-later.
+ */
+
+import type { MatchTerm } from "/dist/modules/match-term.mjs";
+
+type BaseFlow<WithNode extends boolean> = {
+	text: string
+	spans: Array<BaseSpan<WithNode>>
+}
+
+type BaseSpan<WithNode extends boolean> = {
+	term: MatchTerm
+	start: number
+	end: number
+} & (WithNode extends true
+	? { node: Text }
+	: Record<never, never>
+)
+
+export type { BaseFlow, BaseSpan };
diff --git a/src/modules/highlight/matcher.mts → src/modules/highlight/common/matching.mts b/src/modules/highlight/matcher.mts → src/modules/highlight/common/matching.mts
@@ -4,22 +4,9 @@
  * Licensed under the EUPL-1.2-or-later.
  */
 
+import type { BaseSpan } from "/dist/modules/highlight/common/matching.d.mjs";
 import type { MatchTerm, TermPatterns } from "/dist/modules/match-term.mjs";
 
-type BaseFlow<WithNode extends boolean> = {
-	text: string
-	spans: Array<BaseSpan<WithNode>>
-}
-
-type BaseSpan<WithNode extends boolean> = {
-	term: MatchTerm
-	start: number
-	end: number
-} & (WithNode extends true
-	? { node: Text }
-	: Record<never, never>
-)
-
 const matchInText = (
 	terms: ReadonlyArray<MatchTerm>,
 	termPatterns: TermPatterns,
@@ -79,7 +66,4 @@ const matchInTextFlow = (
 	return spans;
 };
 
-export {
-	type BaseFlow, type BaseSpan,
-	matchInText, matchInTextFlow,
-};
+export { matchInText, matchInTextFlow };
diff --git a/src/modules/highlight/common/term-css.mts b/src/modules/highlight/common/term-css.mts
@@ -0,0 +1,36 @@
+/*
+ * This file is part of Mark My Search.
+ * Copyright © 2021-present ‘ator-dev’, Mark My Search contributors.
+ * Licensed under the EUPL-1.2-or-later.
+ */
+
+abstract class TermCSS {
+	static getFlatStyle (this: void, color: string) {
+		return color;
+	}
+
+	static getDiagonalStyle (this: void, colorA: string, colorB: string, cycle: number) {
+		const isAboveStyleLevel = (level: number) => cycle >= level;
+		return isAboveStyleLevel(1)
+			? `repeating-linear-gradient(${
+				isAboveStyleLevel(3) ? isAboveStyleLevel(4) ? 0 : 90 : isAboveStyleLevel(2) ? 45 : -45
+			}deg, ${colorA}, ${colorA} 2px, ${colorB} 2px, ${colorB} 8px)`
+			: colorA;
+	}
+
+	static getHorizontalStyle (this: void, colorA: string, colorB: string, cycle: number) {
+		const isAboveStyleLevel = (level: number) => cycle >= level;
+		return isAboveStyleLevel(1)
+			? `linear-gradient(${Array(Math.floor(cycle/2 + 1.5) * 2)
+				.fill("")
+				.map((v, i) => (
+					(Math.floor(i / 2) % 2 == cycle % 2 ? colorB : colorA)
+					+ (Math.floor((i + 1) / 2)/(Math.floor((cycle + 1) / 2) + 1) * 100) + "%"
+				))
+				.join(", ")
+			})`
+			: colorA;
+	}
+}
+
+export default TermCSS;
diff --git a/src/modules/highlight/engine-manager.d.mts b/src/modules/highlight/engine-manager.d.mts
@@ -4,8 +4,9 @@
  * Licensed under the EUPL-1.2-or-later.
  */
 
-import type { HighlighterCounterInterface, HighlighterWalkerInterface } from "/dist/modules/highlight/model.d.mjs";
 import type { Highlighter } from "/dist/modules/highlight/engine.d.mjs";
+import type { AbstractTermCounter } from "/dist/modules/highlight/tools/term-counter.mjs";
+import type { MatchTerm } from "/dist/modules/match-term.mjs";
 import type { Engine, PaintEngineMethod } from "/dist/modules/common.mjs";
 
 interface AbstractEngineManager extends Highlighter, HighlighterCounterInterface, HighlighterWalkerInterface {
@@ -24,4 +25,29 @@ interface AbstractEngineManager extends Highlighter, HighlighterCounterInterface
 	readonly removeSpecialEngine: () => void
 }
 
-export type { AbstractEngineManager };
+interface HighlighterCounterInterface {
+	readonly termCounter: AbstractTermCounter;
+}
+
+interface HighlighterWalkerInterface {
+	/**
+	 * Moves to the next (downwards) occurrence of a term in the document, beginning from the current selection position.
+	 * If an occurrence is successfully focused, the corresponding term marker in the scrollbar will be raised.
+	 * *Refer to the TermWalker and TermMarker interfaces for more details.*
+	 * @param reverse Indicates whether elements should be tried in reverse, selecting the previous term as opposed to the next.
+	 * @param stepNotJump 
+	 * @param term A term to jump to. If unspecified, the next closest occurrence of any term is jumpted to.
+	 * @returns The element landed on by the function, if any.
+	 */
+	readonly stepToNextOccurrence: (
+		reverse: boolean,
+		stepNotJump: boolean,
+		term: MatchTerm | null,
+	) => HTMLElement | null
+}
+
+export type {
+	AbstractEngineManager,
+	HighlighterCounterInterface,
+	HighlighterWalkerInterface,
+};
diff --git a/src/modules/highlight/engine-manager.mts b/src/modules/highlight/engine-manager.mts
@@ -11,7 +11,7 @@ import type { AbstractTermWalker } from "/dist/modules/highlight/tools/term-walk
 import type { AbstractTermMarker } from "/dist/modules/highlight/tools/term-marker.d.mjs";
 import type { AbstractTreeEditEngine } from "/dist/modules/highlight/models/tree-edit.mjs";
 import type { AbstractTreeCacheEngine } from "/dist/modules/highlight/models/tree-cache.d.mjs";
-import { getContainerBlock } from "/dist/modules/highlight/container-blocks.mjs";
+import { getContainerBlock } from "/dist/modules/highlight/common/container-blocks.mjs";
 import type { Engine, PaintEngineMethod } from "/dist/modules/common.mjs";
 import type { MatchTerm, TermTokens, TermPatterns } from "/dist/modules/match-term.mjs";
 import { requestCallFn } from "/dist/modules/call-requester.mjs";

diff --git a/src/modules/highlight/engines/element.mts b/src/modules/highlight/engines/element.mts
@@ -6,9 +6,9 @@
 
 import type { AbstractTreeEditEngine } from "/dist/modules/highlight/models/tree-edit.mjs";
 import { HIGHLIGHT_TAG, HIGHLIGHT_TAG_UPPER } from "/dist/modules/highlight/models/tree-edit/tags.mjs";
-import type { FlowMutationObserver } from "/dist/modules/highlight/flow-mutation-observer.d.mjs";
-import { highlightTags } from "/dist/modules/highlight/highlight-tags.mjs";
-import * as TermCSS from "/dist/modules/highlight/term-css.mjs";
+import type { FlowMutationObserver } from "/dist/modules/highlight/common/flow-mutations.d.mjs";
+import { highlightTags } from "/dist/modules/highlight/common/highlight-tags.mjs";
+import TermCSS from "/dist/modules/highlight/common/term-css.mjs";
 import type { MatchTerm, TermTokens, TermPatterns } from "/dist/modules/match-term.mjs";
 import { StyleManager } from "/dist/modules/style-manager.mjs";
 import { HTMLStylesheet } from "/dist/modules/stylesheets/html.mjs";

diff --git a/src/modules/highlight/engines/highlight.mts b/src/modules/highlight/engines/highlight.mts
@@ -7,7 +7,7 @@
 import type { AbstractTreeCacheEngine } from "/dist/modules/highlight/models/tree-cache.d.mjs";
 import type { AbstractFlowTracker, Flow, Span } from "/dist/modules/highlight/models/tree-cache/flow-tracker.d.mjs";
 import { FlowTracker } from "/dist/modules/highlight/models/tree-cache/flow-tracker.mjs";
-import * as TermCSS from "/dist/modules/highlight/term-css.mjs";
+import TermCSS from "/dist/modules/highlight/common/term-css.mjs";
 import type { MatchTerm, TermTokens, TermPatterns } from "/dist/modules/match-term.mjs";
 import { StyleManager } from "/dist/modules/style-manager.mjs";
 import { HTMLStylesheet } from "/dist/modules/stylesheets/html.mjs";

diff --git a/src/modules/highlight/engines/paint.mts b/src/modules/highlight/engines/paint.mts
@@ -9,8 +9,8 @@ import { getBoxesOwned } from "/dist/modules/highlight/engines/paint/boxes.mjs";
 import type { AbstractTreeCacheEngine } from "/dist/modules/highlight/models/tree-cache.d.mjs";
 import type { AbstractFlowTracker, Flow, Span } from "/dist/modules/highlight/models/tree-cache/flow-tracker.d.mjs";
 import { FlowTracker } from "/dist/modules/highlight/models/tree-cache/flow-tracker.mjs";
-import { highlightTags } from "/dist/modules/highlight/highlight-tags.mjs";
-import * as TermCSS from "/dist/modules/highlight/term-css.mjs";
+import { highlightTags } from "/dist/modules/highlight/common/highlight-tags.mjs";
+import TermCSS from "/dist/modules/highlight/common/term-css.mjs";
 import type { MatchTerm, TermTokens, TermPatterns } from "/dist/modules/match-term.mjs";
 import { StyleManager } from "/dist/modules/style-manager.mjs";
 import { HTMLStylesheet } from "/dist/modules/stylesheets/html.mjs";

diff --git a/src/modules/highlight/engines/paint/boxes.mts b/src/modules/highlight/engines/paint/boxes.mts
@@ -6,7 +6,7 @@
 
 import type { Flow, Span, Box } from "/dist/modules/highlight/engines/paint.mjs";
 import type { Highlightables } from "/dist/modules/highlight/engines/paint/highlightables.d.mjs";
-import { highlightTags } from "/dist/modules/highlight/highlight-tags.mjs";
+import { highlightTags } from "/dist/modules/highlight/common/highlight-tags.mjs";
 import type { TermTokens } from "/dist/modules/match-term.mjs";
 import type { AllReadonly } from "/dist/modules/common.mjs";
 

diff --git a/src/modules/highlight/engines/paint/methods/element.mts b/src/modules/highlight/engines/paint/methods/element.mts
@@ -7,7 +7,7 @@
 import type { AbstractMethod } from "/dist/modules/highlight/engines/paint/method.d.mjs";
 import { getBoxesOwned } from "/dist/modules/highlight/engines/paint/boxes.mjs";
 import type { HighlightingStyleObserver, Flow, Span, Box } from "/dist/modules/highlight/engines/paint.mjs";
-import * as TermCSS from "/dist/modules/highlight/term-css.mjs";
+import TermCSS from "/dist/modules/highlight/common/term-css.mjs";
 import type { MatchTerm, TermTokens } from "/dist/modules/match-term.mjs";
 import { StyleManager } from "/dist/modules/style-manager.mjs";
 import { HTMLStylesheet } from "/dist/modules/stylesheets/html.mjs";

diff --git a/src/modules/highlight/engines/paint/methods/paint.mts b/src/modules/highlight/engines/paint/methods/paint.mts
@@ -27,7 +27,9 @@ class PaintMethod implements AbstractMethod {
 	constructor (termTokens: TermTokens) {
 		this.#termTokens = termTokens;
 		if (!PaintMethod.#paintModuleAdded) {
-			CSS.paintWorklet?.addModule(chrome.runtime.getURL("/dist/paint.js"));
+			CSS.paintWorklet?.addModule(chrome.runtime.getURL(
+				"/dist/modules/highlight/engines/paint/methods/paint/paint-worklet.mjs",
+			));
 			PaintMethod.#paintModuleAdded = true;
 		}
 	}

diff --git a/src/paint.ts → ...nes/paint/methods/paint/paint-worklet.mts b/src/paint.ts → ...nes/paint/methods/paint/paint-worklet.mts
diff --git a/src/modules/highlight/model.d.mts b/src/modules/highlight/model.d.mts
diff --git a/src/modules/highlight/models/tree-cache/flow-tracker.d.mts b/src/modules/highlight/models/tree-cache/flow-tracker.d.mts
@@ -4,8 +4,8 @@
  * Licensed under the EUPL-1.2-or-later.
  */
 
-import type { FlowMutationObserver } from "/dist/modules/highlight/flow-mutation-observer.d.mjs";
-import type { BaseFlow, BaseSpan } from "/dist/modules/highlight/matcher.mjs";
+import type { FlowMutationObserver } from "/dist/modules/highlight/common/flow-mutations.d.mjs";
+import type { BaseFlow, BaseSpan } from "/dist/modules/highlight/common/matching.d.mjs";
 import type { MatchTerm } from "/dist/modules/match-term.mjs";
 import type { AllReadonly } from "/dist/modules/common.mjs";
 

diff --git a/src/modules/highlight/models/tree-cache/flow-tracker.mts b/src/modules/highlight/models/tree-cache/flow-tracker.mts
@@ -5,8 +5,8 @@
  */
 
 import type { Flow, Span, AbstractFlowTracker } from "/dist/modules/highlight/models/tree-cache/flow-tracker.d.mjs";
-import { highlightTags } from "/dist/modules/highlight/highlight-tags.mjs";
-import { matchInTextFlow } from "/dist/modules/highlight/matcher.mjs";
+import { highlightTags } from "/dist/modules/highlight/common/highlight-tags.mjs";
+import { matchInTextFlow } from "/dist/modules/highlight/common/matching.mjs";
 import type { MatchTerm, TermPatterns } from "/dist/modules/match-term.mjs";
 import type { RContainer, AllReadonly } from "/dist/modules/common.mjs";
 

diff --git a/src/modules/highlight/special-engines/paint.mts b/src/modules/highlight/special-engines/paint.mts
@@ -7,7 +7,8 @@
 import type { AbstractSpecialEngine } from "/dist/modules/highlight/special-engine.d.mjs";
 import type { Box } from "/dist/modules/highlight/engines/paint.mjs";
 import { UrlMethod } from "/dist/modules/highlight/engines/paint/methods/url.mjs";
-import { type BaseFlow, type BaseSpan, matchInText } from "/dist/modules/highlight/matcher.mjs";
+import { type BaseFlow, type BaseSpan } from "/dist/modules/highlight/common/matching.d.mjs";
+import { matchInText } from "/dist/modules/highlight/common/matching.mjs";
 import type { MatchTerm, TermTokens, TermPatterns } from "/dist/modules/match-term.mjs";
 import { StyleManager } from "/dist/modules/style-manager.mjs";
 import { HTMLStylesheet } from "/dist/modules/stylesheets/html.mjs";

diff --git a/src/modules/highlight/term-css.mts b/src/modules/highlight/term-css.mts
diff --git a/src/modules/highlight/tools/term-counters/tree-cache.mts b/src/modules/highlight/tools/term-counters/tree-cache.mts
@@ -5,8 +5,8 @@
  */
 
 import type { AbstractTermCounter } from "/dist/modules/highlight/tools/term-counter.d.mjs";
-import type { BaseFlow } from "/dist/modules/highlight/matcher.mjs";
-import { highlightTags } from "/dist/modules/highlight/highlight-tags.mjs";
+import type { BaseFlow } from "/dist/modules/highlight/common/matching.d.mjs";
+import { highlightTags } from "/dist/modules/highlight/common/highlight-tags.mjs";
 import type { MatchTerm } from "/dist/modules/match-term.mjs";
 import type { AllReadonly } from "/dist/modules/common.mjs";
 

diff --git a/src/modules/highlight/tools/term-markers/tree-cache.mts b/src/modules/highlight/tools/term-markers/tree-cache.mts
@@ -6,7 +6,7 @@
 
 import type { AbstractTermMarker } from "/dist/modules/highlight/tools/term-marker.d.mjs";
 import { Styles } from "/dist/modules/highlight/tools/term-marker/common.mjs";
-import type { BaseFlow } from "/dist/modules/highlight/matcher.mjs";
+import type { BaseFlow } from "/dist/modules/highlight/common/matching.d.mjs";
 import type { MatchTerm, TermTokens } from "/dist/modules/match-term.mjs";
 import { StyleManager } from "/dist/modules/style-manager.mjs";
 import { HTMLStylesheet } from "/dist/modules/stylesheets/html.mjs";

diff --git a/src/modules/highlight/tools/term-markers/tree-edit.mts b/src/modules/highlight/tools/term-markers/tree-edit.mts
@@ -6,7 +6,7 @@
 
 import type { AbstractTermMarker } from "/dist/modules/highlight/tools/term-marker.d.mjs";
 import { Styles } from "/dist/modules/highlight/tools/term-marker/common.mjs";
-import { getContainerBlock } from "/dist/modules/highlight/container-blocks.mjs";
+import { getContainerBlock } from "/dist/modules/highlight/common/container-blocks.mjs";
 import type { MatchTerm, TermTokens } from "/dist/modules/match-term.mjs";
 import { StyleManager } from "/dist/modules/style-manager.mjs";
 import { HTMLStylesheet } from "/dist/modules/stylesheets/html.mjs";

diff --git a/src/modules/highlight/tools/term-walkers/tree-cache.mts b/src/modules/highlight/tools/term-walkers/tree-cache.mts
@@ -6,7 +6,7 @@
 
 import type { AbstractTermWalker } from "/dist/modules/highlight/tools/term-walker.d.mjs";
 import { Styles } from "/dist/modules/highlight/tools/term-walker/common.mjs";
-import type { BaseFlow } from "/dist/modules/highlight/matcher.mjs";
+import type { BaseFlow } from "/dist/modules/highlight/common/matching.d.mjs";
 import type { MatchTerm } from "/dist/modules/match-term.mjs";
 import { StyleManager } from "/dist/modules/style-manager.mjs";
 import { HTMLStylesheet } from "/dist/modules/stylesheets/html.mjs";

diff --git a/src/modules/highlight/tools/term-walkers/tree-edit.mts b/src/modules/highlight/tools/term-walkers/tree-edit.mts
@@ -6,7 +6,7 @@
 
 import type { AbstractTermWalker } from "/dist/modules/highlight/tools/term-walker.d.mjs";
 import { Styles } from "/dist/modules/highlight/tools/term-walker/common.mjs";
-import { getContainerBlock } from "/dist/modules/highlight/container-blocks.mjs";
+import { getContainerBlock } from "/dist/modules/highlight/common/container-blocks.mjs";
 import { HIGHLIGHT_TAG, HIGHLIGHT_TAG_UPPER } from "/dist/modules/highlight/models/tree-edit/tags.mjs";
 import type { MatchTerm, TermTokens } from "/dist/modules/match-term.mjs";
 import { StyleManager } from "/dist/modules/style-manager.mjs";