DPL Analysis: support configurables in string expressions

Author: aalkin

Framework/Core/include/Framework/Expressions.h

@@ -165,6 +165,14 @@ struct PlaceholderNode : LiteralNode {
     retrieve = [](InitContext& context, char const* name) { return LiteralNode::var_t{static_cast<AT>(context.options().get<T>(name))}; };
   }
 
+  template <typename T>
+  PlaceholderNode(T defaultValue, std::string&& path)
+    : LiteralNode{defaultValue},
+      name{path}
+  {
+    retrieve = [](InitContext& context, char const* name){ return LiteralNode::var_t{context.options().get<T>(name)}; };
+  }
+
   void reset(InitContext& context)
   {
     value = retrieve(context, name.data());
@@ -596,6 +604,13 @@ inline Node protect0(Node&& expr)
   return ifnode(nabs(Node{copy}) < o2::constants::math::Almost0, o2::constants::math::Almost0, Node{copy});
 }
 
+/// context-independent configurable
+template <typename T>
+inline Node ncfg(T defaultValue, std::string path)
+{
+  return PlaceholderNode(defaultValue, path);
+}
+
 /// A struct, containing the root of the expression tree
 struct Filter {
   Filter() = default;

Framework/Core/src/Expressions.cxx

@@ -64,6 +64,17 @@ constexpr std::array<std::string_view, BasicOp::Conditional + 1> mapping{
   "nbitwise_not",
   "ifnode"};
 
+constexpr std::array<std::string_view, 8> cfgtypes{
+  "uint16_t",   // 0
+  "int16_t",    // 1
+  "uint32_t",   // 2
+  "int32_t",    // 3
+  "uint64_t",   // 4
+  "int64_t",    // 5
+  "float",      // 6
+  "double"      // 7
+};
+
 /// math constants to recognize in string expressions
 constexpr std::array<std::string_view, 9> mathConstants{
   "Almost0",
@@ -813,7 +824,8 @@ Tokenizer::Tokenizer(std::string const& input)
 {
   LastChar = ' ';
   if (!source.empty()) {
-    source.erase(std::remove_if(source.begin(), source.end(), ::isspace), source.end());
+    source.erase(std::remove_if(source.begin(), source.end(), ::isspace), source.end()); // strip whitespaces
+    source.erase(std::remove(source.begin(), source.end(), '\"'), source.end()); // strip quotes
   }
   current = source.begin();
 }
@@ -827,7 +839,8 @@ void Tokenizer::reset(std::string const& input)
   FloatValue = 0.f;
   source = input;
   if (!source.empty()) {
-    source.erase(std::remove_if(source.begin(), source.end(), ::isspace), source.end());
+    source.erase(std::remove_if(source.begin(), source.end(), ::isspace), source.end()); // strip whitespaces
+    source.erase(std::remove(source.begin(), source.end(), '\"'), source.end()); // strip quotes
   }
   current = source.begin();
   currentToken = Token::Unexpected;
@@ -1202,6 +1215,78 @@ std::unique_ptr<Node> Parser::parseBase(Tokenizer& tk)
       }
       tk.nextToken();
       return node;
+    } else if (id == "ncfg") { // configurable placeholder, 3 args none of them can be expressions
+      int args = 0;
+      std::string type;
+      std::string value;
+      std::string path;
+      while (tk.currentToken != ')') {
+        do {
+          tk.nextToken();
+          if (args == 0) { // type
+            type = tk.TokenStr;
+            tk.nextToken();
+          } else if (args == 1) { // value
+            value = tk.TokenStr;
+            tk.nextToken();
+          } else if (args == 2) { // path
+            path = tk.TokenStr;
+            tk.nextToken();
+          } else {
+            throw runtime_error_f("Extra argument in configurable: %s", tk.TokenStr.c_str());
+          }
+          ++args;
+        } while (tk.currentToken == ',');
+      }
+      tk.nextToken();
+      auto locate = std::find(cfgtypes.begin(), cfgtypes.end(), type);
+      if (locate == cfgtypes.end()) {
+        throw runtime_error_f("Unsupported type in configurable: %s", type.c_str());
+      }
+      switch (std::distance(cfgtypes.begin(), locate)) {
+        case 0:
+          return std::make_unique<Node>(
+            PlaceholderNode(
+              static_cast<uint16_t>(std::stoi(value)),
+              std::move(path)));
+        case 1:
+          return std::make_unique<Node>(
+            PlaceholderNode(
+              static_cast<int16_t>(std::stoi(value)),
+              std::move(path)));
+        case 2:
+          return std::make_unique<Node>(
+            PlaceholderNode(
+              static_cast<uint32_t>(std::stoi(value)),
+              std::move(path)));
+        case 3:
+          return std::make_unique<Node>(
+            PlaceholderNode(
+              static_cast<int32_t>(std::stoi(value)),
+              std::move(path)));
+        case 4:
+          return std::make_unique<Node>(
+            PlaceholderNode(
+              static_cast<uint64_t>(std::stoll(value)),
+              std::move(path)));
+        case 5:
+          return std::make_unique<Node>(
+            PlaceholderNode(
+              static_cast<int64_t>(std::stol(value)),
+              std::move(path)));
+        case 6:
+          return std::make_unique<Node>(
+            PlaceholderNode(
+              std::stof(value),
+              std::move(path)));
+        case 7:
+          return std::make_unique<Node>(
+            PlaceholderNode(
+              std::stod(value),
+              std::move(path)));
+        default:
+          throw runtime_error_f("Unsupported type in configurable: %s", type.c_str());
+      }
     } else { // normal function
       auto node = std::make_unique<Node>(opFromToken(id), LiteralNode{-1}, LiteralNode{-1});
       int args = 0;

Framework/Core/test/test_Expressions.cxx

@@ -375,4 +375,19 @@ TEST_CASE("TestStringExpressionsParsing")
   auto treef2 = createExpressionTree(tf2, schema);
 
   REQUIRE(treef1->ToString() == treef2->ToString());
+
+  Configurable<float> pTCut{"pTCut", 0.5f, "Lower pT limit"};
+  Filter pcfg1 = o2::aod::track::pt > pTCut;
+  Filter pcfg2 = Parser::parse("o2::aod::track::pt > ncfg(float, 0.5, \"pTCut\")");
+  auto pcfg1specs = createOperations(pcfg1);
+  auto pcfg2specs = createOperations(pcfg2);
+
+  REQUIRE(pcfg2.node->right->self.index() == 3);
+  REQUIRE(pcfg2specs[0].right == (DatumSpec{LiteralNode::var_t{0.5f}, atype::FLOAT}));
+
+  schema = std::make_shared<arrow::Schema>(std::vector{o2::aod::track::Pt::asArrowField()});
+  auto tree1c = createExpressionTree(pcfg1specs, schema);
+  auto tree2c = createExpressionTree(pcfg2specs, schema);
+
+  REQUIRE(tree1c->ToString() == tree2c->ToString());
 }

Framework/TestWorkflows/src/o2TestHistograms.cxx

@@ -45,7 +45,7 @@ struct EtaAndClsHistogramsSimple {
   void init(InitContext&)
   {
     if (!trackFilterString->empty()) {
-      trackFilter = trackFilterString;
+      trackFilter = Parser::parse((std::string)trackFilterString);
     }
   }
 
@@ -68,7 +68,7 @@ struct EtaAndClsHistogramsIUSimple {
   void init(InitContext&)
   {
     if (!trackFilterString->empty()) {
-      trackFilter = trackFilterString;
+      trackFilter = Parser::parse((std::string)trackFilterString);
     }
   }
 
@@ -90,7 +90,7 @@ struct EtaAndClsHistogramsFull {
   void init(InitContext&)
   {
     if (!trackFilterString->empty()) {
-      trackFilter = trackFilterString;
+      trackFilter = Parser::parse((std::string)trackFilterString);
     }
   }