From ab33836637634269d25f08b12b2c39caceaab48d Mon Sep 17 00:00:00 2001
From: Kelly Brazil <kellyjonbrazil@gmail.com>
Date: Tue, 13 Sep 2022 14:04:15 -0700
Subject: [PATCH] add proc-iomem parser

---
 docs/parsers/proc_iomem.md |  85 ++++++++++++++++++++++++
 jc/lib.py                  |   1 +
 jc/parsers/proc_iomem.py   | 130 +++++++++++++++++++++++++++++++++++++
 man/jc.1                   |   5 ++
 4 files changed, 221 insertions(+)
 create mode 100644 docs/parsers/proc_iomem.md
 create mode 100644 jc/parsers/proc_iomem.py

diff --git a/docs/parsers/proc_iomem.md b/docs/parsers/proc_iomem.md
new file mode 100644
index 00000000..4bd0ce2f
--- /dev/null
+++ b/docs/parsers/proc_iomem.md
@@ -0,0 +1,85 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_iomem"></a>
+
+# jc.parsers.proc\_iomem
+
+jc - JSON Convert `/proc/iomem` file parser
+
+Usage (cli):
+
+    $ cat /proc/iomem | jc --proc
+
+or
+
+    $ jc /proc/iomem
+
+or
+
+    $ cat /proc/iomem | jc --proc-iomem
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_iomem_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_iomem', proc_iomem_file)
+
+Schema:
+
+    [
+      {
+        "start":                   string,
+        "end":                     string,
+        "device":                  string
+      }
+    ]
+
+Examples:
+
+    $ cat /proc/iomem | jc --proc -p
+    [
+      {
+        "start": "00000000",
+        "end": "00000fff",
+        "device": "Reserved"
+      },
+      {
+        "start": "00001000",
+        "end": "0009e7ff",
+        "device": "System RAM"
+      },
+      {
+        "start": "0009e800",
+        "end": "0009ffff",
+        "device": "Reserved"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.proc_iomem.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)
diff --git a/jc/lib.py b/jc/lib.py
index 106052cd..a693fb7c 100644
--- a/jc/lib.py
+++ b/jc/lib.py
@@ -94,6 +94,7 @@ parsers = [
     'proc-driver-rtc',
     'proc-filesystems',
     'proc-interrupts',
+    'proc-iomem',
     'proc-meminfo',
     'proc-modules',
     'ps',
diff --git a/jc/parsers/proc_iomem.py b/jc/parsers/proc_iomem.py
new file mode 100644
index 00000000..4b526d7a
--- /dev/null
+++ b/jc/parsers/proc_iomem.py
@@ -0,0 +1,130 @@
+"""jc - JSON Convert `/proc/iomem` file parser
+
+Usage (cli):
+
+    $ cat /proc/iomem | jc --proc
+
+or
+
+    $ jc /proc/iomem
+
+or
+
+    $ cat /proc/iomem | jc --proc-iomem
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_iomem_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_iomem', proc_iomem_file)
+
+Schema:
+
+    [
+      {
+        "start":                   string,
+        "end":                     string,
+        "device":                  string
+      }
+    ]
+
+Examples:
+
+    $ cat /proc/iomem | jc --proc -p
+    [
+      {
+        "start": "00000000",
+        "end": "00000fff",
+        "device": "Reserved"
+      },
+      {
+        "start": "00001000",
+        "end": "0009e7ff",
+        "device": "System RAM"
+      },
+      {
+        "start": "0009e800",
+        "end": "0009ffff",
+        "device": "Reserved"
+      },
+      ...
+    ]
+"""
+from typing import List, Dict
+import jc.utils
+
+
+class info():
+    """Provides parser metadata (version, author, etc.)"""
+    version = '1.0'
+    description = '`/proc/iomem` file parser'
+    author = 'Kelly Brazil'
+    author_email = 'kellyjonbrazil@gmail.com'
+    compatible = ['linux']
+    hidden = True
+
+
+__version__ = info.version
+
+
+def _process(proc_data: List[Dict]) -> List[Dict]:
+    """
+    Final processing to conform to the schema.
+
+    Parameters:
+
+        proc_data:   (List of Dictionaries) raw structured data to process
+
+    Returns:
+
+        List of Dictionaries. Structured to conform to the schema.
+    """
+    return proc_data
+
+
+def parse(
+    data: str,
+    raw: bool = False,
+    quiet: bool = False
+) -> List[Dict]:
+    """
+    Main text parsing function
+
+    Parameters:
+
+        data:        (string)  text data to parse
+        raw:         (boolean) unprocessed output if True
+        quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        List of Dictionaries. Raw or processed structured data.
+    """
+    jc.utils.compatibility(__name__, info.compatible, quiet)
+    jc.utils.input_type_check(data)
+
+    raw_output: List = []
+
+    if jc.utils.has_data(data):
+
+        for line in filter(None, data.splitlines()):
+
+            colon_split = line.split(':', maxsplit=1)
+            device = colon_split[1].strip()
+            mem_split = colon_split[0].split('-', maxsplit=1)
+            start = mem_split[0].strip()
+            end = mem_split[1].strip()
+
+            raw_output.append(
+                {
+                    'start': start,
+                    'end': end,
+                    'device': device
+                }
+            )
+
+    return raw_output if raw else _process(raw_output)
diff --git a/man/jc.1 b/man/jc.1
index c9df998f..db93f147 100644
--- a/man/jc.1
+++ b/man/jc.1
@@ -455,6 +455,11 @@ PLIST file parser
 \fB--proc-interrupts\fP
 `/proc/interrupts` file parser
 
+.TP
+.B
+\fB--proc-iomem\fP
+`/proc/iomem` file parser
+
 .TP
 .B
 \fB--proc-meminfo\fP