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