1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
|
// Copyright 2023 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package golang
import (
"fmt"
"go/ast"
"go/token"
"go/types"
"strings"
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/ast/astutil"
"golang.org/x/tools/gopls/internal/util/safetoken"
)
// invertIfCondition is a singleFileFixFunc that inverts an if/else statement
func invertIfCondition(fset *token.FileSet, start, end token.Pos, src []byte, file *ast.File, _ *types.Package, _ *types.Info) (*token.FileSet, *analysis.SuggestedFix, error) {
ifStatement, _, err := canInvertIfCondition(file, start, end)
if err != nil {
return nil, nil, err
}
var replaceElse analysis.TextEdit
endsWithReturn, err := endsWithReturn(ifStatement.Else)
if err != nil {
return nil, nil, err
}
if endsWithReturn {
// Replace the whole else part with an empty line and an unindented
// version of the original if body
sourcePos := safetoken.StartPosition(fset, ifStatement.Pos())
indent := sourcePos.Column - 1
if indent < 0 {
indent = 0
}
standaloneBodyText := ifBodyToStandaloneCode(fset, ifStatement.Body, src)
replaceElse = analysis.TextEdit{
Pos: ifStatement.Body.Rbrace + 1, // 1 == len("}")
End: ifStatement.End(),
NewText: []byte("\n\n" + strings.Repeat("\t", indent) + standaloneBodyText),
}
} else {
// Replace the else body text with the if body text
bodyStart := safetoken.StartPosition(fset, ifStatement.Body.Lbrace)
bodyEnd := safetoken.EndPosition(fset, ifStatement.Body.Rbrace+1) // 1 == len("}")
bodyText := src[bodyStart.Offset:bodyEnd.Offset]
replaceElse = analysis.TextEdit{
Pos: ifStatement.Else.Pos(),
End: ifStatement.Else.End(),
NewText: bodyText,
}
}
// Replace the if text with the else text
elsePosInSource := safetoken.StartPosition(fset, ifStatement.Else.Pos())
elseEndInSource := safetoken.EndPosition(fset, ifStatement.Else.End())
elseText := src[elsePosInSource.Offset:elseEndInSource.Offset]
replaceBodyWithElse := analysis.TextEdit{
Pos: ifStatement.Body.Pos(),
End: ifStatement.Body.End(),
NewText: elseText,
}
// Replace the if condition with its inverse
inverseCondition, err := invertCondition(fset, ifStatement.Cond, src)
if err != nil {
return nil, nil, err
}
replaceConditionWithInverse := analysis.TextEdit{
Pos: ifStatement.Cond.Pos(),
End: ifStatement.Cond.End(),
NewText: inverseCondition,
}
// Return a SuggestedFix with just that TextEdit in there
return fset, &analysis.SuggestedFix{
TextEdits: []analysis.TextEdit{
replaceConditionWithInverse,
replaceBodyWithElse,
replaceElse,
},
}, nil
}
func endsWithReturn(elseBranch ast.Stmt) (bool, error) {
elseBlock, isBlockStatement := elseBranch.(*ast.BlockStmt)
if !isBlockStatement {
return false, fmt.Errorf("unable to figure out whether this ends with return: %T", elseBranch)
}
if len(elseBlock.List) == 0 {
// Empty blocks don't end in returns
return false, nil
}
lastStatement := elseBlock.List[len(elseBlock.List)-1]
_, lastStatementIsReturn := lastStatement.(*ast.ReturnStmt)
return lastStatementIsReturn, nil
}
// Turn { fmt.Println("Hello") } into just fmt.Println("Hello"), with one less
// level of indentation.
//
// The first line of the result will not be indented, but all of the following
// lines will.
func ifBodyToStandaloneCode(fset *token.FileSet, ifBody *ast.BlockStmt, src []byte) string {
// Get the whole body (without the surrounding braces) as a string
bodyStart := safetoken.StartPosition(fset, ifBody.Lbrace+1) // 1 == len("}")
bodyEnd := safetoken.EndPosition(fset, ifBody.Rbrace)
bodyWithoutBraces := string(src[bodyStart.Offset:bodyEnd.Offset])
bodyWithoutBraces = strings.TrimSpace(bodyWithoutBraces)
// Unindent
bodyWithoutBraces = strings.ReplaceAll(bodyWithoutBraces, "\n\t", "\n")
return bodyWithoutBraces
}
func invertCondition(fset *token.FileSet, cond ast.Expr, src []byte) ([]byte, error) {
condStart := safetoken.StartPosition(fset, cond.Pos())
condEnd := safetoken.EndPosition(fset, cond.End())
oldText := string(src[condStart.Offset:condEnd.Offset])
switch expr := cond.(type) {
case *ast.Ident, *ast.ParenExpr, *ast.CallExpr, *ast.StarExpr, *ast.IndexExpr, *ast.IndexListExpr, *ast.SelectorExpr:
newText := "!" + oldText
if oldText == "true" {
newText = "false"
} else if oldText == "false" {
newText = "true"
}
return []byte(newText), nil
case *ast.UnaryExpr:
if expr.Op != token.NOT {
// This should never happen
return dumbInvert(fset, cond, src), nil
}
inverse := expr.X
if p, isParen := inverse.(*ast.ParenExpr); isParen {
// We got !(x), remove the parentheses with the ! so we get just "x"
inverse = p.X
start := safetoken.StartPosition(fset, inverse.Pos())
end := safetoken.EndPosition(fset, inverse.End())
if start.Line != end.Line {
// The expression is multi-line, so we can't remove the parentheses
inverse = expr.X
}
}
start := safetoken.StartPosition(fset, inverse.Pos())
end := safetoken.EndPosition(fset, inverse.End())
textWithoutNot := src[start.Offset:end.Offset]
return textWithoutNot, nil
case *ast.BinaryExpr:
// These inversions are unsound for floating point NaN, but that's ok.
negations := map[token.Token]string{
token.EQL: "!=",
token.LSS: ">=",
token.GTR: "<=",
token.NEQ: "==",
token.LEQ: ">",
token.GEQ: "<",
}
negation, negationFound := negations[expr.Op]
if !negationFound {
return invertAndOr(fset, expr, src)
}
xPosInSource := safetoken.StartPosition(fset, expr.X.Pos())
opPosInSource := safetoken.StartPosition(fset, expr.OpPos)
yPosInSource := safetoken.StartPosition(fset, expr.Y.Pos())
textBeforeOp := string(src[xPosInSource.Offset:opPosInSource.Offset])
oldOpWithTrailingWhitespace := string(src[opPosInSource.Offset:yPosInSource.Offset])
newOpWithTrailingWhitespace := negation + oldOpWithTrailingWhitespace[len(expr.Op.String()):]
textAfterOp := string(src[yPosInSource.Offset:condEnd.Offset])
return []byte(textBeforeOp + newOpWithTrailingWhitespace + textAfterOp), nil
}
return dumbInvert(fset, cond, src), nil
}
// dumbInvert is a fallback, inverting cond into !(cond).
func dumbInvert(fset *token.FileSet, expr ast.Expr, src []byte) []byte {
start := safetoken.StartPosition(fset, expr.Pos())
end := safetoken.EndPosition(fset, expr.End())
text := string(src[start.Offset:end.Offset])
return []byte("!(" + text + ")")
}
func invertAndOr(fset *token.FileSet, expr *ast.BinaryExpr, src []byte) ([]byte, error) {
if expr.Op != token.LAND && expr.Op != token.LOR {
// Neither AND nor OR, don't know how to invert this
return dumbInvert(fset, expr, src), nil
}
oppositeOp := "&&"
if expr.Op == token.LAND {
oppositeOp = "||"
}
xEndInSource := safetoken.EndPosition(fset, expr.X.End())
opPosInSource := safetoken.StartPosition(fset, expr.OpPos)
whitespaceAfterBefore := src[xEndInSource.Offset:opPosInSource.Offset]
invertedBefore, err := invertCondition(fset, expr.X, src)
if err != nil {
return nil, err
}
invertedAfter, err := invertCondition(fset, expr.Y, src)
if err != nil {
return nil, err
}
yPosInSource := safetoken.StartPosition(fset, expr.Y.Pos())
oldOpWithTrailingWhitespace := string(src[opPosInSource.Offset:yPosInSource.Offset])
newOpWithTrailingWhitespace := oppositeOp + oldOpWithTrailingWhitespace[len(expr.Op.String()):]
return []byte(string(invertedBefore) + string(whitespaceAfterBefore) + newOpWithTrailingWhitespace + string(invertedAfter)), nil
}
// canInvertIfCondition reports whether we can do invert-if-condition on the
// code in the given range
func canInvertIfCondition(file *ast.File, start, end token.Pos) (*ast.IfStmt, bool, error) {
path, _ := astutil.PathEnclosingInterval(file, start, end)
for _, node := range path {
stmt, isIfStatement := node.(*ast.IfStmt)
if !isIfStatement {
continue
}
if stmt.Else == nil {
// Can't invert conditions without else clauses
return nil, false, fmt.Errorf("else clause required")
}
if _, hasElseIf := stmt.Else.(*ast.IfStmt); hasElseIf {
// Can't invert conditions with else-if clauses, unclear what that
// would look like
return nil, false, fmt.Errorf("else-if not supported")
}
return stmt, true, nil
}
return nil, false, fmt.Errorf("not an if statement")
}
|