japi-cxx_0.5

Author: bph-c8y

config.xpybuild.py

@@ -0,0 +1,35 @@
+# xpyBuild build file. For inclusion by the root build file. 
+#
+# $Copyright (c) 2018 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.$
+# Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG
+#
+# $Id: config.xpybuild.py 392694 2021-06-29 13:29:16Z sgol $
+#
+
+from xpybuild.propertysupport import *
+from xpybuild.buildcommon import *
+from xpybuild.pathsets import *
+
+# configure build process and modes
+defineEnumerationProperty('BUILD_MODE', default='release', enumValues=['release', 'debug'])
+BUILD_MODE = getBuildInitializationContext().getPropertyValue('BUILD_MODE')
+
+if BUILD_MODE == 'debug':
+    defineStringProperty('DEBUGSUFFIX', "d")
+else:
+    defineStringProperty('DEBUGSUFFIX', "")
+    
+defineStringProperty('PLATFORM', None)    
+defineStringProperty('LIBRARY_EXTENSION', '' if isWindows() else '.0')
+definePathProperty('LIB_BOOST_INCLUDE', None)
+definePathProperty('JAVA_HOME', None)
+definePathProperty('LIB_JNI_INCLUDE', '${JAVA_HOME}/include')
+definePathProperty('DOXYGEN', '/usr/bin/doxygen')
+
+definePathProperty('LIB_DIR', 'lib/')
+definePathProperty('DOC_DIR', 'docs/')
+setGlobalOption('doxygen.exepath', '${DOXYGEN}')
+definePropertiesFromFile('release.properties')
+
+include('platform.${PLATFORM}.xpybuild.py')
+

doxygen.py

@@ -0,0 +1,115 @@
+# $Copyright(c) 2013 Progress Software Corporation (PSC). All rights reserved.$
+# $Copyright (c) 2013-2017 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.$
+# Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG
+#
+# $Id: doxygen.py 392236 2021-06-17 15:25:31Z sgol $
+
+import subprocess, re
+
+from xpybuild.basetarget import BaseTarget
+
+from xpybuild.buildcommon import *
+from xpybuild.utils.buildexceptions import *
+from xpybuild.utils.fileutils import openForWrite, mkdir
+from xpybuild.pathsets import PathSet
+from xpybuild.propertysupport import defineOption
+
+defineOption('doxygen.exepath', None)
+defineOption('doxygen.warnignores', [])
+
+class Doxygen(BaseTarget):
+	def __init__(self, target, source, config, internal=False, dependencies=None, failOnWarnings=False):
+		"""
+		Uses the doxygen tool to generate a directory of API documentation for languages such as C/C++. 
+		
+		@param target: The destination directory. 
+		
+		@param source: pathset listing the top-level source files to be documented. 
+		To avoid classes appearing twice under different namespaces, use "dependencies" not "source" 
+		for files that are #included by source/documented files where the namespace is provided 
+		around the #include statement but not in the file itself. 
+		
+		@param config: the doxygen configuration file. 
+		
+		@param internal: True if items marked as internal/private should be included. 
+		
+		@param dependencies: optional pathset for files that are implicitly depended upon 
+		by the source files to be documented (e.g. due to #include statements) but should not be 
+		handled as source files in their own right (e.g. if the namespace is provided by the 
+		file that #includes them). 
+		
+		@param failOnWarnings: makes this target fail if any warnings are logged to stderr 
+		(the option doxygen.warnignores can be used to ignore expected warnings)
+		"""
+		
+		BaseTarget.__init__(self, target, dependencies=[source, config, dependencies])
+		self.source = PathSet(source)
+		self.config = PathSet(config)
+		self.internal = internal
+		self.failOnWarnings = failOnWarnings
+	
+	# todo: ought to be setting hashable implicit inputs
+	
+	def run(self, context):
+		configtmpl = self.config.resolve(context)
+		assert len(configtmpl)==1, configtmpl
+		configtmpl = configtmpl[0]
+		
+		sources = " ".join(self.source.resolve(context))
+		config = os.path.join(self.workDir, 'doxygen.conf')
+
+		replace = {
+			'INPUT' : sources,
+			'OUTPUT_DIR' : self.path,
+			'INTERNAL':'YES' if self.internal else 'NO',
+			'HIDE_INTERNAL':'NO' if self.internal else 'YES',
+		}
+
+		mkdir(self.workDir)
+		with openForWrite(config, 'wb') as outf:
+			with open(configtmpl, 'rb') as inf:
+				for l in inf:
+					for k in replace:
+						l = l.replace('@%s@' % k, replace[k])
+					outf.write(l)
+
+		exe = context.mergeOptions(self)['doxygen.exepath']
+		if not exe: raise BuildException('doxygen.exepath option must be set')
+		args = [ exe, config ]
+
+		args = [ context.expandPropertyValues(x) for x in args ]
+		#self.log.info('%s doxygen output file is: %s', self, os.path.join(self.workDir, 'doxygen.err'))
+		with open(os.path.join(self.workDir, 'doxygen.out'), 'wb') as stdout:
+			with open(os.path.join(self.workDir, 'doxygen.err'), 'wb') as stderr:
+				subprocess.check_call(args, stdout=stdout, stderr=stderr)
+
+		contents = []
+		with open(os.path.join(self.workDir, 'doxygen.out'), 'r') as stdout:
+			for l in stdout:
+				# Generating docs for compound com::softwareag::connectivity::StatusReporter...
+				if l.startswith('Generating docs for '):
+					# normalize " nested compound " to " compound " since the sorted list is easier to read that way
+					l = l.replace(' nested ', ' ').replace('Generating docs for ','').strip().strip('.')
+					contents.append(l)
+		if contents:
+			with open(os.path.join(self.path, 'html/contents.txt'), 'w') as f:
+				for l in sorted(contents):
+					print >>f, l
+		with open(os.path.join(self.workDir, 'doxygen.err'), 'r') as stderr:
+			errs = []
+			for l in stderr:
+				if not l.strip(): continue
+				if l.startswith(' ') and errs:
+					errs[-1] += ' - '+l.strip()
+				else:
+					errs.append(l.strip())
+			ignores = context.mergeOptions(self)['doxygen.warnignores']
+			errs = [e for e in errs if not any([re.match(i, e) for i in ignores])]
+			if errs:
+				if self.failOnWarnings:
+					self.log.error('Doxygen reported %d lines of stderr warnings for %s; see %s: \n%s', len(errs), self, os.path.join(self.workDir, 'doxygen.err'), '\n  '.join(errs))
+					raise BuildException('Doxygen reported %d lines of stderr warnings (see %s), first is: %s'%(len(errs), os.path.join(self.workDir, 'doxygen.err'), errs[0].strip()))
+				else:
+					self.log.info('Doxygen reported %d lines of stderr warnings for %s; see %s', len(errs), self, os.path.join(self.workDir, 'doxygen.err'))
+
+