podio-dump: Make -e -1 dump all of the entries (#906)

* podio-dump: Make -e -1 dump all of the entries

Many of our other tools support passing -1 as a value to the number of
events signifying to simply do all of them.

* Add simple test for new option

Author: tmadlener

tests/CTestCustom.cmake

@@ -158,6 +158,7 @@ if ((NOT "@FORCE_RUN_ALL_TESTS@" STREQUAL "ON") AND (NOT "@USE_SANITIZER@" STREQ
 
       podio-dump-root
       podio-dump-detailed-root
+      podio-dump-all-events
 
       write_interface_root
       read_interface_root

tools/CMakeLists.txt

@@ -88,6 +88,7 @@ if(BUILD_TESTING)
   CREATE_DUMP_TEST(podio-dump-help _dummy_target_ --help)
   CREATE_DUMP_TEST(podio-dump-root "podio_write_root_fixture" ${PROJECT_BINARY_DIR}/tests/root_io/example_frame.root)
   CREATE_DUMP_TEST(podio-dump-detailed-root "podio_write_root_fixture" --detailed --category other_events --entries 2:3 ${PROJECT_BINARY_DIR}/tests/root_io/example_frame.root)
+  CREATE_DUMP_TEST(podio-dump-all-events "podio_write_root_fixture" ${PROJECT_BINARY_DIR}/tests/root_io/example_frame.root --entries -1)
 
   CREATE_LEGACY_DUMP_TEST("root" v00-16-06 v00-16-06-example.root)
   CREATE_LEGACY_DUMP_TEST("root-detailed" v00-16-06 v00-16-06-example.root --detailed --entries 2:3)

tools/src/podio-dump-tool.cpp

@@ -43,7 +43,7 @@ positional arguments:
   -c CATEGORY, --category CATEGORY
                         Which Frame category to dump
   -e ENTRIES, --entries ENTRIES
-                        Which entries to print. A single number, comma-separated list of numbers or "first:last" for an inclusive range of entries. Defaults to the first entry.
+                        Which entries to print. A single number, comma-separated list of numbers or "first:last" for an inclusive range of entries. Defaults to the first entry. Use -1 to print all available entries.
   -d, --detailed        Dump the full contents, not just the collection info
   -s, --size-stats      Show size statistics per collection for the whole file (if available for the file format)
   --dump-edm DUMP_EDM   Dump the specified EDM definition from the file in yaml format
@@ -70,6 +70,12 @@ std::vector<size_t> parseEventRange(const std::string_view evtRange) {
     std::exit(1);
   };
 
+  // We handle this later and for now just emplace a tombstone value that is
+  // easy to recognize
+  if (evtRange == "-1") {
+    return {static_cast<size_t>(-1)};
+  }
+
   // Split by ',' to see if we have to handle multiple events
   auto splitRange = podio::utils::splitString(evtRange, ',');
 
@@ -102,6 +108,16 @@ std::vector<size_t> parseEventRange(const std::string_view evtRange) {
   return {};
 }
 
+std::vector<size_t> fullEntryList(const ParsedArgs& args, const podio::Reader& reader) {
+  if (args.events.size() == 1 && args.events[0] == static_cast<std::size_t>(-1)) {
+    const auto nEntries = reader.getEntries(args.category);
+    std::vector<size_t> allEntries(nEntries);
+    std::iota(allEntries.begin(), allEntries.end(), 0);
+    return allEntries;
+  }
+  return args.events;
+}
+
 ParsedArgs parseArgs(std::vector<std::string> argv) {
   // find help or version
   if (const auto it = findFlags(argv, "-h", "--help", "--version"); it != argv.end()) {
@@ -276,7 +292,7 @@ int main(int argc, char* argv[]) {
     stats = reader.getSizeStats(args.category);
   }
 
-  for (const auto event : args.events) {
+  for (const auto event : fullEntryList(args, reader)) {
     try {
       const auto& frame = reader.readFrame(args.category, event);
       printFrame(frame, args.category, event, args.detailed, stats);