code cleanup: add check spelling osl
[blender.git] / GNUmakefile
1 # -*- mode: gnumakefile; tab-width: 8; indent-tabs-mode: t; -*-
2 # vim: tabstop=4
3 #
4 # ##### BEGIN GPL LICENSE BLOCK #####
5 #
6 #  This program is free software; you can redistribute it and/or
7 #  modify it under the terms of the GNU General Public License
8 #  as published by the Free Software Foundation; either version 2
9 #  of the License, or (at your option) any later version.
10 #
11 #  This program is distributed in the hope that it will be useful,
12 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
13 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 #  GNU General Public License for more details.
15 #
16 #  You should have received a copy of the GNU General Public License
17 #  along with this program; if not, write to the Free Software Foundation,
18 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 #
20 # ##### END GPL LICENSE BLOCK #####
21
22 # This Makefile does an out-of-source CMake build in ../build_`OS`_`CPU`
23 # eg:
24 #   ../build_linux_i386
25 # This is for users who like to configure & build blender with a single command.
26
27
28 # System Vars
29 OS:=$(shell uname -s)
30 OS_NCASE:=$(shell uname -s | tr '[A-Z]' '[a-z]')
31 # CPU:=$(shell uname -m)  # UNUSED
32
33
34 # Source and Build DIR's
35 BLENDER_DIR:=$(shell pwd -P)
36 BUILD_TYPE:=Release
37
38 ifndef BUILD_CMAKE_ARGS
39         BUILD_CMAKE_ARGS:=
40 endif
41
42 ifndef BUILD_DIR
43         BUILD_DIR:=$(shell dirname $(BLENDER_DIR))/build_$(OS_NCASE)
44 endif
45
46
47 # -----------------------------------------------------------------------------
48 # additional targets for the build configuration
49
50 # support 'make debug'
51 ifneq "$(findstring debug, $(MAKECMDGOALS))" ""
52         BUILD_DIR:=$(BUILD_DIR)_debug
53         BUILD_TYPE:=Debug
54 endif
55 ifneq "$(findstring lite, $(MAKECMDGOALS))" ""
56         BUILD_DIR:=$(BUILD_DIR)_lite
57         BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C$(BLENDER_DIR)/build_files/cmake/config/blender_lite.cmake
58 endif
59 ifneq "$(findstring headless, $(MAKECMDGOALS))" ""
60         BUILD_DIR:=$(BUILD_DIR)_bpy
61         BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C$(BLENDER_DIR)/build_files/cmake/config/blender_headless.cmake
62 endif
63 ifneq "$(findstring bpy, $(MAKECMDGOALS))" ""
64         BUILD_DIR:=$(BUILD_DIR)_bpy
65         BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C$(BLENDER_DIR)/build_files/cmake/config/bpy_module.cmake
66 endif
67
68
69 # -----------------------------------------------------------------------------
70 # Get the number of cores for threaded build
71 NPROCS:=1
72 ifeq ($(OS), Linux)
73         NPROCS:=$(shell grep -c ^processor /proc/cpuinfo)
74 endif
75 ifeq ($(OS), Darwin)
76         NPROCS:=$(shell sysctl -a | grep "hw.ncpu " | cut -d" " -f3)
77 endif
78 ifeq ($(OS), FreeBSD)
79         NPROCS:=$(shell sysctl -a | grep "hw.ncpu " | cut -d" " -f3 )
80 endif
81 ifeq ($(OS), NetBSD)
82         NPROCS:=$(shell sysctl -a | grep "hw.ncpu " | cut -d" " -f3 )
83 endif
84
85
86 # -----------------------------------------------------------------------------
87 # Macro for configuring cmake
88
89 CMAKE_CONFIG = cmake $(BUILD_CMAKE_ARGS) \
90                      -H$(BLENDER_DIR) \
91                      -B$(BUILD_DIR) \
92                      -DCMAKE_BUILD_TYPE:STRING=$(BUILD_TYPE)
93
94
95 # -----------------------------------------------------------------------------
96 # Tool for 'make config'
97
98 # X11 spesific
99 ifdef DISPLAY
100         CMAKE_CONFIG_TOOL = cmake-gui
101 else 
102         CMAKE_CONFIG_TOOL = ccmake
103 endif
104
105
106 # -----------------------------------------------------------------------------
107 # Build Blender
108 all:
109         @echo
110         @echo Configuring Blender ...
111
112         # if test ! -f $(BUILD_DIR)/CMakeCache.txt ; then \
113         #       $(CMAKE_CONFIG); \
114         # fi
115         
116         # do this always incase of failed initial build, could be smarter here...
117         $(CMAKE_CONFIG)
118
119         @echo
120         @echo Building Blender ...
121         $(MAKE) -C $(BUILD_DIR) -s -j $(NPROCS) install
122         @echo
123         @echo edit build configuration with: "$(BUILD_DIR)/CMakeCache.txt" run make again to rebuild.
124         @echo blender installed, run from: "$(BUILD_DIR)/bin/blender"
125         @echo
126
127 debug: all
128 lite: all
129 headless: all
130 bpy: all
131
132
133 # -----------------------------------------------------------------------------
134 # Configuration (save some cd'ing around)
135 config:
136         $(CMAKE_CONFIG_TOOL) $(BUILD_DIR)
137
138
139 # -----------------------------------------------------------------------------
140 # Help for build targets
141 help:
142         @echo ""
143         @echo "Convenience targets provided for building blender, (multiple at once can be used)"
144         @echo "  * debug     - build a debug binary"
145         @echo "  * lite      - disable non essential features for a smaller binary and faster build"
146         @echo "  * headless  - build without an interface (renderfarm or server automation)"
147         @echo "  * bpy       - build as a python module which can be loaded from python directly"
148         @echo ""
149         @echo "  * config    - run cmake configuration tool to set build options"
150         @echo ""
151         @echo "  Note, passing the argument 'BUILD_DIR=path' when calling make will override the default build dir."
152         @echo "  Note, passing the argument 'BUILD_CMAKE_ARGS=args' lets you add cmake arguments."
153         @echo ""
154         @echo ""
155         @echo "Project Files for IDE's"
156         @echo "  * project_qtcreator - QtCreator Project Files"
157         @echo "  * project_netbeans  - NetBeans Project Files"
158         @echo "  * project_eclipse   - Eclipse CDT4 Project Files"
159         @echo ""
160         @echo "Package Targets"
161         @echo "  * package_debian  - build a debian package"
162         @echo "  * package_pacman  - build an arch linux pacmanpackage"
163         @echo "  * package_archive - build an archive package"
164         @echo ""
165         @echo "Testing Targets (not associated with building blender)"
166         @echo "  * test               - run ctest, currently tests import/export, operator execution and that python modules load"
167         @echo "  * test_cmake         - runs our own cmake file checker which detects errors in the cmake file list definitions"
168         @echo "  * test_pep8          - checks all python script are pep8 which are tagged to use the stricter formatting"
169         @echo "  * test_deprecated    - checks for deprecation tags in our code which may need to be removed"
170         @echo "  * test_style_c       - checks C/C++ conforms with blenders style guide: http://wiki.blender.org/index.php/Dev:Doc/CodeStyle"
171         @echo "  * test_style_c_qtc   - same as test_style but outputs QtCreator tasks format"
172         @echo "  * test_style_osl     - checks OpenShadingLanguage conforms with blenders style guide: http://wiki.blender.org/index.php/Dev:Doc/CodeStyle"
173         @echo "  * test_style_osl_qtc - checks OpenShadingLanguage conforms with blenders style guide: http://wiki.blender.org/index.php/Dev:Doc/CodeStyle"
174         @echo ""
175         @echo "Static Source Code Checking (not associated with building blender)"
176         @echo "  * check_cppcheck     - run blender source through cppcheck (C & C++)"
177         @echo "  * check_clang_array  - run blender source through clang array checking script (C & C++)"
178         @echo "  * check_splint       - run blenders source through splint (C only)"
179         @echo "  * check_sparse       - run blenders source through sparse (C only)"
180         @echo "  * check_smatch       - run blenders source through smatch (C only)"
181         @echo "  * check_spelling_c   - check for spelling errors (OSL only)"
182         @echo "  * check_spelling_osl - check for spelling errors (C/C++ only)"
183         @echo "  * check_spelling_py  - check for spelling errors (Python only)"
184         @echo ""
185         @echo "Utilities (not associated with building blender)"
186         @echo "  * tbz      - create a compressed svn export 'blender_archive.tar.bz2'"
187         @echo ""
188         @echo "Documentation Targets (not associated with building blender)"
189         @echo "  * doc_py   - generate sphinx python api docs"
190         @echo "  * doc_doxy - generate doxygen C/C++ docs"
191         @echo "  * doc_dna  - generate blender file format reference"
192         @echo "  * doc_man  - generate manpage"
193         @echo ""
194
195 # -----------------------------------------------------------------------------
196 # Packages
197 #
198 package_debian:
199         cd build_files/package_spec ; DEB_BUILD_OPTIONS="parallel=$(NPROCS)" sh ./build_debian.sh
200
201 package_pacman:
202         cd build_files/package_spec/pacman ; MAKEFLAGS="-j$(NPROCS)" makepkg --asroot
203
204 package_archive:
205         make -C $(BUILD_DIR) -s package_archive
206         @echo archive in "$(BUILD_DIR)/release"
207
208
209 # -----------------------------------------------------------------------------
210 # Tests
211 #
212 test:
213         cd $(BUILD_DIR) ; ctest . --output-on-failure
214
215 # run pep8 check check on scripts we distribute.
216 test_pep8:
217         python3 source/tests/pep8.py > test_pep8.log 2>&1
218         @echo "written: test_pep8.log"
219
220 # run some checks on our cmakefiles.
221 test_cmake:
222         python3 build_files/cmake/cmake_consistency_check.py > test_cmake_consistency.log 2>&1
223         @echo "written: test_cmake_consistency.log"
224
225 # run deprecation tests, see if we have anything to remove.
226 test_deprecated:
227         python3 source/tests/check_deprecated.py
228
229 test_style_c:
230         # run our own checks on C/C++ style
231         PYTHONIOENCODING=utf_8 python3 $(BLENDER_DIR)/source/tools/check_style_c.py $(BLENDER_DIR)/source/blender $(BLENDER_DIR)/source/creator --no-length-check
232
233 test_style_c_qtc:
234         # run our own checks on C/C++ style
235         USE_QTC_TASK=1 \
236         PYTHONIOENCODING=utf_8 python3 $(BLENDER_DIR)/source/tools/check_style_c.py $(BLENDER_DIR)/source/blender $(BLENDER_DIR)/source/creator --no-length-check > \
237         test_style.tasks
238         @echo "written: test_style.tasks"
239
240
241 test_style_osl:
242         # run our own checks on C/C++ style
243         PYTHONIOENCODING=utf_8 python3 $(BLENDER_DIR)/source/tools/check_style_c.py $(BLENDER_DIR)/intern/cycles/kernel/osl
244
245
246 test_style_osl_qtc:
247         # run our own checks on C/C++ style
248         USE_QTC_TASK=1 \
249         PYTHONIOENCODING=utf_8 python3 $(BLENDER_DIR)/source/tools/check_style_c.py $(BLENDER_DIR)/intern/cycles/kernel/osl > \
250         test_style.tasks
251         @echo "written: test_style.tasks"
252
253 # -----------------------------------------------------------------------------
254 # Project Files
255 #
256
257 project_qtcreator:
258         python3 build_files/cmake/cmake_qtcreator_project.py $(BUILD_DIR)
259
260 project_netbeans:
261         python3 build_files/cmake/cmake_netbeans_project.py $(BUILD_DIR)
262
263 project_eclipse:
264         cmake -G"Eclipse CDT4 - Unix Makefiles" -H$(BLENDER_DIR) -B$(BUILD_DIR)
265
266
267 # -----------------------------------------------------------------------------
268 # Static Checking
269 #
270
271 check_cppcheck:
272         $(CMAKE_CONFIG)
273         cd $(BUILD_DIR) ; python3 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_cppcheck.py
274
275 check_clang_array:
276         $(CMAKE_CONFIG)
277         cd $(BUILD_DIR) ; python3 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_clang_array.py
278
279 check_splint:
280         $(CMAKE_CONFIG)
281         cd $(BUILD_DIR) ; python3 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_splint.py
282
283 check_sparse:
284         $(CMAKE_CONFIG)
285         cd $(BUILD_DIR) ; python3 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_sparse.py
286
287 check_smatch:
288         $(CMAKE_CONFIG)
289         cd $(BUILD_DIR) ; python3 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_smatch.py
290
291 check_spelling_py:
292         cd $(BUILD_DIR) ; PYTHONIOENCODING=utf_8 python3 $(BLENDER_DIR)/source/tools/spell_check_source.py $(BLENDER_DIR)/release/scripts
293
294 check_spelling_c:
295         cd $(BUILD_DIR) ; PYTHONIOENCODING=utf_8 python3 $(BLENDER_DIR)/source/tools/spell_check_source.py $(BLENDER_DIR)/source
296
297 check_spelling_osl:
298         cd $(BUILD_DIR) ; PYTHONIOENCODING=utf_8 python3 $(BLENDER_DIR)/source/tools/spell_check_source.py $(BLENDER_DIR)/intern/cycles/kernel/osl
299
300 # -----------------------------------------------------------------------------
301 # Utilities
302 #
303
304 tbz:
305         svn export . blender_archive
306         tar cjf blender_archive.tar.bz2 blender_archive/
307         rm -rf blender_archive/
308         @echo "blender_archive.tar.bz2 written"
309
310
311 # -----------------------------------------------------------------------------
312 # Documentation
313 #
314
315 # Simple version of ./doc/python_api/sphinx_doc_gen.sh with no PDF generation.
316 doc_py:
317         $(BUILD_DIR)/bin/blender --background -noaudio --factory-startup --python doc/python_api/sphinx_doc_gen.py
318         cd doc/python_api ; sphinx-build -b html sphinx-in sphinx-out
319         @echo "docs written into: '$(BLENDER_DIR)/doc/python_api/sphinx-out/contents.html'"
320
321 doc_doxy:
322         cd doc/doxygen; doxygen Doxyfile
323         @echo "docs written into: '$(BLENDER_DIR)/doc/doxygen/html/index.html'"
324
325 doc_dna:
326         $(BUILD_DIR)/bin/blender --background -noaudio --factory-startup --python doc/blender_file_format/BlendFileDnaExporter_25.py
327         @echo "docs written into: '$(BLENDER_DIR)/doc/blender_file_format/dna.html'"
328
329 doc_man:
330         python3 doc/manpage/blender.1.py $(BUILD_DIR)/bin/blender
331
332
333 clean:
334         $(MAKE) -C $(BUILD_DIR) clean
335
336 .PHONY: all