Skip to content

Commit

Permalink
Add clang format & skip build if no source file modified (#5433)
Browse files Browse the repository at this point in the history
* [BUILD] Add clang format + build skipping

* Add clang-format tool to check codestyle.
Warning: it check the whole modified file, not the diff part, it's why it's lazy. Please also look if rules are perfect, i take the Linux codestyle from LLVM site

Fix issue #5415

* Skip building project if no file is modified
* Fix a wrong brace to trigger LINT

* Make lint step outside of unix build scope

* Add AccessModifierOffset: -8

* Typo fix & needs compile fix

* Fix header priorities
  • Loading branch information
nerzhul committed Mar 25, 2017
1 parent 5a59ad2 commit 22567d1
Show file tree
Hide file tree
Showing 6 changed files with 68 additions and 3 deletions.
12 changes: 12 additions & 0 deletions .clang-format
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
BasedOnStyle: LLVM
IndentWidth: 8
UseTab: Always
BreakBeforeBraces: Linux
AllowShortIfStatementsOnASingleLine: false
IndentCaseLabels: false
AccessModifierOffset: -8
IncludeCategories:
- Regex: '^".*'
Priority: 2
- Regex: '^<.*'
Priority: 1
4 changes: 4 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ matrix:
compiler: clang
os: linux
dist: trusty
- env: COMPILER=none LINT=1
compiler: clang
os: linux
dist: trusty
- env: PLATFORM=Unix COMPILER=g++-6
compiler: gcc
os: linux
Expand Down
4 changes: 3 additions & 1 deletion src/nameidmapping.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,12 @@ class NameIdMapping
void serialize(std::ostream &os) const;
void deSerialize(std::istream &is);

void clear(){
void clear()
{
m_id_to_name.clear();
m_name_to_id.clear();
}

void set(u16 id, const std::string &name){
m_id_to_name[id] = name;
m_name_to_id[name] = id;
Expand Down
12 changes: 11 additions & 1 deletion util/travis/before_install.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
#!/bin/bash -e
echo "Preparing for $TRAVIS_COMMIT_RANGE"
. util/travis/common.sh

if [[ "$LINT" == "1" ]]; then
curl http://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
sudo add-apt-repository "deb http://apt.llvm.org/trusty/ llvm-toolchain-trusty-3.9 main"
sudo apt-get -yq update
sudo apt-get install clang-format-3.9
exit 0
fi

. util/travis/common.sh
needs_compile || exit 0

if [[ $TRAVIS_OS_NAME == "linux" ]]; then
Expand All @@ -11,6 +19,7 @@ fi

if [[ $PLATFORM == "Unix" ]]; then
if [[ $TRAVIS_OS_NAME == "linux" ]]; then
sudo apt-get update
sudo apt-get install libirrlicht-dev cmake libbz2-dev libpng12-dev \
libjpeg-dev libxxf86vm-dev libgl1-mesa-dev libsqlite3-dev \
libhiredis-dev libogg-dev libgmp-dev libvorbis-dev libopenal-dev \
Expand All @@ -21,6 +30,7 @@ if [[ $PLATFORM == "Unix" ]]; then
if [[ "$VALGRIND" == "1" ]]; then
sudo apt-get install valgrind
fi

else
brew update
brew install freetype gettext hiredis irrlicht jpeg leveldb libogg libvorbis luajit
Expand Down
3 changes: 2 additions & 1 deletion util/travis/common.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
#!/bin/bash -e

# Relative to git-repository root:
TRIGGER_COMPILE_PATHS="src/|CMakeLists.txt|cmake/Modules/|util/travis/|util/buildbot/"
TRIGGER_COMPILE_PATHS="src/.*\.(c|cpp|h)|CMakeLists.txt|cmake/Modules/|util/travis/|util/buildbot/"

needs_compile() {
git diff --name-only $TRAVIS_COMMIT_RANGE | egrep -q "^($TRIGGER_COMPILE_PATHS)"
}

36 changes: 36 additions & 0 deletions util/travis/script.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,57 @@

needs_compile || exit 0

function perform_lint() {
CLANG_FORMAT=clang-format-3.9
if [ "$TRAVIS_EVENT_TYPE" = "pull_request" ]; then
# Get list of every file modified in this pull request
files_to_lint="$(git diff --name-only --diff-filter=ACMRTUXB $TRAVIS_COMMIT_RANGE | grep '^src/[^.]*[.]\(cpp\|h\)$' | egrep -v '^src/(gmp|lua|jsoncpp)/' || true)"
else
# Check everything for branch pushes
files_to_lint="$(find src/ -name '*.cpp' -or -name '*.h' | egrep -v '^src/(gmp|lua|jsoncpp)/')"
fi

local fail=0
for f in ${files_to_lint}; do
d=$(diff -u "$f" <(${CLANG_FORMAT} "$f") || true)
if ! [ -z "$d" ]; then
printf "The file %s is not compliant with the coding style:\n%s\n" "$f" "$d"
# Disable build failure at this moment as we need to have a complete MT source whitelist to check
fail=0
fi
done

if [ "$fail" = 1 ]; then
exit 1
fi

exit 0
}

if [[ "$LINT" == "1" ]]; then
# Lint with exit CI
perform_lint
fi

if [[ $PLATFORM == "Unix" ]]; then
mkdir -p travisbuild
cd travisbuild || exit 1

CMAKE_FLAGS=''
if [[ $COMPILER == "g++-6" ]]; then
export CC=gcc-6
export CXX=g++-6
fi

# Clang builds with FreeType fail on Travis
if [[ $CC == "clang" ]]; then
CMAKE_FLAGS+=' -DENABLE_FREETYPE=FALSE'
fi

if [[ $TRAVIS_OS_NAME == "osx" ]]; then
CMAKE_FLAGS+=' -DCUSTOM_GETTEXT_PATH=/usr/local/opt/gettext'
fi

cmake -DCMAKE_BUILD_TYPE=Debug \
-DRUN_IN_PLACE=TRUE \
-DENABLE_GETTEXT=TRUE \
Expand Down

0 comments on commit 22567d1

Please sign in to comment.