@suss/resolution 0.35.1 → 0.37.0

package/dist/index.d.cts

@@ -497,6 +497,19 @@ declare function renderExplanation(explanation: ResolutionExplanation, describe:
 /** Each importing file's imported files, both spelled by `displayPathOf`. */
 declare function importedFilesByFile(db: Database, displayPathOf: (file: string) => string): Map<string, string[]>;
 
+/**
+ * The method a class has under a name, its bases' included, for a walk
+ * that looks a method up on a subclass the call was sent to rather than
+ * on the class the calling method is written in.
+ */
+
+/**
+ * The member a class has under a name, its bases' included, once the
+ * members a nearer one overrides are set aside. Null when there is none,
+ * or more than one, as with two bases that both write it.
+ */
+declare function memberOf(db: Database, classKey: string, name: string, program: OnDemandRules): string | null;
+
 /**
  * Mount composition, shared between adapters. An adapter states one
  * fact per mount call, `mounted(child, parent, prefix)`, however its
@@ -866,6 +879,53 @@ declare function underQuestionSpend(db: Database): Readonly<UnderSpend>;
  */
 declare function askResolutionUnder(db: Database, pairs: Iterable<readonly [string, string]>, program?: OnDemandRules, questionBudget?: number, runBudget?: number): UnderOutcome;
 
+/** The form a receiver takes when the method runs on the class itself. */
+declare const SELF_AS_CLASS_NAME = "class";
+declare const SELF_AS_CLASS: _suss_datalog.Term;
+/** The form a receiver takes when the method runs on an instance. */
+declare const SELF_AS_INSTANCE_NAME = "instance";
+declare const SELF_AS_INSTANCE: _suss_datalog.Term;
+type SelfForm = typeof SELF_AS_CLASS_NAME | typeof SELF_AS_INSTANCE_NAME;
+/**
+ * The receiver a call was sent to when the method it ran returns that
+ * receiver, or one made from it, and the form it returns. Null when the
+ * key is no such call, or could be more than one.
+ */
+declare function selfResultOf(db: Database, key: string): {
+    readonly receiver: string;
+    readonly form: SelfForm;
+} | null;
+/**
+ * The form in which a key asked about with `wanted` comes from this
+ * receiver, or null when it does not, or when it comes from it both as
+ * the class and as an instance.
+ */
+declare function selfFormOf(db: Database, key: string, receiver: string): SelfForm | null;
+/** A class that inherits a method, by a file that declares it and its name. */
+interface SubclassPlace {
+    readonly file: string;
+    readonly name: string;
+}
+/** The walk's key for a method running on a subclass. */
+declare function variantKey(key: string, subclass: SubclassPlace): string;
+/** The method's own key, from its key or one of its variants' keys. */
+declare function plainKeyOf(key: string): string;
+/** A method a walk reached on a subclass, as one of the walk's bodies. */
+interface ReceiverVariant {
+    readonly key: string;
+    /** Whether one of its calls goes somewhere else on the subclass than on the class the method is written in. */
+    readonly differs: boolean;
+    /** The keys of the bodies its calls reach. */
+    readonly calls: readonly string[];
+}
+/**
+ * The variants worth a summary of their own: one whose calls go
+ * somewhere else on the subclass, and one that calls such a variant. Any
+ * other variant does what the method does on its own class, so its
+ * callers link to that summary instead.
+ */
+declare function keptVariants(variants: readonly ReceiverVariant[]): Set<string>;
+
 /**
  * The result shape a why session hands back, shared by every language
  * adapter so the CLI reads one type regardless of which adapter
@@ -1287,4 +1347,4 @@ declare const ANSWER_RELATIONS: string[];
  */
 declare const UNDER_ANSWER_RELATIONS: string[];
 
-export { ANSWER_RELATIONS, ASKING_RELATIONS, type AddRow, type AskUnder, type AssociationConstructor, BASE_CLASS_RULE, type CalleeOutcome, type CaseFiles, type ChainReads, type Changes, type ContractCase, type ContractOptions, DEFAULT_IMPORT_NAME, DISPATCH_QUESTION, type Dependencies, DependencyLedger, type DescribeAtom, type DispatchOutcome, type EntersAsSelf, EntryReuse, type ExplainOptions, type ExplainResolvedKeyOptions, type ExplainStats, FACT_CONTRACT_CASES, FactLog, type FactsOf, GLOBAL_MODULE, type GivesBackOne, type GivesBackOneOfArgument, type GivesBackOneOfImport, INSTANCE_STEP, type KeySpan, type MountEdge, type MountEdges, NAMED_STORE_NAME, NAMESPACE_IMPORT, NAMESPACE_IMPORT_NAME, NAMESPACE_MEMBER_RULE, NAME_HOP_RULE, NO_CONTEXT, NO_CONTEXT_NAME, type NameReads, type NameWrite, type OrderedWrite, type PackWords, RECEIVER_STORE_NAME, RESOLUTION_QUESTIONS, RESOLUTION_RULES, RESULT_STEP, type ReadNode, type ResolutionExplanation, type ResolutionStep, SPREAD_ENTRY, type SourceEnd, type SourceLeaf, type SourceQuestion, type SpannedNode, type StepContext, type StepPhrase, type StoredDependencies, type StoredFacts, type StoredFileRecord, type StoredWalkRecord, type SuppliesParameter, type TemplatePiece, UNDER_ANSWER_RELATIONS, UNDER_QUESTION_ROW_BUDGET, UNDER_RUN_ROW_BUDGET, UNPLACED_STORE_NAME, USES_QUESTION, type UnderOutcome, type UnwrapsByName, VALUE_ENTRY, VALUE_STEP, type ValueLocation, type ValueUses, WatchedMap, type WhyExplained, type WrittenEntry, addEntryRows, addPackWords, addTemplateRows, agreedMountPrefix, allocationSitesOf, alsoSteps, answersFor, answersFromTestsLeftOut, askResolution, askResolutionUnder, askSources, calleeOutcomeOf, calleeOutcomes, checkFactContract, classMemberName, classMemberOf, comesToUnder, couldBeSettled, declaredTypesOf, dispatchOutcomes, exitCodeFunctions, explainResolutionProof, explainResolvedKey, fallbackWrittenAs, fileOfKey, hashString, importedFilesByFile, isObserved, isWrittenAsUnder, joinMountedPath, mergeStoredDependencies, mountPathsOf, noDependencies, nodeOfKey, noteKeyRead, noteLookup, objectOfUnder, observeDemand, packHashes, proofRules, queryFacts, readDispatchOutcomes, readUses, recordsToReplay, renderExplanation, resolutionProgram, resolutionUnderProgram, resolvedFunctions, settledFunction, sourceLeavesOf, spanOfKey, startsAtName, staysInItsFunction, stillValid, underQuestionSpend, unpackHashes, valueLeftByWrites, walkRecordsByFile, writesRunInOrder, writtenAnswersFor, writtenSourcesOf, writtenValueOf, writtenValueUnder, writtenValuesByKey, writtenValuesOf };
+export { ANSWER_RELATIONS, ASKING_RELATIONS, type AddRow, type AskUnder, type AssociationConstructor, BASE_CLASS_RULE, type CalleeOutcome, type CaseFiles, type ChainReads, type Changes, type ContractCase, type ContractOptions, DEFAULT_IMPORT_NAME, DISPATCH_QUESTION, type Dependencies, DependencyLedger, type DescribeAtom, type DispatchOutcome, type EntersAsSelf, EntryReuse, type ExplainOptions, type ExplainResolvedKeyOptions, type ExplainStats, FACT_CONTRACT_CASES, FactLog, type FactsOf, GLOBAL_MODULE, type GivesBackOne, type GivesBackOneOfArgument, type GivesBackOneOfImport, INSTANCE_STEP, type KeySpan, type MountEdge, type MountEdges, NAMED_STORE_NAME, NAMESPACE_IMPORT, NAMESPACE_IMPORT_NAME, NAMESPACE_MEMBER_RULE, NAME_HOP_RULE, NO_CONTEXT, NO_CONTEXT_NAME, type NameReads, type NameWrite, type OrderedWrite, type PackWords, RECEIVER_STORE_NAME, RESOLUTION_QUESTIONS, RESOLUTION_RULES, RESULT_STEP, type ReadNode, type ReceiverVariant, type ResolutionExplanation, type ResolutionStep, SELF_AS_CLASS, SELF_AS_CLASS_NAME, SELF_AS_INSTANCE, SELF_AS_INSTANCE_NAME, SPREAD_ENTRY, type SelfForm, type SourceEnd, type SourceLeaf, type SourceQuestion, type SpannedNode, type StepContext, type StepPhrase, type StoredDependencies, type StoredFacts, type StoredFileRecord, type StoredWalkRecord, type SubclassPlace, type SuppliesParameter, type TemplatePiece, UNDER_ANSWER_RELATIONS, UNDER_QUESTION_ROW_BUDGET, UNDER_RUN_ROW_BUDGET, UNPLACED_STORE_NAME, USES_QUESTION, type UnderOutcome, type UnwrapsByName, VALUE_ENTRY, VALUE_STEP, type ValueLocation, type ValueUses, WatchedMap, type WhyExplained, type WrittenEntry, addEntryRows, addPackWords, addTemplateRows, agreedMountPrefix, allocationSitesOf, alsoSteps, answersFor, answersFromTestsLeftOut, askResolution, askResolutionUnder, askSources, calleeOutcomeOf, calleeOutcomes, checkFactContract, classMemberName, classMemberOf, comesToUnder, couldBeSettled, declaredTypesOf, dispatchOutcomes, exitCodeFunctions, explainResolutionProof, explainResolvedKey, fallbackWrittenAs, fileOfKey, hashString, importedFilesByFile, isObserved, isWrittenAsUnder, joinMountedPath, keptVariants, memberOf, mergeStoredDependencies, mountPathsOf, noDependencies, nodeOfKey, noteKeyRead, noteLookup, objectOfUnder, observeDemand, packHashes, plainKeyOf, proofRules, queryFacts, readDispatchOutcomes, readUses, recordsToReplay, renderExplanation, resolutionProgram, resolutionUnderProgram, resolvedFunctions, selfFormOf, selfResultOf, settledFunction, sourceLeavesOf, spanOfKey, startsAtName, staysInItsFunction, stillValid, underQuestionSpend, unpackHashes, valueLeftByWrites, variantKey, walkRecordsByFile, writesRunInOrder, writtenAnswersFor, writtenSourcesOf, writtenValueOf, writtenValueUnder, writtenValuesByKey, writtenValuesOf };

package/dist/index.d.ts

@@ -497,6 +497,19 @@ declare function renderExplanation(explanation: ResolutionExplanation, describe:
 /** Each importing file's imported files, both spelled by `displayPathOf`. */
 declare function importedFilesByFile(db: Database, displayPathOf: (file: string) => string): Map<string, string[]>;
 
+/**
+ * The method a class has under a name, its bases' included, for a walk
+ * that looks a method up on a subclass the call was sent to rather than
+ * on the class the calling method is written in.
+ */
+
+/**
+ * The member a class has under a name, its bases' included, once the
+ * members a nearer one overrides are set aside. Null when there is none,
+ * or more than one, as with two bases that both write it.
+ */
+declare function memberOf(db: Database, classKey: string, name: string, program: OnDemandRules): string | null;
+
 /**
  * Mount composition, shared between adapters. An adapter states one
  * fact per mount call, `mounted(child, parent, prefix)`, however its
@@ -866,6 +879,53 @@ declare function underQuestionSpend(db: Database): Readonly<UnderSpend>;
  */
 declare function askResolutionUnder(db: Database, pairs: Iterable<readonly [string, string]>, program?: OnDemandRules, questionBudget?: number, runBudget?: number): UnderOutcome;
 
+/** The form a receiver takes when the method runs on the class itself. */
+declare const SELF_AS_CLASS_NAME = "class";
+declare const SELF_AS_CLASS: _suss_datalog.Term;
+/** The form a receiver takes when the method runs on an instance. */
+declare const SELF_AS_INSTANCE_NAME = "instance";
+declare const SELF_AS_INSTANCE: _suss_datalog.Term;
+type SelfForm = typeof SELF_AS_CLASS_NAME | typeof SELF_AS_INSTANCE_NAME;
+/**
+ * The receiver a call was sent to when the method it ran returns that
+ * receiver, or one made from it, and the form it returns. Null when the
+ * key is no such call, or could be more than one.
+ */
+declare function selfResultOf(db: Database, key: string): {
+    readonly receiver: string;
+    readonly form: SelfForm;
+} | null;
+/**
+ * The form in which a key asked about with `wanted` comes from this
+ * receiver, or null when it does not, or when it comes from it both as
+ * the class and as an instance.
+ */
+declare function selfFormOf(db: Database, key: string, receiver: string): SelfForm | null;
+/** A class that inherits a method, by a file that declares it and its name. */
+interface SubclassPlace {
+    readonly file: string;
+    readonly name: string;
+}
+/** The walk's key for a method running on a subclass. */
+declare function variantKey(key: string, subclass: SubclassPlace): string;
+/** The method's own key, from its key or one of its variants' keys. */
+declare function plainKeyOf(key: string): string;
+/** A method a walk reached on a subclass, as one of the walk's bodies. */
+interface ReceiverVariant {
+    readonly key: string;
+    /** Whether one of its calls goes somewhere else on the subclass than on the class the method is written in. */
+    readonly differs: boolean;
+    /** The keys of the bodies its calls reach. */
+    readonly calls: readonly string[];
+}
+/**
+ * The variants worth a summary of their own: one whose calls go
+ * somewhere else on the subclass, and one that calls such a variant. Any
+ * other variant does what the method does on its own class, so its
+ * callers link to that summary instead.
+ */
+declare function keptVariants(variants: readonly ReceiverVariant[]): Set<string>;
+
 /**
  * The result shape a why session hands back, shared by every language
  * adapter so the CLI reads one type regardless of which adapter
@@ -1287,4 +1347,4 @@ declare const ANSWER_RELATIONS: string[];
  */
 declare const UNDER_ANSWER_RELATIONS: string[];
 
-export { ANSWER_RELATIONS, ASKING_RELATIONS, type AddRow, type AskUnder, type AssociationConstructor, BASE_CLASS_RULE, type CalleeOutcome, type CaseFiles, type ChainReads, type Changes, type ContractCase, type ContractOptions, DEFAULT_IMPORT_NAME, DISPATCH_QUESTION, type Dependencies, DependencyLedger, type DescribeAtom, type DispatchOutcome, type EntersAsSelf, EntryReuse, type ExplainOptions, type ExplainResolvedKeyOptions, type ExplainStats, FACT_CONTRACT_CASES, FactLog, type FactsOf, GLOBAL_MODULE, type GivesBackOne, type GivesBackOneOfArgument, type GivesBackOneOfImport, INSTANCE_STEP, type KeySpan, type MountEdge, type MountEdges, NAMED_STORE_NAME, NAMESPACE_IMPORT, NAMESPACE_IMPORT_NAME, NAMESPACE_MEMBER_RULE, NAME_HOP_RULE, NO_CONTEXT, NO_CONTEXT_NAME, type NameReads, type NameWrite, type OrderedWrite, type PackWords, RECEIVER_STORE_NAME, RESOLUTION_QUESTIONS, RESOLUTION_RULES, RESULT_STEP, type ReadNode, type ResolutionExplanation, type ResolutionStep, SPREAD_ENTRY, type SourceEnd, type SourceLeaf, type SourceQuestion, type SpannedNode, type StepContext, type StepPhrase, type StoredDependencies, type StoredFacts, type StoredFileRecord, type StoredWalkRecord, type SuppliesParameter, type TemplatePiece, UNDER_ANSWER_RELATIONS, UNDER_QUESTION_ROW_BUDGET, UNDER_RUN_ROW_BUDGET, UNPLACED_STORE_NAME, USES_QUESTION, type UnderOutcome, type UnwrapsByName, VALUE_ENTRY, VALUE_STEP, type ValueLocation, type ValueUses, WatchedMap, type WhyExplained, type WrittenEntry, addEntryRows, addPackWords, addTemplateRows, agreedMountPrefix, allocationSitesOf, alsoSteps, answersFor, answersFromTestsLeftOut, askResolution, askResolutionUnder, askSources, calleeOutcomeOf, calleeOutcomes, checkFactContract, classMemberName, classMemberOf, comesToUnder, couldBeSettled, declaredTypesOf, dispatchOutcomes, exitCodeFunctions, explainResolutionProof, explainResolvedKey, fallbackWrittenAs, fileOfKey, hashString, importedFilesByFile, isObserved, isWrittenAsUnder, joinMountedPath, mergeStoredDependencies, mountPathsOf, noDependencies, nodeOfKey, noteKeyRead, noteLookup, objectOfUnder, observeDemand, packHashes, proofRules, queryFacts, readDispatchOutcomes, readUses, recordsToReplay, renderExplanation, resolutionProgram, resolutionUnderProgram, resolvedFunctions, settledFunction, sourceLeavesOf, spanOfKey, startsAtName, staysInItsFunction, stillValid, underQuestionSpend, unpackHashes, valueLeftByWrites, walkRecordsByFile, writesRunInOrder, writtenAnswersFor, writtenSourcesOf, writtenValueOf, writtenValueUnder, writtenValuesByKey, writtenValuesOf };
+export { ANSWER_RELATIONS, ASKING_RELATIONS, type AddRow, type AskUnder, type AssociationConstructor, BASE_CLASS_RULE, type CalleeOutcome, type CaseFiles, type ChainReads, type Changes, type ContractCase, type ContractOptions, DEFAULT_IMPORT_NAME, DISPATCH_QUESTION, type Dependencies, DependencyLedger, type DescribeAtom, type DispatchOutcome, type EntersAsSelf, EntryReuse, type ExplainOptions, type ExplainResolvedKeyOptions, type ExplainStats, FACT_CONTRACT_CASES, FactLog, type FactsOf, GLOBAL_MODULE, type GivesBackOne, type GivesBackOneOfArgument, type GivesBackOneOfImport, INSTANCE_STEP, type KeySpan, type MountEdge, type MountEdges, NAMED_STORE_NAME, NAMESPACE_IMPORT, NAMESPACE_IMPORT_NAME, NAMESPACE_MEMBER_RULE, NAME_HOP_RULE, NO_CONTEXT, NO_CONTEXT_NAME, type NameReads, type NameWrite, type OrderedWrite, type PackWords, RECEIVER_STORE_NAME, RESOLUTION_QUESTIONS, RESOLUTION_RULES, RESULT_STEP, type ReadNode, type ReceiverVariant, type ResolutionExplanation, type ResolutionStep, SELF_AS_CLASS, SELF_AS_CLASS_NAME, SELF_AS_INSTANCE, SELF_AS_INSTANCE_NAME, SPREAD_ENTRY, type SelfForm, type SourceEnd, type SourceLeaf, type SourceQuestion, type SpannedNode, type StepContext, type StepPhrase, type StoredDependencies, type StoredFacts, type StoredFileRecord, type StoredWalkRecord, type SubclassPlace, type SuppliesParameter, type TemplatePiece, UNDER_ANSWER_RELATIONS, UNDER_QUESTION_ROW_BUDGET, UNDER_RUN_ROW_BUDGET, UNPLACED_STORE_NAME, USES_QUESTION, type UnderOutcome, type UnwrapsByName, VALUE_ENTRY, VALUE_STEP, type ValueLocation, type ValueUses, WatchedMap, type WhyExplained, type WrittenEntry, addEntryRows, addPackWords, addTemplateRows, agreedMountPrefix, allocationSitesOf, alsoSteps, answersFor, answersFromTestsLeftOut, askResolution, askResolutionUnder, askSources, calleeOutcomeOf, calleeOutcomes, checkFactContract, classMemberName, classMemberOf, comesToUnder, couldBeSettled, declaredTypesOf, dispatchOutcomes, exitCodeFunctions, explainResolutionProof, explainResolvedKey, fallbackWrittenAs, fileOfKey, hashString, importedFilesByFile, isObserved, isWrittenAsUnder, joinMountedPath, keptVariants, memberOf, mergeStoredDependencies, mountPathsOf, noDependencies, nodeOfKey, noteKeyRead, noteLookup, objectOfUnder, observeDemand, packHashes, plainKeyOf, proofRules, queryFacts, readDispatchOutcomes, readUses, recordsToReplay, renderExplanation, resolutionProgram, resolutionUnderProgram, resolvedFunctions, selfFormOf, selfResultOf, settledFunction, sourceLeavesOf, spanOfKey, startsAtName, staysInItsFunction, stillValid, underQuestionSpend, unpackHashes, valueLeftByWrites, variantKey, walkRecordsByFile, writesRunInOrder, writtenAnswersFor, writtenSourcesOf, writtenValueOf, writtenValueUnder, writtenValuesByKey, writtenValuesOf };