srdhelper: Add SrdStrEnum with various helper methods.

[libsigrokdecode.git] / decoders / common / srdhelper / mod.py

diff --git a/decoders/common/srdhelper/mod.py b/decoders/common/srdhelper/mod.py
index e65ab17e5ae590ae6854f6edddd7b4acd1dfc143..6c45af98b7ae9232b8d115caafa6478801436d20 100644 (file)
--- a/decoders/common/srdhelper/mod.py
+++ b/decoders/common/srdhelper/mod.py
@@ -1,7 +1,7 @@
 ##
 ## This file is part of the libsigrokdecode project.
 ##
-## Copyright (C) 2012-2014 Uwe Hermann <uwe@hermann-uwe.de>
+## Copyright (C) 2012-2020 Uwe Hermann <uwe@hermann-uwe.de>
 ##
 ## This program is free software; you can redistribute it and/or modify
 ## it under the terms of the GNU General Public License as published by
@@ -14,10 +14,71 @@
 ## GNU General Public License for more details.
 ##
 ## You should have received a copy of the GNU General Public License
-## along with this program; if not, write to the Free Software
-## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+## along with this program; if not, see <http://www.gnu.org/licenses/>.
 ##
 
+from enum import Enum, IntEnum, unique
+from itertools import chain
+import re
+
 # Return the specified BCD number (max. 8 bits) as integer.
 def bcd2int(b):
     return (b & 0x0f) + ((b >> 4) * 10)
+
+def bin2int(s: str):
+    return int('0b' + s, 2)
+
+def bitpack(bits):
+    return sum([b << i for i, b in enumerate(bits)])
+
+def bitunpack(num, minbits=0):
+    res = []
+    while num or minbits > 0:
+        res.append(num & 1)
+        num >>= 1
+        minbits -= 1
+    return tuple(res)
+
+@unique
+class SrdStrEnum(Enum):
+    @classmethod
+    def from_list(cls, name, l):
+        # Keys are limited/converted to [A-Z0-9_], values can be any string.
+        items = [(re.sub('[^A-Z0-9_]', '_', l[i]), l[i]) for i in range(len(l))]
+        return cls(name, items)
+
+    @classmethod
+    def from_str(cls, name, s):
+        return cls.from_list(name, s.split())
+
+@unique
+class SrdIntEnum(IntEnum):
+    @classmethod
+    def _prefix(cls, p):
+        return tuple([a.value for a in cls if a.name.startswith(p)])
+
+    @classmethod
+    def prefixes(cls, prefix_list):
+        if isinstance(prefix_list, str):
+            prefix_list = prefix_list.split()
+        return tuple(chain(*[cls._prefix(p) for p in prefix_list]))
+
+    @classmethod
+    def _suffix(cls, s):
+        return tuple([a.value for a in cls if a.name.endswith(s)])
+
+    @classmethod
+    def suffixes(cls, suffix_list):
+        if isinstance(suffix_list, str):
+            suffix_list = suffix_list.split()
+        return tuple(chain(*[cls._suffix(s) for s in suffix_list]))
+
+    @classmethod
+    def from_list(cls, name, l):
+        # Manually construct (Python 3.4 is missing the 'start' argument).
+        # Python defaults to start=1, but we want start=0.
+        return cls(name, [(l[i], i) for i in range(len(l))])
+
+    @classmethod
+    def from_str(cls, name, s):
+        return cls.from_list(name, s.split())