Merge pull request #5476 from ubirch/add-cmake-export

add cmake exporter for CLion use
pull/5917/merge
Cruz Monrreal 2018-01-26 15:07:55 -06:00 committed by GitHub
commit 6e964a6fe4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 374 additions and 1 deletions

View File

@ -33,6 +33,7 @@ from tools.export import embitz, coide, kds, simplicity, atmelstudio, mcuxpresso
from tools.export import sw4stm32, e2studio, zip, cmsis, uvision, cdt, vscode
from tools.export import gnuarmeclipse
from tools.export import qtcreator
from tools.export import cmake
from tools.export import nb
from tools.targets import TARGET_NAMES
@ -63,7 +64,8 @@ EXPORTERS = {
'qtcreator': qtcreator.QtCreator,
'vscode_gcc_arm' : vscode.VSCodeGcc,
'vscode_iar' : vscode.VSCodeIAR,
'vscode_armc5' : vscode.VSCodeArmc5
'vscode_armc5' : vscode.VSCodeArmc5,
'cmake_gcc_arm': cmake.GccArm
}
ERROR_MESSAGE_UNSUPPORTED_TOOLCHAIN = """

View File

@ -0,0 +1,106 @@
# This file was automagically generated by mbed.org.
# If you would like to add your own targets, create a
# project.cmake file locally in your project directory.
CMAKE_MINIMUM_REQUIRED(VERSION 3.9)
SET(CMAKE_SYSTEM_NAME Generic)
#SET(CMAKE_SYSTEM_PROCESSOR arm)
SET(CMAKE_CROSSCOMPILING TRUE)
# force compiler settings
SET(CMAKE_C_COMPILER_WORKS TRUE)
SET(CMAKE_CXX_COMPILER_WORKS TRUE)
# force cmake compilers
SET(CMAKE_ASM_COMPILER "{{asm}}")
SET(CMAKE_C_COMPILER "{{cc}}")
SET(CMAKE_CXX_COMPILER "{{cxx}}")
SET(ELF2BIN "{{elf2bin}}")
{% if hex_files %}
SET(SREC_CAT "srec_cat")
{%- endif %}
# if the environment does not specify build type, set to Debug
IF(NOT CMAKE_BUILD_TYPE)
set(CMAKE_BUILD_TYPE "Debug"
CACHE STRING "Choose the type of build, options are: Debug Release RelWithDebInfo MinSizeRel."
FORCE)
ENDIF()
# here starts the project
PROJECT({{name}} C CXX ASM)
# uncomment below to have a verbose build process
#SET(CMAKE_VERBOSE_MAKEFILE ON)
SET(LD_SYS_LIBS "{%- block sys_libs -%} -Wl,--start-group {{ld_sys_libs|join(" ")}} {{libraries|join(" ")}} -Wl,--end-group {%- endblock -%}")
SET(CMAKE_C_FLAGS "{{cc_flags}} -include mbed_config.h")
SET(CMAKE_CXX_FLAGS "{{cxx_flags}} -include mbed_config.h")
SET(CMAKE_ASM_FLAGS "{{asm_flags}} -include mbed_config.h")
SET(CMAKE_CXX_LINK_FLAGS "{{ld_flags}} {% for p in library_paths %} {{user_library_flag}}${CMAKE_CURRENT_SOURCE_DIR}/{{p}} {% endfor %}")
{% if pp -%}
SET(CMAKE_CXX_LINK_FLAGS "${CMAKE_CXX_LINK_FLAGS} ${LD_SYS_LIBS} {{link_script_option}} ${CMAKE_BINARY_DIR}/{{name}}_pp.link_script.ld")
{%- endif %}
ADD_DEFINITIONS(
{% for d in symbols %}-D{{d}}
{% endfor %})
INCLUDE_DIRECTORIES(
{% for p in include_paths %}{{p}}
{% endfor %})
# executable {{name}}
ADD_EXECUTABLE({{name}}
{% for src in sources %}{{src}}
{% endfor %})
SET_TARGET_PROPERTIES({{name}} PROPERTIES ENABLE_EXPORTS 1)
# add syslibs dependencies to create the correct linker order
TARGET_LINK_LIBRARIES({{name}} {{ld_sys_libs|join(" ")}})
{% if pp -%}
add_custom_command(TARGET {{name}} PRE_LINK
COMMAND "{{pp}}" {{pp_flags}} {{linker_script}} -o ${CMAKE_CURRENT_BINARY_DIR}/{{name}}_pp.link_script.ld
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
BYPRODUCTS "${CMAKE_CURRENT_BINARY_DIR}/{{name}}_pp.link_script.ld"
)
{%- endif %}
add_custom_command(TARGET {{name}} POST_BUILD
COMMAND ${ELF2BIN} -O ihex $<TARGET_FILE:{{name}}> $<TARGET_FILE:{{name}}>.hex
COMMAND ${CMAKE_COMMAND} -E echo "-- built: $<TARGET_FILE:{{name}}>.hex"
)
##########################################################################
# mbed-cli specific targets
##########################################################################
# detect the build type and select the corresponding cli profile
SET(MBED_BUILD_PROFILE "")
STRING(TOLOWER ${CMAKE_BUILD_TYPE} LOWERCASE_CMAKE_BUILD_TYPE)
IF(LOWERCASE_CMAKE_BUILD_TYPE MATCHES debug)
SET(MBED_BUILD_PROFILE "mbed-os/tools/profiles/debug.json")
ELSEIF(LOWERCASE_CMAKE_BUILD_TYPE MATCHES relwithdebinfo)
SET(MBED_BUILD_PROFILE "mbed-os/tools/profiles/develop.json")
ELSEIF(LOWERCASE_CMAKE_BUILD_TYPE MATCHES release)
SET(MBED_BUILD_PROFILE "mbed-os/tools/profiles/release.json")
ELSEIF(LOWERCASE_CMAKE_BUILD_TYPE MATCHES minsizerel)
SET(MBED_BUILD_PROFILE "mbed-os/tools/profiles/release.json")
ELSE()
MESSAGE(WARNING "Build type '${CMAKE_BUILD_TYPE}' is unknown, using debug profile")
SET(MBED_BUILD_PROFILE "mbed-os/tools/profiles/debug.json")
ENDIF()
# optional custom target to build via mbed-cli
ADD_CUSTOM_TARGET(mbed-cli-build
COMMAND ${CMAKE_COMMAND} -E echo "mbed compile --build BUILD/${CMAKE_BUILD_TYPE} --profile ${MBED_BUILD_PROFILE}"
COMMAND mbed compile --build BUILD/${CMAKE_BUILD_TYPE} --profile ${MBED_BUILD_PROFILE}
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
SOURCES ${SOURCE_FILES} ${SYS_SOURCE_FILES})
IF(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/project.cmake)
INCLUDE(${CMAKE_CURRENT_SOURCE_DIR}/project.cmake)
ELSE()
MESSAGE(STATUS "Add a local project.cmake file to add your own targets.")
ENDIF()

View File

@ -0,0 +1,15 @@
# CLion CMakeLists.txt Generator
This exporter generates a CMakeLists.txt file that can be used to
develop mbed using [IntelliJ CLion](https://www.jetbrains.com/clion/).
It will not create a functional CMake build system that mimics the
mbed build system, but rather uses the mbed-cli itself to compile
the targets. The generated files help CLion to understand the
includes and dependencies of your code.
Run the following command to create/overwrite your CMakeLists.txt.
```
mbed export -i cmake_gcc_arm
```
> Run the command again if files or libraries have been added or removed.

View File

@ -0,0 +1,250 @@
"""
mbed SDK
Copyright (c) 2011-2016 ARM Limited
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""
import re
import shutil
from os import remove, getcwd, chdir, mkdir
from os.path import basename, exists
from subprocess import Popen, PIPE
from jinja2.exceptions import TemplateNotFound
from tools.export.exporters import Exporter, apply_supported_whitelist
from tools.targets import TARGET_MAP
class CMake(Exporter):
"""Generic CMake template that mimics the behavior of the python build
system
"""
TEMPLATE = 'CMakeLists.txt'
MBED_CONFIG_HEADER_SUPPORTED = True
PREPROCESS_ASM = False
POST_BINARY_WHITELIST = set([
"MCU_NRF51Code.binary_hook",
"TEENSY3_1Code.binary_hook",
"LPCTargetCode.lpc_patch",
"LPC4088Code.binary_hook"
])
@classmethod
def is_target_supported(cls, target_name):
target = TARGET_MAP[target_name]
return apply_supported_whitelist(
cls.TOOLCHAIN, cls.POST_BINARY_WHITELIST, target)
def generate(self):
"""Generate the CMakefiles.txt
"""
self.resources.win_to_unix()
# get all source files including headers, adding headers allows IDEs to detect which files
# belong to the project, otherwise headers may be greyed out and not work with inspection
# (that is true for CLion and definitely for Visual Code)
srcs = set(self.resources.c_sources +
self.resources.cpp_sources +
self.resources.s_sources +
self.resources.headers)
srcs = [re.sub(r'^[.]/', '', f) for f in srcs]
# additional libraries
libraries = [self.prepare_lib(basename(lib)) for lib in self.resources.libraries]
sys_libs = [self.prepare_sys_lib(lib) for lib in self.toolchain.sys_libs]
# sort includes reverse, so the deepest dir comes first (ensures short includes)
includes = sorted([re.sub(r'^[.]/', '', l) for l in self.resources.inc_dirs], reverse=True)
ctx = {
'name': self.project_name,
'target': self.target,
'sources': sorted(srcs),
'libraries': libraries,
'ld_sys_libs': sys_libs,
'include_paths': includes,
'library_paths': sorted([re.sub(r'^[.]/', '', l) for l in self.resources.lib_dirs]),
'linker_script': self.resources.linker_script,
'hex_files': self.resources.hex_files,
'ar': basename(self.toolchain.ar),
'cc': basename(self.toolchain.cc[0]),
'cc_flags': " ".join(flag for flag in self.toolchain.cc[1:] if not flag == "-c"),
'cxx': basename(self.toolchain.cppc[0]),
'cxx_flags': " ".join(flag for flag in self.toolchain.cppc[1:] if not flag == "-c"),
'asm': basename(self.toolchain.asm[0]),
'asm_flags': " ".join(flag for flag in self.toolchain.asm[1:] if not flag == "-c"),
'symbols': sorted(self.toolchain.get_symbols()),
'ld': basename(self.toolchain.ld[0]),
# fix the missing underscore '_' (see
'ld_flags': re.sub("--wrap,_(?!_)", "--wrap,__", " ".join(self.toolchain.ld[1:])),
'elf2bin': basename(self.toolchain.elf2bin),
'link_script_ext': self.toolchain.LINKER_EXT,
'link_script_option': self.LINK_SCRIPT_OPTION,
'user_library_flag': self.USER_LIBRARY_FLAG,
'needs_asm_preproc': self.PREPROCESS_ASM,
}
if hasattr(self.toolchain, "preproc"):
ctx['pp'] = basename(self.toolchain.preproc[0])
ctx['pp_flags'] = " ".join(self.toolchain.preproc[1:] +
self.toolchain.ld[1:])
else:
ctx['pp'] = None
ctx['pp_flags'] = None
try:
self.gen_file('cmake/%s.tmpl' % self.TEMPLATE, ctx, 'CMakeLists.txt')
except TemplateNotFound:
pass
@staticmethod
def build(project_name, log_name="build_log.txt", cleanup=True):
""" Build Make project """
# change into our build directory
current_dir = getcwd()
if not exists("BUILD"):
mkdir("BUILD")
chdir("BUILD")
# > run cmake initial command
cmd = ["cmake", ".."]
# Build the project
p = Popen(cmd, stdout=PIPE, stderr=PIPE)
out, err = p.communicate()
ret_code = p.returncode
if ret_code == 0:
# we create the cmake files inside BUILD, change into and run cmake
# > run make -j
cmd = ["make", "-j"]
p = Popen(cmd, stdout=PIPE, stderr=PIPE)
out, err = p.communicate()
ret_code = p.returncode
# go back to the original directory
chdir(current_dir)
out_string = "=" * 10 + "STDOUT" + "=" * 10 + "\n"
out_string += out
out_string += "=" * 10 + "STDERR" + "=" * 10 + "\n"
out_string += err
if ret_code == 0:
out_string += "SUCCESS"
else:
out_string += "FAILURE"
print out_string
if log_name:
# Write the output to the log file
with open(log_name, 'w+') as f:
f.write(out_string)
# Cleanup the exported and built files
if cleanup:
remove("CMakeLists.txt")
remove(log_name)
# legacy .build directory cleaned if exists
if exists('.build'):
shutil.rmtree('.build')
if exists('BUILD'):
shutil.rmtree('BUILD')
if ret_code != 0:
# Seems like something went wrong.
return -1
else:
return 0
class GccArm(CMake):
"""GCC ARM specific cmake target"""
NAME = 'CMake-GCC-ARM'
TOOLCHAIN = "GCC_ARM"
LINK_SCRIPT_OPTION = "-T"
USER_LIBRARY_FLAG = "-L"
@staticmethod
def prepare_lib(libname):
if "lib" == libname[:3]:
libname = libname[3:-2]
return "-l" + libname
@staticmethod
def prepare_sys_lib(libname):
return "-l" + libname
# class Arm(CMake):
# """ARM Compiler generic cmake target"""
# LINK_SCRIPT_OPTION = "--scatter"
# USER_LIBRARY_FLAG = "--userlibpath "
#
# @staticmethod
# def prepare_lib(libname):
# return libname
#
# @staticmethod
# def prepare_sys_lib(libname):
# return libname
#
# def generate(self):
# if self.resources.linker_script:
# new_script = self.toolchain.correct_scatter_shebang(
# self.resources.linker_script)
# if new_script is not self.resources.linker_script:
# self.resources.linker_script = new_script
# self.generated_files.append(new_script)
# return super(Arm, self).generate()
#
#
# class Armc5(Arm):
# """ARM Compiler 5 (armcc) specific makefile target"""
# NAME = 'CMake-ARMc5'
# TOOLCHAIN = "ARM"
# PREPROCESS_ASM = True
#
#
# class Armc6(Arm):
# """ARM Compiler 6 (armclang) specific generic makefile target"""
# NAME = 'CMake-ARMc6'
# TOOLCHAIN = "ARMC6"
#
#
# class IAR(CMake):
# """IAR specific cmake target"""
# NAME = 'CMake-IAR'
# TOOLCHAIN = "IAR"
# LINK_SCRIPT_OPTION = "--config"
# USER_LIBRARY_FLAG = "-L"
#
# @staticmethod
# def prepare_lib(libname):
# if "lib" == libname[:3]:
# libname = libname[3:]
# return "-l" + splitext(libname)[0]
#
# @staticmethod
# def prepare_sys_lib(libname):
# if "lib" == libname[:3]:
# libname = libname[3:]
# return "-l" + splitext(libname)[0]