Mentions légales du service

Skip to content
Snippets Groups Projects
Commit f6721d74 authored by hhakim's avatar hhakim
Browse files

Enhance cmake post-processing of matfaust scripts (experimental code filtering... 

Enhance cmake post-processing of matfaust scripts (experimental code filtering and inline doc generation).

- Replace configure_file() by cmake targets (it avoids to copy/filter scripts each time when building, but only when they change).
- Make the dependencies more consistent, first filter experimental code (if it applies) then filter for inline doc.
- Sanitize gen_doc/gen_matlab_inline_doc_from_doxy_blocks.sh and misc/binpkg_postinst_scripts/filter_experimental_code.py to avoid errors when none operation is needed.
parent ccae65d6
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
gen_doc/Doxyfile.in
+ 1
− 1
View file @ f6721d74
......@@ -464,7 +464,7 @@ INPUT = "@PROJECT_BINARY_DIR@/doc/mainpage.md" \
"@FAUST_ALGORITHM_FACTORIZATION_SRC_DIR@" \
"@FAUST_BIN_CMDLINE_SRC_DIR@" \
"@FAUST_BIN_TEST_SRC_DIR@" \
@FAUST_PYTHON_BIN_DIR@ @PROJECT_BINARY_DIR@/tmp_gendoc_matfaust # @FAUST_MATLAB_BIN_DIR@
@FAUST_PYTHON_BIN_DIR@ @PROJECT_BINARY_DIR@/@FAUST_MATLAB_BIN_DIR@
USE_MDFILE_AS_MAINPAGE = mainpage
INPUT_ENCODING = UTF-8
......
gen_doc/gen_matlab_inline_doc_from_doxy_blocks.sh
+ 7
− 3
View file @ f6721d74
......@@ -10,6 +10,7 @@ function usage {
}
function usage_exit {
[[ $# -gt 1 ]] && echo "error: $2" >&2
usage
exit $1
}
......@@ -38,8 +39,9 @@ function parse_doxy_block {
# parse input args
[[ $# -ge 2 && -r "$1" ]] && INPUT_FILE="$1" || usage_exit 1
[[ -z $(dirname "$2") || -d "$(dirname $2)" ]] && OUTPUT_FILE="$2" || usage_exit 2
[[ $# -ge 2 ]] && INPUT_FILE="$1" || usage_exit 1
[[ ! -r $1 ]] && exit 0
[[ -n "$2" ]] && OUTPUT_FILE="$2" || usage_exit 2 "arg 2 is empty"
# get function names
FUNCTIONS=$(sed -ne 's/^[[:blank:]]*function[[:blank:]]\{1,\}\([^=]\{1,\}=\)\{0,1\}[[:blank:]]*\([^([:blank:]]\{1,\}\).*$/\2/p' "$INPUT_FILE")
......@@ -47,6 +49,7 @@ FUNCTIONS=$(sed -ne 's/^[[:blank:]]*function[[:blank:]]\{1,\}\([^=]\{1,\}=\)\{0,
[[ -z "${FUNCTIONS}" ]] && echo "ERROR in getting the list of functions in $INPUT_FILE" && exit 3
mkdir -p $(dirname "$OUTPUT_FILE")
cp "$INPUT_FILE" "$OUTPUT_FILE"
[ ! "$?" = 0 ] && echo "ERROR in copying file." >&2 && exit 4
......@@ -107,4 +110,5 @@ echo -e "$INLINE_HEADER" | sed 's/^[[:blank:]]\{1,\}//' > ${OUTPUT_FILE}_tmp
echo -e '\n\n' >> ${OUTPUT_FILE}_tmp
sed -ne "${HEADER_START_END[0]},${OUT_NUM_LINES}p" $OUTPUT_FILE >> ${OUTPUT_FILE}_tmp
[ "$?" = 0 ] && mv ${OUTPUT_FILE}_tmp ${OUTPUT_FILE}
[[ -z "$DEBUG" ]] && rm ${OUTPUT_FILE}_tmp
[[ -z "$DEBUG" && -r "${OUTPUT_FILE}_tmp" ]] && rm ${OUTPUT_FILE}_tmp
exit 0
misc/binpkg_postinst_scripts/filter_experimental_code.py
+ 7
− 0
View file @ f6721d74
#!/usr/bin/env python
import re, sys
from os.path import exists
EXP_BLOCK_START="^(#|%) experimental block start"
EXP_BLOCK_END="^(#|%) experimental block end"
......@@ -16,6 +17,9 @@ else:
if(len(sys.argv) >= 2):
for script in [sys.argv[1]]:
if(not exists(script)):
print(script, "doesn't exist.")
continue
in_exp_block = False
if sys.version_info[0] < 3:
# python2 doesn't provide encoding argument
......@@ -45,6 +49,9 @@ if(len(sys.argv) >= 3):
outf.writelines(out_lines)
outf.close()
else:
if(not exists(sys.argv[2])):
print(sys.argv[2], "doesn't exist.")
exit(0)
print("deleting file:", sys.argv[2])
# delete the file
import os
......
wrapper/matlab/CMakeLists.txt
+ 47
− 24
View file @ f6721d74
......@@ -23,43 +23,65 @@ foreach(MATLAB_TOOL ${MATLAB_TOOLS})
#install(FILES ${FAUST_MATLAB_TOOL_BIN_DIR}/${MATLAB_TOOL}.m DESTINATION ${FAUST_MATLAB_TOOL_INSTALL_DIR} PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_WRITE GROUP_EXECUTE WORLD_READ WORLD_WRITE WORLD_EXECUTE)
endforeach()
FILE(COPY ${FAUST_MATLAB_NAMESPACE_SRC_DIR} DESTINATION ${PROJECT_BINARY_DIR}/tmp_gendoc_matfaust)
#FILE(COPY ${FAUST_MATLAB_NAMESPACE_SRC_DIR} DESTINATION ${PROJECT_BINARY_DIR}/tmp_gendoc_matfaust)
#message(FATAL_ERROR ${FAUST_MATLAB_MATFAUST_FILE_LIST})
foreach(MATFAUST_FILE IN LISTS FAUST_MATLAB_MATFAUST_FILE_LIST)
string(REGEX REPLACE "[^+]*\\+matfaust\\/" "" MATFAUST_FILE ${MATFAUST_FILE})
get_filename_component(PARENT_DIR ${MATFAUST_FILE} DIRECTORY)
get_filename_component(MATFAUST_SHORT_FILE ${MATFAUST_FILE} NAME_WE )
file(MAKE_DIRECTORY ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${PARENT_DIR})
message(STATUS "Creating folder ${PARENT_DIR}")
file(MAKE_DIRECTORY ${FAUST_MATLAB_BIN_DIR}/expfiltered)
set_property(DIRECTORY PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "${FAUST_MATLAB_BIN_DIR}/expfiltered" "${FAUST_MATLAB_BIN_DIR}/+matfaust")
if(EXPERIMENTAL_PKG)
add_custom_command(
OUTPUT ${FAUST_MATLAB_BIN_DIR}/expfiltered/${MATFAUST_FILE}
COMMAND ${CMAKE_COMMAND} -E make_directory ${FAUST_MATLAB_BIN_DIR}/expfiltered/${PARENT_DIR}
COMMAND
${CMAKE_COMMAND} -E copy
${FAUST_MATLAB_NAMESPACE_SRC_DIR}/${MATFAUST_FILE}
${FAUST_MATLAB_BIN_DIR}/expfiltered/${MATFAUST_FILE}
DEPENDS ${FAUST_MATLAB_NAMESPACE_SRC_DIR}/${MATFAUST_FILE}
COMMENT "Copying matfaust ${MATFAUST_FILE} code including experimental code.")
else()
add_custom_command(
OUTPUT ${FAUST_MATLAB_BIN_DIR}/expfiltered/${MATFAUST_FILE}
COMMAND ${CMAKE_COMMAND} -E echo "mkdir ${FAUST_MATLAB_BIN_DIR}/expfiltered/${PARENT_DIR}"
COMMAND ${CMAKE_COMMAND} -E make_directory ${FAUST_MATLAB_BIN_DIR}/expfiltered/${PARENT_DIR}
COMMAND python
"${PROJECT_SOURCE_DIR}/misc/binpkg_postinst_scripts/filter_experimental_code.py"
${FAUST_MATLAB_NAMESPACE_SRC_DIR}/${MATFAUST_FILE}
${FAUST_MATLAB_BIN_DIR}/expfiltered/${MATFAUST_FILE} "--no-empty"
DEPENDS ${FAUST_MATLAB_NAMESPACE_SRC_DIR}/${MATFAUST_FILE}
COMMENT "Filtering matfaust ${MATFAUST_FILE} experimental code.")
endif()
add_custom_target(FILTERING_EXP_CODE_${MATFAUST_SHORT_FILE} ALL DEPENDS ${FAUST_MATLAB_BIN_DIR}/expfiltered/${MATFAUST_FILE})
# use script generating inline doc only for real matlab classes
if(${MATFAUST_FILE} MATCHES "@")
message(STATUS "matfaust class: " ${MATFAUST_FILE})
if(WIN32)
execute_process(COMMAND git-bash ${PROJECT_SOURCE_DIR}/gen_doc/gen_matlab_inline_doc_from_doxy_blocks.sh ${FAUST_MATLAB_NAMESPACE_SRC_DIR}/${MATFAUST_FILE} ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE} ERROR_QUIET)
#configure_file(${FAUST_MATLAB_NAMESPACE_SRC_DIR}/${MATFAUST_FILE} ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE} COPYONLY)
else()
execute_process(COMMAND ${PROJECT_SOURCE_DIR}/gen_doc/gen_matlab_inline_doc_from_doxy_blocks.sh ${FAUST_MATLAB_NAMESPACE_SRC_DIR}/${MATFAUST_FILE} ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE} ERROR_QUIET)
#TODO: copy if error (fallback solution)
#configure_file(${FAUST_MATLAB_NAMESPACE_SRC_DIR}/${MATFAUST_FILE} ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE} COPYONLY)
endif()
set(SH_CMD git-bash)
endif() # on Unix, count on bash that is in PATH
add_custom_command(OUTPUT ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE}
COMMAND ${PROJECT_SOURCE_DIR}/gen_doc/gen_matlab_inline_doc_from_doxy_blocks.sh ${FAUST_MATLAB_BIN_DIR}/expfiltered/${MATFAUST_FILE} ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE}
DEPENDS ${FAUST_MATLAB_BIN_DIR}/expfiltered/${MATFAUST_FILE}
COMMENT "Generating matfaust inline doc for ${MATFAUST_FILE}")
#execute_process(COMMAND ${PROJECT_SOURCE_DIR}/gen_doc/gen_matlab_inline_doc_from_doxy_blocks.sh ${FAUST_MATLAB_NAMESPACE_SRC_DIR}/${MATFAUST_FILE} ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE} ERROR_QUIET)
#TODO: copy if error (fallback solution)
#configure_file(${FAUST_MATLAB_NAMESPACE_SRC_DIR}/${MATFAUST_FILE} ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE} COPYONLY)
add_custom_target(GEN_MATFAUST_INLINE_DOC_${MATFAUST_SHORT_FILE} ALL DEPENDS ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE})
else()
message(STATUS "matfaust function file: " ${MATFAUST_FILE})
# just copy the .m
configure_file(${FAUST_MATLAB_NAMESPACE_SRC_DIR}/${MATFAUST_FILE} ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE} @ONLY)
endif()
if(NOT EXPERIMENTAL_PKG)
# filter out experimental code
foreach(MATFAUST_DIR ${FAUST_MATLAB_NAMESPACE_BIN_DIR} ${PROJECT_BINARY_DIR}/tmp_gendoc_matfaust/+matfaust)
execute_process(COMMAND
python
"${PROJECT_SOURCE_DIR}/misc/binpkg_postinst_scripts/filter_experimental_code.py"
${MATFAUST_DIR}/${MATFAUST_FILE}
${MATFAUST_DIR}/${MATFAUST_FILE} "--no-empty")
endforeach()
# --no-empty deletes emtpy file after filtering
# easy way to delete the whole module instead of having to insert deletion tags into each file
#FILE(REMOVE_RECURSE "${FAUST_MATLAB_NAMESPACE_BIN_DIR}/+factparams") #TODO: do it in py script directly with a special arg
#FILE(REMOVE_RECURSE "${PROJECT_BINARY_DIR}/tmp_gendoc_matfaust/+matfaust/+factparams") #TODO: do it in py script directly with a special arg
#TODO: inline doc should be possible for function files too
#configure_file(${FAUST_MATLAB_NAMESPACE_SRC_DIR}/${MATFAUST_FILE} ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE} @ONLY)
add_custom_command(OUTPUT ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE}
COMMAND python
ARGS -c 'import shutil, os.path, os\;os.path.exists(\"${FAUST_MATLAB_BIN_DIR}/expfiltered/${MATFAUST_FILE}\") and (os.path.exists(\"${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${PARENT_DIR}\") or os.mkdir(\"${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${PARENT_DIR}\")) and shutil.copy(\"${FAUST_MATLAB_BIN_DIR}/expfiltered/${MATFAUST_FILE}\", \"${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE}\")'
DEPENDS ${FAUST_MATLAB_BIN_DIR}/expfiltered/${MATFAUST_FILE}
COMMENT "Generating matfaust inline doc for ${MATFAUST_FILE} (just copied because it's a function file).")
add_custom_target(GEN_MATFAUST_INLINE_DOC_${MATFAUST_SHORT_FILE} ALL DEPENDS ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE})
endif()
endforeach()
......@@ -148,6 +170,7 @@ foreach(mex_target ${MEXFILE_TARGET_LIST})
target_include_directories(${mex_target} PRIVATE $<TARGET_PROPERTY:${FAUST_TARGET},INTERFACE_INCLUDE_DIRECTORIES>)
add_dependencies(${mex_target} ${FAUST_TARGET})
add_dependencies(${mex_target} ${FAUST_MEXTOOLS_TARGET})
set_property(TARGET ${mex_target} PROPERTY CXX_STANDARD 11) # TODO: variable in main CMakeLists.txt
target_compile_definitions(${mex_target} PRIVATE $<TARGET_PROPERTY:${FAUST_TARGET},COMPILE_DEFINITIONS>)
target_compile_options(${mex_target} PRIVATE $<TARGET_PROPERTY:${FAUST_TARGET},COMPILE_OPTIONS>)
target_link_libraries(${mex_target} ${FAUST_TARGET})
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment