New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove deregisterProvider from SearchProviderRegistry interface #6282
Merged
blink1073
merged 4 commits into
jupyterlab:master
from
aschlaep:remove-searchprovider-deregister
May 2, 2019
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,8 @@ import { NotebookSearchProvider } from './providers/notebooksearchprovider'; | |
|
||
import { Token } from '@phosphor/coreutils'; | ||
import { Widget } from '@phosphor/widgets'; | ||
import { IDisposable, DisposableDelegate } from '@phosphor/disposable'; | ||
import { ISignal, Signal } from '@phosphor/signaling'; | ||
|
||
/* tslint:disable */ | ||
/** | ||
|
@@ -22,15 +24,7 @@ export interface ISearchProviderRegistry { | |
* | ||
* @param key - The provider key. | ||
*/ | ||
registerProvider(key: string, provider: ISearchProviderConstructor): void; | ||
|
||
/** | ||
* Remove provider from registry. | ||
* | ||
* @param key - The provider key. | ||
* @returns true if removed, false if key did not exist in map. | ||
*/ | ||
deregisterProvider(key: string): boolean; | ||
register(key: string, provider: ISearchProviderConstructor): IDisposable; | ||
|
||
/** | ||
* Returns a matching provider for the widget. | ||
|
@@ -39,6 +33,12 @@ export interface ISearchProviderRegistry { | |
* @returns the search provider, or undefined if none exists. | ||
*/ | ||
getProviderForWidget(widget: any): ISearchProvider | undefined; | ||
|
||
/** | ||
* Signal that emits when a new search provider has been registered | ||
* or removed. | ||
*/ | ||
changed: ISignal<ISearchProviderRegistry, void>; | ||
} | ||
|
||
export class SearchProviderRegistry implements ISearchProviderRegistry { | ||
|
@@ -58,18 +58,13 @@ export class SearchProviderRegistry implements ISearchProviderRegistry { | |
* | ||
* @param key - The provider key. | ||
*/ | ||
registerProvider(key: string, provider: ISearchProviderConstructor): void { | ||
register(key: string, provider: ISearchProviderConstructor): IDisposable { | ||
this._customProviders.set(key, provider); | ||
} | ||
|
||
/** | ||
* Remove provider from registry. | ||
* | ||
* @param key - The provider key. | ||
* @returns true if removed, false if key did not exist in map. | ||
*/ | ||
deregisterProvider(key: string): boolean { | ||
return this._customProviders.delete(key); | ||
this._changed.emit(); | ||
return new DisposableDelegate(() => { | ||
this._customProviders.delete(key); | ||
this._changed.emit(); | ||
}); | ||
} | ||
|
||
/** | ||
|
@@ -85,6 +80,10 @@ export class SearchProviderRegistry implements ISearchProviderRegistry { | |
); | ||
} | ||
|
||
get changed(): ISignal<this, void> { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Missing docstring? |
||
return this._changed; | ||
} | ||
|
||
private _registerDefaultProviders( | ||
key: string, | ||
provider: ISearchProviderConstructor | ||
|
@@ -106,6 +105,7 @@ export class SearchProviderRegistry implements ISearchProviderRegistry { | |
return undefined; | ||
} | ||
|
||
private _changed = new Signal<this, void>(this); | ||
private _defaultProviders: Private.ProviderMap = new Map< | ||
string, | ||
ISearchProviderConstructor | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing doc for the return value?