file_info_dumper.cc File Reference

#include "art/Framework/IO/Root/GetFileFormatEra.h"
#include "art/Framework/IO/Root/RootDB/SQLite3Wrapper.h"
#include "art/Framework/IO/Root/RootDB/tkeyvfs.h"
#include "art/Framework/IO/Root/detail/InfoDumperInputFile.h"
#include "boost/program_options.hpp"
#include "canvas/Persistency/Provenance/FileFormatVersion.h"
#include "canvas/Persistency/Provenance/rootNames.h"
#include "cetlib/HorizontalRule.h"
#include "cetlib/container_algorithms.h"
#include "TError.h"
#include "TFile.h"
#include "sqlite3.h"
#include <algorithm>
#include <bitset>
#include <iostream>
#include <ostream>
#include <sstream>
#include <string>

Go to the source code of this file.

Typedefs
using	stringvec = vector< string >

Functions
int	print_process_history (InfoDumperInputFile const &file, ostream &output)
int	print_range_sets (InfoDumperInputFile const &file, ostream &output, bool compact)
int	print_event_list (InfoDumperInputFile const &file, ostream &output)
int	print_file_index (InfoDumperInputFile const &file, ostream &output)
int	print_branchIDLists (InfoDumperInputFile const &file, ostream &output)
int	db_to_file (InfoDumperInputFile const &file, ostream &output, ostream &errors)
int	main (int argc, char *argv[])

Typedef Documentation

using stringvec = vector<string>

Definition at line 32 of file file_info_dumper.cc.

Function Documentation

int db_to_file	(	InfoDumperInputFile const &	file,
		ostream &	output,
		ostream &	errors
	)

Definition at line 324 of file file_info_dumper.cc.

{
  TFile* current_file = file.tfile();
  std::string const& rootFileName = current_file->GetName();

  // db file name has the same base as the input art/ROOT file
  std::string::size_type const dist{rootFileName.find(".root") -
                                    rootFileName.find_last_of('/')};
  std::string const base{
    rootFileName.substr(rootFileName.find_last_of('/') + 1, dist)};
  std::string const extFileName{base + "db"};

  art::SQLite3Wrapper db{current_file, "RootFileDB"};
  int const rc{dbToFile(db, extFileName.c_str())};
  if (rc == 0) {
    output << "\nRootFileDB from file \"" << current_file->GetName() << "\"\n"
           << "saved to external database file \"" << extFileName << "\".\n";
  } else {
    errors << "\nCould not save RootFileDB from file \""
           << current_file->GetName() << "\"\n"
           << "to external database file.\n";
  }
  return rc;
}

int main	(	int	argc,
		char *	argv[]
	)

Definition at line 127 of file file_info_dumper.cc.

                                 {
  // ------------------
  // use the boost command line option processing library to help out
  // with command line options
  std::ostringstream descstr;
  descstr << argv[0] << " <options> [<source-file>]+";

  bpo::options_description desc{descstr.str()};
  desc.add_options()("help,h", "produce help message")(
    "full-path", "print full path of file name")(
    "event-list", "print event-list for each input file")(
    "file-index", "prints FileIndex object for each input file")(
    "process-history",
    "prints list of processes that produced this file (output given in "
    "chronological order)")(
    "range-of-validity",
    bpo::value<string>()->implicit_value("full"),
    "prints range of validity for each input file.  Allowed values are\n"
    "  \"full\" (default)\n"
    "  \"compact\"")("branch-ids,B",
                     "prints BranchID lists stored in the file")(
    "db-to-file",
    ("Writes RootFileDB to external SQLite database with the same base name as the input file and the suffix '.db'.\n"s +
     "(Writes to directory in which '"s + argv[0] + "' is executed)."s)
      .c_str())(
    "source,s", bpo::value<stringvec>(), "source data file (multiple OK)");

  bpo::options_description all_opts{"All Options"};
  all_opts.add(desc);

  // Each non-option argument is interpreted as the name of a files to
  // be processed. Any number of filenames is allowed.
  bpo::positional_options_description pd;
  pd.add("source", -1);
  // The variables_map contains the actual program options.
  bpo::variables_map vm;
  try {
    bpo::store(bpo::command_line_parser(argc, argv)
                 .options(all_opts)
                 .positional(pd)
                 .run(),
               vm);
    bpo::notify(vm);
  }
  catch (bpo::error const& e) {
    std::cerr << "Exception from command line processing in " << argv[0] << ": "
              << e.what() << "\n";
    return 2;
  }

  if (vm.count("help")) {
    std::cout << desc << std::endl;
    return 1;
  }

  // Get the names of the files we will process.
  stringvec file_names;
  size_t const file_count{vm.count("source")};
  if (file_count < 1) {
    std::cerr << "One or more input files must be specified;"
              << " supply filenames as program arguments\n"
              << "For usage and options list, please do '" << argv[0]
              << " --help'.\n";
    return 3;
  }
  file_names.reserve(file_count);
  cet::copy_all(vm["source"].as<stringvec>(), std::back_inserter(file_names));

  enum options_t {
    PrintProcessHistory = 0,
    PrintRangeSetsFull,
    PrintRangeSetsCompact,
    PrintEventList,
    PrintFileIndex,
    SaveDBtoFile,
    FullPath,
    PrintBranchIDLists,
    NumOptions
  };

  std::bitset<NumOptions> options;
  options[PrintProcessHistory] = vm.count("process-history") > 0;
  if (vm.count("range-of-validity") > 0) {
    auto const& rov_value = vm["range-of-validity"].as<std::string>();
    if (rov_value == "full") {
      options.set(PrintRangeSetsFull);
    } else if (rov_value == "compact") {
      options.set(PrintRangeSetsCompact);
    } else {
      std::cerr
        << "Incorrect argument value supplied for the 'range-of-validity'\n"
        << "program option.  Allowed values are:\n"
        << "  \"full\" (default)\n"
        << "  \"compact\"\n";
      return 4;
    }
  }
  options[PrintEventList] = vm.count("event-list") > 0;
  options[PrintFileIndex] = vm.count("file-index") > 0;
  options[SaveDBtoFile] = vm.count("db-to-file") > 0;
  options[FullPath] = vm.count("full-path") > 0;
  options[PrintBranchIDLists] = vm.count("branch-ids") > 0;

  if (options.none()) {
    std::cerr << "No options were specified for processing input files.\n"
              << "For usage and options list, please do '" << argv[0]
              << " --help'.\n";
    return 5;
  }

  if (options.test(PrintEventList) && options.test(PrintFileIndex)) {
    std::cerr
      << "The --event-list and --file-index options are mutually exclusive.\n";
    return 6;
  }

  SetErrorHandler(RootErrorHandler);
  tkeyvfs_init();

  ostream& output = std::cout;
  ostream& errors = std::cerr;

  int rc{0};
  for (auto const& fn : file_names) {
    auto const& printed_name =
      options.test(FullPath) ? fn : fn.substr(fn.find_last_of('/') + 1ul);
    output << cet::HorizontalRule{30}('=') << '\n'
           << "File: " << printed_name << '\n';
    InfoDumperInputFile const file{fn};
    if (options.test(PrintProcessHistory))
      rc += print_process_history(file, output);
    if (options.test(PrintRangeSetsFull))
      rc += print_range_sets(file, output, false);
    if (options.test(PrintRangeSetsCompact))
      rc += print_range_sets(file, output, true);
    if (options.test(PrintFileIndex))
      rc += print_file_index(file, output);
    if (options.test(PrintEventList))
      rc += print_event_list(file, output);
    if (options.test(SaveDBtoFile))
      rc += db_to_file(file, output, errors);
    if (options.test(PrintBranchIDLists))
      rc += print_branchIDLists(file, output);
    output << '\n';
  }
  return rc;
}
catch (cet::exception const& e) {
  std::cerr << e.what() << '\n';
  return 7;
}
catch (...) {
  std::cerr << "Exception thrown for the last processed file.  Please remove "
               "it from the file list.\n";
  return 8;
}

int print_branchIDLists	(	InfoDumperInputFile const &	file,
		ostream &	output
	)

Definition at line 317 of file file_info_dumper.cc.

{
  file.print_branchIDLists(output);
  return 0;
}

int print_event_list	(	InfoDumperInputFile const &	file,
		ostream &	output
	)

Definition at line 303 of file file_info_dumper.cc.

{
  file.print_event_list(output);
  return 0;
}

int print_file_index	(	InfoDumperInputFile const &	file,
		ostream &	output
	)

Definition at line 310 of file file_info_dumper.cc.

{
  file.print_file_index(output);
  return 0;
}

int print_process_history	(	InfoDumperInputFile const &	file,
		ostream &	output
	)

Definition at line 287 of file file_info_dumper.cc.

{
  file.print_process_history(output);
  return 0;
}

int print_range_sets	(	InfoDumperInputFile const &	file,
		ostream &	output,
		bool	compact
	)

Definition at line 294 of file file_info_dumper.cc.

{
  file.print_range_sets(output, compactRanges);
  return 0;
}