add the alarm and handle the newline in #if

ginkgo-project · yhmtsai · Apr 2, 2020 · Nov 15, 2019 · Nov 15, 2019 · Nov 18, 2019
commit 31383a4b93b8873ff2f7430eb3ff875ab8baf363
diff --git a/dev_tools/scripts/format_header.sh b/dev_tools/scripts/format_header.sh
@@ -43,59 +43,59 @@ remove_regroup () {
 }
 
 get_include_regex () {
-local file="$1"
-local core_suffix=""
-local path_prefix=""
-local path_ignore="0"
-local fix_include=""
-local remove_test="false"
-local item_regex="^-\ +\"(.*)\""
-local path_prefix_regex="PathPrefix:\ +\"(.*)\""
-local core_suffix_regex="CoreSuffix:\ +\"(.*)\""
-local path_ignore_regex="PathIgnore:\ +\"(.*)\""
-local fix_include_regex="FixInclude:\ +\"(.*)\""
-local remove_test_regex="RemoveTest:\ +\"(.*)\""
-local match="false"
-while IFS='' read -r line; do
-    if [[ "$line" =~ $item_regex ]]; then
-        file_regex="${BASH_REMATCH[1]}"
-        if [[ "$match" = "true" ]]; then
-            break
-        elif [[ $file =~ $file_regex ]]; then
-            match="true"
+    local file="$1"
+    local core_suffix=""
+    local path_prefix=""
+    local path_ignore="0"
+    local fix_include=""
+    local remove_test="false"
+    local item_regex="^-\ +\"(.*)\""
+    local path_prefix_regex="PathPrefix:\ +\"(.*)\""
+    local core_suffix_regex="CoreSuffix:\ +\"(.*)\""
+    local path_ignore_regex="PathIgnore:\ +\"(.*)\""
+    local fix_include_regex="FixInclude:\ +\"(.*)\""
+    local remove_test_regex="RemoveTest:\ +\"(.*)\""
+    local match="false"
+    while IFS='' read -r line; do
+        if [[ "$line" =~ $item_regex ]]; then
+            file_regex="${BASH_REMATCH[1]}"
+            if [[ "$match" = "true" ]]; then
+                break
+            elif [[ $file =~ $file_regex ]]; then
+                match="true"
+            fi
+        elif [ "$match" = "true" ]; then
+            if [[ "$line" =~ $path_prefix_regex ]]; then
+                path_prefix="${BASH_REMATCH[1]}"
+            elif [[ "$line" =~ $core_suffix_regex ]]; then
+                core_suffix="${BASH_REMATCH[1]}"
+            elif [[ "$line" =~ $path_ignore_regex ]]; then
+                path_ignore="${BASH_REMATCH[1]}"
+            elif [[ "$line" =~ $fix_include_regex ]]; then
+                fix_include="${BASH_REMATCH[1]}"
+            elif [[ "$line" =~ $remove_test_regex ]]; then
+                remove_test="${BASH_REMATCH[1]}"
+            else
+                echo "wrong: ${line}"
+            fi
         fi
-    elif [ "$match" = "true" ]; then
-        if [[ "$line" =~ $path_prefix_regex ]]; then
-            path_prefix="${BASH_REMATCH[1]}"
-        elif [[ "$line" =~ $core_suffix_regex ]]; then
-            core_suffix="${BASH_REMATCH[1]}"
-        elif [[ "$line" =~ $path_ignore_regex ]]; then
-            path_ignore="${BASH_REMATCH[1]}"
-        elif [[ "$line" =~ $fix_include_regex ]]; then
-            fix_include="${BASH_REMATCH[1]}"
-        elif [[ "$line" =~ $remove_test_regex ]]; then
-            remove_test="${BASH_REMATCH[1]}"
-        else
-            echo "wrong: ${line}"
+    done < "dev_tools/scripts/config"
+    output=""
+    if [ -z "${fix_include}" ]; then
+        local path_regex="([a-zA-Z_]*\/){${path_ignore}}(.*)\.(cpp|hpp|cu|cuh)"
+        if [ ! -z "${path_prefix}" ]; then
+            path_prefix="${path_prefix}/"
         fi
+        output=$(echo "${file}" | sed -E "s~\.hip~~g;s~$path_regex~$path_prefix\2~g")
+        output=$(echo "${output}" | sed -E "s~$core_suffix$~~g")
+        output="#include (<|\")$output\.(hpp|hip\.hpp|cuh)(\"|>)"
+        if [ "${remove_test}" = "true" ]; then
+            output=$(echo "${output}" | sed -E "s~test/~~g")
+        fi
+    else
+        output="#include (<|\")$fix_include(\"|>)"
     fi
-done < "dev_tools/scripts/config"
-output=""
-if [ -z "${fix_include}" ]; then
-    local path_regex="([a-zA-Z_]*\/){${path_ignore}}(.*)\.(cpp|hpp|cu|cuh)"
-    if [ ! -z "${path_prefix}" ]; then
-        path_prefix="${path_prefix}/"
-    fi
-    output=$(echo "${file}" | sed -E "s~\.hip~~g;s~$path_regex~$path_prefix\2~g")
-    output=$(echo "${output}" | sed -E "s~$core_suffix$~~g")
-    output="#include (<|\")$output\.(hpp|hip\.hpp|cuh)(\"|>)"
-    if [ "${remove_test}" = "true" ]; then
-        output=$(echo "${output}" | sed -E "s~test/~~g")
-    fi
-else
-    output="#include (<|\")$fix_include(\"|>)"
-fi
-echo "$output"
+    echo "$output"
 }
 
 GINKGO_LICENSE_BEACON="******************************<GINKGO LICENSE>******************************"
@@ -105,6 +105,7 @@ BEFORE="before" # Store the main header and the #ifdef/#define of header file
 HAS_HIP_RUNTIME="false"
 DURING_LICENSE="false"
 INCLUDE_REGEX="^#include.*"
+INCLUDE_INC="\.inc"
 MAIN_PART_MATCH="$(get_include_regex $1)"
 HEADER_DEF=$(get_header_def $1)
 IFNDEF=""
@@ -118,7 +119,8 @@ ENDIF_REX="^#endif"
 IN_IF="false"
 KEEP_LINES=0
 LAST_NONEMPTY=""
-
+ALARM=""
+COMMENT_REGEX="^ *(\/\/|\/\*)"
 
 while IFS='' read -r line || [ -n "$line" ]; do
     if [ "${line}" = '#include "hip/hip_runtime.h"' ] && [ "${SKIP}" = "true" ]; then
@@ -150,18 +152,29 @@ while IFS='' read -r line || [ -n "$line" ]; do
                 IN_IF="false"
             fi
             SKIP="false"
+            if [ -z "${ALARM}" ]; then
+                ALARM="set"
+            fi
         elif [ ! -z "${MAIN_PART_MATCH}" ] && [[ "${line}" =~ ${MAIN_PART_MATCH} ]]; then
             line="$(convert_header ${line})"
             echo "${line}" >> ${BEFORE}
         else 
-            if [[ "${line}" =~ $INCLUDE_REGEX ]]; then
+            if [ -z "${ALARM}" ] && [[ "${line}" =~ $COMMENT_REGEX ]]; then
+                ALARM="set"
+            elif [[ "${line}" =~ $INCLUDE_REGEX ]]; then
                 line="$(convert_header ${line})"
+                if [[ ! "${line}" =~ $INCLUDE_INC ]] && [ "${ALARM}" = "set" ]; then
+                    ALARM="true"
+                fi
             fi
             echo "${line}" >> "${CONTENT}"
             SKIP="false"
         fi
     fi
 done < $1
+if [ "${ALARM}" = "true" ]; then
+    echo "ALARM $1 may not be sorted correctly"
+fi
 echo "/*${GINKGO_LICENSE_BEACON}" > $1
 cat LICENSE >> $1
 echo "${GINKGO_LICENSE_BEACON}*/" >> $1
@@ -221,31 +234,20 @@ if [ -f "${CONTENT}" ]; then
     PREV_INC=0
     IN_IF="false"
     while IFS='' read -r line; do
-        if [[ "${line}" =~ $IF_REX ]] || [ "$IN_IF" = "true" ]; then
-            # make sure that the header in #if is not extracted
-            echo "${line}" >> $1
-            IN_IF="true"
-            if [[ "${line}" =~ $ENDIF_REX ]]; then
-                IN_IF="false"
-                # To keep the original lines
-                PREV_INC=-3
+        if [[ ${line} =~ ${INCLUDE_REGEX} ]] && [[ ! ${line} =~ ${INCLUDE_INC} ]]; then
+            if [[ ${PREV_INC} == 1 ]]; then
+                echo "" >> $1
             fi
+            PREV_INC=0
         else
-            if [[ ${line} =~ ${INCLUDE_REGEX} ]]; then
-                if [[ ${PREV_INC} == 1 ]]; then
-                    echo "" >> $1
-                fi
-                PREV_INC=0
+            if [ -z "${line}" ]; then
+                PREV_INC=$((PREV_INC+1))
             else
-                if [ -z "${line}" ]; then
-                    PREV_INC=$((PREV_INC+1))
-                else
-                    # To keep the original lines
-                    PREV_INC=-3
-                fi
+                # To keep the original lines
+                PREV_INC=-3
             fi
-            echo "${line}" >> $1
         fi
+        echo "${line}" >> $1
     done < ${CONTENT}
     rm ${CONTENT}
 fi