Added Lamp screen space visual
[blender.git] / GNUmakefile
index 88ce32959afa5569ad0ef4c44d7fab1f67ffa603..1fda1a25a9266767ff6eca126803afb09da6a06d 100644 (file)
@@ -19,9 +19,9 @@
 #
 # ##### END GPL LICENSE BLOCK #####
 
-# This Makefile does an out-of-source CMake build in ../build/`OS`_`CPU`
+# This Makefile does an out-of-source CMake build in ../build_`OS`_`CPU`
 # eg:
-#   ../build/Linux_i386
+#   ../build_linux_i386
 # This is for users who like to configure & build blender with a single command.
 
 
@@ -40,7 +40,12 @@ ifndef BUILD_CMAKE_ARGS
 endif
 
 ifndef BUILD_DIR
-       BUILD_DIR:=$(shell dirname $(BLENDER_DIR))/build/$(OS_NCASE)
+       BUILD_DIR:=$(shell dirname "$(BLENDER_DIR)")/build_$(OS_NCASE)
+endif
+
+# Allow to use alternative binary (pypy3, etc)
+ifndef PYTHON
+       PYTHON:=python3
 endif
 
 
@@ -52,34 +57,44 @@ ifneq "$(findstring debug, $(MAKECMDGOALS))" ""
        BUILD_DIR:=$(BUILD_DIR)_debug
        BUILD_TYPE:=Debug
 endif
+ifneq "$(findstring full, $(MAKECMDGOALS))" ""
+       BUILD_DIR:=$(BUILD_DIR)_full
+       BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C"$(BLENDER_DIR)/build_files/cmake/config/blender_full.cmake"
+endif
 ifneq "$(findstring lite, $(MAKECMDGOALS))" ""
        BUILD_DIR:=$(BUILD_DIR)_lite
-       BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C$(BLENDER_DIR)/build_files/cmake/config/blender_lite.cmake
+       BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C"$(BLENDER_DIR)/build_files/cmake/config/blender_lite.cmake"
+endif
+ifneq "$(findstring cycles, $(MAKECMDGOALS))" ""
+       BUILD_DIR:=$(BUILD_DIR)_cycles
+       BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C"$(BLENDER_DIR)/build_files/cmake/config/cycles_standalone.cmake"
 endif
 ifneq "$(findstring headless, $(MAKECMDGOALS))" ""
-       BUILD_DIR:=$(BUILD_DIR)_bpy
-       BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C$(BLENDER_DIR)/build_files/cmake/config/blender_headless.cmake
+       BUILD_DIR:=$(BUILD_DIR)_headless
+       BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C"$(BLENDER_DIR)/build_files/cmake/config/blender_headless.cmake"
 endif
 ifneq "$(findstring bpy, $(MAKECMDGOALS))" ""
        BUILD_DIR:=$(BUILD_DIR)_bpy
-       BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C$(BLENDER_DIR)/build_files/cmake/config/bpy_module.cmake
+       BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C"$(BLENDER_DIR)/build_files/cmake/config/bpy_module.cmake"
 endif
 
 
 # -----------------------------------------------------------------------------
 # Get the number of cores for threaded build
-NPROCS:=1
-ifeq ($(OS), Linux)
-       NPROCS:=$(shell grep -c ^processor /proc/cpuinfo)
-endif
-ifeq ($(OS), Darwin)
-       NPROCS:=$(shell sysctl -a | grep "hw.ncpu " | cut -d" " -f3)
-endif
-ifeq ($(OS), FreeBSD)
-       NPROCS:=$(shell sysctl -a | grep "hw.ncpu " | cut -d" " -f3 )
-endif
-ifeq ($(OS), NetBSD)
-       NPROCS:=$(shell sysctl -a | grep "hw.ncpu " | cut -d" " -f3 )
+ifndef NPROCS
+       NPROCS:=1
+       ifeq ($(OS), Linux)
+               NPROCS:=$(shell nproc)
+       endif
+       ifeq ($(OS), Darwin)
+               NPROCS:=$(shell sysctl -n hw.ncpu)
+       endif
+       ifeq ($(OS), FreeBSD)
+               NPROCS:=$(shell sysctl -n hw.ncpu)
+       endif
+       ifeq ($(OS), NetBSD)
+               NPROCS:=$(shell sysctl -n hw.ncpu)
+       endif
 endif
 
 
@@ -87,8 +102,8 @@ endif
 # Macro for configuring cmake
 
 CMAKE_CONFIG = cmake $(BUILD_CMAKE_ARGS) \
-                     -H$(BLENDER_DIR) \
-                     -B$(BUILD_DIR) \
+                     -H"$(BLENDER_DIR)" \
+                     -B"$(BUILD_DIR)" \
                      -DCMAKE_BUILD_TYPE:STRING=$(BUILD_TYPE)
 
 
@@ -105,45 +120,49 @@ endif
 
 # -----------------------------------------------------------------------------
 # Build Blender
-all:
+all: .FORCE
        @echo
-       @echo Configuring Blender ...
+       @echo Configuring Blender in \"$(BUILD_DIR)\" ...
 
-       # if test ! -f $(BUILD_DIR)/CMakeCache.txt ; then \
-       #       $(CMAKE_CONFIG); \
-       # fi
+#      # if test ! -f $(BUILD_DIR)/CMakeCache.txt ; then \
+#      #       $(CMAKE_CONFIG); \
+#      # fi
        
-       # do this always incase of failed initial build, could be smarter here...
-       $(CMAKE_CONFIG)
+#      # do this always incase of failed initial build, could be smarter here...
+       @$(CMAKE_CONFIG)
 
        @echo
        @echo Building Blender ...
-       $(MAKE) -C $(BUILD_DIR) -s -j $(NPROCS) install
+       $(MAKE) -C "$(BUILD_DIR)" -s -j $(NPROCS) install
        @echo
        @echo edit build configuration with: "$(BUILD_DIR)/CMakeCache.txt" run make again to rebuild.
-       @echo blender installed, run from: "$(BUILD_DIR)/bin/blender"
+       @echo Blender successfully built, run from: "$(BUILD_DIR)/bin/blender"
        @echo
 
 debug: all
+full: all
 lite: all
+cycles: all
 headless: all
 bpy: all
 
 
 # -----------------------------------------------------------------------------
 # Configuration (save some cd'ing around)
-config:
-       $(CMAKE_CONFIG_TOOL) $(BUILD_DIR)
+config: .FORCE
+       $(CMAKE_CONFIG_TOOL) "$(BUILD_DIR)"
 
 
 # -----------------------------------------------------------------------------
 # Help for build targets
-help:
+help: .FORCE
        @echo ""
        @echo "Convenience targets provided for building blender, (multiple at once can be used)"
        @echo "  * debug     - build a debug binary"
+       @echo "  * full      - enable all supported dependencies & options"
        @echo "  * lite      - disable non essential features for a smaller binary and faster build"
        @echo "  * headless  - build without an interface (renderfarm or server automation)"
+       @echo "  * cycles    - build Cycles standalone only, without Blender"
        @echo "  * bpy       - build as a python module which can be loaded from python directly"
        @echo ""
        @echo "  * config    - run cmake configuration tool to set build options"
@@ -159,22 +178,47 @@ help:
        @echo ""
        @echo "Package Targets"
        @echo "  * package_debian  - build a debian package"
-       @echo "  * package_pacman  - build an arch linux pacmanpackage"
+       @echo "  * package_pacman  - build an arch linux pacman package"
        @echo "  * package_archive - build an archive package"
        @echo ""
        @echo "Testing Targets (not associated with building blender)"
-       @echo "  * test            - run ctest, currently tests import/export, operator execution and that python modules load"
-       @echo "  * test_cmake      - runs our own cmake file checker which detects errors in the cmake file list definitions"
-       @echo "  * test_pep8       - checks all python script are pep8 which are tagged to use the stricter formatting"
-       @echo "  * test_deprecated - checks for deprecation tags in our code which may need to be removed"
-       @echo "  * test_style      - checks C/C++ conforms with blenders style guide: http://wiki.blender.org/index.php/Dev:Doc/CodeStyle"
+       @echo "  * test               - run ctest, currently tests import/export,"
+       @echo "                         operator execution and that python modules load"
+       @echo "  * test_cmake         - runs our own cmake file checker"
+       @echo "                         which detects errors in the cmake file list definitions"
+       @echo "  * test_pep8          - checks all python script are pep8"
+       @echo "                         which are tagged to use the stricter formatting"
+       @echo "  * test_deprecated    - checks for deprecation tags in our code which may need to be removed"
+       @echo "  * test_style_c       - checks C/C++ conforms with blenders style guide:"
+       @echo "                         http://wiki.blender.org/index.php/Dev:Doc/CodeStyle"
+       @echo "  * test_style_c_qtc   - same as test_style but outputs QtCreator tasks format"
+       @echo "  * test_style_osl     - checks OpenShadingLanguage conforms with blenders style guide:"
+       @echo "                         http://wiki.blender.org/index.php/Dev:Doc/CodeStyle"
+       @echo "  * test_style_osl_qtc - checks OpenShadingLanguage conforms with blenders style guide:"
+       @echo "                         http://wiki.blender.org/index.php/Dev:Doc/CodeStyle"
        @echo ""
        @echo "Static Source Code Checking (not associated with building blender)"
-       @echo "  * check_cppcheck    - run blender source through cppcheck (C & C++)"
-       @echo "  * check_splint      - run blenders source through splint (C only)"
-       @echo "  * check_sparse      - run blenders source through sparse (C only)"
-       @echo "  * check_spelling_c  - check for spelling errors (C/C++ only)"
-       @echo "  * check_spelling_py - check for spelling errors (Python only)"
+       @echo "  * check_cppcheck       - run blender source through cppcheck (C & C++)"
+       @echo "  * check_clang_array    - run blender source through clang array checking script (C & C++)"
+       @echo "  * check_splint         - run blenders source through splint (C only)"
+       @echo "  * check_sparse         - run blenders source through sparse (C only)"
+       @echo "  * check_smatch         - run blenders source through smatch (C only)"
+       @echo "  * check_spelling_c     - check for spelling errors (C/C++ only)"
+       @echo "  * check_spelling_c_qtc - same as check_spelling_c but outputs QtCreator tasks format"
+       @echo "  * check_spelling_osl   - check for spelling errors (OSL only)"
+       @echo "  * check_spelling_py    - check for spelling errors (Python only)"
+       @echo "  * check_descriptions   - check for duplicate/invalid descriptions"
+       @echo ""
+       @echo "Utilities (not associated with building blender)"
+       @echo "  * icons    - updates PNG icons from SVG files."
+       @echo "  * tgz      - create a compressed archive of the source code."
+       @echo "  * update   - updates git and all submodules"
+       @echo ""
+       @echo "Environment Variables"
+       @echo "  * BUILD_CMAKE_ARGS    - arguments passed to CMake."
+       @echo "  * BUILD_DIR           - override default build path."
+       @echo "  * PYTHON              - use this for the Python command (used for checking tools)."
+       @echo "  * NPROCS              - number of processes to use building (auto-detect when omitted)."
        @echo ""
        @echo "Documentation Targets (not associated with building blender)"
        @echo "  * doc_py   - generate sphinx python api docs"
@@ -182,104 +226,222 @@ help:
        @echo "  * doc_dna  - generate blender file format reference"
        @echo "  * doc_man  - generate manpage"
        @echo ""
+       @echo "Information"
+       @echo "  * help          - this help message"
+       @echo "  * help_features - show a list of optional features when building"
+       @echo ""
 
 # -----------------------------------------------------------------------------
 # Packages
 #
-package_debian:
+package_debian: .FORCE
        cd build_files/package_spec ; DEB_BUILD_OPTIONS="parallel=$(NPROCS)" sh ./build_debian.sh
 
-package_pacman:
-       cd build_files/package_spec/pacman ; MAKEFLAGS="-j$(NPROCS)" makepkg --asroot
+package_pacman: .FORCE
+       cd build_files/package_spec/pacman ; MAKEFLAGS="-j$(NPROCS)" makepkg
 
-package_archive:
-       make -C $(BUILD_DIR) -s package_archive
+package_archive: .FORCE
+       make -C "$(BUILD_DIR)" -s package_archive
        @echo archive in "$(BUILD_DIR)/release"
 
 
 # -----------------------------------------------------------------------------
 # Tests
 #
-test:
+test: .FORCE
        cd $(BUILD_DIR) ; ctest . --output-on-failure
 
 # run pep8 check check on scripts we distribute.
-test_pep8:
-       python3.2 source/tests/pep8.py > test_pep8.log 2>&1
+test_pep8: .FORCE
+       $(PYTHON) tests/python/pep8.py > test_pep8.log 2>&1
        @echo "written: test_pep8.log"
 
 # run some checks on our cmakefiles.
-test_cmake:
-       python3.2 build_files/cmake/cmake_consistency_check.py > test_cmake_consistency.log 2>&1
+test_cmake: .FORCE
+       $(PYTHON) build_files/cmake/cmake_consistency_check.py > test_cmake_consistency.log 2>&1
        @echo "written: test_cmake_consistency.log"
 
 # run deprecation tests, see if we have anything to remove.
-test_deprecated:
-       python3.2 source/tests/check_deprecated.py
+test_deprecated: .FORCE
+       $(PYTHON) tests/check_deprecated.py
 
-test_style:
+test_style_c: .FORCE
+       # run our own checks on C/C++ style
+       PYTHONIOENCODING=utf_8 $(PYTHON) \
+           "$(BLENDER_DIR)/source/tools/check_source/check_style_c.py" \
+           "$(BLENDER_DIR)/source/blender" \
+           "$(BLENDER_DIR)/source/creator" \
+           --no-length-check
+
+test_style_c_qtc: .FORCE
+       # run our own checks on C/C++ style
+       USE_QTC_TASK=1 \
+       PYTHONIOENCODING=utf_8 $(PYTHON) \
+           "$(BLENDER_DIR)/source/tools/check_source/check_style_c.py" \
+           "$(BLENDER_DIR)/source/blender" \
+           "$(BLENDER_DIR)/source/creator" \
+           --no-length-check \
+           > \
+           "$(BLENDER_DIR)/test_style.tasks"
+       @echo "written: test_style.tasks"
+
+
+test_style_osl: .FORCE
        # run our own checks on C/C++ style
-       PYTHONIOENCODING=utf_8 python3.2 $(BLENDER_DIR)/source/tools/check_style_c.py $(BLENDER_DIR)/source/blender $(BLENDER_DIR)/source/creator --no-length-check
+       PYTHONIOENCODING=utf_8 $(PYTHON) \
+           "$(BLENDER_DIR)/source/tools/check_source/check_style_c.py" \
+           "$(BLENDER_DIR)/intern/cycles/kernel/shaders" \
+           "$(BLENDER_DIR)/release/scripts/templates_osl"
+
+
+test_style_osl_qtc: .FORCE
+       # run our own checks on C/C++ style
+       USE_QTC_TASK=1 \
+       PYTHONIOENCODING=utf_8 $(PYTHON) \
+           "$(BLENDER_DIR)/source/tools/check_source/check_style_c.py" \
+           "$(BLENDER_DIR)/intern/cycles/kernel/shaders" \
+           "$(BLENDER_DIR)/release/scripts/templates_osl" \
+           > \
+           "$(BLENDER_DIR)/test_style.tasks"
+       @echo "written: test_style.tasks"
 
 # -----------------------------------------------------------------------------
 # Project Files
 #
 
-project_qtcreator:
-       python3.2 build_files/cmake/cmake_qtcreator_project.py $(BUILD_DIR)
+project_qtcreator: .FORCE
+       $(PYTHON) build_files/cmake/cmake_qtcreator_project.py "$(BUILD_DIR)"
 
-project_netbeans:
-       python3.2 build_files/cmake/cmake_netbeans_project.py $(BUILD_DIR)
+project_netbeans: .FORCE
+       $(PYTHON) build_files/cmake/cmake_netbeans_project.py "$(BUILD_DIR)"
 
-project_eclipse:
-       cmake -G"Eclipse CDT4 - Unix Makefiles" -H$(BLENDER_DIR) -B$(BUILD_DIR)
+project_eclipse: .FORCE
+       cmake -G"Eclipse CDT4 - Unix Makefiles" -H"$(BLENDER_DIR)" -B"$(BUILD_DIR)"
 
 
 # -----------------------------------------------------------------------------
 # Static Checking
 #
 
-check_cppcheck:
+check_cppcheck: .FORCE
+       $(CMAKE_CONFIG)
+       cd "$(BUILD_DIR)" ; \
+       $(PYTHON) "$(BLENDER_DIR)/build_files/cmake/cmake_static_check_cppcheck.py" 2> \
+           "$(BLENDER_DIR)/check_cppcheck.txt"
+       @echo "written: check_cppcheck.txt"
+
+check_clang_array: .FORCE
+       $(CMAKE_CONFIG)
+       cd "$(BUILD_DIR)" ; \
+       $(PYTHON) "$(BLENDER_DIR)/build_files/cmake/cmake_static_check_clang_array.py"
+
+check_splint: .FORCE
        $(CMAKE_CONFIG)
-       cd $(BUILD_DIR) ; python3.2 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_cppcheck.py
+       cd "$(BUILD_DIR)" ; \
+       $(PYTHON) "$(BLENDER_DIR)/build_files/cmake/cmake_static_check_splint.py"
 
-check_splint:
+check_sparse: .FORCE
        $(CMAKE_CONFIG)
-       cd $(BUILD_DIR) ; python3.2 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_splint.py
+       cd "$(BUILD_DIR)" ; \
+       $(PYTHON) "$(BLENDER_DIR)/build_files/cmake/cmake_static_check_sparse.py"
 
-check_sparse:
+check_smatch: .FORCE
        $(CMAKE_CONFIG)
-       cd $(BUILD_DIR) ; python3.2 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_sparse.py
+       cd "$(BUILD_DIR)" ; \
+       $(PYTHON) "$(BLENDER_DIR)/build_files/cmake/cmake_static_check_smatch.py"
+
+check_spelling_py: .FORCE
+       cd "$(BUILD_DIR)" ; \
+       PYTHONIOENCODING=utf_8 $(PYTHON) \
+           "$(BLENDER_DIR)/source/tools/check_source/check_spelling.py" \
+           "$(BLENDER_DIR)/release/scripts"
+
+check_spelling_c: .FORCE
+       cd "$(BUILD_DIR)" ; \
+       PYTHONIOENCODING=utf_8 $(PYTHON) \
+           "$(BLENDER_DIR)/source/tools/check_source/check_spelling.py" \
+           "$(BLENDER_DIR)/source" \
+           "$(BLENDER_DIR)/intern/cycles" \
+           "$(BLENDER_DIR)/intern/guardedalloc" \
+           "$(BLENDER_DIR)/intern/ghost" \
+
+check_spelling_c_qtc: .FORCE
+       cd "$(BUILD_DIR)" ; USE_QTC_TASK=1 \
+       PYTHONIOENCODING=utf_8 $(PYTHON) \
+           "$(BLENDER_DIR)/source/tools/check_source/check_spelling.py" \
+           "$(BLENDER_DIR)/source" \
+           "$(BLENDER_DIR)/intern/cycles" \
+           "$(BLENDER_DIR)/intern/guardedalloc" \
+           "$(BLENDER_DIR)/intern/ghost" \
+           > \
+           "$(BLENDER_DIR)/check_spelling_c.tasks"
+
+check_spelling_osl: .FORCE
+       cd "$(BUILD_DIR)" ;\
+       PYTHONIOENCODING=utf_8 $(PYTHON) \
+           "$(BLENDER_DIR)/source/tools/check_source/check_spelling.py" \
+           "$(BLENDER_DIR)/intern/cycles/kernel/shaders"
+
+check_descriptions: .FORCE
+       "$(BUILD_DIR)/bin/blender" --background -noaudio --factory-startup --python \
+           "$(BLENDER_DIR)/source/tools/check_source/check_descriptions.py"
 
-check_spelling_py:
-       cd $(BUILD_DIR) ; PYTHONIOENCODING=utf_8 python3.2 $(BLENDER_DIR)/source/tools/spell_check_source.py $(BLENDER_DIR)/release/scripts
+# -----------------------------------------------------------------------------
+# Utilities
+#
+
+tgz: .FORCE
+       ./build_files/utils/build_tgz.sh
+
+icons: .FORCE
+       "$(BLENDER_DIR)/release/datafiles/blender_icons_update.py"
+       "$(BLENDER_DIR)/release/datafiles/prvicons_update.py"
+
+update: .FORCE
+       if [ -d "../lib" ]; then \
+               svn update ../lib/* ; \
+       fi
+       git pull --rebase
+       git submodule foreach git pull --rebase origin master
 
-check_spelling_c:
-       cd $(BUILD_DIR) ; PYTHONIOENCODING=utf_8 python3.2 $(BLENDER_DIR)/source/tools/spell_check_source.py $(BLENDER_DIR)/source
 
 # -----------------------------------------------------------------------------
 # Documentation
 #
 
 # Simple version of ./doc/python_api/sphinx_doc_gen.sh with no PDF generation.
-doc_py:
-       $(BUILD_DIR)/bin/blender --background -noaudio --factory-startup --python doc/python_api/sphinx_doc_gen.py
+doc_py: .FORCE
+       "$(BUILD_DIR)/bin/blender" --background -noaudio --factory-startup \
+               --python doc/python_api/sphinx_doc_gen.py
        cd doc/python_api ; sphinx-build -b html sphinx-in sphinx-out
        @echo "docs written into: '$(BLENDER_DIR)/doc/python_api/sphinx-out/contents.html'"
 
-doc_doxy:
+doc_doxy: .FORCE
        cd doc/doxygen; doxygen Doxyfile
        @echo "docs written into: '$(BLENDER_DIR)/doc/doxygen/html/index.html'"
 
-doc_dna:
-       $(BUILD_DIR)/bin/blender --background -noaudio --factory-startup --python doc/blender_file_format/BlendFileDnaExporter_25.py
+doc_dna: .FORCE
+       "$(BUILD_DIR)/bin/blender" --background -noaudio --factory-startup \
+               --python doc/blender_file_format/BlendFileDnaExporter_25.py
        @echo "docs written into: '$(BLENDER_DIR)/doc/blender_file_format/dna.html'"
 
-doc_man:
-       python3.2 doc/manpage/blender.1.py $(BUILD_DIR)/bin/blender
+doc_man: .FORCE
+       $(PYTHON) doc/manpage/blender.1.py "$(BUILD_DIR)/bin/blender"
+
+help_features: .FORCE
+       @$(PYTHON) -c \
+               "import re; \
+               print('\n'.join([ \
+               w for l in open('"$(BLENDER_DIR)"/CMakeLists.txt', 'r').readlines() \
+               if not l.lstrip().startswith('#') \
+               for w in (re.sub(\
+                   r'.*\boption\s*\(\s*(WITH_[a-zA-Z0-9_]+)\s+(\".*\")\s*.*', r'\g<1> - \g<2>', l).strip('() \n'),) \
+               if w.startswith('WITH_')]))" | uniq
 
 
-clean:
-       $(MAKE) -C $(BUILD_DIR) clean
+clean: .FORCE
+       $(MAKE) -C "$(BUILD_DIR)" clean
 
 .PHONY: all
+
+.FORCE: