4 # pragma warning( disable : 4273 ) 14 # pragma warning( disable : 279 ) 17 #include "boost/program_options.hpp" 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" 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> 67 #include <type_traits> 70 namespace po = boost::program_options;
71 namespace fs = boost::filesystem;
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 ) 92 const boost::regex pythonIdentifier(
"^[a-zA-Z_][a-zA-Z0-9_]*$" );
110 {
typeid( Gaudi::Algorithm::Factory::FactoryType ).
name(), component_t::Algorithm},
111 {
typeid( Service::Factory::FactoryType ).
name(), component_t::Service},
112 {
typeid( AlgTool::Factory::FactoryType ).
name(), component_t::AlgTool},
113 {
typeid( Auditor::Factory::FactoryType ).
name(), component_t::Auditor},
118 "Auditor",
"Service",
"ApplicationMgr",
"IInterface",
119 "Converter",
"DataObject",
"Unknown"};
120 return names.
at(
static_cast<std::underlying_type_t<component_t>
>(
type ) );
127 static const string in(
"<>&*,: ()." );
128 static const string out(
"__rp__s___" );
129 auto r = boost::algorithm::replace_all_copy(
name,
", ",
"," );
130 for (
auto&
c : r ) {
131 auto rep = in.find(
c );
132 if ( rep != string::npos )
c = out[rep];
137 template <
typename T>
143 #if defined( _WIN32 ) 144 return libName +
".dll";
145 #elif defined( __linux ) || defined( __APPLE__ ) 146 return "lib" + libName +
".so";
167 bool m_importGaudiHandles =
false;
168 bool m_importDataObjectHandles =
false;
185 : m_pkgName( pkgName ), m_outputDirName( outputDirName ) {}
191 int genConfig(
const Strings_t& modules,
const string& userModule );
198 m_configurable[component_t::DefaultName] = defaultName;
203 m_configurable[component_t::Algorithm] = cfgAlgorithm;
214 m_configurable[component_t::Service] = cfgService;
215 m_configurable[component_t::ApplicationMgr] = cfgService;
230 void pythonizeValue(
const PropertyBase* prop,
string& pvalue,
string& ptype );
237 namespace keywords = boost::log::keywords;
238 namespace expr = boost::log::expressions;
242 << logging::trivial::severity <<
"] " << expr::smessage ) );
252 ? boost::log::trivial::info
253 : boost::log::trivial::warning );
262 po::options_description
generic(
"Generic options" );
263 generic.add_options()(
"help,h",
"produce this help message" )(
264 "package-name,p", po::value<string>(),
"name of the package for which we create the configurables file" )(
265 "input-libraries,i", po::value<string>(),
"libraries to extract the component configurables from" )(
266 "input-cfg,c", po::value<string>(),
267 "path to the cfg file holding the description of the Configurable base " 268 "classes, the python module holding the Configurable definitions, etc..." )(
269 "output-dir,o", po::value<string>()->default_value(
"../genConf" ),
270 "output directory for genconf files." )(
"debug-level,d", po::value<int>()->default_value( 0 ),
"debug level" )(
271 "load-library,l", po::value<Strings_t>()->composing(),
"preloading library" )(
272 "user-module,m", po::value<string>(),
"user-defined module to be imported by the genConf-generated one" )(
273 "no-init",
"do not generate the (empty) __init__.py" );
277 po::options_description
config(
"Configuration" );
278 config.add_options()(
"configurable-module", po::value<string>()->default_value(
"AthenaCommon" ),
279 "Name of the module holding the configurable classes" )(
280 "configurable-default-name", po::value<string>()->default_value(
"Configurable.DefaultName" ),
281 "Default name for the configurable instance" )(
"configurable-algorithm",
282 po::value<string>()->default_value(
"ConfigurableAlgorithm" ),
283 "Name of the configurable base class for Algorithm components" )(
284 "configurable-algtool", po::value<string>()->default_value(
"ConfigurableAlgTool" ),
285 "Name of the configurable base class for AlgTool components" )(
286 "configurable-auditor", po::value<string>()->default_value(
"ConfigurableAuditor" ),
287 "Name of the configurable base class for Auditor components" )(
288 "configurable-service", po::value<string>()->default_value(
"ConfigurableService" ),
289 "Name of the configurable base class for Service components" );
291 po::options_description cmdline_options;
292 cmdline_options.add(
generic ).add(
config );
294 po::options_description config_file_options;
295 config_file_options.add(
config );
297 po::options_description visible(
"Allowed options" );
298 visible.add(
generic ).add(
config );
300 po::variables_map vm;
303 po::store( po::command_line_parser(
argc,
argv ).
options( cmdline_options ).run(), vm );
308 if ( vm.count(
"input-cfg" ) ) {
309 string cfgFileName = vm[
"input-cfg"].as<
string>();
310 cfgFileName = fs::system_complete(
fs::path( cfgFileName ) ).
string();
312 po::store( parse_config_file( ifs, config_file_options ), vm );
316 }
catch ( po::error& err ) {
317 LOG_ERROR <<
"error detected while parsing command options: " << err.what();
322 if ( vm.count(
"help" ) ) {
327 if ( vm.count(
"package-name" ) ) {
328 pkgName = vm[
"package-name"].as<
string>();
335 if ( vm.count(
"user-module" ) ) {
336 userModule = vm[
"user-module"].as<
string>();
337 LOG_INFO <<
"INFO: will import user module " << userModule;
340 if ( vm.count(
"input-libraries" ) ) {
348 boost::split( inputLibs, tmp, boost::is_any_of(
" " ), boost::token_compress_on );
353 for (
const auto& iLib : inputLibs ) {
355 if ( lib.
compare( 0, 3,
"lib" ) == 0 ) {
361 if ( libs.
empty() ) {
362 LOG_ERROR <<
"input component library(ies) required !\n";
363 LOG_ERROR <<
"'input-libraries' argument was [" << vm[
"input-libraries"].as<
string>() <<
"]";
367 LOG_ERROR <<
"input component library(ies) required";
372 if ( vm.count(
"output-dir" ) ) { out = fs::system_complete(
fs::path( vm[
"output-dir"].as<string>() ) ); }
376 if ( vm.count(
"load-library" ) ) {
377 for (
const auto& lLib : vm[
"load-library"].as<Strings_t>() ) {
381 if ( err != 1 )
LOG_WARNING <<
"failed to load: " << lLib;
385 if ( !fs::exists( out ) ) {
387 fs::create_directory( out );
388 }
catch ( fs::filesystem_error& err ) {
389 LOG_ERROR <<
"error creating directory: " << err.what();
396 msg <<
":::::: libraries : [ ";
404 py.setConfigurableDefaultName( vm[
"configurable-default-name"].as<string>() );
405 py.setConfigurableAlgorithm( vm[
"configurable-algorithm"].as<string>() );
406 py.setConfigurableAlgTool( vm[
"configurable-algtool"].as<string>() );
407 py.setConfigurableAuditor( vm[
"configurable-auditor"].as<string>() );
408 py.setConfigurableService( vm[
"configurable-service"].as<string>() );
410 int sc = EXIT_FAILURE;
412 sc = py.genConfig( libs, userModule );
414 cout <<
"ERROR: Could not generate Configurable(s) !\n" 415 <<
"ERROR: Got exception: " << e.
what() <<
endl;
419 if ( EXIT_SUCCESS == sc && !vm.count(
"no-init" ) ) {
421 std::fstream initPy( ( out /
fs::path(
"__init__.py" ) ).
string(), std::ios_base::out | std::ios_base::trunc );
422 initPy <<
"## Hook for " << pkgName <<
" genConf module\n" <<
flush;
427 msg <<
":::::: libraries : [ ";
429 msg <<
"] :::::: [DONE]";
442 const auto endLib = libs.
end();
444 static const std::string gaudiSvc =
"GaudiCoreSvc";
445 const bool isGaudiSvc = (
std::find( libs.
begin(), endLib, gaudiSvc ) != endLib );
449 cout <<
"ERROR: ApplicationMgr can not be created. Check environment" <<
endl;
454 using Gaudi::PluginService::Details::Registry;
455 const Registry&
registry = Registry::instance();
457 auto bkgNames =
registry.loadedFactoryNames();
466 for (
const auto& iLib : libs ) {
468 LOG_INFO <<
":::: processing library: " << iLib <<
"...";
471 m_importGaudiHandles =
false;
472 m_importDataObjectHandles =
false;
486 for (
const auto& factoryName :
registry.loadedFactoryNames() ) {
487 if ( bkgNames.find( factoryName ) != bkgNames.end() ) {
489 LOG_INFO <<
"\t==> skipping [" << factoryName <<
"]...";
493 auto entry =
factories.find( factoryName );
495 LOG_ERROR <<
"inconsistency in component factories list: I cannot find anymore " << factoryName;
498 const auto& info = entry->second;
499 if ( !info.is_set() )
continue;
502 if ( !info.getprop(
"ReflexName" ).empty() )
continue;
508 if ( libNativeName( iLib ) != info.library ) {
509 LOG_WARNING <<
"library [" << iLib <<
"] exposes factory [" << factoryName <<
"] which is declared in [" 510 << info.library <<
"] !!";
516 const auto ft = allowedFactories.find( info.factory.type().name() );
517 if ( ft != allowedFactories.end() ) {
519 }
else if ( factoryName ==
"ApplicationMgr" ) {
520 type = component_t::ApplicationMgr;
528 const auto className = info.getprop(
"ClassName" );
532 string cname =
"DefaultName";
536 case component_t::Algorithm:
537 prop =
SmartIF<IAlgorithm>( Gaudi::Algorithm::Factory::create( factoryName, cname, svcLoc ).release() );
539 case component_t::Service:
540 prop =
SmartIF<IService>( Service::Factory::create( factoryName, cname, svcLoc ).release() );
542 case component_t::AlgTool:
548 case component_t::Auditor:
549 prop =
SmartIF<IAuditor>( Auditor::Factory::create( factoryName, cname, svcLoc ).release() );
551 case component_t::ApplicationMgr:
558 LOG_ERROR <<
"Error instantiating " <<
name <<
" from " << iLib;
563 LOG_ERROR <<
"Error instantiating " <<
name <<
" from " << iLib;
571 LOG_ERROR <<
"could not cast IInterface* object to an IProperty* !";
572 LOG_ERROR <<
"NO Configurable will be generated for [" <<
name <<
"] !";
583 std::fstream py( pyName, std::ios_base::out | std::ios_base::trunc );
584 std::fstream db( dbName, std::ios_base::out | std::ios_base::trunc );
587 if ( !userModule.
empty() ) py <<
"from " << userModule <<
" import *" <<
endl;
589 genTrailer( py, db );
596 return allGood ? EXIT_SUCCESS : EXIT_FAILURE;
601 std::string::size_type pos = 0, nxtpos = 0;
604 while ( std::string::npos != pos ) {
606 nxtpos = m_configurable[component_t::Module].find_first_of(
',', pos );
609 mod = m_configurable[component_t::Module].substr( pos, nxtpos - pos );
615 if ( std::string::npos == nxtpos ) {
617 s << indent <<
import.str() <<
"\n" <<
flush;
618 pos = std::string::npos;
621 s << indent <<
"try:\n" << indent << py_tab <<
import.str() <<
"\n" << indent <<
"except ImportError:\n" <<
flush;
636 <<
"\"\"\"Automatically generated. DO NOT EDIT please\"\"\"\n" 638 <<
"if sys.version_info >= (3,):\n" 639 <<
" # Python 2 compatibility\n" 642 if ( m_importGaudiHandles ) { py <<
"from GaudiKernel.GaudiHandles import *\n"; }
644 if ( m_importDataObjectHandles ) { py <<
"from GaudiKernel.DataObjectHandleBase import DataObjectHandleBase\n"; }
646 genImport( py,
boost::format(
"from %1%.Configurable import *" ) );
649 db <<
"## -*- ascii -*- \n" 650 <<
"# db file automatically generated by genconf on: " << now <<
"\n" 658 db <<
"## " << m_pkgName <<
"\n" <<
std::flush;
666 auto cname = pythonizeName( componentName );
671 m_pyBuf <<
"\nclass " << cname <<
"( " << m_configurable[componentType] <<
" ) :\n";
672 m_pyBuf <<
" __slots__ = { \n";
674 const string&
pname = prop->name();
676 if ( !boost::regex_match(
pname, pythonIdentifier ) ) {
677 std::cout <<
"ERROR: invalid property name \"" <<
pname <<
"\" in component " << cname
678 <<
" (invalid Python identifier)" <<
std::endl;
680 m_pyBuf <<
" #ERROR-invalid identifier '" <<
pname <<
"'\n" 685 string pvalue, ptype;
686 pythonizeValue( prop, pvalue, ptype );
687 m_pyBuf <<
" '" <<
pname <<
"' : " << pvalue <<
", # " << ptype <<
"\n";
689 if ( prop->documentation() !=
"none" ) {
690 propDoc.
emplace_back(
pname, prop->documentation() +
" [" + prop->ownerTypeName() +
"]" );
694 m_pyBuf <<
" _propertyDocDct = { \n";
695 for (
const auto& prop : propDoc ) {
696 m_pyBuf <<
std::setw( 5 ) <<
"'" << prop.first <<
"' : " 697 <<
"\"\"\" " << prop.second <<
" \"\"\",\n";
701 m_pyBuf <<
" def __init__(self, name = " << m_configurable[component_t::DefaultName] <<
", **kwargs):\n" 702 <<
" super(" << cname <<
", self).__init__(name)\n" 703 <<
" for n,v in kwargs.items():\n" 704 <<
" setattr(self, n, v)\n" 705 <<
" def getDlls( self ):\n" 706 <<
" return '" << libName <<
"'\n" 707 <<
" def getType( self ):\n" 708 <<
" return '" << componentName <<
"'\n" 709 <<
" pass # class " << cname <<
"\n" 713 const string pyName = (
fs::path( m_outputDirName ) /
fs::path( libName +
"Conf.py" ) ).
string();
717 m_dbBuf << m_pkgName <<
"." << modName <<
" " << libName <<
" " << cname <<
"\n" <<
flush;
728 if ( ti == typeIndex<bool>() ) {
729 pvalue = ( cvalue ==
"0" || cvalue ==
"False" || cvalue ==
"false" ) ?
"False" :
"True";
731 }
else if ( ti == typeIndex<char>() || ti == typeIndex<signed char>() || ti == typeIndex<unsigned char>() ||
732 ti == typeIndex<short>() || ti == typeIndex<unsigned short>() || ti == typeIndex<int>() ||
733 ti == typeIndex<unsigned int>() || ti == typeIndex<long>() || ti == typeIndex<unsigned long>() ) {
736 }
else if ( ti == typeIndex<long long>() || ti == typeIndex<unsigned long long>() ) {
737 pvalue =
"long(" + cvalue +
")";
739 }
else if ( ti == typeIndex<float>() || ti == typeIndex<double>() ) {
741 pvalue = boost::to_lower_copy( cvalue );
742 if ( pvalue ==
"nan" ) {
743 pvalue =
"float('nan')";
745 }
else if ( std::string::npos == pvalue.
find(
"." ) && std::string::npos == pvalue.
find(
"e" ) ) {
746 pvalue = cvalue +
".0";
749 }
else if ( ti == typeIndex<string>() ) {
750 pvalue =
"'" + cvalue +
"'";
752 }
else if ( ti == typeIndex<GaudiHandleBase>() ) {
757 ptype =
"GaudiHandle";
758 m_importGaudiHandles =
true;
759 }
else if ( ti == typeIndex<GaudiHandleArrayBase>() ) {
764 ptype =
"GaudiHandleArray";
765 m_importGaudiHandles =
true;
766 }
else if ( ti == typeIndex<DataObjectHandleBase>() ) {
771 ptype =
"DataObjectHandleBase";
772 m_importDataObjectHandles =
true;
775 v_str.
setf( std::ios::showpoint );
777 pvalue = v_str.
str();
789 if ( !propMgr || !appUI )
return EXIT_FAILURE;
792 propMgr->setProperty(
"AppName",
"" );
793 propMgr->setProperty(
"OutputLevel",
"7" );
796 msgSvc->setProperty(
"setWarning",
"['DefaultName', 'PropertyHolder']" );
797 msgSvc->setProperty(
"Format",
"%T %0W%M" );
GAUDI_API std::string getEnv(const char *var)
get a particular environment variable (returning "UNKNOWN" if not set)
int genConfig(const Strings_t &modules, const string &userModule)
main entry point of this class:
The ISvcLocator is the interface implemented by the Service Factory in the Application Manager to loc...
The data converters are responsible to translate data from one representation into another.
GAUDI_API std::string format(const char *,...)
MsgStream format utility "a la sprintf(...)".
const GaudiHandleArrayBase & value() const
std::vector< std::string > Strings_t
std::string pythonRepr() const override
std::string toString(const TYPE &obj)
the generic implementation of the type conversion to the string
static Time current()
Returns the current time.
virtual void toStream(std::ostream &out) const =0
value -> stream
SmartIF< IFace > as() const
return a new SmartIF instance to another interface
void setConfigurableDefaultName(const std::string &defaultName)
customize the default name for configurable instances
std::vector< fs::path > LibPathNames_t
void setConfigurableAlgTool(const std::string &cfgAlgTool)
customize the configurable base class for AlgTool component
const std::string name() const
property name
auto get(const Handle &handle, const Algo &, const EventContext &) -> decltype(details::deref(handle.get()))
void * ImageHandle
Definition of an image handle.
std::string pythonRepr() const override
Python representation of handle, i.e.
stringstream m_pyBuf
buffer of auto-generated configurables
DataObjectHandleProperty.h GaudiKernel/DataObjectHandleProperty.h.
void setConfigurableModule(const std::string &moduleName)
customize the Module name where configurable base classes are defined
const std::type_info * type_info() const
property type-info
virtual StatusCode setProperty(const Gaudi::Details::PropertyBase &p)=0
Set the property by property.
int main(int argc, char **argv)
GAUDI_API ISvcLocator * svcLocator()
GAUDIPS_API Logger & logger()
Return the current logger instance.
Definition of the basic interface.
void genHeader(std::ostream &pyOut, std::ostream &dbOut)
PropertyBase base class allowing PropertyBase* collections to be "homogeneous".
stringstream m_dbBuf
buffer of generated configurables informations for the "Db" file The "Db" file is holding information...
configGenerator(const string &pkgName, const string &outputDirName)
void setConfigurableAlgorithm(const std::string &cfgAlgorithm)
customize the configurable base class for Algorithm component
GAUDI_API bool isEnvSet(const char *var)
Check if an environment variable is set or not.
const DataObjectHandleBase & value() const
void init_logging(boost::log::trivial::severity_level level)
Alias for backward compatibility.
Base class of array's of various gaudihandles.
string m_outputDirName
absolute path to the directory where genconf will store auto-generated files (Configurables and Confi...
std::string format(bool local, std::string spec="%c") const
Format the time using strftime.
void pythonizeValue(const PropertyBase *prop, string &pvalue, string &ptype)
handle the "marshalling" of Properties
virtual unsigned long release()=0
Release Interface instance.
DataObjectHandleBase GaudiKernel/DataObjectHandleBase.h.
void genImport(std::ostream &s, const boost::format &frmt, std::string indent)
void setConfigurableService(const std::string &cfgService)
customize the configurable base class for Service component
GAUDI_API const std::string & moduleName()
Get the name of the (executable/DLL) file without file-type.
virtual const std::vector< Gaudi::Details::PropertyBase * > & getProperties() const =0
Get list of properties.
std::map< component_t, std::string > m_configurable
Configurable customization.
string m_pkgName
name of the package we are processing
virtual unsigned long addRef()=0
Increment the reference count of Interface instance.
static GAUDI_API void disableChecking()
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
void genTrailer(std::ostream &pyOut, std::ostream &dbOut)
GAUDI_API const std::string getLastErrorString()
Get last system error as string.
Base class to handles to be used in lieu of naked pointers to various Gaudi components.
const GaudiHandleBase & value() const
virtual StatusCode configure()=0
Configure the job.
bool genComponent(const std::string &libName, const std::string &componentName, component_t componentType, const vector< PropertyBase * > &properties)
The IProperty is the basic interface for all components which have properties that can be set or get.
Base class for all services.
GAUDIPS_API void SetDebug(int debugLevel)
Backward compatibility with Reflex.
virtual std::string toString() const =0
value -> string
void genBody(std::ostream &pyOut, std::ostream &dbOut)
GAUDI_API IAppMgrUI * createApplicationMgr(const std::string &dllname, const std::string &factname)
std::ostream & operator<<(std::ostream &str, const GaudiAlg::ID &id)
Operator overloading for ostream.
Base class from which all concrete auditor classes should be derived.
GAUDI_API unsigned long loadDynamicLib(const std::string &name, ImageHandle *handle)
Load dynamic link library.
void setConfigurableAuditor(const std::string &cfgAuditor)
customize the configurable base class for AlgTool component
T emplace_back(T... args)
std::string pythonRepr() const override
Python representation of array of handles, i.e.