-
Notifications
You must be signed in to change notification settings - Fork 8
/
JBBitmap.sol
76 lines (67 loc) · 2.02 KB
/
JBBitmap.sol
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
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.16;
import '../structs/JBBitmapWord.sol';
/**
@notice
Utilities to manage bool bitmap storing the inactive tiers.
*/
library JBBitmap {
/**
@notice
Initialize a BitmapWord struct, based on the mapping storage pointer and a given index.
*/
function readId(mapping(uint256 => uint256) storage self, uint256 _index)
internal
view
returns (JBBitmapWord memory)
{
uint256 _depth = _retrieveDepth(_index);
return JBBitmapWord({currentWord: self[_depth], currentDepth: _depth});
}
/**
@notice
Returns the status of a given bit, in the single word stored in a BitmapWord struct.
*/
function isTierIdRemoved(JBBitmapWord memory self, uint256 _index) internal pure returns (bool) {
return (self.currentWord >> (_index % 256)) & 1 == 1;
}
/**
@notice
Returns the status of a bit in a given bitmap (index is the index in the reshaped bitmap matrix 1*n).
*/
function isTierIdRemoved(mapping(uint256 => uint256) storage self, uint256 _index)
internal
view
returns (bool)
{
uint256 _depth = _retrieveDepth(_index);
return isTierIdRemoved(JBBitmapWord({currentWord: self[_depth], currentDepth: _depth}), _index);
}
/**
@notice
Flip the bit at a given index to true (this is a one-way operation).
*/
function removeTier(mapping(uint256 => uint256) storage self, uint256 _index) internal {
uint256 _depth = _retrieveDepth(_index);
self[_depth] |= uint256(1 << (_index % 256));
}
/**
@notice
Return true if the index is in an another word than the one stored in the BitmapWord struct.
*/
function refreshBitmapNeeded(JBBitmapWord memory self, uint256 _index)
internal
pure
returns (bool)
{
return _retrieveDepth(_index) != self.currentDepth;
}
// Lib internal
/**
@notice
Return the lines of the bitmap matrix where an index lies.
*/
function _retrieveDepth(uint256 _index) internal pure returns (uint256) {
return _index >> 8; // div by 256
}
}