Migrate ScriptX to Github for open source, ignoring previous history.

Author: taylorcyang

.clang-format

@@ -0,0 +1,18 @@
+# this is the tencent cpp format style
+Language: Cpp
+BasedOnStyle: Google
+ColumnLimit: 100
+
+# Only sort headers in each include block
+SortIncludes: true
+IncludeBlocks: Preserve
+
+---
+Language: ObjC
+BasedOnStyle: Google
+ColumnLimit: 100
+
+---
+Language: JavaScript
+BasedOnStyle: Google
+ColumnLimit: 100

.clang-tidy

@@ -0,0 +1,225 @@
+---
+Checks:          'clang-diagnostic-*,
+                  clang-analyzer-*,
+                  -*,
+                  modernize-*,
+                  -modernize-use-trailing-return-type,
+                  -modernize-use-nodiscard,
+                  bugprone-*,
+                  -bugprone-macro-parentheses,
+                  google-*,
+                  performance-*,
+                  -performance-trivially-destructible,
+                  misc-*,
+                  clang-*,
+                  android-*,
+                  cppcoreguidelines-*,
+                  -cppcoreguidelines-pro-type-reinterpret-cast,
+                  -cppcoreguidelines-owning-memory,
+                  -cppcoreguidelines-pro-bounds-array-to-pointer-decay,
+                  -cppcoreguidelines-macro-usage,
+                  -cppcoreguidelines-pro-type-const-cast,
+                  -cppcoreguidelines-pro-bounds-pointer-arithmetic,
+                  -cppcoreguidelines-avoid-non-const-global-variables'
+WarningsAsErrors: ''
+HeaderFilterRegex: ''
+AnalyzeTemporaryDtors: false
+FormatStyle:     none
+User:            young
+CheckOptions:
+  - key:             bugprone-argument-comment.StrictMode
+    value:           '0'
+  - key:             bugprone-assert-side-effect.AssertMacros
+    value:           assert
+  - key:             bugprone-assert-side-effect.CheckFunctionCalls
+    value:           '0'
+  - key:             bugprone-dangling-handle.HandleClasses
+    value:           'std::basic_string_view;std::experimental::basic_string_view'
+  - key:             bugprone-exception-escape.FunctionsThatShouldNotThrow
+    value:           ''
+  - key:             bugprone-exception-escape.IgnoredExceptions
+    value:           ''
+  - key:             bugprone-misplaced-widening-cast.CheckImplicitCasts
+    value:           '0'
+  - key:             bugprone-sizeof-expression.WarnOnSizeOfCompareToConstant
+    value:           '1'
+  - key:             bugprone-sizeof-expression.WarnOnSizeOfConstant
+    value:           '1'
+  - key:             bugprone-sizeof-expression.WarnOnSizeOfIntegerExpression
+    value:           '0'
+  - key:             bugprone-sizeof-expression.WarnOnSizeOfThis
+    value:           '1'
+  - key:             bugprone-string-constructor.LargeLengthThreshold
+    value:           '8388608'
+  - key:             bugprone-string-constructor.WarnOnLargeLength
+    value:           '1'
+  - key:             bugprone-suspicious-enum-usage.StrictMode
+    value:           '0'
+  - key:             bugprone-suspicious-missing-comma.MaxConcatenatedTokens
+    value:           '5'
+  - key:             bugprone-suspicious-missing-comma.RatioThreshold
+    value:           '0.200000'
+  - key:             bugprone-suspicious-missing-comma.SizeThreshold
+    value:           '5'
+  - key:             bugprone-suspicious-string-compare.StringCompareLikeFunctions
+    value:           ''
+  - key:             bugprone-suspicious-string-compare.WarnOnImplicitComparison
+    value:           '1'
+  - key:             bugprone-suspicious-string-compare.WarnOnLogicalNotComparison
+    value:           '0'
+  - key:             bugprone-unused-return-value.CheckedFunctions
+    value:           '::std::async;::std::launder;::std::remove;::std::remove_if;::std::unique;::std::unique_ptr::release;::std::basic_string::empty;::std::vector::empty'
+  - key:             cert-dcl16-c.NewSuffixes
+    value:           'L;LL;LU;LLU'
+  - key:             cppcoreguidelines-avoid-magic-numbers.IgnoredFloatingPointValues
+    value:           '1.0;100.0;'
+  - key:             cppcoreguidelines-avoid-magic-numbers.IgnoredIntegerValues
+    value:           '1;2;3;4;'
+  - key:             cppcoreguidelines-no-malloc.Allocations
+    value:           '::malloc;::calloc'
+  - key:             cppcoreguidelines-no-malloc.Deallocations
+    value:           '::free'
+  - key:             cppcoreguidelines-no-malloc.Reallocations
+    value:           '::realloc'
+  - key:             cppcoreguidelines-non-private-member-variables-in-classes.IgnoreClassesWithAllMemberVariablesBeingPublic
+    value:           '1'
+  - key:             cppcoreguidelines-owning-memory.LegacyResourceConsumers
+    value:           '::free;::realloc;::freopen;::fclose'
+  - key:             cppcoreguidelines-owning-memory.LegacyResourceProducers
+    value:           '::malloc;::aligned_alloc;::realloc;::calloc;::fopen;::freopen;::tmpfile'
+  - key:             cppcoreguidelines-pro-bounds-constant-array-index.GslHeader
+    value:           ''
+  - key:             cppcoreguidelines-pro-bounds-constant-array-index.IncludeStyle
+    value:           '0'
+  - key:             cppcoreguidelines-pro-type-member-init.IgnoreArrays
+    value:           '0'
+  - key:             cppcoreguidelines-special-member-functions.AllowMissingMoveFunctions
+    value:           '0'
+  - key:             cppcoreguidelines-special-member-functions.AllowSoleDefaultDtor
+    value:           '0'
+  - key:             google-build-namespaces.HeaderFileExtensions
+    value:           ',h,hh,hpp,hxx'
+  - key:             google-global-names-in-headers.HeaderFileExtensions
+    value:           ',h,hh,hpp,hxx'
+  - key:             google-readability-braces-around-statements.ShortStatementLines
+    value:           '1'
+  - key:             google-readability-function-size.BranchThreshold
+    value:           '4294967295'
+  - key:             google-readability-function-size.LineThreshold
+    value:           '4294967295'
+  - key:             google-readability-function-size.NestingThreshold
+    value:           '4294967295'
+  - key:             google-readability-function-size.ParameterThreshold
+    value:           '4294967295'
+  - key:             google-readability-function-size.StatementThreshold
+    value:           '800'
+  - key:             google-readability-function-size.VariableThreshold
+    value:           '4294967295'
+  - key:             google-readability-namespace-comments.ShortNamespaceLines
+    value:           '10'
+  - key:             google-readability-namespace-comments.SpacesBeforeComments
+    value:           '2'
+  - key:             google-runtime-int.SignedTypePrefix
+    value:           int
+  - key:             google-runtime-int.TypeSuffix
+    value:           ''
+  - key:             google-runtime-int.UnsignedTypePrefix
+    value:           uint
+  - key:             google-runtime-references.WhiteListTypes
+    value:           ''
+  - key:             misc-definitions-in-headers.HeaderFileExtensions
+    value:           ',h,hh,hpp,hxx'
+  - key:             misc-definitions-in-headers.UseHeaderFileExtension
+    value:           '1'
+  - key:             misc-throw-by-value-catch-by-reference.CheckThrowTemporaries
+    value:           '1'
+  - key:             misc-unused-parameters.StrictMode
+    value:           '0'
+  - key:             modernize-loop-convert.MaxCopySize
+    value:           '16'
+  - key:             modernize-loop-convert.MinConfidence
+    value:           reasonable
+  - key:             modernize-loop-convert.NamingStyle
+    value:           CamelCase
+  - key:             modernize-make-shared.IgnoreMacros
+    value:           '1'
+  - key:             modernize-make-shared.IncludeStyle
+    value:           '0'
+  - key:             modernize-make-shared.MakeSmartPtrFunction
+    value:           'std::make_shared'
+  - key:             modernize-make-shared.MakeSmartPtrFunctionHeader
+    value:           memory
+  - key:             modernize-make-unique.IgnoreMacros
+    value:           '1'
+  - key:             modernize-make-unique.IncludeStyle
+    value:           '0'
+  - key:             modernize-make-unique.MakeSmartPtrFunction
+    value:           'std::make_unique'
+  - key:             modernize-make-unique.MakeSmartPtrFunctionHeader
+    value:           memory
+  - key:             modernize-pass-by-value.IncludeStyle
+    value:           llvm
+  - key:             modernize-pass-by-value.ValuesOnly
+    value:           '0'
+  - key:             modernize-raw-string-literal.ReplaceShorterLiterals
+    value:           '0'
+  - key:             modernize-replace-auto-ptr.IncludeStyle
+    value:           llvm
+  - key:             modernize-replace-random-shuffle.IncludeStyle
+    value:           llvm
+  - key:             modernize-use-auto.MinTypeNameLength
+    value:           '5'
+  - key:             modernize-use-auto.RemoveStars
+    value:           '0'
+  - key:             modernize-use-default-member-init.IgnoreMacros
+    value:           '1'
+  - key:             modernize-use-default-member-init.UseAssignment
+    value:           '0'
+  - key:             modernize-use-emplace.ContainersWithPushBack
+    value:           '::std::vector;::std::list;::std::deque'
+  - key:             modernize-use-emplace.SmartPointers
+    value:           '::std::shared_ptr;::std::unique_ptr;::std::auto_ptr;::std::weak_ptr'
+  - key:             modernize-use-emplace.TupleMakeFunctions
+    value:           '::std::make_pair;::std::make_tuple'
+  - key:             modernize-use-emplace.TupleTypes
+    value:           '::std::pair;::std::tuple'
+  - key:             modernize-use-equals-default.IgnoreMacros
+    value:           '1'
+  - key:             modernize-use-equals-delete.IgnoreMacros
+    value:           '1'
+  - key:             modernize-use-nodiscard.ReplacementString
+    value:           '[[nodiscard]]'
+  - key:             modernize-use-noexcept.ReplacementString
+    value:           ''
+  - key:             modernize-use-noexcept.UseNoexceptFalse
+    value:           '1'
+  - key:             modernize-use-nullptr.NullMacros
+    value:           'NULL'
+  - key:             modernize-use-transparent-functors.SafeMode
+    value:           '0'
+  - key:             modernize-use-using.IgnoreMacros
+    value:           '1'
+  - key:             performance-faster-string-find.StringLikeClasses
+    value:           'std::basic_string'
+  - key:             performance-for-range-copy.AllowedTypes
+    value:           ''
+  - key:             performance-for-range-copy.WarnOnAllAutoCopies
+    value:           '0'
+  - key:             performance-inefficient-string-concatenation.StrictMode
+    value:           '0'
+  - key:             performance-inefficient-vector-operation.VectorLikeClasses
+    value:           '::std::vector'
+  - key:             performance-move-const-arg.CheckTriviallyCopyableMove
+    value:           '1'
+  - key:             performance-move-constructor-init.IncludeStyle
+    value:           llvm
+  - key:             performance-type-promotion-in-math-fn.IncludeStyle
+    value:           llvm
+  - key:             performance-unnecessary-copy-initialization.AllowedTypes
+    value:           ''
+  - key:             performance-unnecessary-value-param.AllowedTypes
+    value:           ''
+  - key:             performance-unnecessary-value-param.IncludeStyle
+    value:           llvm
+...
+

.devtools/LicenseHeader.template

@@ -0,0 +1,17 @@
+ /*
+  * Tencent is pleased to support the open source community by making ScriptX available.
+  * Copyright (C) ${YEAR} THL A29 Limited, a Tencent company.  All rights reserved.
+  *
+  * Licensed under the Apache License, Version 2.0 (the "License");
+  * you may not use this file except in compliance with the License.
+  * You may obtain a copy of the License at
+  *
+  *      http://www.apache.org/licenses/LICENSE-2.0
+  *
+  * Unless required by applicable law or agreed to in writing, software
+  * distributed under the License is distributed on an "AS IS" BASIS,
+  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  * See the License for the specific language governing permissions and
+  * limitations under the License.
+  */
+

.devtools/appendLicenseHeader.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+# bash case insensitive match
+shopt -s nocasematch
+
+DEVTOOLS=$(dirname $0)
+
+file=$1
+
+TEMPLATE_FILE=${DEVTOOLS}/LicenseHeader.template
+THIRDPARTY_PATTERN='thirdparty|third_party'
+YEAR=$(date +"%Y")
+
+if [[ $file =~ ${THIRDPARTY_PATTERN} ]]; then
+  exit 0
+fi
+
+if ! grep -q 'THL A29 Limited, a Tencent company.' $file; then
+  echo "append license header to $file"
+  temp_file=$(mktemp)
+  sed -e "s/\${YEAR\}/${YEAR}/" ${TEMPLATE_FILE} > $temp_file
+  cat $file >> $temp_file
+  # copy file content instead of moving file to keep file attributes
+  cat $temp_file > $file
+  rm -f $temp_file
+fi

.devtools/hooks/pre-commit

@@ -0,0 +1,71 @@
+#!/bin/bash
+
+DEVTOOLS=.devtools
+# C C++ OC files
+SOURCE_SUFFIX='\.(h|c|cpp|cc|hpp|cxx|hxx|m|mm|js)$'
+
+# bash case insensitive match
+shopt -s nocasematch
+
+# clang-format
+if ! command -v clang-format >/dev/null 2>&1; then
+  cat >&2 <<EOF
+clang-format not fond, abort git commit.
+please install clang-format first, then commit again.
+
+mac     -> brew install clang-format
+windows -> http://llvm.org/builds/
+ubuntu  -> sudo apt install clang-format
+
+EOF
+  exit 1
+fi
+
+function regenerateVersionHeader() {
+  VERSION_STRING=$(cat VERSION)
+  IFS='.' read -a VERSION_ARRAY <<<"${VERSION_STRING}"
+
+  cat > src/version.h <<EOF
+// ScriptX version config files
+// auto generated from the file VERSION
+#define SCRIPTX_VERSION_STRING "${VERSION_STRING}"
+#define SCRIPTX_VERSION_MAJOR ${VERSION_ARRAY[0]}
+#define SCRIPTX_VERSION_MINOR ${VERSION_ARRAY[1]}
+#define SCRIPTX_VERSION_PATCH ${VERSION_ARRAY[2]}
+
+constexpr const char* kVersionString = SCRIPTX_VERSION_STRING;
+constexpr int kVersionMajor = SCRIPTX_VERSION_MAJOR;
+constexpr int kVersionMinor = SCRIPTX_VERSION_MINOR;
+constexpr int kVersionPatch = SCRIPTX_VERSION_PATCH;
+
+EOF
+
+  git add src/version.h
+}
+
+function formatFile() {
+  file=$1
+  if [[ -f $file ]]; then
+    # append license headers
+    ${DEVTOOLS}/appendLicenseHeader.sh $file
+    echo "clang-format $file"
+    clang-format -i $file
+    # stage changed
+    git add $file
+  fi
+}
+
+for file in $(git diff-index --cached --diff-filter=d --name-only HEAD); do
+  # version file
+  if [[ $file == "VERSION" ]]; then
+    echo regenerate src/version.h from VERSION
+    regenerateVersionHeader
+    formatFile src/version.h
+  fi
+
+  # clang-format & license header
+  if [[ $file =~ ${SOURCE_SUFFIX} ]]; then
+    formatFile "$file"
+  fi
+
+done

.devtools/install.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+set -e
+
+cd "$(git rev-parse --show-toplevel)"
+DEVTOOLS=.devtools
+
+chmod a+x ${DEVTOOLS}/*.sh
+
+cp ${DEVTOOLS}/hooks/pre-commit .git/hooks/
+chmod a+x .git/hooks/pre-commit
+
+if ! command -v clang-format >/dev/null 2>&1; then
+  cat >&2 <<EOF
+clang-format not fond, git commit would fail.
+please install clang-format.
+
+mac     -> brew install clang-format
+windows -> http://llvm.org/builds/
+ubuntu  -> sudo apt install clang-format
+
+EOF
+fi