The Gaudi Framework  v30r3 (a5ef0a68)
genconf.cpp
Go to the documentation of this file.
1 #ifdef _WIN32
2 // Disable a warning in Boost program_options headers:
3 // inconsistent linkage in program_options/variables_map.hpp
4 #pragma warning( disable : 4273 )
5 
6 // Avoid conflicts between windows and the message service.
7 #define NOMSG
8 #define NOGDI
9 #endif
10 
11 #ifdef __ICC
12 // disable icc warning #279: controlling expression is constant
13 // ... a lot of noise produced by the boost/filesystem/operations.hpp
14 #pragma warning( disable : 279 )
15 #endif
16 
17 #include "boost/program_options.hpp"
18 
19 // Include files----------------------------------------------------------------
20 #include "boost/algorithm/string/case_conv.hpp"
21 #include "boost/algorithm/string/classification.hpp"
22 #include "boost/algorithm/string/replace.hpp"
23 #include "boost/algorithm/string/split.hpp"
24 #include "boost/algorithm/string/trim.hpp"
25 #include "boost/filesystem/convenience.hpp"
26 #include "boost/filesystem/exception.hpp"
27 #include "boost/filesystem/operations.hpp"
28 #include "boost/format.hpp"
29 #include "boost/regex.hpp"
30 
31 #include <boost/log/core.hpp>
32 #include <boost/log/expressions.hpp>
33 #include <boost/log/trivial.hpp>
34 #include <boost/log/utility/setup/common_attributes.hpp>
35 #include <boost/log/utility/setup/console.hpp>
36 
37 #include "GaudiKernel/Bootstrap.h"
41 #include "GaudiKernel/HashMap.h"
42 #include "GaudiKernel/IAlgTool.h"
43 #include "GaudiKernel/IAlgorithm.h"
44 #include "GaudiKernel/IAppMgrUI.h"
45 #include "GaudiKernel/IAuditor.h"
46 #include "GaudiKernel/IProperty.h"
48 #include "GaudiKernel/Service.h"
49 #include "GaudiKernel/SmartIF.h"
50 #include "GaudiKernel/System.h"
51 
52 #include "GaudiKernel/AlgTool.h"
53 #include "GaudiKernel/Algorithm.h"
54 #include "GaudiKernel/Auditor.h"
55 #include "GaudiKernel/Service.h"
56 
57 #include "GaudiKernel/Time.h"
58 
59 #include <Gaudi/PluginService.h>
60 
61 #include <algorithm>
62 #include <exception>
63 #include <fstream>
64 #include <iostream>
65 #include <set>
66 #include <sstream>
67 #include <type_traits>
68 #include <vector>
69 
70 namespace po = boost::program_options;
71 namespace fs = boost::filesystem;
72 
73 #define LOG_ERROR BOOST_LOG_TRIVIAL( error )
74 #define LOG_WARNING BOOST_LOG_TRIVIAL( warning )
75 #define LOG_INFO BOOST_LOG_TRIVIAL( info )
76 #define LOG_DEBUG BOOST_LOG_TRIVIAL( debug )
77 
78 using namespace std;
80 
81 class IConverter;
82 
83 // useful typedefs
86 
87 namespace
88 {
89  const std::string py_tab = " ";
90 
93  const boost::regex pythonIdentifier( "^[a-zA-Z_][a-zA-Z0-9_]*$" );
94 
95  //-----------------------------------------------------------------------------
96  enum class component_t {
97  Module,
98  DefaultName,
99  Algorithm,
100  AlgTool,
101  Auditor,
102  Service,
103  ApplicationMgr,
104  IInterface,
105  Converter,
106  DataObject,
107  Unknown
108  };
109 
110  const std::map<std::string, component_t> allowedFactories{
111  {typeid( Algorithm::Factory::FactoryType ).name(), component_t::Algorithm},
112  {typeid( Service::Factory::FactoryType ).name(), component_t::Service},
113  {typeid( AlgTool::Factory::FactoryType ).name(), component_t::AlgTool},
114  {typeid( Auditor::Factory::FactoryType ).name(), component_t::Auditor},
115  };
116 
118  {
119  static const std::array<std::string, 11> names = {"Module", "DefaultName", "Algorithm", "AlgTool",
120  "Auditor", "Service", "ApplicationMgr", "IInterface",
121  "Converter", "DataObject", "Unknown"};
122  return names.at( static_cast<std::underlying_type_t<component_t>>( type ) );
123  }
124  std::ostream& operator<<( std::ostream& os, component_t type ) { return os << toString( type ); }
125 
126  //-----------------------------------------------------------------------------
128  std::string pythonizeName( const std::string& name )
129  {
130  static const string in( "<>&*,: ()." );
131  static const string out( "__rp__s___" );
132  auto r = boost::algorithm::replace_all_copy( name, ", ", "," );
133  for ( auto& c : r ) {
134  auto rep = in.find( c );
135  if ( rep != string::npos ) c = out[rep];
136  }
137  return r;
138  }
139  //-----------------------------------------------------------------------------
140  template <typename T>
141  std::type_index typeIndex()
142  {
143  return std::type_index{typeid( T )};
144  }
145  //-----------------------------------------------------------------------------
146  inline std::string libNativeName( const std::string& libName )
147  {
148 #if defined( _WIN32 )
149  return libName + ".dll";
150 #elif defined( __linux ) || defined( __APPLE__ )
151  return "lib" + libName + ".so";
152 #else
153  // variant of the GIGO design pattern
154  return libName;
155 #endif
156  }
157 }
158 
160 {
162  string m_pkgName;
163 
167 
170 
173  bool m_importGaudiHandles = false;
174  bool m_importDataObjectHandles = false;
175 
181 
188 
189 public:
190  configGenerator( const string& pkgName, const string& outputDirName )
191  : m_pkgName( pkgName ), m_outputDirName( outputDirName )
192  {
193  }
194 
199  int genConfig( const Strings_t& modules, const string& userModule );
200 
202  void setConfigurableModule( const std::string& moduleName ) { m_configurable[component_t::Module] = moduleName; }
203 
205  void setConfigurableDefaultName( const std::string& defaultName )
206  {
207  m_configurable[component_t::DefaultName] = defaultName;
208  }
209 
211  void setConfigurableAlgorithm( const std::string& cfgAlgorithm )
212  {
213  m_configurable[component_t::Algorithm] = cfgAlgorithm;
214  }
215 
217  void setConfigurableAlgTool( const std::string& cfgAlgTool ) { m_configurable[component_t::AlgTool] = cfgAlgTool; }
218 
220  void setConfigurableAuditor( const std::string& cfgAuditor ) { m_configurable[component_t::Auditor] = cfgAuditor; }
221 
223  void setConfigurableService( const std::string& cfgService )
224  {
225  m_configurable[component_t::Service] = cfgService;
226  m_configurable[component_t::ApplicationMgr] = cfgService;
227  }
228 
229 private:
230  bool genComponent( const std::string& libName, const std::string& componentName, component_t componentType,
232  void genImport( std::ostream& s, const boost::format& frmt, std::string indent );
233  void genHeader( std::ostream& pyOut, std::ostream& dbOut );
234  void genBody( std::ostream& pyOut, std::ostream& dbOut )
235  {
236  pyOut << m_pyBuf.str() << flush;
237  dbOut << m_dbBuf.str() << flush;
238  }
239  void genTrailer( std::ostream& pyOut, std::ostream& dbOut );
240 
242  void pythonizeValue( const PropertyBase* prop, string& pvalue, string& ptype );
243 };
244 
245 int createAppMgr();
246 
247 void init_logging( boost::log::trivial::severity_level level )
248 {
249  namespace logging = boost::log;
250  namespace keywords = boost::log::keywords;
251  namespace expr = boost::log::expressions;
252 
253  logging::add_console_log( std::cout, keywords::format =
254  ( expr::stream << "[" << std::setw( 7 ) << std::left
255  << logging::trivial::severity << "] " << expr::smessage ) );
256 
257  logging::core::get()->set_filter( logging::trivial::severity >= level );
258 }
259 
260 //--- Command main program-----------------------------------------------------
261 int main( int argc, char** argv )
262 //-----------------------------------------------------------------------------
263 {
264  init_logging( ( System::isEnvSet( "VERBOSE" ) && !System::getEnv( "VERBOSE" ).empty() )
265  ? boost::log::trivial::info
266  : boost::log::trivial::warning );
267 
268  fs::path pwd = fs::initial_path();
269  fs::path out;
270  Strings_t libs;
271  std::string pkgName;
272  std::string userModule;
273 
274  // declare a group of options that will be allowed only on command line
275  po::options_description generic( "Generic options" );
276  generic.add_options()( "help,h", "produce this help message" )(
277  "package-name,p", po::value<string>(), "name of the package for which we create the configurables file" )(
278  "input-libraries,i", po::value<string>(), "libraries to extract the component configurables from" )(
279  "input-cfg,c", po::value<string>(), "path to the cfg file holding the description of the Configurable base "
280  "classes, the python module holding the Configurable definitions, etc..." )(
281  "output-dir,o", po::value<string>()->default_value( "../genConf" ),
282  "output directory for genconf files." )( "debug-level,d", po::value<int>()->default_value( 0 ), "debug level" )(
283  "load-library,l", po::value<Strings_t>()->composing(), "preloading library" )(
284  "user-module,m", po::value<string>(), "user-defined module to be imported by the genConf-generated one" )(
285  "no-init", "do not generate the (empty) __init__.py" );
286 
287  // declare a group of options that will be allowed both on command line
288  // _and_ in configuration file
289  po::options_description config( "Configuration" );
290  config.add_options()( "configurable-module", po::value<string>()->default_value( "AthenaCommon" ),
291  "Name of the module holding the configurable classes" )(
292  "configurable-default-name", po::value<string>()->default_value( "Configurable.DefaultName" ),
293  "Default name for the configurable instance" )( "configurable-algorithm",
294  po::value<string>()->default_value( "ConfigurableAlgorithm" ),
295  "Name of the configurable base class for Algorithm components" )(
296  "configurable-algtool", po::value<string>()->default_value( "ConfigurableAlgTool" ),
297  "Name of the configurable base class for AlgTool components" )(
298  "configurable-auditor", po::value<string>()->default_value( "ConfigurableAuditor" ),
299  "Name of the configurable base class for Auditor components" )(
300  "configurable-service", po::value<string>()->default_value( "ConfigurableService" ),
301  "Name of the configurable base class for Service components" );
302 
303  po::options_description cmdline_options;
304  cmdline_options.add( generic ).add( config );
305 
306  po::options_description config_file_options;
307  config_file_options.add( config );
308 
309  po::options_description visible( "Allowed options" );
310  visible.add( generic ).add( config );
311 
312  po::variables_map vm;
313 
314  try {
315  po::store( po::command_line_parser( argc, argv ).options( cmdline_options ).run(), vm );
316 
317  po::notify( vm );
318 
319  // try to read configuration from the optionally given configuration file
320  if ( vm.count( "input-cfg" ) ) {
321  string cfgFileName = vm["input-cfg"].as<string>();
322  cfgFileName = fs::system_complete( fs::path( cfgFileName ) ).string();
323  std::ifstream ifs( cfgFileName );
324  po::store( parse_config_file( ifs, config_file_options ), vm );
325  }
326 
327  po::notify( vm );
328  } catch ( po::error& err ) {
329  LOG_ERROR << "error detected while parsing command options: " << err.what();
330  return EXIT_FAILURE;
331  }
332 
333  //--- Process command options -----------------------------------------------
334  if ( vm.count( "help" ) ) {
335  cout << visible << endl;
336  return EXIT_FAILURE;
337  }
338 
339  if ( vm.count( "package-name" ) ) {
340  pkgName = vm["package-name"].as<string>();
341  } else {
342  LOG_ERROR << "'package-name' required";
343  cout << visible << endl;
344  return EXIT_FAILURE;
345  }
346 
347  if ( vm.count( "user-module" ) ) {
348  userModule = vm["user-module"].as<string>();
349  LOG_INFO << "INFO: will import user module " << userModule;
350  }
351 
352  if ( vm.count( "input-libraries" ) ) {
353  // re-shape the input arguments:
354  // - removes spurious spaces,
355  // - split into tokens.
356  Strings_t inputLibs;
357  {
358  std::string tmp = vm["input-libraries"].as<std::string>();
359  boost::trim( tmp );
360  boost::split( inputLibs, tmp, boost::is_any_of( " " ), boost::token_compress_on );
361  }
362 
363  //
364  libs.reserve( inputLibs.size() );
365  for ( const auto& iLib : inputLibs ) {
366  std::string lib = fs::path( iLib ).stem().string();
367  if ( lib.compare( 0, 3, "lib" ) == 0 ) {
368  lib = lib.substr( 3 ); // For *NIX remove "lib"
369  }
370  // remove duplicates
371  if ( !lib.empty() && std::find( libs.begin(), libs.end(), lib ) == libs.end() ) {
372  libs.push_back( lib );
373  }
374  } //> end loop over input-libraries
375  if ( libs.empty() ) {
376  LOG_ERROR << "input component library(ies) required !\n";
377  LOG_ERROR << "'input-libraries' argument was [" << vm["input-libraries"].as<string>() << "]";
378  return EXIT_FAILURE;
379  }
380  } else {
381  LOG_ERROR << "input component library(ies) required";
382  cout << visible << endl;
383  return EXIT_FAILURE;
384  }
385 
386  if ( vm.count( "output-dir" ) ) {
387  out = fs::system_complete( fs::path( vm["output-dir"].as<string>() ) );
388  }
389 
390  if ( vm.count( "debug-level" ) ) {
391  Gaudi::PluginService::SetDebug( vm["debug-level"].as<int>() );
392  }
393 
394  if ( vm.count( "load-library" ) ) {
395  for ( const auto& lLib : vm["load-library"].as<Strings_t>() ) {
396  // load done through Gaudi helper class
397  System::ImageHandle tmp; // we ignore the library handle
398  unsigned long err = System::loadDynamicLib( lLib, &tmp );
399  if ( err != 1 ) LOG_WARNING << "failed to load: " << lLib;
400  }
401  }
402 
403  if ( !fs::exists( out ) ) {
404  try {
405  fs::create_directory( out );
406  } catch ( fs::filesystem_error& err ) {
407  LOG_ERROR << "error creating directory: " << err.what();
408  return EXIT_FAILURE;
409  }
410  }
411 
412  {
414  msg << ":::::: libraries : [ ";
415  std::copy( libs.begin(), libs.end(), std::ostream_iterator<std::string>( msg, " " ) );
416  msg << "] ::::::";
417  LOG_INFO << msg.str();
418  }
419 
420  configGenerator py( pkgName, out.string() );
421  py.setConfigurableModule( vm["configurable-module"].as<string>() );
422  py.setConfigurableDefaultName( vm["configurable-default-name"].as<string>() );
423  py.setConfigurableAlgorithm( vm["configurable-algorithm"].as<string>() );
424  py.setConfigurableAlgTool( vm["configurable-algtool"].as<string>() );
425  py.setConfigurableAuditor( vm["configurable-auditor"].as<string>() );
426  py.setConfigurableService( vm["configurable-service"].as<string>() );
427 
428  int sc = EXIT_FAILURE;
429  try {
430  sc = py.genConfig( libs, userModule );
431  } catch ( exception& e ) {
432  cout << "ERROR: Could not generate Configurable(s) !\n"
433  << "ERROR: Got exception: " << e.what() << endl;
434  return EXIT_FAILURE;
435  }
436 
437  if ( EXIT_SUCCESS == sc && !vm.count( "no-init" ) ) {
438  // create an empty __init__.py file in the output dir
439  std::fstream initPy( ( out / fs::path( "__init__.py" ) ).string(), std::ios_base::out | std::ios_base::trunc );
440  initPy << "## Hook for " << pkgName << " genConf module\n" << flush;
441  }
442 
443  {
445  msg << ":::::: libraries : [ ";
446  std::copy( libs.begin(), libs.end(), std::ostream_iterator<std::string>( msg, " " ) );
447  msg << "] :::::: [DONE]";
448  LOG_INFO << msg.str();
449  }
450  return sc;
451 }
452 
453 //-----------------------------------------------------------------------------
454 int configGenerator::genConfig( const Strings_t& libs, const string& userModule )
455 //-----------------------------------------------------------------------------
456 {
457  //--- Disable checking StatusCode -------------------------------------------
459 
460  const auto endLib = libs.end();
461 
462  static const std::string gaudiSvc = "GaudiCoreSvc";
463  const bool isGaudiSvc = ( std::find( libs.begin(), endLib, gaudiSvc ) != endLib );
464 
465  //--- Instantiate ApplicationMgr --------------------------------------------
466  if ( !isGaudiSvc && createAppMgr() ) {
467  cout << "ERROR: ApplicationMgr can not be created. Check environment" << endl;
468  return EXIT_FAILURE;
469  }
470 
471  //--- Iterate over component factories --------------------------------------
472  using Gaudi::PluginService::Details::Registry;
473  const Registry& registry = Registry::instance();
474 
475  auto bkgNames = registry.loadedFactoryNames();
476 
477  ISvcLocator* svcLoc = Gaudi::svcLocator();
478  IInterface* dummySvc = new Service( "DummySvc", svcLoc );
479  dummySvc->addRef();
480 
481  bool allGood = true;
482 
483  // iterate over all the requested libraries
484  for ( const auto& iLib : libs ) {
485 
486  LOG_INFO << ":::: processing library: " << iLib << "...";
487 
488  // reset state
489  m_importGaudiHandles = false;
490  m_importDataObjectHandles = false;
491  m_pyBuf.str( "" );
492  m_dbBuf.str( "" );
493 
494  //--- Load component library ----------------------------------------------
495  System::ImageHandle handle;
496  unsigned long err = System::loadDynamicLib( iLib, &handle );
497  if ( err != 1 ) {
499  allGood = false;
500  continue;
501  }
502 
503  const auto& factories = registry.factories();
504  for ( const auto& factoryName : registry.loadedFactoryNames() ) {
505  if ( bkgNames.find( factoryName ) != bkgNames.end() ) {
507  LOG_INFO << "\t==> skipping [" << factoryName << "]...";
508  }
509  continue;
510  }
511  auto entry = factories.find( factoryName );
512  if ( entry == end( factories ) ) {
513  LOG_ERROR << "inconsistency in component factories list: I cannot find anymore " << factoryName;
514  continue;
515  }
516  const auto& info = entry->second;
517  if ( !info.is_set() ) continue;
518 
519  // do not generate configurables for the Reflex-compatible aliases
520  if ( !info.getprop( "ReflexName" ).empty() ) continue;
521 
522  // Atlas contributed code (patch #1247)
523  // Skip the generation of configurables if the component does not come
524  // from the same library we are processing (i.e. we found a symbol that
525  // is coming from a library loaded by the linker).
526  if ( libNativeName( iLib ) != info.library ) {
527  LOG_WARNING << "library [" << iLib << "] exposes factory [" << factoryName << "] which is declared in ["
528  << info.library << "] !!";
529  continue;
530  }
531 
532  component_t type = component_t::Unknown;
533  {
534  const auto ft = allowedFactories.find( info.factory.type().name() );
535  if ( ft != allowedFactories.end() ) {
536  type = ft->second;
537  } else if ( factoryName == "ApplicationMgr" ) {
538  type = component_t::ApplicationMgr;
539  } else
540  continue;
541  }
542 
543  // handle possible problems with templated components
544  std::string name = boost::trim_copy( factoryName );
545 
546  const auto className = info.getprop( "ClassName" );
547  LOG_INFO << " - component: " << className << " (" << ( className != name ? ( name + ": " ) : std::string() )
548  << type << ")";
549 
550  string cname = "DefaultName";
551  SmartIF<IProperty> prop;
552  try {
553  switch ( type ) {
554  case component_t::Algorithm:
555  prop = SmartIF<IAlgorithm>( Algorithm::Factory::create( factoryName, cname, svcLoc ).release() );
556  break;
557  case component_t::Service:
558  prop = SmartIF<IService>( Service::Factory::create( factoryName, cname, svcLoc ).release() );
559  break;
560  case component_t::AlgTool:
561  prop =
562  SmartIF<IAlgTool>( AlgTool::Factory::create( factoryName, cname, toString( type ), dummySvc ).release() );
563  // FIXME: AlgTool base class increase artificially by 1 the refcount.
564  prop->release();
565  break;
566  case component_t::Auditor:
567  prop = SmartIF<IAuditor>( Auditor::Factory::create( factoryName, cname, svcLoc ).release() );
568  break;
569  case component_t::ApplicationMgr:
570  prop = SmartIF<ISvcLocator>( svcLoc );
571  break;
572  default:
573  continue; // unknown
574  }
575  } catch ( exception& e ) {
576  LOG_ERROR << "Error instantiating " << name << " from " << iLib;
577  LOG_ERROR << "Got exception: " << e.what();
578  allGood = false;
579  continue;
580  } catch ( ... ) {
581  LOG_ERROR << "Error instantiating " << name << " from " << iLib;
582  allGood = false;
583  continue;
584  }
585  if ( prop ) {
586  if ( !genComponent( iLib, name, type, prop->getProperties() ) ) {
587  allGood = false;
588  }
589  prop.reset();
590  } else {
591  LOG_ERROR << "could not cast IInterface* object to an IProperty* !";
592  LOG_ERROR << "NO Configurable will be generated for [" << name << "] !";
593  allGood = false;
594  }
595  } //> end loop over factories
596 
600  const std::string pyName = ( fs::path( m_outputDirName ) / fs::path( iLib + "Conf.py" ) ).string();
601  const std::string dbName = ( fs::path( m_outputDirName ) / fs::path( iLib + ".confdb" ) ).string();
602 
603  std::fstream py( pyName, std::ios_base::out | std::ios_base::trunc );
604  std::fstream db( dbName, std::ios_base::out | std::ios_base::trunc );
605 
606  genHeader( py, db );
607  if ( !userModule.empty() ) py << "from " << userModule << " import *" << endl;
608  genBody( py, db );
609  genTrailer( py, db );
610 
611  } //> end loop over libraries
612 
613  dummySvc->release();
614  dummySvc = 0;
615 
616  return allGood ? EXIT_SUCCESS : EXIT_FAILURE;
617 }
618 
620 {
621 
622  std::string::size_type pos = 0, nxtpos = 0;
624 
625  while ( std::string::npos != pos ) {
626  // find end of module name
627  nxtpos = m_configurable[component_t::Module].find_first_of( ',', pos );
628 
629  // Prepare import string
630  mod = m_configurable[component_t::Module].substr( pos, nxtpos - pos );
631  std::ostringstream import;
632  import << boost::format( frmt ) % mod;
633 
634  // append a normal import or a try/except enclosed one depending
635  // on availability of a fall-back module (next in the list)
636  if ( std::string::npos == nxtpos ) {
637  // last possible module
638  s << indent << import.str() << "\n" << flush;
639  pos = std::string::npos;
640  } else {
641  // we have a fallback for this
642  s << indent << "try:\n" << indent << py_tab << import.str() << "\n" << indent << "except ImportError:\n" << flush;
643  pos = nxtpos + 1;
644  }
645  // increase indentation level for next iteration
646  indent += py_tab;
647  }
648 }
649 
650 //-----------------------------------------------------------------------------
652 //-----------------------------------------------------------------------------
653 {
654  // python file part
655  std::string now = Gaudi::Time::current().format( true );
656  py << "#" << now //<< "\n"
657  << "\"\"\"Automatically generated. DO NOT EDIT please\"\"\"\n";
658  if ( m_importGaudiHandles ) {
659  py << "from GaudiKernel.GaudiHandles import *\n";
660  }
661 
662  if ( m_importDataObjectHandles ) {
663  py << "from GaudiKernel.DataObjectHandleBase import DataObjectHandleBase\n";
664  }
665 
666  genImport( py, boost::format( "from %1%.Configurable import *" ) );
667 
668  // db file part
669  db << "## -*- ascii -*- \n"
670  << "# db file automatically generated by genconf on: " << now << "\n"
671  << flush;
672 }
673 //-----------------------------------------------------------------------------
675 //-----------------------------------------------------------------------------
676 {
677  // db file part
678  db << "## " << m_pkgName << "\n" << std::flush;
679 }
680 
681 //-----------------------------------------------------------------------------
682 bool configGenerator::genComponent( const std::string& libName, const std::string& componentName,
683  component_t componentType, const vector<PropertyBase*>& properties )
684 //-----------------------------------------------------------------------------
685 {
686  auto cname = pythonizeName( componentName );
687 
689  propDoc.reserve( properties.size() );
690 
691  m_pyBuf << "\nclass " << cname << "( " << m_configurable[componentType] << " ) :\n";
692  m_pyBuf << " __slots__ = { \n";
693  for ( const auto& prop : properties ) {
694  const string& pname = prop->name();
695  // Validate property name (it must be a valid Python identifier)
696  if ( !boost::regex_match( pname, pythonIdentifier ) ) {
697  std::cout << "ERROR: invalid property name \"" << pname << "\" in component " << cname
698  << " (invalid Python identifier)" << std::endl;
699  // try to make the buffer at least more or less valid python code.
700  m_pyBuf << " #ERROR-invalid identifier '" << pname << "'\n"
701  << " }\n";
702  return false;
703  }
704 
705  string pvalue, ptype;
706  pythonizeValue( prop, pvalue, ptype );
707  m_pyBuf << " '" << pname << "' : " << pvalue << ", # " << ptype << "\n";
708 
709  if ( prop->documentation() != "none" ) {
710  propDoc.emplace_back( pname, prop->documentation() + " [" + prop->ownerTypeName() + "]" );
711  }
712  }
713  m_pyBuf << " }\n";
714  m_pyBuf << " _propertyDocDct = { \n";
715  for ( const auto& prop : propDoc ) {
716  m_pyBuf << std::setw( 5 ) << "'" << prop.first << "' : "
717  << "\"\"\" " << prop.second << " \"\"\",\n";
718  }
719  m_pyBuf << " }\n";
720 
721  m_pyBuf << " def __init__(self, name = " << m_configurable[component_t::DefaultName] << ", **kwargs):\n"
722  << " super(" << cname << ", self).__init__(name)\n"
723  << " for n,v in kwargs.items():\n"
724  << " setattr(self, n, v)\n"
725  << " def getDlls( self ):\n"
726  << " return '" << libName << "'\n"
727  << " def getType( self ):\n"
728  << " return '" << componentName << "'\n"
729  << " pass # class " << cname << "\n"
730  << flush;
731 
732  // name of the auto-generated module
733  const string pyName = ( fs::path( m_outputDirName ) / fs::path( libName + "Conf.py" ) ).string();
734  const string modName = fs::basename( fs::path( pyName ).leaf() );
735 
736  // now the db part
737  m_dbBuf << m_pkgName << "." << modName << " " << libName << " " << cname << "\n" << flush;
738 
739  return true;
740 }
741 
742 //-----------------------------------------------------------------------------
743 void configGenerator::pythonizeValue( const PropertyBase* p, string& pvalue, string& ptype )
744 //-----------------------------------------------------------------------------
745 {
746  const std::string cvalue = p->toString();
747  const std::type_index ti = std::type_index( *p->type_info() );
748  if ( ti == typeIndex<bool>() ) {
749  pvalue = ( cvalue == "0" || cvalue == "False" || cvalue == "false" ) ? "False" : "True";
750  ptype = "bool";
751  } else if ( ti == typeIndex<char>() || ti == typeIndex<signed char>() || ti == typeIndex<unsigned char>() ||
752  ti == typeIndex<short>() || ti == typeIndex<unsigned short>() || ti == typeIndex<int>() ||
753  ti == typeIndex<unsigned int>() || ti == typeIndex<long>() || ti == typeIndex<unsigned long>() ) {
754  pvalue = cvalue;
755  ptype = "int";
756  } else if ( ti == typeIndex<long long>() || ti == typeIndex<unsigned long long>() ) {
757  pvalue = cvalue + "L";
758  ptype = "long";
759  } else if ( ti == typeIndex<float>() || ti == typeIndex<double>() ) {
760  // forces python to handle this as a float: put a dot in there...
761  pvalue = boost::to_lower_copy( cvalue );
762  if ( pvalue == "nan" ) {
763  pvalue = "float('nan')";
764  std::cout << "WARNING: default value for [" << p->name() << "] is NaN !!" << std::endl;
765  } else if ( std::string::npos == pvalue.find( "." ) && std::string::npos == pvalue.find( "e" ) ) {
766  pvalue = cvalue + ".0";
767  }
768  ptype = "float";
769  } else if ( ti == typeIndex<string>() ) {
770  pvalue = "'" + cvalue + "'";
771  ptype = "str";
772  } else if ( ti == typeIndex<GaudiHandleBase>() ) {
773  const GaudiHandleProperty& hdl = dynamic_cast<const GaudiHandleProperty&>( *p );
774  const GaudiHandleBase& base = hdl.value();
775 
776  pvalue = base.pythonRepr();
777  ptype = "GaudiHandle";
778  m_importGaudiHandles = true;
779  } else if ( ti == typeIndex<GaudiHandleArrayBase>() ) {
780  const GaudiHandleArrayProperty& hdl = dynamic_cast<const GaudiHandleArrayProperty&>( *p );
781  const GaudiHandleArrayBase& base = hdl.value();
782 
783  pvalue = base.pythonRepr();
784  ptype = "GaudiHandleArray";
785  m_importGaudiHandles = true;
786  } else if ( ti == typeIndex<DataObjectHandleBase>() ) {
787  const DataObjectHandleProperty& hdl = dynamic_cast<const DataObjectHandleProperty&>( *p );
788  const DataObjectHandleBase& base = hdl.value();
789 
790  pvalue = base.pythonRepr();
791  ptype = "DataObjectHandleBase";
792  m_importDataObjectHandles = true;
793  } else {
794  std::ostringstream v_str;
795  v_str.setf( std::ios::showpoint ); // to correctly display floats
796  p->toStream( v_str );
797  pvalue = v_str.str();
798  ptype = "list";
799  }
800 }
801 
802 //-----------------------------------------------------------------------------
804 //-----------------------------------------------------------------------------
805 {
807  SmartIF<IAppMgrUI> appUI( iface );
808  auto propMgr = appUI.as<IProperty>();
809  if ( !propMgr || !appUI ) return EXIT_FAILURE;
810 
811  propMgr->setProperty( "JobOptionsType", "NONE" ); // No job options
812  propMgr->setProperty( "AppName", "" ); // No initial printout message
813  propMgr->setProperty( "OutputLevel", "7" ); // No other printout messages
814  appUI->configure();
815  auto msgSvc = SmartIF<IMessageSvc>{iface}.as<IProperty>();
816  msgSvc->setProperty( "setWarning", "['DefaultName', 'PropertyHolder']" );
817  msgSvc->setProperty( "Format", "%T %0W%M" );
818  return EXIT_SUCCESS;
819 }
GAUDI_API std::string getEnv(const char *var)
get a particular environment variable (returning "UNKNOWN" if not set)
Definition: System.cpp:411
int genConfig(const Strings_t &modules, const string &userModule)
main entry point of this class:
Definition: genconf.cpp:454
T setf(T...args)
T empty(T...args)
T copy(T...args)
The ISvcLocator is the interface implemented by the Service Factory in the Application Manager to loc...
Definition: ISvcLocator.h:25
The data converters are responsible to translate data from one representation into another...
Definition: IConverter.h:58
GAUDI_API std::string format(const char *,...)
MsgStream format utility "a la sprintf(...)".
Definition: MsgStream.cpp:120
component_t
Definition: genconf.cpp:96
std::vector< std::string > Strings_t
Definition: genconf.cpp:81
const std::string name() const
property name
Definition: Property.h:40
list argv
Definition: gaudirun.py:235
#define LOG_ERROR
Definition: genconf.cpp:73
T endl(T...args)
static Time current()
Returns the current time.
Definition: Time.cpp:112
T left(T...args)
void setConfigurableDefaultName(const std::string &defaultName)
customize the default name for configurable instances
Definition: genconf.cpp:205
STL namespace.
std::vector< fs::path > LibPathNames_t
Definition: genconf.cpp:85
void setConfigurableAlgTool(const std::string &cfgAlgTool)
customize the configurable base class for AlgTool component
Definition: genconf.cpp:217
T end(T...args)
void * ImageHandle
Definition of an image handle.
Definition: ModuleInfo.h:31
virtual std::string toString() const =0
value -> string
STL class.
stringstream m_pyBuf
buffer of auto-generated configurables
Definition: genconf.cpp:169
virtual void toStream(std::ostream &out) const =0
value -> stream
T setw(T...args)
DataObjectHandleProperty.h GaudiKernel/DataObjectHandleProperty.h.
void setConfigurableModule(const std::string &moduleName)
customize the Module name where configurable base classes are defined
Definition: genconf.cpp:202
STL class.
T at(T...args)
T push_back(T...args)
virtual StatusCode setProperty(const Gaudi::Details::PropertyBase &p)=0
Set the property by property.
SmartIF< IFace > as() const
return a new SmartIF instance to another interface
Definition: SmartIF.h:115
int main(int argc, char **argv)
Definition: genconf.cpp:261
GAUDI_API ISvcLocator * svcLocator()
GAUDIPS_API Logger & logger()
Return the current logger instance.
T what(T...args)
#define LOG_INFO
Definition: genconf.cpp:75
Definition of the basic interface.
Definition: IInterface.h:277
STL class.
const GaudiHandleBase & value() const
Definition: Property.h:922
void genHeader(std::ostream &pyOut, std::ostream &dbOut)
Definition: genconf.cpp:651
T str(T...args)
const GaudiHandleArrayBase & value() const
Definition: Property.h:962
PropertyBase base class allowing PropertyBase* collections to be "homogeneous".
Definition: Property.h:32
stringstream m_dbBuf
buffer of generated configurables informations for the "Db" file The "Db" file is holding information...
Definition: genconf.cpp:180
Converter base class.
Definition: Converter.h:24
configGenerator(const string &pkgName, const string &outputDirName)
Definition: genconf.cpp:190
STL class.
std::string pythonRepr() const override
Python representation of array of handles, i.e.
Definition: GaudiHandle.cpp:86
void setConfigurableAlgorithm(const std::string &cfgAlgorithm)
customize the configurable base class for Algorithm component
Definition: genconf.cpp:211
virtual const std::vector< Gaudi::Details::PropertyBase * > & getProperties() const =0
Get list of properties.
GAUDI_API bool isEnvSet(const char *var)
Check if an environment variable is set or not.
Definition: System.cpp:433
T flush(T...args)
void init_logging(boost::log::trivial::severity_level level)
Definition: genconf.cpp:247
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:78
T find(T...args)
T size(T...args)
Base class of array&#39;s of various gaudihandles.
Definition: GaudiHandle.h:354
string m_outputDirName
absolute path to the directory where genconf will store auto-generated files (Configurables and Confi...
Definition: genconf.cpp:166
void pythonizeValue(const PropertyBase *prop, string &pvalue, string &ptype)
handle the "marshalling" of Properties
Definition: genconf.cpp:743
virtual unsigned long release()=0
Release Interface instance.
#define LOG_WARNING
Definition: genconf.cpp:74
DataObjectHandleBase GaudiKernel/DataObjectHandleBase.h.
void genImport(std::ostream &s, const boost::format &frmt, std::string indent)
Definition: genconf.cpp:619
T begin(T...args)
std::string pythonRepr() const override
Python representation of handle, i.e.
Definition: GaudiHandle.cpp:53
void setConfigurableService(const std::string &cfgService)
customize the configurable base class for Service component
Definition: genconf.cpp:223
GAUDI_API const std::string & moduleName()
Get the name of the (executable/DLL) file without file-type.
Definition: ModuleInfo.cpp:54
Base class from which all the concrete tool classes should be derived.
Definition: AlgTool.h:47
string s
Definition: gaudirun.py:253
STL class.
std::string pythonRepr() const override
std::map< component_t, std::string > m_configurable
Configurable customization.
Definition: genconf.cpp:187
string m_pkgName
name of the package we are processing
Definition: genconf.cpp:162
virtual unsigned long addRef()=0
Increment the reference count of Interface instance.
T substr(T...args)
static GAUDI_API void disableChecking()
Definition: StatusCode.cpp:42
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:92
void genTrailer(std::ostream &pyOut, std::ostream &dbOut)
Definition: genconf.cpp:674
const DataObjectHandleBase & value() const
GAUDI_API const std::string getLastErrorString()
Get last system error as string.
Definition: System.cpp:294
Base class to handles to be used in lieu of naked pointers to various Gaudi components.
Definition: GaudiHandle.h:94
virtual StatusCode configure()=0
Configure the job.
bool genComponent(const std::string &libName, const std::string &componentName, component_t componentType, const vector< PropertyBase * > &properties)
Definition: genconf.cpp:682
The IProperty is the basic interface for all components which have properties that can be set or get...
Definition: IProperty.h:20
Base class for all services.
Definition: Service.h:36
GAUDIPS_API void SetDebug(int debugLevel)
Backward compatibility with Reflex.
int createAppMgr()
Definition: genconf.cpp:803
STL class.
void genBody(std::ostream &pyOut, std::ostream &dbOut)
Definition: genconf.cpp:234
STL class.
std::string toString(const Type &)
T compare(T...args)
const std::type_info * type_info() const
property type-info
Definition: Property.h:44
std::string format(bool local, std::string spec="%c") const
Format the time using strftime.
Definition: Time.cpp:260
GAUDI_API IAppMgrUI * createApplicationMgr(const std::string &dllname, const std::string &factname)
T reserve(T...args)
std::ostream & operator<<(std::ostream &str, const GaudiAlg::ID &id)
Operator overloading for ostream.
Definition: GaudiHistoID.h:136
Base class from which all concrete auditor classes should be derived.
Definition: Auditor.h:35
GAUDI_API unsigned long loadDynamicLib(const std::string &name, ImageHandle *handle)
Load dynamic link library.
Definition: System.cpp:154
void setConfigurableAuditor(const std::string &cfgAuditor)
customize the configurable base class for AlgTool component
Definition: genconf.cpp:220
T emplace_back(T...args)