SCons/CMake single function setup

Author: Vano

CMakeLists.txt

@@ -66,27 +66,47 @@ if(${GODOT_CPP_WARNING_AS_ERROR})
 endif()
 
 ###############################
+# godot-cppscript creation
+
+# include module
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/")
 include(godot-cppscript)
 
-set(INCLUDE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/../src)
-set(GEN_DIR ${CMAKE_CURRENT_SOURCE_DIR}/../.gen)
-
+# Get header files (.hpp only)
 file(GLOB_RECURSE CPPSCRIPT_HEADERS ../src/*.hpp)
 
-get_target_property(DEFS ${PROJECT_NAME} COMPILE_DEFINITIONS)
-get_target_property(INC_PATHS ${PROJECT_NAME} INCLUDE_DIRECTORIES)
+# Optional
+
+# C++ defines (TOOLS_ENABLED, DEBUG_METHODS etc.)
+# enable, if you conditionally enable classes/members
+# based on definitions
+#get_target_property(DEFS ${PROJECT_NAME} COMPILE_DEFINITIONS)
+
+# Include paths
+# (try to avoid godot-cpp headers paths,
+# it slows parsing drastically)
+#get_target_property(INC_PATHS ${PROJECT_NAME} INCLUDE_DIRECTORIES)
 create_cppscript_target(
+	# Name of your main target
+	${PROJECT_NAME}
+
+	# Name of header to be included to enable cppscript
+	# (Prefer name unique to your project)
 	cppscript.h
-	${INCLUDE_DIR}
-	${GEN_DIR}
+
+	# FULL PATH to C++ header files
+	${CMAKE_CURRENT_SOURCE_DIR}/../src
+
+	# FULL PATH to generated object files
+	${CMAKE_CURRENT_SOURCE_DIR}/../.gen
+
+	# Generate bindings to public methods automatically
+	# or require GMETHOD() before methods
 	ON
-	"${INC_PATHS}"
-	"${DEFS}"
-	CPPSCRIPT_MY_SOURCES
-)
 
-target_sources(${PROJECT_NAME} PRIVATE ${CPPSCRIPT_MY_SOURCES})
-target_include_directories(${PROJECT_NAME} PRIVATE ${INCLUDE_DIR} src)
+	# Optional
+	""	# OR "${INC_PATHS}"
+	""	# OR "${DEFS}"
+)
 ###############################
 

SConstruct

@@ -1,4 +1,4 @@
-from cppscript import GlobRecursive, generate_header_scons, generate_header_emitter
+from cppscript import create_cppscript_target, GlobRecursive
 import os
 
 SRC_DIR = '../src'
@@ -9,37 +9,56 @@ env = SConscript('godot-cpp/SConstruct').Clone()
 sources = GlobRecursive(SRC_DIR, '*.cpp')
 scripts = GlobRecursive(SRC_DIR, '*.hpp')
 
-env.Append(CPPPATH=[SRC_DIR, 'src'])
-								# CppScript config
-env['header_name'] = 'cppscript.h'				# Name of header to be included to enable cppscript
-								# (Prefer name unique to your project)
-env['header_dir'] = SRC_DIR					# Path to C++ header files
-env['gen_dir'] = "../.gen"					# Path for generated object files
-env['auto_methods'] = True					# Generate bindings to public methods automatically
-								# Or require GMETHOD() before methods
 env.Append(CXXFLAGS='-fdiagnostics-color=always')
-env.Append(BUILDERS={'CppScript' : Builder(
-    action=generate_header_scons,
-    emitter=generate_header_emitter)})
 
-generated = env.CppScript(scripts)
-header, *bindings = generated
+generated = create_cppscript_target(
+		env,		# SCons env, env.Clone() for different projects
+		scripts,	# Header files to parse (.hpp only)
 
-env.Precious(generated)
+		# CppScript config
+		{
+		# Name of header to be included to enable cppscript
+		# (Prefer name unique to your project)
+		'header_name' : 'cppscript.h',
+
+		# Path to C++ header files
+		'header_dir' : SRC_DIR,
+
+		# Path to generated object files
+		'gen_dir' : "../.gen",
+
+		# Generate bindings to public methods automatically
+		# or require GMETHOD() before methods
+		'auto_methods' : True,
+
+		# Optional
+
+		## C++ defines (TOOLS_ENABLED, DEBUG_METHODS etc.)
+		## enable, if you conditionally enable classes/members
+		## based on definitions
+		#'compile_defs' : env['CPPDEFINES'],
+		#
+		## Include paths
+		## (try to avoid godot-cpp headers paths,
+		## it slows parsing drastically)
+		#'include_paths' : env['CPPPATH']
+		}
+)
 
 if env["platform"] == "macos":
     library = env.SharedLibrary(
 	"../bin/lib{}.{}.{}.framework/lib{}.{}.{}".format(
 	library_name, env["platform"], env["target"], library_name, env["platform"], env["target"]
 	),
-	source=sources + bindings,
+	source=sources + generated, # Add generated source files to target
     )
 else:
     library = env.SharedLibrary(
 	"../bin/lib{}{}{}".format(library_name, env["suffix"], env["SHLIBSUFFIX"]),
-	source=sources + bindings,
+	source=sources + generated, # Add generated source files to target
     )
 
+# Rebuild after headers change
 env.Depends(library[0].sources, generated)
 
 Default(library)

cmake/godot-cppscript.cmake

@@ -3,10 +3,15 @@ find_package(Python3 3.4 REQUIRED)
 set(CPPSCRIPT_DIR ${CMAKE_CURRENT_LIST_DIR}/..)
 
 #TODO: make it work in parallel
-function(create_cppscript_target HEADER_NAME HEADERS_DIR GEN_DIR AUTO_METHODS INCLUDE_PATHS COMPILE_DEFS CPPSCRIPT_SOURCES)
+function(create_cppscript_target TARGET_NAME HEADER_NAME HEADERS_DIR GEN_DIR AUTO_METHODS INCLUDE_PATHS COMPILE_DEFS)
+	# Handle empty lists
 	if("${COMPILE_DEFS}" STREQUAL "DEFS-NOTFOUND")
 		set(COMPILE_DEFS "")
 	endif()
+	if("${INCLUDE_PATHS}" STREQUAL "INC_PATHS-NOTFOUND")
+		set(INCLUDE_PATHS "")
+	endif()
+
 	if(${AUTO_METHODS})
 		set(AUTO_METHODS_STR "True")
 	else()
@@ -19,7 +24,6 @@ function(create_cppscript_target HEADER_NAME HEADERS_DIR GEN_DIR AUTO_METHODS IN
 		string(REGEX REPLACE "\.hpp$" ".gen.cpp" relative_path "${PATH}")
 		list(APPEND SOURCES_LIST ${GEN_DIR}/${relative_path})
 	endforeach()
-	set(${CPPSCRIPT_SOURCES} ${SOURCES_LIST} PARENT_SCOPE)
 
 	add_custom_command(
 		OUTPUT
@@ -44,5 +48,8 @@ function(create_cppscript_target HEADER_NAME HEADERS_DIR GEN_DIR AUTO_METHODS IN
 		VERBATIM
 		COMMENT "Parsing header files..."
 	)
+
+	target_sources(${TARGET_NAME} PRIVATE ${SOURCES_LIST})
+	target_include_directories(${TARGET_NAME} PUBLIC ${HEADERS_DIR} ${CPPSCRIPT_DIR}/src)
 endfunction()
 

cppscript.py

@@ -3,6 +3,36 @@
 
 if 'NOT_SCONS' not in os.environ.keys():
 	from SCons.Script import Glob
+	from SCons.Builder import Builder
+
+	def create_cppscript_target(env, sources, cppscript_env, *args, **kwargs):
+		if not 'CppScript' in env['BUILDERS'].keys():
+			env.Append(BUILDERS={'CppScript' : CppScriptBuilder()})
+		
+		return env.CppScript(sources, cppscript_env, *args, **kwargs)
+
+	class CppScriptBuilder():
+		def __init__(self, *args, **kwargs):
+			self.builder = Builder(action=generate_header_scons, emitter=generate_header_emitter, *args, **kwargs)
+
+		def __call__(self, scons_env, source, call_args, *args, **kwargs):
+			env, *other = call_args
+			cppscript_src = os.path.join(os.path.dirname(__file__), 'src')
+			# Convert scons variables to cppscript's env
+			scons_env['cppscript_env'] = {
+					'header_name' : env['header_name'],
+					'header_dir' : env['header_dir'],
+					'gen_dir' : env['gen_dir'],
+					'compile_defs' : [f'{i[0]}={i[1]}' if type(i) is tuple else str(i) for i in env.get('compile_defs', [])],
+					'include_paths' : [cppscript_src] + env.get('include_paths', []),
+					'auto_methods' : env['auto_methods']
+				}
+
+			# Append needed directories
+			scons_env.Append(CPPPATH=[cppscript_src, env['header_dir']])
+			return self.builder(scons_env, source=source, *other, *args, **kwargs)
+
+
 	def GlobRecursive(path, pattern, **kwargs):
 		found = []
 		for root, dirs, files in os.walk(path):
@@ -151,29 +181,23 @@ def is_virtual_method(cursor):
 
 # Builder
 def generate_header_emitter(target, source, env):
-	return [env.File(os.path.join(env['header_dir'], 'scripts.gen.h'))] + [env.File(filename_to_gen_filename(str(i), env)) for i in source], source
+	generated = [env.File(filename_to_gen_filename(str(i), env['cppscript_env'])) for i in source]
 
+	# To avoid generated sources deletion and re-parsing
+	env.Precious(generated)
 
-def generate_header_scons(target, source, env):
-	# Convert scons variables to cppscript's env
-	cppscript_env = {
-			'header_name' : env['header_name'],
-			'header_dir' : env['header_dir'],
-			'gen_dir' : env['gen_dir'],
-			'compile_defs' : [f'{i[0]}={i[1]}' if type(i) is tuple else str(i) for i in env['CPPDEFINES']],
-			'include_paths' : env['CPPPATH'],
-			'auto_methods' : env['auto_methods']
-		}
+	return generated, source
 
 
-	return generate_header(target, source, cppscript_env, get_file_scons)
+def generate_header_scons(target, source, env):
+	return generate_header(source, env['cppscript_env'], get_file_scons)
 
 
 def generate_header_cmake(source, env):
-	return generate_header(None, source, env, get_file_cmake)
+	return generate_header(source, env, get_file_cmake)
 
 
-def generate_header(target, source, env, get_file):
+def generate_header(source, env, get_file):
 	index = Index.create()
 	prop_file_name = os.path.join(env['header_dir'], 'properties.gen.h')