IEP-1018 Automation of hints viewer #809
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| /******************************************************************************* | ||
| * Copyright 2022-2023 Espressif Systems (Shanghai) PTE LTD. All rights reserved. | ||
| * Use is subject to license terms. | ||
| *******************************************************************************/ | ||
| package com.espressif.idf.core.build; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import org.eclipse.cdt.core.IConsoleParser; | ||
|
|
||
| import com.espressif.idf.core.resources.OpenDialogListenerSupport; | ||
| import com.espressif.idf.core.resources.PopupDialog; | ||
| import com.espressif.idf.core.util.StringUtil; | ||
|
|
||
| /** | ||
| * The EspIdfErrorParser class implements the IConsoleParser interface to parse console output for ESP-IDF errors and | ||
| * extract relevant hints. It processes each line of the console output and checks against a list of regular expression | ||
| * patterns to identify errors and their corresponding hints. | ||
| * | ||
| * This class maintains a list of regular expression hint pairs (ReHintPair) that are used to match and identify errors, | ||
| * and associate them with appropriate hints. It accumulates matched pairs in the 'allMatchesList' for further | ||
| * processing. | ||
| * | ||
| * The processLine method is responsible for processing each input line by iterating through the list of regular | ||
| * expression hint pairs. It uses regular expressions to determine if the line matches any error pattern. If a match is | ||
| * found, the corresponding hint is associated with the error message and added to the 'allMatchesList'. | ||
| * | ||
| * The shutdown method is used to trigger the completion of parsing. It notifies listeners registred in the UI plugin | ||
| * that the list of available hints has changed and providing the accumulated error hint pairs. The 'allMatchesList' is | ||
| * then cleared to prepare for the next parsing session. | ||
| * | ||
| * | ||
| * @author Denys Almazov ([email protected]) | ||
| * | ||
| */ | ||
| public class EspIdfErrorParser implements IConsoleParser | ||
| { | ||
|
|
||
| private List<ReHintPair> reHintsList; | ||
| private List<ReHintPair> allMatchesList; | ||
|
|
||
| public EspIdfErrorParser(List<ReHintPair> reHintPairs) | ||
| { | ||
| this.reHintsList = reHintPairs; | ||
| this.allMatchesList = new ArrayList<>(); | ||
| } | ||
|
Comment on lines
+44
to
+47
There was a problem hiding this comment. The constructor + if (reHintPairs == null) {
+ throw new IllegalArgumentException("reHintPairs cannot be null");
+ } |
||
| public boolean processLine(String paramString) | ||
| { | ||
| for (ReHintPair reHintEntry : reHintsList) | ||
| { | ||
| boolean isRegexMatchesWithProcessedString = Pattern.compile(reHintEntry.getRe()).matcher(paramString) | ||
| .find(); | ||
| if (isRegexMatchesWithProcessedString) | ||
| { | ||
| allMatchesList.add(new ReHintPair(paramString, reHintEntry.getHint())); | ||
| return true; | ||
| } | ||
| } | ||
|
There was a problem hiding this comment. The regular expression pattern is compiled for every line processed, which can be inefficient if the number of lines or patterns is large. Consider compiling the patterns once during initialization and reusing them. - public boolean processLine(String paramString)
- {
- for (ReHintPair reHintEntry : reHintsList)
- {
- boolean isRegexMatchesWithProcessedString = Pattern.compile(reHintEntry.getRe()).matcher(paramString)
- .find();
- if (isRegexMatchesWithProcessedString)
- {
- allMatchesList.add(new ReHintPair(paramString, reHintEntry.getHint()));
- return true;
- }
- }
- return false;
- }
+ public boolean processLine(String paramString)
+ {
+ for (ReHintPair reHintEntry : reHintsList)
+ {
+ boolean isRegexMatchesWithProcessedString = reHintEntry.getPattern().matcher(paramString).find();
+ if (isRegexMatchesWithProcessedString)
+ {
+ allMatchesList.add(new ReHintPair(paramString, reHintEntry.getHint()));
+ return true;
+ }
+ }
+ return false;
+ }In the above diff, I'm assuming that you will modify the |
||
| return false; | ||
| } | ||
|
|
||
| public void shutdown() | ||
| { | ||
| OpenDialogListenerSupport.getSupport().firePropertyChange(PopupDialog.AVAILABLE_HINTS.name(), | ||
| StringUtil.EMPTY, new ArrayList<>(allMatchesList)); | ||
| allMatchesList.clear(); | ||
| } | ||
sigmaaa marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
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 |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| package com.espressif.idf.core.resources; | ||
|
|
||
| public enum PopupDialog | ||
| { | ||
| LOW_PARTITION_SIZE, AVAILABLE_HINTS | ||
| } |
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
Oops, something went wrong.
Oops, something went wrong.
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.
The constructor
EspIdfErrorParser(List<ReHintPair> reHintPairs)does not check if the passed listreHintPairsis null. This can lead to a NullPointerException in theprocessLinemethod when it tries to iterate overreHintsList. It's a good practice to validate constructor parameters to avoid potential runtime exceptions.