Fix #3587. IfcCSV now supports custom formatting functions.

src/ifcopenshell-python/ifcopenshell/util/selector.py

@@ -20,6 +20,7 @@ import re
 import lark
 import ifcopenshell.util
 import ifcopenshell.util.fm
+import ifcopenshell.util.unit
 import ifcopenshell.util.element
 import ifcopenshell.util.classification
 
@@ -112,6 +113,106 @@ get_element_grammar = lark.Lark(
  """
 )
 
+format_grammar = lark.Lark(
+    """start: function
+
+    function: round | format_length | lower | upper | title | concat | ESCAPED_STRING | NUMBER
+
+    round: "round(" function "," NUMBER ")"
+    format_length: metric_length | imperial_length
+    metric_length: "metric_length(" function "," NUMBER "," NUMBER ")"
+    imperial_length: "imperial_length(" function "," NUMBER ["," ESCAPED_STRING] ")"
+    lower: "lower(" function ")"
+    upper: "upper(" function ")"
+    title: "title(" function ")"
+    concat: "concat(" function ("," function)* ")"
+
+    // Embed common.lark for packaging
+    DIGIT: "0".."9"
+    HEXDIGIT: "a".."f"|"A".."F"|DIGIT
+    INT: DIGIT+
+    SIGNED_INT: ["+"|"-"] INT
+    DECIMAL: INT "." INT? | "." INT
+    _EXP: ("e"|"E") SIGNED_INT
+    FLOAT: INT _EXP | DECIMAL _EXP?
+    SIGNED_FLOAT: ["+"|"-"] FLOAT
+    NUMBER: FLOAT | INT
+    SIGNED_NUMBER: ["+"|"-"] NUMBER
+    _STRING_INNER: /.*?/
+    _STRING_ESC_INNER: _STRING_INNER /(?<!\\\\)(\\\\\\\\)*?/
+    ESCAPED_STRING : "\\"" _STRING_ESC_INNER "\\""
+    LCASE_LETTER: "a".."z"
+    UCASE_LETTER: "A".."Z"
+    LETTER: UCASE_LETTER | LCASE_LETTER
+    WORD: LETTER+
+    CNAME: ("_"|LETTER) ("_"|LETTER|DIGIT)*
+    WS_INLINE: (" "|/\\t/)+
+    WS: /[ \\t\\f\\r\\n]/+
+    CR : /\\r/
+    LF : /\\n/
+    NEWLINE: (CR? LF)+
+
+    %ignore WS // Disregard spaces in text
+"""
+)
+
+
+class FormatTransformer(lark.Transformer):
+    def start(self, args):
+        return args[0]
+
+    def function(self, args):
+        return args[0]
+
+    def ESCAPED_STRING(self, args):
+        return args[1:-1].replace("\\", "")
+
+    def NUMBER(self, args):
+        return str(args)
+
+    def lower(self, args):
+        return str(args[0]).lower()
+
+    def upper(self, args):
+        return str(args[0]).upper()
+
+    def title(self, args):
+        return str(args[0]).title()
+
+    def concat(self, args):
+        return "".join(args)
+
+    def round(self, args):
+        return str(round(float(args[0]) / float(args[1])) * float(args[1]))
+
+    def format_length(self, args):
+        return args[0]
+
+    def metric_length(self, args):
+        value, precision, decimal_places = args
+        return ifcopenshell.util.unit.format_length(
+            float(value), float(precision), int(decimal_places), unit_system="metric"
+        )
+
+    def imperial_length(self, args):
+        if len(args) == 2:
+            imperial_unit = "foot"
+            value, precision = args
+        else:
+            value, precision, imperial_unit = args
+            if imperial_unit == "inch":
+                imperial_unit = "inch"
+            else:
+                imperial_unit = "foot"
+
+        return ifcopenshell.util.unit.format_length(
+            float(value), int(precision), unit_system="imperial", imperial_unit=imperial_unit
+        )
+
+
+def format(query):
+    return FormatTransformer().transform(format_grammar.parse(query))
+
 
 def get_element_value(element, query):
     start = get_element_grammar.parse(query)

src/ifcopenshell-python/ifcopenshell/util/unit.py

@@ -17,6 +17,7 @@
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
 
 from math import pi
+from fractions import Fraction
 
 prefixes = {
     "EXA": 1e18,

src/ifcopenshell-python/test/util/test_selector.py

@@ -22,6 +22,32 @@ import ifcopenshell.api
 import ifcopenshell.util.selector as subject
 
 
+class TestFormat():
+    def test_no_formatting(self):
+        assert subject.format("123") == "123"
+        assert subject.format('\"123\"') == "123"
+        assert subject.format('\"foo\"') == "foo"
+
+    def test_string_formatting(self):
+        assert subject.format('upper(\"fOo\")') == "FOO"
+        assert subject.format('lower(\"fOo\")') == "foo"
+        assert subject.format('title(\"fOo\")') == "Foo"
+        assert subject.format('concat(\"fOo\", \"bar\")') == "fOobar"
+        assert subject.format('upper(concat(\"fOo\", \"bar\"))') == "FOOBAR"
+
+    def test_number_formatting(self):
+        assert subject.format("round(123, 5)") == "125.0"
+        assert subject.format('round(\"123\", 5)') == "125.0"
+        assert subject.format('metric_length(123, 5, 2)') == "125.00"
+        assert subject.format('metric_length(123.123, 0.1, 2)') == "123.10"
+        assert subject.format('metric_length(\"123\", 5, 2)') == "125.00"
+        assert subject.format('imperial_length(1, 1)') == "1'"
+        assert subject.format('imperial_length(3.123, 1)') == "3' - 1\""
+        assert subject.format('imperial_length(3.123, 2)') == "3' - 1 1/2\""
+        assert subject.format('imperial_length(\"3.123\", 2)') == "3' - 1 1/2\""
+        assert subject.format('imperial_length(\"123.123\", 2, \"inch\")') == "10' - 3\""
+
+
 class TestGetElementValue(test.bootstrap.IFC4):
     def test_selecting_an_elements_class_or_id_using_a_query(self):
         element = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcWall")