Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
K
kotlin-bitflags
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Janne Mareike Koschinski
kotlin-bitflags
Commits
8614d0f2
Verified
Commit
8614d0f2
authored
4 years ago
by
Janne Mareike Koschinski
Browse files
Options
Downloads
Patches
Plain Diff
Reorganize code and add readme
parent
ace3dba0
No related branches found
No related tags found
No related merge requests found
Pipeline
#594
passed
4 years ago
Stage: build
Stage: test
Changes
3
Pipelines
1
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
README.md
+50
-0
50 additions, 0 deletions
README.md
src/main/kotlin/de/justjanne/bitflags/of.kt
+77
-0
77 additions, 0 deletions
src/main/kotlin/de/justjanne/bitflags/of.kt
src/main/kotlin/de/justjanne/bitflags/toFlag.kt
+0
-90
0 additions, 90 deletions
src/main/kotlin/de/justjanne/bitflags/toFlag.kt
with
127 additions
and
90 deletions
README.md
0 → 100644
+
50
−
0
View file @
8614d0f2
# Kotlin Bitflags
Kotlin-Bitflags is a utility library to simplify implementing bitflags in Kotlin. It integrates with Kotlin unsigned
types and Java Enumsets. This especially useful when interacting with binary protocols from Kotlin.
## Using Kotlin-Bitflags
After adding this module to your dependencies, you'll have to implement the related interfaces in your classes:
```
kotlin
enum
class
MessageFlag
(
override
val
value
:
UInt
,
)
:
Flag
<
UInt
>
{
Self
(
0x01u
),
Highlight
(
0x02u
),
Redirected
(
0x04u
),
ServerMsg
(
0x08u
),
Backlog
(
0x80u
);
companion
object
:
Flags
<
UInt
,
MessageFlag
>
{
override
val
all
:
Set
<
MessageFlag
>
=
values
().
toEnumSet
()
}
}
```
This allows you to then use this elsewhere to e.g initialize a field from discrete values
```
kotlin
// Construct from varargs or an array
val
field
=
MessageFlag
.
of
(
MessageFlag
.
Self
,
MessageFlag
.
Highlight
)
val
values
=
listOf
(
MessageFlag
.
Self
,
MessageFlag
.
Highlight
)
// Or from a collection
val
field
=
MessageFlag
.
of
(
values
)
// Or use the to helper
val
field
=
values
.
toEnumSet
()
```
You can also convert such a field into the raw binary value easily
```
kotlin
// Returns in this case UInt
field
.
toBits
()
```
Additional utility functions are available:
```
kotlin
// Empty field
MessageFlag
.
none
()
// Get all non-null values
MessageFlag
.
validValues
()
```
This diff is collapsed.
Click to expand it.
src/main/kotlin/de/justjanne/bitflags/of.kt
+
77
−
0
View file @
8614d0f2
...
...
@@ -11,6 +11,7 @@
package
de.justjanne.bitflags
import
java.util.EnumSet
import
kotlin.experimental.and
/**
* Construct a bitfield out of discrete flags
...
...
@@ -25,3 +26,79 @@ inline fun <reified T> Flags<*, T>.of(vararg values: T): EnumSet<T>
*/
inline
fun
<
reified
T
>
Flags
<*,
T
>.
of
(
values
:
Collection
<
T
>):
EnumSet
<
T
>
where
T
:
Flag
<
*
>,
T
:
Enum
<
T
>
=
values
.
toEnumSet
()
/**
* Construct a bitfield out of a binary value
* @return bitfield
*/
inline
fun
<
reified
T
>
Flags
<
Byte
,
T
>.
of
(
value
:
Byte
?):
EnumSet
<
T
>
where
T
:
Flag
<
Byte
>,
T
:
Enum
<
T
>
{
if
(
value
==
null
)
return
emptyList
<
T
>().
toEnumSet
()
return
all
.
filter
{
(
value
and
it
.
value
)
!=
0
.
toByte
()
}.
toEnumSet
()
}
/**
* Construct a bitfield out of a binary value
* @return bitfield
*/
@ExperimentalUnsignedTypes
inline
fun
<
reified
T
>
Flags
<
UByte
,
T
>.
of
(
value
:
UByte
?):
EnumSet
<
T
>
where
T
:
Flag
<
UByte
>,
T
:
Enum
<
T
>
{
if
(
value
==
null
)
return
emptyList
<
T
>().
toEnumSet
()
return
all
.
filter
{
(
value
and
it
.
value
)
!=
0
.
toUByte
()
}.
toEnumSet
()
}
/**
* Construct a bitfield out of a binary value
* @return bitfield
*/
inline
fun
<
reified
T
>
Flags
<
Short
,
T
>.
of
(
value
:
Short
?):
EnumSet
<
T
>
where
T
:
Flag
<
Short
>,
T
:
Enum
<
T
>
{
if
(
value
==
null
)
return
emptyList
<
T
>().
toEnumSet
()
return
all
.
filter
{
(
value
and
it
.
value
)
!=
0
.
toShort
()
}.
toEnumSet
()
}
/**
* Construct a bitfield out of a binary value
* @return bitfield
*/
@ExperimentalUnsignedTypes
inline
fun
<
reified
T
>
Flags
<
UShort
,
T
>.
of
(
value
:
UShort
?):
EnumSet
<
T
>
where
T
:
Flag
<
UShort
>,
T
:
Enum
<
T
>
{
if
(
value
==
null
)
return
emptyList
<
T
>().
toEnumSet
()
return
all
.
filter
{
(
value
and
it
.
value
)
!=
0
.
toUShort
()
}.
toEnumSet
()
}
/**
* Construct a bitfield out of a binary value
* @return bitfield
*/
inline
fun
<
reified
T
>
Flags
<
Int
,
T
>.
of
(
value
:
Int
?):
EnumSet
<
T
>
where
T
:
Flag
<
Int
>,
T
:
Enum
<
T
>
{
if
(
value
==
null
)
return
emptyList
<
T
>().
toEnumSet
()
return
all
.
filter
{
(
value
and
it
.
value
)
!=
0
}.
toEnumSet
()
}
/**
* Construct a bitfield out of a binary value
* @return bitfield
*/
@ExperimentalUnsignedTypes
inline
fun
<
reified
T
>
Flags
<
UInt
,
T
>.
of
(
value
:
UInt
?):
EnumSet
<
T
>
where
T
:
Flag
<
UInt
>,
T
:
Enum
<
T
>
{
if
(
value
==
null
)
return
emptyList
<
T
>().
toEnumSet
()
return
all
.
filter
{
(
value
and
it
.
value
)
!=
0u
}.
toEnumSet
()
}
/**
* Construct a bitfield out of a binary value
* @return bitfield
*/
inline
fun
<
reified
T
>
Flags
<
Long
,
T
>.
of
(
value
:
Long
?):
EnumSet
<
T
>
where
T
:
Flag
<
Long
>,
T
:
Enum
<
T
>
{
if
(
value
==
null
)
return
emptyList
<
T
>().
toEnumSet
()
return
all
.
filter
{
(
value
and
it
.
value
)
!=
0L
}.
toEnumSet
()
}
/**
* Construct a bitfield out of a binary value
* @return bitfield
*/
@ExperimentalUnsignedTypes
inline
fun
<
reified
T
>
Flags
<
ULong
,
T
>.
of
(
value
:
ULong
?):
EnumSet
<
T
>
where
T
:
Flag
<
ULong
>,
T
:
Enum
<
T
>
{
if
(
value
==
null
)
return
emptyList
<
T
>().
toEnumSet
()
return
all
.
filter
{
(
value
and
it
.
value
)
!=
0uL
}.
toEnumSet
()
}
This diff is collapsed.
Click to expand it.
src/main/kotlin/de/justjanne/bitflags/toFlag.kt
deleted
100644 → 0
+
0
−
90
View file @
ace3dba0
/*
* Kotlin Bitflags
*
* Copyright (c) 2021 Janne Mareike Koschinski
*
* This Source Code Form is subject to the terms of the Mozilla Public License,
* v. 2.0. If a copy of the MPL was not distributed with this file, You can
* obtain one at https://mozilla.org/MPL/2.0/.
*/
package
de.justjanne.bitflags
import
java.util.EnumSet
import
kotlin.experimental.and
/**
* Construct a bitfield out of a binary value
* @return bitfield
*/
inline
fun
<
reified
T
>
Flags
<
Byte
,
T
>.
of
(
value
:
Byte
?):
EnumSet
<
T
>
where
T
:
Flag
<
Byte
>,
T
:
Enum
<
T
>
{
if
(
value
==
null
)
return
emptyList
<
T
>().
toEnumSet
()
return
all
.
filter
{
(
value
and
it
.
value
)
!=
0
.
toByte
()
}.
toEnumSet
()
}
/**
* Construct a bitfield out of a binary value
* @return bitfield
*/
@ExperimentalUnsignedTypes
inline
fun
<
reified
T
>
Flags
<
UByte
,
T
>.
of
(
value
:
UByte
?):
EnumSet
<
T
>
where
T
:
Flag
<
UByte
>,
T
:
Enum
<
T
>
{
if
(
value
==
null
)
return
emptyList
<
T
>().
toEnumSet
()
return
all
.
filter
{
(
value
and
it
.
value
)
!=
0
.
toUByte
()
}.
toEnumSet
()
}
/**
* Construct a bitfield out of a binary value
* @return bitfield
*/
inline
fun
<
reified
T
>
Flags
<
Short
,
T
>.
of
(
value
:
Short
?):
EnumSet
<
T
>
where
T
:
Flag
<
Short
>,
T
:
Enum
<
T
>
{
if
(
value
==
null
)
return
emptyList
<
T
>().
toEnumSet
()
return
all
.
filter
{
(
value
and
it
.
value
)
!=
0
.
toShort
()
}.
toEnumSet
()
}
/**
* Construct a bitfield out of a binary value
* @return bitfield
*/
@ExperimentalUnsignedTypes
inline
fun
<
reified
T
>
Flags
<
UShort
,
T
>.
of
(
value
:
UShort
?):
EnumSet
<
T
>
where
T
:
Flag
<
UShort
>,
T
:
Enum
<
T
>
{
if
(
value
==
null
)
return
emptyList
<
T
>().
toEnumSet
()
return
all
.
filter
{
(
value
and
it
.
value
)
!=
0
.
toUShort
()
}.
toEnumSet
()
}
/**
* Construct a bitfield out of a binary value
* @return bitfield
*/
inline
fun
<
reified
T
>
Flags
<
Int
,
T
>.
of
(
value
:
Int
?):
EnumSet
<
T
>
where
T
:
Flag
<
Int
>,
T
:
Enum
<
T
>
{
if
(
value
==
null
)
return
emptyList
<
T
>().
toEnumSet
()
return
all
.
filter
{
(
value
and
it
.
value
)
!=
0
}.
toEnumSet
()
}
/**
* Construct a bitfield out of a binary value
* @return bitfield
*/
@ExperimentalUnsignedTypes
inline
fun
<
reified
T
>
Flags
<
UInt
,
T
>.
of
(
value
:
UInt
?):
EnumSet
<
T
>
where
T
:
Flag
<
UInt
>,
T
:
Enum
<
T
>
{
if
(
value
==
null
)
return
emptyList
<
T
>().
toEnumSet
()
return
all
.
filter
{
(
value
and
it
.
value
)
!=
0u
}.
toEnumSet
()
}
/**
* Construct a bitfield out of a binary value
* @return bitfield
*/
inline
fun
<
reified
T
>
Flags
<
Long
,
T
>.
of
(
value
:
Long
?):
EnumSet
<
T
>
where
T
:
Flag
<
Long
>,
T
:
Enum
<
T
>
{
if
(
value
==
null
)
return
emptyList
<
T
>().
toEnumSet
()
return
all
.
filter
{
(
value
and
it
.
value
)
!=
0L
}.
toEnumSet
()
}
/**
* Construct a bitfield out of a binary value
* @return bitfield
*/
@ExperimentalUnsignedTypes
inline
fun
<
reified
T
>
Flags
<
ULong
,
T
>.
of
(
value
:
ULong
?):
EnumSet
<
T
>
where
T
:
Flag
<
ULong
>,
T
:
Enum
<
T
>
{
if
(
value
==
null
)
return
emptyList
<
T
>().
toEnumSet
()
return
all
.
filter
{
(
value
and
it
.
value
)
!=
0uL
}.
toEnumSet
()
}
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment