From 361a15c9ace529526a3c27ed273bed749733b5df Mon Sep 17 00:00:00 2001 From: Fabio Zadrozny Date: Sun, 1 Sep 2024 10:30:14 -0300 Subject: [PATCH] Move IAssistProps to core --- .../src/org/python/pydev/core}/IAssistProps.java | 5 +---- .../pydev/debug/quick_assist/QuickAssistDontTrace.java | 2 +- plugins/org.python.pydev/schema/pydev_ctrl_1.exsd | 6 +++--- .../ctrl_1/AbstractAnalysisMarkersParticipants.java | 4 ++-- .../analysis/ctrl_1/DontAnalyzeFileMarkerParticipant.java | 2 +- .../correctionassist/PythonCorrectionProcessor.java | 1 + .../correctionassist/docstrings/AssistDocString.java | 6 +++--- .../editor/correctionassist/heuristics/AssistAssign.java | 8 ++++---- .../editor/correctionassist/heuristics/AssistFString.java | 2 +- .../editor/correctionassist/heuristics/AssistImport.java | 6 +++--- .../correctionassist/heuristics/AssistImportToLocal.java | 2 +- .../heuristics/AssistPercentToFormat.java | 6 +++--- .../correctionassist/heuristics/AssistSurroundWith.java | 6 +++--- .../heuristics/AssistCreateInModuleTest.java | 2 +- 14 files changed, 28 insertions(+), 30 deletions(-) rename plugins/{org.python.pydev/src/org/python/pydev/editor/correctionassist => org.python.pydev.core/src/org/python/pydev/core}/IAssistProps.java (91%) diff --git a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/IAssistProps.java b/plugins/org.python.pydev.core/src/org/python/pydev/core/IAssistProps.java similarity index 91% rename from plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/IAssistProps.java rename to plugins/org.python.pydev.core/src/org/python/pydev/core/IAssistProps.java index ee039ba709..c256f890ce 100644 --- a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/IAssistProps.java +++ b/plugins/org.python.pydev.core/src/org/python/pydev/core/IAssistProps.java @@ -9,15 +9,12 @@ * * @author Fabio Zadrozny */ -package org.python.pydev.editor.correctionassist; +package org.python.pydev.core; import java.io.File; import java.util.List; import org.eclipse.jface.text.BadLocationException; -import org.python.pydev.core.IPyEdit; -import org.python.pydev.core.IPythonNature; -import org.python.pydev.core.MisconfigurationException; import org.python.pydev.core.docutils.PySelection; import org.python.pydev.shared_core.code_completion.ICompletionProposalHandle; import org.python.pydev.shared_core.image.IImageCache; diff --git a/plugins/org.python.pydev.debug/src/org/python/pydev/debug/quick_assist/QuickAssistDontTrace.java b/plugins/org.python.pydev.debug/src/org/python/pydev/debug/quick_assist/QuickAssistDontTrace.java index 77a5e94156..e243f1151c 100644 --- a/plugins/org.python.pydev.debug/src/org/python/pydev/debug/quick_assist/QuickAssistDontTrace.java +++ b/plugins/org.python.pydev.debug/src/org/python/pydev/debug/quick_assist/QuickAssistDontTrace.java @@ -5,13 +5,13 @@ import java.util.List; import org.eclipse.jface.text.BadLocationException; +import org.python.pydev.core.IAssistProps; import org.python.pydev.core.IPyEdit; import org.python.pydev.core.IPythonNature; import org.python.pydev.core.MisconfigurationException; import org.python.pydev.core.docutils.PySelection; import org.python.pydev.core.proposals.CompletionProposalFactory; import org.python.pydev.debug.ui.DebugPrefsPage; -import org.python.pydev.editor.correctionassist.IAssistProps; import org.python.pydev.shared_core.code_completion.ICompletionProposalHandle; import org.python.pydev.shared_core.code_completion.IPyCompletionProposal; import org.python.pydev.shared_core.image.IImageCache; diff --git a/plugins/org.python.pydev/schema/pydev_ctrl_1.exsd b/plugins/org.python.pydev/schema/pydev_ctrl_1.exsd index 2282d32dd2..ad7180c232 100644 --- a/plugins/org.python.pydev/schema/pydev_ctrl_1.exsd +++ b/plugins/org.python.pydev/schema/pydev_ctrl_1.exsd @@ -50,7 +50,7 @@ - must implement the interface org.python.pydev.editor.correctionassist.IAssistProps + must implement the interface org.python.pydev.core.IAssistProps @@ -78,7 +78,7 @@ &nbsp;&nbsp;&nbsp;&nbsp;&lt;builder_participant class="my.AssistAddition"/&gt;<br> &lt;/extension&gt;<br> <br> -and my.AssistAddition must implement org.python.pydev.editor.correctionassist.IAssistProps. +and my.AssistAddition must implement org.python.pydev.core.IAssistProps. To get the problem markers at some line, the code below can be used:<br> <br> @@ -105,7 +105,7 @@ To get the problem markers at some line, the code below can be used:<br> - See org.python.pydev.editor.correctionassist.IAssistProps for more details.<br> + See org.python.pydev.core.IAssistProps for more details.<br> <br> It gives an option to see if the completions in a given line are valid (with IAssistProps.isValid) and asks for the completions to apply (IAssistProps.getProps). diff --git a/plugins/org.python.pydev/src/com/python/pydev/analysis/ctrl_1/AbstractAnalysisMarkersParticipants.java b/plugins/org.python.pydev/src/com/python/pydev/analysis/ctrl_1/AbstractAnalysisMarkersParticipants.java index 6ba0093162..cc944b0a94 100644 --- a/plugins/org.python.pydev/src/com/python/pydev/analysis/ctrl_1/AbstractAnalysisMarkersParticipants.java +++ b/plugins/org.python.pydev/src/com/python/pydev/analysis/ctrl_1/AbstractAnalysisMarkersParticipants.java @@ -12,6 +12,7 @@ import org.eclipse.jface.text.BadLocationException; import org.python.pydev.ast.analysis.IAnalysisPreferences; +import org.python.pydev.core.IAssistProps; import org.python.pydev.core.IPyEdit; import org.python.pydev.core.IPythonNature; import org.python.pydev.core.docutils.PySelection; @@ -19,7 +20,6 @@ import org.python.pydev.editor.PyEdit; import org.python.pydev.editor.codefolding.MarkerAnnotationAndPosition; import org.python.pydev.editor.codefolding.PySourceViewer; -import org.python.pydev.editor.correctionassist.IAssistProps; import org.python.pydev.shared_core.code_completion.ICompletionProposalHandle; import org.python.pydev.shared_core.image.IImageCache; import org.python.pydev.shared_core.structure.OrderedSet; @@ -81,7 +81,7 @@ public List getProps(PySelection ps, IImageCache imag /** * It is valid if any marker generated from the analysis is found * - * @see org.python.pydev.editor.correctionassist.IAssistProps#isValid(org.python.pydev.core.docutils.PySelection, java.lang.String, org.python.pydev.editor.PyEdit, int) + * @see org.python.pydev.core.IAssistProps#isValid(org.python.pydev.core.docutils.PySelection, java.lang.String, org.python.pydev.editor.PyEdit, int) */ @Override public boolean isValid(PySelection ps, String sel, IPyEdit edit, int offset) { diff --git a/plugins/org.python.pydev/src/com/python/pydev/analysis/ctrl_1/DontAnalyzeFileMarkerParticipant.java b/plugins/org.python.pydev/src/com/python/pydev/analysis/ctrl_1/DontAnalyzeFileMarkerParticipant.java index ffcace9c41..2c66067fe2 100644 --- a/plugins/org.python.pydev/src/com/python/pydev/analysis/ctrl_1/DontAnalyzeFileMarkerParticipant.java +++ b/plugins/org.python.pydev/src/com/python/pydev/analysis/ctrl_1/DontAnalyzeFileMarkerParticipant.java @@ -11,11 +11,11 @@ import java.util.List; import org.eclipse.jface.text.BadLocationException; +import org.python.pydev.core.IAssistProps; import org.python.pydev.core.IPyEdit; import org.python.pydev.core.IPythonNature; import org.python.pydev.core.docutils.PySelection; import org.python.pydev.core.proposals.CompletionProposalFactory; -import org.python.pydev.editor.correctionassist.IAssistProps; import org.python.pydev.shared_core.code_completion.ICompletionProposalHandle; import org.python.pydev.shared_core.code_completion.IPyCompletionProposal; import org.python.pydev.shared_core.image.IImageCache; diff --git a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/PythonCorrectionProcessor.java b/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/PythonCorrectionProcessor.java index c79f7f1c27..ae16a155d0 100644 --- a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/PythonCorrectionProcessor.java +++ b/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/PythonCorrectionProcessor.java @@ -30,6 +30,7 @@ import org.eclipse.ui.texteditor.spelling.SpellingProblem; import org.python.pydev.ast.codecompletion.ProposalsComparator; import org.python.pydev.core.ExtensionHelper; +import org.python.pydev.core.IAssistProps; import org.python.pydev.core.IPySyntaxHighlightingAndCodeCompletionEditor; import org.python.pydev.core.IPythonNature; import org.python.pydev.core.MisconfigurationException; diff --git a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/docstrings/AssistDocString.java b/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/docstrings/AssistDocString.java index 14be2891cd..d73422b2a7 100644 --- a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/docstrings/AssistDocString.java +++ b/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/docstrings/AssistDocString.java @@ -24,6 +24,7 @@ import java.util.regex.Pattern; import org.eclipse.jface.text.BadLocationException; +import org.python.pydev.core.IAssistProps; import org.python.pydev.core.IPyEdit; import org.python.pydev.core.IPythonNature; import org.python.pydev.core.autoedit.DefaultIndentPrefs; @@ -31,7 +32,6 @@ import org.python.pydev.core.docutils.PySelection; import org.python.pydev.core.docutils.PySelection.DocstringInfo; import org.python.pydev.core.proposals.CompletionProposalFactory; -import org.python.pydev.editor.correctionassist.IAssistProps; import org.python.pydev.shared_core.code_completion.ICompletionProposalHandle; import org.python.pydev.shared_core.code_completion.IPyCompletionProposal; import org.python.pydev.shared_core.image.IImageCache; @@ -57,7 +57,7 @@ public AssistDocString(String docStringStyle) { } /** - * @see org.python.pydev.editor.correctionassist.IAssistProps#getProps(org.python.pydev.core.docutils.PySelection, + * @see org.python.pydev.core.IAssistProps#getProps(org.python.pydev.core.docutils.PySelection, * org.python.pydev.shared_ui.ImageCache) */ @Override @@ -135,7 +135,7 @@ public ParamInfo() { } /** - * @see org.python.pydev.editor.correctionassist.IAssistProps#isValid(org.python.pydev.core.docutils.PySelection, + * @see org.python.pydev.core.IAssistProps#isValid(org.python.pydev.core.docutils.PySelection, * java.lang.String) */ @Override diff --git a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistAssign.java b/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistAssign.java index c6a9280b3f..12b21d0edf 100644 --- a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistAssign.java +++ b/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistAssign.java @@ -18,6 +18,7 @@ import org.eclipse.jface.text.BadLocationException; import org.eclipse.jface.text.source.ISourceViewer; import org.python.pydev.codingstd.ICodingStd; +import org.python.pydev.core.IAssistProps; import org.python.pydev.core.IPyEdit; import org.python.pydev.core.IPythonNature; import org.python.pydev.core.docutils.ParsingUtils; @@ -28,7 +29,6 @@ import org.python.pydev.core.proposals.CompletionProposalFactory; import org.python.pydev.editor.PyEdit; import org.python.pydev.editor.codefolding.PySourceViewer; -import org.python.pydev.editor.correctionassist.IAssistProps; import org.python.pydev.plugin.preferences.PyCodeStylePreferencesPage; import org.python.pydev.shared_core.code_completion.ICompletionProposalHandle; import org.python.pydev.shared_core.code_completion.IPyCompletionProposal; @@ -69,7 +69,7 @@ private IImageHandle getImage(IImageCache imageCache, String c) { } /** - * @see org.python.pydev.editor.correctionassist.IAssistProps#getProps + * @see org.python.pydev.core.IAssistProps#getProps */ @Override public List getProps(PySelection ps, IImageCache imageCache, File f, @@ -87,7 +87,7 @@ public List getProps(PySelection ps, IImageCache imag /** * Actual implementation (receiving a source viewer and only the actually used parameters). * - * @see org.python.pydev.editor.correctionassist.IAssistProps#getProps + * @see org.python.pydev.core.IAssistProps#getProps * * @param lineWithoutComments the line that should be checked (without any comments) */ @@ -167,7 +167,7 @@ private String changeToCodingStd(String callName) { } /** - * @see org.python.pydev.editor.correctionassist.IAssistProps#isValid + * @see org.python.pydev.core.IAssistProps#isValid */ @Override public boolean isValid(PySelection ps, String sel, IPyEdit edit, int offset) { diff --git a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistFString.java b/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistFString.java index bf94276305..e32b18590f 100644 --- a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistFString.java +++ b/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistFString.java @@ -7,6 +7,7 @@ import org.eclipse.jface.text.BadLocationException; import org.eclipse.jface.text.IDocument; import org.eclipse.jface.text.ITypedRegion; +import org.python.pydev.core.IAssistProps; import org.python.pydev.core.IPyEdit; import org.python.pydev.core.IPythonNature; import org.python.pydev.core.MisconfigurationException; @@ -15,7 +16,6 @@ import org.python.pydev.core.docutils.SyntaxErrorException; import org.python.pydev.core.partition.PyPartitionScanner; import org.python.pydev.core.proposals.CompletionProposalFactory; -import org.python.pydev.editor.correctionassist.IAssistProps; import org.python.pydev.shared_core.code_completion.ICompletionProposalHandle; import org.python.pydev.shared_core.code_completion.IPyCompletionProposal; import org.python.pydev.shared_core.image.IImageCache; diff --git a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistImport.java b/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistImport.java index 67c6a83a2a..16ed349a15 100644 --- a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistImport.java +++ b/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistImport.java @@ -16,12 +16,12 @@ import java.util.List; import org.eclipse.jface.text.BadLocationException; +import org.python.pydev.core.IAssistProps; import org.python.pydev.core.IPyEdit; import org.python.pydev.core.IPythonNature; import org.python.pydev.core.docutils.PySelection; import org.python.pydev.core.imports.ImportPreferences; import org.python.pydev.core.proposals.CompletionProposalFactory; -import org.python.pydev.editor.correctionassist.IAssistProps; import org.python.pydev.shared_core.code_completion.ICompletionProposalHandle; import org.python.pydev.shared_core.code_completion.IPyCompletionProposal; import org.python.pydev.shared_core.image.IImageCache; @@ -34,7 +34,7 @@ public class AssistImport implements IAssistProps { /** - * @see org.python.pydev.editor.correctionassist.IAssistProps#getProps(org.python.pydev.core.docutils.PySelection, org.python.pydev.shared_ui.ImageCache) + * @see org.python.pydev.core.IAssistProps#getProps(org.python.pydev.core.docutils.PySelection, org.python.pydev.shared_ui.ImageCache) */ @Override public List getProps(PySelection ps, IImageCache imageCache, File f, @@ -90,7 +90,7 @@ public List getProps(PySelection ps, IImageCache imag } /** - * @see org.python.pydev.editor.correctionassist.IAssistProps#isValid(org.python.pydev.core.docutils.PySelection) + * @see org.python.pydev.core.IAssistProps#isValid(org.python.pydev.core.docutils.PySelection) */ @Override public boolean isValid(PySelection ps, String sel, IPyEdit edit, int offset) { diff --git a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistImportToLocal.java b/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistImportToLocal.java index 588bf200f8..c97cf0b691 100644 --- a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistImportToLocal.java +++ b/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistImportToLocal.java @@ -8,6 +8,7 @@ import org.eclipse.core.runtime.NullProgressMonitor; import org.eclipse.jface.text.BadLocationException; import org.python.pydev.ast.refactoring.RefactoringRequest; +import org.python.pydev.core.IAssistProps; import org.python.pydev.core.IPyEdit; import org.python.pydev.core.IPythonNature; import org.python.pydev.core.MisconfigurationException; @@ -18,7 +19,6 @@ import org.python.pydev.core.proposals.CompletionProposalFactory; import org.python.pydev.editor.PyEdit; import org.python.pydev.editor.actions.refactoring.PyRefactorAction; -import org.python.pydev.editor.correctionassist.IAssistProps; import org.python.pydev.shared_core.code_completion.ICompletionProposalHandle; import org.python.pydev.shared_core.image.IImageCache; import org.python.pydev.shared_core.image.UIConstants; diff --git a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistPercentToFormat.java b/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistPercentToFormat.java index 98ff39f299..207ca0f9f1 100644 --- a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistPercentToFormat.java +++ b/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistPercentToFormat.java @@ -28,12 +28,12 @@ import org.eclipse.jface.text.templates.TemplateContext; import org.python.pydev.ast.codecompletion.AbstractTemplateCodeCompletion; import org.python.pydev.ast.codecompletion.CompletionRequest; +import org.python.pydev.core.IAssistProps; import org.python.pydev.core.IPyEdit; import org.python.pydev.core.IPythonNature; import org.python.pydev.core.TokensOrProposalsList; import org.python.pydev.core.docutils.PySelection; import org.python.pydev.core.proposals.CompletionProposalFactory; -import org.python.pydev.editor.correctionassist.IAssistProps; import org.python.pydev.shared_core.code_completion.ICompletionProposalHandle; import org.python.pydev.shared_core.image.IImageCache; import org.python.pydev.shared_core.image.UIConstants; @@ -43,7 +43,7 @@ public class AssistPercentToFormat extends AbstractTemplateCodeCompletion implem private static final boolean DEBUG = false; /** - * @see org.python.pydev.editor.correctionassist.IAssistProps#getProps(org.python.pydev.core.docutils.PySelection, + * @see org.python.pydev.core.IAssistProps#getProps(org.python.pydev.core.docutils.PySelection, * org.python.pydev.shared_ui.ImageCache) */ @Override @@ -102,7 +102,7 @@ public List getProps(PySelection ps, IImageCache imag } /** - * @see org.python.pydev.editor.correctionassist.IAssistProps#isValid(org.python.pydev.core.docutils.PySelection, + * @see org.python.pydev.core.IAssistProps#isValid(org.python.pydev.core.docutils.PySelection, * java.lang.String) */ @Override diff --git a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistSurroundWith.java b/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistSurroundWith.java index ab6bcbaa07..53294201bb 100644 --- a/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistSurroundWith.java +++ b/plugins/org.python.pydev/src/org/python/pydev/editor/correctionassist/heuristics/AssistSurroundWith.java @@ -22,6 +22,7 @@ import org.eclipse.jface.text.templates.TemplateContext; import org.python.pydev.ast.codecompletion.AbstractTemplateCodeCompletion; import org.python.pydev.ast.codecompletion.CompletionRequest; +import org.python.pydev.core.IAssistProps; import org.python.pydev.core.IPyEdit; import org.python.pydev.core.IPythonNature; import org.python.pydev.core.TokensOrProposalsList; @@ -29,7 +30,6 @@ import org.python.pydev.core.docutils.PySelection; import org.python.pydev.core.proposals.CompletionProposalFactory; import org.python.pydev.editor.codecompletion.PyTemplateProposal; -import org.python.pydev.editor.correctionassist.IAssistProps; import org.python.pydev.shared_core.code_completion.ICompletionProposalHandle; import org.python.pydev.shared_core.image.IImageCache; import org.python.pydev.shared_core.image.UIConstants; @@ -44,7 +44,7 @@ public class AssistSurroundWith extends AbstractTemplateCodeCompletion implement /** * @throws BadLocationException - * @see org.python.pydev.editor.correctionassist.IAssistProps#getProps(org.python.pydev.core.docutils.PySelection, org.python.pydev.shared_ui.ImageCache) + * @see org.python.pydev.core.IAssistProps#getProps(org.python.pydev.core.docutils.PySelection, org.python.pydev.shared_ui.ImageCache) */ @Override public List getProps(PySelection ps, IImageCache imageCache, File f, @@ -171,7 +171,7 @@ public String getAdditionalProposalInfo() { "%sif ${True}:%s%s%s%s%s${cursor}", "if", "%swith ${var}:%s%s%s%s%s${cursor}", "with", }; /** - * @see org.python.pydev.editor.correctionassist.IAssistProps#isValid(org.python.pydev.core.docutils.PySelection) + * @see org.python.pydev.core.IAssistProps#isValid(org.python.pydev.core.docutils.PySelection) */ @Override public boolean isValid(PySelection ps, String sel, IPyEdit edit, int offset) { diff --git a/plugins/org.python.pydev/tests/org/python/pydev/editor/correctionassist/heuristics/AssistCreateInModuleTest.java b/plugins/org.python.pydev/tests/org/python/pydev/editor/correctionassist/heuristics/AssistCreateInModuleTest.java index 8d0a31fbcb..ddf7899129 100644 --- a/plugins/org.python.pydev/tests/org/python/pydev/editor/correctionassist/heuristics/AssistCreateInModuleTest.java +++ b/plugins/org.python.pydev/tests/org/python/pydev/editor/correctionassist/heuristics/AssistCreateInModuleTest.java @@ -12,7 +12,7 @@ package org.python.pydev.editor.correctionassist.heuristics; import org.python.pydev.ast.codecompletion.revisited.CodeCompletionTestsBase; -import org.python.pydev.editor.correctionassist.IAssistProps; +import org.python.pydev.core.IAssistProps; /** * Might be useful when a decent implementation is given