Skip to content
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.

Sign up for GitHub

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

Add the IncorrectStaticContextHintError as a new hint #6703 #6899

Merged
merged 1 commit into from
Jan 1, 2024
Merged

Add the IncorrectStaticContextHintError as a new hint #6703 #6899

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions php/php.editor/src/org/netbeans/modules/php/editor/CodeUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ public final class CodeUtils {
public static final String OVERRIDE_ATTRIBUTE = "#[" + OVERRIDE_ATTRIBUTE_FQ_NAME + "]"; // NOI18N
public static final String EMPTY_STRING = ""; // NOI18N
public static final String NEW_LINE = "\n"; // NOI18N
public static final String THIS_VARIABLE = "$this"; // NOI18N

public static final Pattern WHITE_SPACES_PATTERN = Pattern.compile("\\s+"); // NOI18N
public static final Pattern SPLIT_TYPES_PATTERN = Pattern.compile("[()|&]+"); // NOI18N
Expand Down
1 change: 1 addition & 0 deletions php/php.editor/src/org/netbeans/modules/php/editor/resources/layer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,6 +433,7 @@
<file name="org-netbeans-modules-php-editor-verification-IncorrectMixedGroupUseHintError.instance"/>
<file name="org-netbeans-modules-php-editor-verification-IncorrectNamedArgumentsHintError.instance"/>
<file name="org-netbeans-modules-php-editor-verification-IncorrectNonAbstractMethodHintError.instance"/>
<file name="org-netbeans-modules-php-editor-verification-IncorrectStaticContextHintError.instance"/>
<file name="org-netbeans-modules-php-editor-verification-LoopOnlyKeywordsUnhandledError.instance"/>
<file name="org-netbeans-modules-php-editor-verification-MethodRedeclarationHintError.instance"/>
<file name="org-netbeans-modules-php-editor-verification-ModifiersCheckHintError.instance"/>
Expand Down
274 changes: 274 additions & 0 deletions ...tor/src/org/netbeans/modules/php/editor/verification/IncorrectStaticContextHintError.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,274 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.netbeans.modules.php.editor.verification;

import java.util.ArrayDeque;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import org.netbeans.modules.csl.api.Hint;
import org.netbeans.modules.csl.api.HintFix;
import org.netbeans.modules.csl.api.OffsetRange;
import org.netbeans.modules.csl.spi.support.CancelSupport;
import org.netbeans.modules.php.editor.CodeUtils;
import org.netbeans.modules.php.editor.model.FileScope;
import org.netbeans.modules.php.editor.parser.PHPParseResult;
import org.netbeans.modules.php.editor.parser.astnodes.ASTNode;
import org.netbeans.modules.php.editor.parser.astnodes.ArrowFunctionDeclaration;
import org.netbeans.modules.php.editor.parser.astnodes.BodyDeclaration;
import org.netbeans.modules.php.editor.parser.astnodes.ClassDeclaration;
import org.netbeans.modules.php.editor.parser.astnodes.ClassInstanceCreation;
import org.netbeans.modules.php.editor.parser.astnodes.EnumDeclaration;
import org.netbeans.modules.php.editor.parser.astnodes.LambdaFunctionDeclaration;
import org.netbeans.modules.php.editor.parser.astnodes.MethodDeclaration;
import org.netbeans.modules.php.editor.parser.astnodes.TraitDeclaration;
import org.netbeans.modules.php.editor.parser.astnodes.Variable;
import org.netbeans.modules.php.editor.parser.astnodes.visitors.DefaultVisitor;
import org.openide.filesystems.FileObject;
import org.openide.util.NbBundle;

/**
* Handle incorrect static context statements.
*/
public class IncorrectStaticContextHintError extends HintErrorRule {

private static final boolean DISABLED = Boolean.getBoolean("nb.php.editor.disableIncorrectStaticContextHintError"); // NOI18N
private FileObject fileObject;

@Override
@NbBundle.Messages("IncorrectStaticContextHintError.displayName=Incorrect Statements in Static Context")
public String getDisplayName() {
return Bundle.IncorrectStaticContextHintError_displayName();
}

@Override
public void invoke(PHPRuleContext context, List<Hint> hints) {
if (DISABLED) {
return;
}
PHPParseResult phpParseResult = (PHPParseResult) context.parserResult;
if (phpParseResult.getProgram() == null) {
return;
}
FileScope fileScope = context.fileScope;
fileObject = phpParseResult.getSnapshot().getSource().getFileObject();
if (fileScope != null && fileObject != null) {
if (CancelSupport.getDefault().isCancelled()) {
return;
}
CheckVisitor checkVisitor = new CheckVisitor();
phpParseResult.getProgram().accept(checkVisitor);
Set<Variable> incorrectThisVariables = checkVisitor.getThisVariableInStaticContext();
addIncorrectThisHints(incorrectThisVariables, hints);
}
}

@NbBundle.Messages("IncorrectStaticContextHintError.incorrectThis=Cannot use \"$this\" in static context.")
private void addIncorrectThisHints(Set<Variable> incorrectThisVariables, List<Hint> hints) {
// e.g.
// public static function staticMethod(): int {
// return $this->field;
// } ^^^^^
for (Variable thisVariable : incorrectThisVariables) {
if (CancelSupport.getDefault().isCancelled()) {
return;
}
addHint(thisVariable, Bundle.IncorrectStaticContextHintError_incorrectThis(), hints);
}
}

private void addHint(ASTNode node, String description, List<Hint> hints) {
addHint(node, description, hints, Collections.emptyList());
}

private void addHint(ASTNode node, String description, List<Hint> hints, List<HintFix> fixes) {
hints.add(new Hint(
this,
description,
fileObject,
new OffsetRange(node.getStartOffset(), node.getEndOffset()),
fixes,
500
));
}

//~ Inner classes
private static final class CheckVisitor extends DefaultVisitor {

private boolean isInTypeDeclaration = false;
private boolean isInStaticMethod = false;
private ASTNode firstStaticClosure = null;
private final ArrayDeque<ASTNode> firstStaticClosureStack = new ArrayDeque<>();
private final ArrayDeque<Boolean> isInStaticMethodStack = new ArrayDeque<>();
private final Set<Variable> thisVariableInStaticContext = new HashSet<>();

@Override
public void visit(MethodDeclaration node) {
if (CancelSupport.getDefault().isCancelled()) {
return;
}
isInStaticMethod = BodyDeclaration.Modifier.isStatic(node.getModifier());
super.visit(node);
isInStaticMethod = false;
}

@Override
public void visit(LambdaFunctionDeclaration node) {
if (CancelSupport.getDefault().isCancelled()) {
return;
}
// e.g.
// $closure = function() {
// $this->something; // ok
// $nestedStaticClosure = static function() {
// $this->something; // error
// $nestedClosure = function() {
// $this->something; // error
// };
// };
// };
if (node.isStatic()) {
if (firstStaticClosure == null) {
firstStaticClosure = node;
}
}
super.visit(node);
if (firstStaticClosure == node) {
firstStaticClosure = null;
}
}

@Override
public void visit(ArrowFunctionDeclaration node) {
if (CancelSupport.getDefault().isCancelled()) {
return;
}
if (node.isStatic()) {
if (firstStaticClosure == null) {
firstStaticClosure = node;
}
}
super.visit(node);
if (firstStaticClosure == node) {
firstStaticClosure = null;
}
}

@Override
public void visit(ClassDeclaration node) {
if (CancelSupport.getDefault().isCancelled()) {
return;
}
isInTypeDeclaration = true;
super.visit(node);
isInTypeDeclaration = false;
}

@Override
public void visit(EnumDeclaration node) {
if (CancelSupport.getDefault().isCancelled()) {
return;
}
isInTypeDeclaration = true;
super.visit(node);
isInTypeDeclaration = false;
}

@Override
public void visit(TraitDeclaration node) {
if (CancelSupport.getDefault().isCancelled()) {
return;
}
isInTypeDeclaration = true;
super.visit(node);
isInTypeDeclaration = false;
}

@Override
public void visit(ClassInstanceCreation node) {
if (CancelSupport.getDefault().isCancelled()) {
return;
}
// static method may have anonymous classes
// e.g.
// public static function getExample(): int {
// self::staticMethod($this); // error
// $anon = new class() {
// private int $field = 1;
//
// public static function nestedStaticMethod(): void {
// echo $this->field; // error
// }
//
// public function nestedMethod(): void {
// echo $this->field; // ok
// }
// };
// return $this->test; // error
// }
boolean isInPreviousTypeDeclaration = this.isInTypeDeclaration;
boolean hasFirstStaticClosure = firstStaticClosure != null;
if (node.isAnonymous()) {
isInTypeDeclaration = true;
isInStaticMethodStack.push(isInStaticMethod);
isInStaticMethod = false;
if (hasFirstStaticClosure) {
firstStaticClosureStack.push(firstStaticClosure);
firstStaticClosure = null;
}
}
super.visit(node);
if (node.isAnonymous()) {
isInTypeDeclaration = isInPreviousTypeDeclaration;
isInStaticMethod = isInStaticMethodStack.pop();
if (hasFirstStaticClosure) {
firstStaticClosure = firstStaticClosureStack.pop();
}
}
}

@Override
public void visit(Variable node) {
if (CancelSupport.getDefault().isCancelled()) {
return;
}
if (isInStaticContext()) {
String variableName = CodeUtils.extractVariableName(node);
if (CodeUtils.THIS_VARIABLE.equals(variableName)) {
thisVariableInStaticContext.add(node);
}
}
super.visit(node);
}

private boolean isInStaticContext() {
// NOTE:
// Check only $this in TypeDeclarations because Frameworks may use `$this` in the global scope
// e.g. CakePHP framework can use `$this` in the global scope of view files
// see: https://book.cakephp.org/5/en/views.html
return isInStaticMethod
|| (isInTypeDeclaration && firstStaticClosure != null);
}

public Set<Variable> getThisVariableInStaticContext() {
return Collections.unmodifiableSet(thisVariableInStaticContext);
}
}
}
Loading