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> 73 namespace fs = boost::filesystem;
75 #define LOG_ERROR BOOST_LOG_TRIVIAL( error ) 76 #define LOG_WARNING BOOST_LOG_TRIVIAL( warning ) 77 #define LOG_INFO BOOST_LOG_TRIVIAL( info ) 78 #define LOG_DEBUG BOOST_LOG_TRIVIAL( debug ) 95 const boost::regex pythonIdentifier(
"^[a-zA-Z_][a-zA-Z0-9_]*$" );
115 "Auditor",
"Service",
"ApplicationMgr",
"IInterface",
116 "Converter",
"DataObject",
"Unknown"};
117 return names.
at(
static_cast<std::underlying_type_t<component_t>
>( type ) );
125 static const string in(
"<>&*,: ()." );
126 static const string out(
"__rp__s___" );
127 auto r = boost::algorithm::replace_all_copy( name,
", ",
"," );
128 for (
auto&
c : r ) {
129 auto rep = in.
find(
c );
130 if ( rep != string::npos )
c = out[rep];
135 template <
typename T>
157 bool m_importGaudiHandles =
false;
158 bool m_importDataObjectHandles =
false;
175 : m_pkgName( pkgName ), m_outputDirName( outputDirName )
183 int genConfig(
const Strings_t& modules,
const string& userModule );
191 m_configurable[component_t::DefaultName] = defaultName;
197 m_configurable[component_t::Algorithm] = cfgAlgorithm;
209 m_configurable[component_t::Service] = cfgService;
210 m_configurable[component_t::ApplicationMgr] = cfgService;
226 void pythonizeValue(
const PropertyBase* prop,
string& pvalue,
string& ptype );
234 namespace keywords = boost::log::keywords;
235 namespace expr = boost::log::expressions;
239 << logging::trivial::severity <<
"] " << expr::smessage ) );
249 ? boost::log::trivial::info
250 : boost::log::trivial::warning );
259 po::options_description
generic(
"Generic options" );
260 generic.add_options()(
"help,h",
"produce this help message" )(
261 "package-name,p", po::value<string>(),
"name of the package for which we create the configurables file" )(
262 "input-libraries,i", po::value<string>(),
"libraries to extract the component configurables from" )(
263 "input-cfg,c", po::value<string>(),
"path to the cfg file holding the description of the Configurable base " 264 "classes, the python module holding the Configurable definitions, etc..." )(
265 "output-dir,o", po::value<string>()->default_value(
"../genConf" ),
266 "output directory for genconf files." )(
"debug-level,d", po::value<int>()->default_value( 0 ),
"debug level" )(
267 "load-library,l", po::value<Strings_t>()->composing(),
"preloading library" )(
268 "user-module,m", po::value<string>(),
"user-defined module to be imported by the genConf-generated one" )(
269 "no-init",
"do not generate the (empty) __init__.py" );
273 po::options_description
config(
"Configuration" );
274 config.add_options()(
"configurable-module", po::value<string>()->default_value(
"AthenaCommon" ),
275 "Name of the module holding the configurable classes" )(
276 "configurable-default-name", po::value<string>()->default_value(
"Configurable.DefaultName" ),
277 "Default name for the configurable instance" )(
"configurable-algorithm",
278 po::value<string>()->default_value(
"ConfigurableAlgorithm" ),
279 "Name of the configurable base class for Algorithm components" )(
280 "configurable-algtool", po::value<string>()->default_value(
"ConfigurableAlgTool" ),
281 "Name of the configurable base class for AlgTool components" )(
282 "configurable-auditor", po::value<string>()->default_value(
"ConfigurableAuditor" ),
283 "Name of the configurable base class for Auditor components" )(
284 "configurable-service", po::value<string>()->default_value(
"ConfigurableService" ),
285 "Name of the configurable base class for Service components" );
287 po::options_description cmdline_options;
288 cmdline_options.add(
generic ).add( config );
290 po::options_description config_file_options;
291 config_file_options.add( config );
293 po::options_description visible(
"Allowed options" );
294 visible.add(
generic ).add( config );
296 po::variables_map vm;
299 po::store( po::command_line_parser( argc, argv ).
options( cmdline_options ).run(), vm );
304 if ( vm.count(
"input-cfg" ) ) {
305 string cfgFileName = vm[
"input-cfg"].as<
string>();
306 cfgFileName = fs::system_complete(
fs::path( cfgFileName ) ).
string();
308 po::store( parse_config_file( ifs, config_file_options ), vm );
312 }
catch ( po::error& err ) {
313 LOG_ERROR <<
"error detected while parsing command options: " << err.what();
318 if ( vm.count(
"help" ) ) {
323 if ( vm.count(
"package-name" ) ) {
324 pkgName = vm[
"package-name"].as<
string>();
331 if ( vm.count(
"user-module" ) ) {
332 userModule = vm[
"user-module"].as<
string>();
333 LOG_INFO <<
"INFO: will import user module " << userModule;
336 if ( vm.count(
"input-libraries" ) ) {
344 boost::split( inputLibs, tmp, boost::is_any_of(
" " ), boost::token_compress_on );
349 for (
const auto& iLib : inputLibs ) {
351 if ( lib.
compare( 0, 3,
"lib" ) == 0 ) {
359 if ( libs.
empty() ) {
360 LOG_ERROR <<
"input component library(ies) required !\n";
361 LOG_ERROR <<
"'input-libraries' argument was [" << vm[
"input-libraries"].as<
string>() <<
"]";
365 LOG_ERROR <<
"input component library(ies) required";
370 if ( vm.count(
"output-dir" ) ) {
371 out = fs::system_complete(
fs::path( vm[
"output-dir"].as<string>() ) );
374 if ( vm.count(
"debug-level" ) ) {
378 if ( vm.count(
"load-library" ) ) {
379 for (
const auto& lLib : vm[
"load-library"].as<Strings_t>() ) {
383 if ( err != 1 )
LOG_WARNING <<
"failed to load: " << lLib;
387 if ( !fs::exists( out ) ) {
389 fs::create_directory( out );
390 }
catch ( fs::filesystem_error& err ) {
391 LOG_ERROR <<
"error creating directory: " << err.what();
398 msg <<
":::::: libraries : [ ";
406 py.setConfigurableDefaultName( vm[
"configurable-default-name"].as<string>() );
407 py.setConfigurableAlgorithm( vm[
"configurable-algorithm"].as<string>() );
408 py.setConfigurableAlgTool( vm[
"configurable-algtool"].as<string>() );
409 py.setConfigurableAuditor( vm[
"configurable-auditor"].as<string>() );
410 py.setConfigurableService( vm[
"configurable-service"].as<string>() );
412 int sc = EXIT_FAILURE;
414 sc = py.genConfig( libs, userModule );
416 cout <<
"ERROR: Could not generate Configurable(s) !\n" 417 <<
"ERROR: Got exception: " << e.
what() <<
endl;
421 if ( EXIT_SUCCESS == sc && !vm.count(
"no-init" ) ) {
423 std::fstream initPy( ( out /
fs::path(
"__init__.py" ) ).
string(), std::ios_base::out | std::ios_base::trunc );
424 initPy <<
"## Hook for " << pkgName <<
" genConf module\n" <<
flush;
429 msg <<
":::::: libraries : [ ";
431 msg <<
"] :::::: [DONE]";
444 const auto endLib = libs.
end();
446 static const std::string gaudiSvc =
"GaudiCoreSvc";
447 const bool isGaudiSvc = (
std::find( libs.
begin(), endLib, gaudiSvc ) != endLib );
451 cout <<
"ERROR: ApplicationMgr can not be created. Check environment" <<
endl;
457 Registry&
registry = Registry::instance();
459 auto bkgNames = registry.loadedFactoryNames();
468 for (
const auto& iLib : libs ) {
470 LOG_INFO <<
":::: processing library: " << iLib <<
"...";
473 m_importGaudiHandles =
false;
474 m_importDataObjectHandles =
false;
487 for (
const auto& factoryName : registry.loadedFactoryNames() ) {
488 if ( bkgNames.find( factoryName ) != bkgNames.end() ) {
490 LOG_INFO <<
"\t==> skipping [" << factoryName <<
"]...";
495 const Registry::FactoryInfo info = registry.getInfo( factoryName );
499 if ( info.properties.find(
"ReflexName" ) != info.properties.end() )
continue;
506 LOG_WARNING <<
"library [" << iLib <<
"] exposes factory [" << factoryName <<
"] which is declared in [" 507 << DsoUtils::dsoName( info.ptr ) <<
"] !!";
512 if ( factoryName ==
"ApplicationMgr" )
513 type = component_t::ApplicationMgr;
515 type = component_t::IInterface;
517 type = component_t::Algorithm;
519 type = component_t::Service;
521 type = component_t::AlgTool;
523 type = component_t::Auditor;
525 type = component_t::Converter;
531 if ( type == component_t::IInterface ) {
542 if ( type == component_t::Unknown ) {
544 <<
" Component [" << factoryName <<
"] is skipped !";
548 LOG_INFO <<
" - component: " << info.className <<
" (" 549 << ( info.className != name ? ( name +
": " ) :
std::string() ) << type <<
")";
551 string cname =
"DefaultName";
555 case component_t::Algorithm:
558 case component_t::Service:
559 prop =
SmartIF<IService>( Service::Factory::create( factoryName, cname, svcLoc ) );
561 case component_t::AlgTool:
566 case component_t::Auditor:
567 prop =
SmartIF<IAuditor>( Auditor::Factory::create( factoryName, cname, svcLoc ) );
569 case component_t::ApplicationMgr:
576 LOG_ERROR <<
"Error instantiating " << name <<
" from " << iLib;
581 LOG_ERROR <<
"Error instantiating " << name <<
" from " << iLib;
586 if ( !genComponent( iLib, name, type, prop->
getProperties() ) ) {
591 LOG_ERROR <<
"could not cast IInterface* object to an IProperty* !";
592 LOG_ERROR <<
"return type from PluginSvc is [" << rtype <<
"]...";
593 LOG_ERROR <<
"NO Configurable will be generated for [" << name <<
"] !";
604 std::fstream py( pyName, std::ios_base::out | std::ios_base::trunc );
605 std::fstream db( dbName, std::ios_base::out | std::ios_base::trunc );
608 if ( !userModule.
empty() ) py <<
"from " << userModule <<
" import *" <<
endl;
610 genTrailer( py, db );
617 return allGood ? EXIT_SUCCESS : EXIT_FAILURE;
623 std::string::size_type pos = 0, nxtpos = 0;
626 while ( std::string::npos != pos ) {
628 nxtpos = m_configurable[component_t::Module].find_first_of(
',', pos );
631 mod = m_configurable[component_t::Module].
substr( pos, nxtpos - pos );
637 if ( std::string::npos == nxtpos ) {
639 s << indent <<
import.str() <<
"\n" <<
flush;
640 pos = std::string::npos;
643 s << indent <<
"try:\n" << indent << py_tab <<
import.str() <<
"\n" << indent <<
"except ImportError:\n" <<
flush;
658 <<
"\"\"\"Automatically generated. DO NOT EDIT please\"\"\"\n";
659 if ( m_importGaudiHandles ) {
660 py <<
"from GaudiKernel.GaudiHandles import *\n";
663 if ( m_importDataObjectHandles ) {
664 py <<
"from GaudiKernel.DataObjectHandleBase import DataObjectHandleBase\n";
667 genImport( py,
boost::format(
"from %1%.Configurable import *" ) );
670 db <<
"## -*- ascii -*- \n" 671 <<
"# db file automatically generated by genconf on: " << now <<
"\n" 679 db <<
"## " << m_pkgName <<
"\n" <<
std::flush;
687 auto cname = pythonizeName( componentName );
692 m_pyBuf <<
"\nclass " << cname <<
"( " << m_configurable[componentType] <<
" ) :\n";
693 m_pyBuf <<
" __slots__ = { \n";
694 for (
const auto& prop : properties ) {
695 const string&
pname = prop->name();
697 if ( !boost::regex_match( pname, pythonIdentifier ) ) {
698 std::cout <<
"ERROR: invalid property name \"" << pname <<
"\" in component " << cname
699 <<
" (invalid Python identifier)" <<
std::endl;
701 m_pyBuf <<
" #ERROR-invalid identifier '" << pname <<
"'\n" 706 string pvalue, ptype;
707 pythonizeValue( prop, pvalue, ptype );
708 m_pyBuf <<
" '" << pname <<
"' : " << pvalue <<
", # " << ptype <<
"\n";
710 if ( prop->documentation() !=
"none" ) {
711 propDoc.
emplace_back( pname, prop->documentation() +
" [" + prop->ownerTypeName() +
"]" );
715 m_pyBuf <<
" _propertyDocDct = { \n";
716 for (
const auto& prop : propDoc ) {
717 m_pyBuf <<
std::setw( 5 ) <<
"'" << prop.first <<
"' : " 718 <<
"\"\"\" " << prop.second <<
" \"\"\",\n";
722 m_pyBuf <<
" def __init__(self, name = " << m_configurable[component_t::DefaultName] <<
", **kwargs):\n" 723 <<
" super(" << cname <<
", self).__init__(name)\n" 724 <<
" for n,v in kwargs.items():\n" 725 <<
" setattr(self, n, v)\n" 726 <<
" def getDlls( self ):\n" 727 <<
" return '" << libName <<
"'\n" 728 <<
" def getType( self ):\n" 729 <<
" return '" << componentName <<
"'\n" 730 <<
" pass # class " << cname <<
"\n" 734 const string pyName = (
fs::path( m_outputDirName ) /
fs::path( libName +
"Conf.py" ) ).
string();
738 m_dbBuf << m_pkgName <<
"." << modName <<
" " << libName <<
" " << cname <<
"\n" <<
flush;
749 if ( ti == typeIndex<bool>() ) {
750 pvalue = ( cvalue ==
"0" || cvalue ==
"False" || cvalue ==
"false" ) ?
"False" :
"True";
752 }
else if ( ti == typeIndex<char>() || ti == typeIndex<signed char>() || ti == typeIndex<unsigned char>() ||
753 ti == typeIndex<short>() || ti == typeIndex<unsigned short>() || ti == typeIndex<int>() ||
754 ti == typeIndex<unsigned int>() || ti == typeIndex<long>() || ti == typeIndex<unsigned long>() ) {
757 }
else if ( ti == typeIndex<long long>() || ti == typeIndex<unsigned long long>() ) {
758 pvalue = cvalue +
"L";
760 }
else if ( ti == typeIndex<float>() || ti == typeIndex<double>() ) {
762 pvalue = boost::to_lower_copy( cvalue );
763 if ( pvalue ==
"nan" ) {
764 pvalue =
"float('nan')";
766 }
else if ( std::string::npos == pvalue.
find(
"." ) && std::string::npos == pvalue.
find(
"e" ) ) {
767 pvalue = cvalue +
".0";
770 }
else if ( ti == typeIndex<string>() ) {
771 pvalue =
"'" + cvalue +
"'";
773 }
else if ( ti == typeIndex<GaudiHandleBase>() ) {
778 ptype =
"GaudiHandle";
779 m_importGaudiHandles =
true;
780 }
else if ( ti == typeIndex<GaudiHandleArrayBase>() ) {
785 ptype =
"GaudiHandleArray";
786 m_importGaudiHandles =
true;
787 }
else if ( ti == typeIndex<DataObjectHandleBase>() ) {
792 ptype =
"DataObjectHandleBase";
793 m_importDataObjectHandles =
true;
796 v_str.
setf( std::ios::showpoint );
798 pvalue = v_str.
str();
810 if ( !propMgr || !appUI )
return EXIT_FAILURE;
813 propMgr->setProperty(
"AppName",
"" );
814 propMgr->setProperty(
"OutputLevel",
"7" );
817 msgSvc->
setProperty(
"setWarning",
"['DefaultName', 'PropertyHolder']" );
818 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(...)".
std::vector< std::string > Strings_t
-*- C++ -*- /////////////////////////////
GAUDI_API const std::string typeinfoName(const std::type_info &)
Get platform independent information about the class type.
const std::string name() const
property name
static Time current()
Returns the current time.
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
void * ImageHandle
Definition of an image handle.
virtual std::string toString() const =0
value -> string
stringstream m_pyBuf
buffer of auto-generated configurables
GAUDIPS_API Logger & logger()
Return the current logger instance.
virtual void toStream(std::ostream &out) const =0
value -> stream
DataObjectHandleProperty.h GaudiKernel/DataObjectHandleProperty.h.
void setConfigurableModule(const std::string &moduleName)
customize the Module name where configurable base classes are defined
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
int main(int argc, char **argv)
GAUDI_API ISvcLocator * svcLocator()
General service interface definition.
Definition of the basic interface.
const GaudiHandleBase & value() const
void genHeader(std::ostream &pyOut, std::ostream &dbOut)
const GaudiHandleArrayBase & value() const
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)
The IAlgorithm is the interface implemented by the Algorithm base class.
std::string pythonRepr() const override
Python representation of array of handles, i.e.
void setConfigurableAlgorithm(const std::string &cfgAlgorithm)
customize the configurable base class for Algorithm component
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.
void init_logging(boost::log::trivial::severity_level level)
Base class from which all concrete algorithm classes should be derived.
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...
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)
std::string pythonRepr() const override
Python representation of handle, i.e.
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.
std::string pythonRepr() const override
std::map< component_t, std::string > m_configurable
Configurable customization.
In-memory database of the loaded factories.
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)
const DataObjectHandleBase & value() const
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.
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.
A DataObject is the base class of any identifiable object on any data store.
The IAuditor is the interface implmented by the AlgAuditor base class.
std::string libNativeName(const std::string &libName)
void genBody(std::ostream &pyOut, std::ostream &dbOut)
std::string toString(const Type &)
const std::type_info * type_info() const
property type-info
std::string format(bool local, std::string spec="%c") const
Format the time using strftime.
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