Skip to content

Commit b7de11b

Browse files
JantherJanther
authored
Adding Parentheses on consecutive equality operators (#1132)
1 parent f4ac691 commit b7de11b

File tree

7 files changed

+735
-12
lines changed

7 files changed

+735
-12
lines changed

‎src/parser.js‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,10 @@ function parse(text, _parsers, options = _parsers) {
176176
'&'
177177
]);
178178
break;
179+
case '==':
180+
case '!=':
181+
ctx.left = tryHug(ctx.left, ['==', '!=']);
182+
break;
179183
case '||':
180184
ctx.left = tryHug(ctx.left, ['&&']);
181185
ctx.right = tryHug(ctx.right, ['&&']);

‎src/slang-nodes/EqualityExpression.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import { NonterminalKind } from '@nomicfoundation/slang/cst';
22
import { printComparisonOperation } from '../slang-printers/print-comparison-operation.js';
3+
import { createHugFunction } from '../slang-utils/create-hug-function.js';
34
import { getNodeMetadata, updateMetadata } from '../slang-utils/metadata.js';
45
import { Expression } from './Expression.js';
56

@@ -8,6 +9,8 @@ import type { AstPath, Doc, ParserOptions } from 'prettier';
89
import type { AstNode } from './types.d.ts';
910
import type { PrintFunction, SlangNode } from '../types.d.ts';
1011

12+
const tryToHug = createHugFunction(['==', '!=']);
13+
1114
export class EqualityExpression implements SlangNode {
1215
readonly kind = NonterminalKind.EqualityExpression;
1316

@@ -32,6 +35,8 @@ export class EqualityExpression implements SlangNode {
3235

3336
this.comments = metadata.comments;
3437
this.loc = metadata.loc;
38+
39+
this.leftOperand = tryToHug(this.leftOperand);
3540
}
3641

3742
print(

‎tests/format/BinaryOperationHierarchy/__snapshots__/format.test.js.snap‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1029,10 +1029,10 @@ contract Group {
10291029
veryVeryVeryLongUint256A ==
10301030
veryVeryVeryLongUint256B ^ veryVeryVeryLongUint256C;
10311031
resultBoolean =
1032-
veryVeryVeryLongUint256A == veryVeryVeryLongUint256B ==
1032+
(veryVeryVeryLongUint256A == veryVeryVeryLongUint256B) ==
10331033
veryVeryVeryLongBooleanC;
10341034
resultBoolean =
1035-
veryVeryVeryLongUint256A == veryVeryVeryLongUint256B !=
1035+
(veryVeryVeryLongUint256A == veryVeryVeryLongUint256B) !=
10361036
veryVeryVeryLongBooleanC;
10371037
resultBoolean =
10381038
veryVeryVeryLongBooleanA ==
@@ -1083,10 +1083,10 @@ contract Group {
10831083
veryVeryVeryLongUint256A !=
10841084
veryVeryVeryLongUint256B ^ veryVeryVeryLongUint256C;
10851085
resultBoolean =
1086-
veryVeryVeryLongUint256A != veryVeryVeryLongUint256B ==
1086+
(veryVeryVeryLongUint256A != veryVeryVeryLongUint256B) ==
10871087
veryVeryVeryLongBooleanC;
10881088
resultBoolean =
1089-
veryVeryVeryLongUint256A != veryVeryVeryLongUint256B !=
1089+
(veryVeryVeryLongUint256A != veryVeryVeryLongUint256B) !=
10901090
veryVeryVeryLongBooleanC;
10911091
resultBoolean =
10921092
veryVeryVeryLongBooleanA !=
@@ -2515,12 +2515,12 @@ contract Indent {
25152515
veryVeryVeryExtremelyExtremelyLongUint256B ^
25162516
veryVeryVeryExtremelyExtremelyLongUint256C;
25172517
resultBoolean =
2518-
veryVeryVeryExtremelyExtremelyLongUint256A ==
2519-
veryVeryVeryExtremelyExtremelyLongUint256B ==
2518+
(veryVeryVeryExtremelyExtremelyLongUint256A ==
2519+
veryVeryVeryExtremelyExtremelyLongUint256B) ==
25202520
veryVeryVeryExtremelyExtremelyLongBooleanC;
25212521
resultBoolean =
2522-
veryVeryVeryExtremelyExtremelyLongUint256A ==
2523-
veryVeryVeryExtremelyExtremelyLongUint256B !=
2522+
(veryVeryVeryExtremelyExtremelyLongUint256A ==
2523+
veryVeryVeryExtremelyExtremelyLongUint256B) !=
25242524
veryVeryVeryExtremelyExtremelyLongBooleanC;
25252525
resultBoolean =
25262526
veryVeryVeryExtremelyExtremelyLongBooleanA ==
@@ -2586,12 +2586,12 @@ contract Indent {
25862586
veryVeryVeryExtremelyExtremelyLongUint256B ^
25872587
veryVeryVeryExtremelyExtremelyLongUint256C;
25882588
resultBoolean =
2589-
veryVeryVeryExtremelyExtremelyLongUint256A !=
2590-
veryVeryVeryExtremelyExtremelyLongUint256B ==
2589+
(veryVeryVeryExtremelyExtremelyLongUint256A !=
2590+
veryVeryVeryExtremelyExtremelyLongUint256B) ==
25912591
veryVeryVeryExtremelyExtremelyLongBooleanC;
25922592
resultBoolean =
2593-
veryVeryVeryExtremelyExtremelyLongUint256A !=
2594-
veryVeryVeryExtremelyExtremelyLongUint256B !=
2593+
(veryVeryVeryExtremelyExtremelyLongUint256A !=
2594+
veryVeryVeryExtremelyExtremelyLongUint256B) !=
25952595
veryVeryVeryExtremelyExtremelyLongBooleanC;
25962596
resultBoolean =
25972597
veryVeryVeryExtremelyExtremelyLongBooleanA !=

‎tests/format/Parentheses/EqualParentheses.sol‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
// SPDX-License-Identifier: MIT
2+
pragma solidity 0.8.28;
3+
4+
contract EqualParentheses {
5+
function notEqualAdd(uint256 a, uint256 b, uint256 c)
6+
public
7+
pure
8+
returns (bool)
9+
{
10+
return a == b + c;
11+
}
12+
13+
function notEqualSub(uint256 a, uint256 b, uint256 c)
14+
public
15+
pure
16+
returns (bool)
17+
{
18+
return a == b - c;
19+
}
20+
21+
function notEqualMul(uint256 a, uint256 b, uint256 c)
22+
public
23+
pure
24+
returns (bool)
25+
{
26+
return a == b * c;
27+
}
28+
29+
function notEqualDiv(uint256 a, uint256 b, uint256 c)
30+
public
31+
pure
32+
returns (bool)
33+
{
34+
return a == b / c;
35+
}
36+
37+
function notEqualMod(uint256 a, uint256 b, uint256 c)
38+
public
39+
pure
40+
returns (bool)
41+
{
42+
return a == b % c;
43+
}
44+
45+
function notEqualExp(uint256 a, uint256 b, uint256 c)
46+
public
47+
pure
48+
returns (bool)
49+
{
50+
return a == b ** c;
51+
}
52+
53+
function notEqualShiftL(uint256 a, uint256 b, uint256 c)
54+
public
55+
pure
56+
returns (bool)
57+
{
58+
return a == b << c;
59+
}
60+
61+
function notEqualShiftR(uint256 a, uint256 b, uint256 c)
62+
public
63+
pure
64+
returns (bool)
65+
{
66+
return a == b >> c;
67+
}
68+
69+
function notEqualBitAnd(uint256 a, uint256 b, uint256 c)
70+
public
71+
pure
72+
returns (bool)
73+
{
74+
return a == b & c;
75+
}
76+
77+
function notEqualBitOr(uint256 a, uint256 b, uint256 c)
78+
public
79+
pure
80+
returns (bool)
81+
{
82+
return a == b | c;
83+
}
84+
85+
function notEqualBitXor(uint256 a, uint256 b, uint256 c)
86+
public
87+
pure
88+
returns (bool)
89+
{
90+
return a == b ^ c;
91+
}
92+
93+
function notEqualEqual(bool a, bool b, bool c)
94+
public
95+
pure
96+
returns (bool)
97+
{
98+
return a == b == c;
99+
}
100+
101+
function notEqualNotEqual(bool a, bool b, bool c)
102+
public
103+
pure
104+
returns (bool)
105+
{
106+
return a == b != c;
107+
}
108+
}

‎tests/format/Parentheses/LogicNoParentheses.sol‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,20 @@ contract LogicNoParentheses {
1717
function andAnd(bool a, bool b, bool c) public pure returns (bool) {
1818
return a && b && c;
1919
}
20+
21+
function equalEqual(bool a, bool b, bool c) public pure returns (bool) {
22+
return a == b == c;
23+
}
24+
25+
function equalNotEqual(bool a, bool b, bool c) public pure returns (bool) {
26+
return a == b != c;
27+
}
28+
29+
function notEqualEqual(bool a, bool b, bool c) public pure returns (bool) {
30+
return a != b == c;
31+
}
32+
33+
function notEqualNotEqual(bool a, bool b, bool c) public pure returns (bool) {
34+
return a != b != c;
35+
}
2036
}

‎tests/format/Parentheses/NotEqualParentheses.sol‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
// SPDX-License-Identifier: MIT
2+
pragma solidity 0.8.28;
3+
4+
contract NotEqualParentheses {
5+
function notEqualAdd(uint256 a, uint256 b, uint256 c)
6+
public
7+
pure
8+
returns (bool)
9+
{
10+
return a != b + c;
11+
}
12+
13+
function notEqualSub(uint256 a, uint256 b, uint256 c)
14+
public
15+
pure
16+
returns (bool)
17+
{
18+
return a != b - c;
19+
}
20+
21+
function notEqualMul(uint256 a, uint256 b, uint256 c)
22+
public
23+
pure
24+
returns (bool)
25+
{
26+
return a != b * c;
27+
}
28+
29+
function notEqualDiv(uint256 a, uint256 b, uint256 c)
30+
public
31+
pure
32+
returns (bool)
33+
{
34+
return a != b / c;
35+
}
36+
37+
function notEqualMod(uint256 a, uint256 b, uint256 c)
38+
public
39+
pure
40+
returns (bool)
41+
{
42+
return a != b % c;
43+
}
44+
45+
function notEqualExp(uint256 a, uint256 b, uint256 c)
46+
public
47+
pure
48+
returns (bool)
49+
{
50+
return a != b ** c;
51+
}
52+
53+
function notEqualShiftL(uint256 a, uint256 b, uint256 c)
54+
public
55+
pure
56+
returns (bool)
57+
{
58+
return a != b << c;
59+
}
60+
61+
function notEqualShiftR(uint256 a, uint256 b, uint256 c)
62+
public
63+
pure
64+
returns (bool)
65+
{
66+
return a != b >> c;
67+
}
68+
69+
function notEqualBitAnd(uint256 a, uint256 b, uint256 c)
70+
public
71+
pure
72+
returns (bool)
73+
{
74+
return a != b & c;
75+
}
76+
77+
function notEqualBitOr(uint256 a, uint256 b, uint256 c)
78+
public
79+
pure
80+
returns (bool)
81+
{
82+
return a != b | c;
83+
}
84+
85+
function notEqualBitXor(uint256 a, uint256 b, uint256 c)
86+
public
87+
pure
88+
returns (bool)
89+
{
90+
return a != b ^ c;
91+
}
92+
93+
function notEqualEqual(bool a, bool b, bool c)
94+
public
95+
pure
96+
returns (bool)
97+
{
98+
return a != b == c;
99+
}
100+
101+
function notEqualNotEqual(bool a, bool b, bool c)
102+
public
103+
pure
104+
returns (bool)
105+
{
106+
return a != b != c;
107+
}
108+
}

0 commit comments

Comments
 (0)