Merge branch 'master' into Distribution-Normal

Author: Jim-215-Fisher

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,4 @@
+<!--
+Thank you for contributing to stdlib.
+To help us get your pull request merged more quickly, please consider reviewing any of the already open pull requests.
+-->

.github/workflows/CI.yml

@@ -21,9 +21,18 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest]
         gcc_v: [9, 10, 11] # Version of GFortran we want to use.
+        build: [cmake]
+        include:
+          - os: ubuntu-latest
+            gcc_v: 10
+            build: cmake-inline
+          - os: ubuntu-latest
+            gcc_v: 10
+            build: make
     env:
       FC: gfortran-${{ matrix.gcc_v }}
       GCC_V: ${{ matrix.gcc_v }}
+      BUILD_DIR: ${{ matrix.build == 'cmake' && 'build' || '.' }}
 
     steps:
     - name: Checkout code
@@ -58,39 +67,38 @@ jobs:
           brew link gcc@${GCC_V}
 
     - name: Configure with CMake
+      if: ${{ contains(matrix.build, 'cmake') }}
       run: >-
         cmake -Wdev
         -DCMAKE_BUILD_TYPE=Release
         -DCMAKE_MAXIMUM_RANK:String=4
         -DCMAKE_INSTALL_PREFIX=$PWD/_dist
-        -S . -B build
+        -S . -B ${{ env.BUILD_DIR }}
 
     - name: Build and compile
-      run: cmake --build build --parallel
+      if: ${{ contains(matrix.build, 'cmake') }}
+      run: cmake --build ${{ env.BUILD_DIR }} --parallel
 
     - name: catch build fail
-      run: cmake --build build --verbose --parallel 1
-      if: failure()
+      run: cmake --build ${{ env.BUILD_DIR }} --verbose --parallel 1
+      if: ${{ failure() && contains(matrix.build, 'cmake') }}
 
     - name: test
-      run: ctest --test-dir build --parallel --output-on-failure
+      if: ${{ contains(matrix.build, 'cmake') }}
+      run: ctest --test-dir ${{ env.BUILD_DIR }} --parallel --output-on-failure
 
     - name: Install project
-      run: cmake --install build
-
-    - name: Test in-tree builds
-      if: contains( matrix.gcc_v, '10') # Only test one compiler on each platform
-      run: |
-          cmake -DCMAKE_MAXIMUM_RANK=4 .
-          cmake --build .
-          cmake --build . --target test
+      if: ${{ contains(matrix.build, 'cmake') }}
+      run: cmake --install ${{ env.BUILD_DIR }}
 
     - name: Test manual makefiles
-      if: contains(matrix.os, 'ubuntu') && contains(matrix.gcc_v, '10')
+      if: ${{ matrix.build == 'make' }}
       run: |
-        make -f Makefile.manual FYPPFLAGS="-DMAXRANK=4" -j
+        make -f Makefile.manual -j
         make -f Makefile.manual test
         make -f Makefile.manual clean
+      env:
+        FYPPFLAGS: "-DMAXRANK=4"
 
   intel-build:
     runs-on: ${{ matrix.os }}

.github/workflows/fpm-deployment.yml

@@ -33,7 +33,7 @@ jobs:
     - name: Install fpm latest release
       uses: fortran-lang/setup-fpm@v3
       with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
+        fpm-version: 'v0.4.0'
 
     - name: Run fpm test ⚙
       run: |

API-doc-FORD-file.md

@@ -9,6 +9,9 @@ media_dir: doc/media
 fpp_extensions: fypp
 preprocess: true
 macro: MAXRANK=3
+       PROJECT_VERSION_MAJOR=0
+       PROJECT_VERSION_MINOR=0
+       PROJECT_VERSION_PATCH=0
 preprocessor: fypp
 display: public
          protected

CMakeLists.txt

@@ -1,9 +1,17 @@
 cmake_minimum_required(VERSION 3.14.0)
 project(fortran_stdlib
         LANGUAGES Fortran
-        VERSION 0.1.0
         DESCRIPTION "Community driven and agreed upon de facto standard library for Fortran"
 )
+
+# Read version from file
+file(STRINGS "${PROJECT_SOURCE_DIR}/VERSION" PROJECT_VERSION)
+string(REPLACE "." ";" VERSION_LIST ${PROJECT_VERSION})
+list(GET VERSION_LIST 0 PROJECT_VERSION_MAJOR)
+list(GET VERSION_LIST 1 PROJECT_VERSION_MINOR)
+list(GET VERSION_LIST 2 PROJECT_VERSION_PATCH)
+unset(VERSION_LIST)
+
 enable_testing()
 
 # Follow GNU conventions for installation directories
@@ -24,7 +32,6 @@ if(CMAKE_Fortran_COMPILER_ID STREQUAL GNU)
   add_compile_options(-Wall)
   add_compile_options(-Wextra)
   add_compile_options(-Wimplicit-procedure)
-  add_compile_options(-Wconversion-extra)
   # -pedantic-errors triggers a false positive for optional arguments of elemental functions,
   # see test_optval and https://gcc.gnu.org/bugzilla/show_bug.cgi?id=95446
   if(CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 11.0)
@@ -55,7 +62,7 @@ endif()
 # --- find preprocessor
 find_program(FYPP fypp)
 if(NOT FYPP)
-  message(FATAL_ERROR "Preprocessor fypp not found!")
+  message(FATAL_ERROR "Preprocessor fypp not found! Please install fypp following the instructions in https://fypp.readthedocs.io/en/stable/fypp.html#installing")
 endif()
 
 add_subdirectory(src)

Makefile.manual

@@ -4,6 +4,12 @@ FC ?= gfortran
 FFLAGS ?= -Wall -Wextra -Wimplicit-interface -fPIC -g -fcheck=all
 FYPPFLAGS ?=
 
+VERSION := $(subst ., ,$(file < VERSION))
+FYPPFLAGS += \
+             -DPROJECT_VERSION_MAJOR=$(word 1,$(VERSION)) \
+             -DPROJECT_VERSION_MINOR=$(word 2,$(VERSION)) \
+             -DPROJECT_VERSION_PATCH=$(word 3,$(VERSION))
+
 export FC
 export FFLAGS
 export FYPPFLAGS

VERSION

@@ -0,0 +1 @@
+0.1.0

ci/fpm-deployment.sh

@@ -12,23 +12,32 @@ fypp="${FYPP:-$(which fypp)}"
 fyflags="${FYFLAGS:--DMAXRANK=4}"
 
 # Number of parallel jobs for preprocessing
-njob="$(nproc)"
+if [ $(uname) = "Darwin" ]; then
+  njob="$(sysctl -n hw.ncpu)"
+else
+  njob="$(nproc)"
+fi
 
 # Additional files to include
 include=(
   "ci/fpm.toml"
   "LICENSE"
+  "VERSION"
 )
 
 # Files to remove from collection
 prune=(
   "$destdir/test/test_always_fail.f90"
   "$destdir/test/test_always_skip.f90"
-  "$destdir/test/test_mean_f03.f90"
   "$destdir/src/common.f90"
   "$destdir/src/f18estop.f90"
 )
 
+major=$(cut -d. -f1 VERSION)
+minor=$(cut -d. -f2 VERSION)
+patch=$(cut -d. -f3 VERSION)
+fyflags="${fyflags} -DPROJECT_VERSION_MAJOR=${major} -DPROJECT_VERSION_MINOR=${minor} -DPROJECT_VERSION_PATCH=${patch}"
+
 mkdir -p "$destdir/src" "$destdir/test"
 
 # Preprocess stdlib sources
@@ -43,7 +52,7 @@ find src/tests -name "*.dat" -exec cp {} "$destdir/" \;
 # Include additional files
 cp "${include[@]}" "$destdir/"
 
-# Source file workarounds for fpm
+# Source file workarounds for fpm; ignore missing files
 rm "${prune[@]}"
 
 # List stdlib-fpm package contents

ci/fpm.toml

@@ -1,6 +1,10 @@
 name = "stdlib"
-version = "0.1.0"
+version = "VERSION"
 license = "MIT"
 author = "stdlib contributors"
 maintainer = "@fortran-lang/stdlib"
 copyright = "2019-2021 stdlib contributors"
+
+[dev-dependencies]
+test-drive.git = "https://github.com/fortran-lang/test-drive"
+test-drive.tag = "v0.4.0"

config/CMakeLists.txt

@@ -10,6 +10,27 @@ if(NOT DEFINED CMAKE_INSTALL_MODULEDIR)
   )
 endif()
 
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
+set(CMAKE_MODULE_PATH "${CMAKE_MODULE_PATH}" PARENT_SCOPE)
+
+# Check for available features
+# Note: users can overwrite the automatic check by setting the value at configure time
+include(CheckFortranSourceRuns)
+if (NOT DEFINED WITH_QP)
+  check_fortran_source_runs(
+    "if (selected_real_kind(33) == -1) stop 1; end"
+    WITH_QP
+  )
+  set(WITH_QP ${WITH_QP} PARENT_SCOPE)
+endif()
+if (NOT DEFINED WITH_XDP)
+  check_fortran_source_runs(
+    "if (any(selected_real_kind(18) == [-1, selected_real_kind(33)])) stop 1; end"
+    WITH_XDP
+  )
+  set(WITH_XDP ${WITH_XDP} PARENT_SCOPE)
+endif()
+
 # Export a pkg-config file
 configure_file(
   "${CMAKE_CURRENT_SOURCE_DIR}/template.pc"