Implement example applications in Fortran fpm

Author: awvwgk

ci/run_tests.bat

@@ -103,6 +103,17 @@ if errorlevel 1 exit 1
 .\build\gfortran_debug\test\farewell_test
 
 
+cd ..\with_examples
+if errorlevel 1 exit 1
+
+del /q /f build
+%fpm_path% build
+if errorlevel 1 exit 1
+
+.\build\gfortran_debug\app\demo-prog
+if errorlevel 1 exit 1
+
+
 cd ..\auto_discovery_off
 if errorlevel 1 exit 1
 
@@ -161,4 +172,4 @@ if errorlevel 1 exit 1
 .\build\gfortran_debug\app\gomp_test
 if errorlevel 1 exit 1
 
-cd ..\..
+cd ..\..

ci/run_tests.sh

@@ -48,6 +48,10 @@ cd ../hello_complex_2
 ./build/gfortran_debug/test/greet_test
 ./build/gfortran_debug/test/farewell_test
 
+cd ../with_examples
+"${f_fpm_path}" build
+./build/gfortran_debug/app/demo-prog
+
 cd ../auto_discovery_off
 "${f_fpm_path}" build
 ./build/gfortran_debug/app/auto_discovery_off
@@ -75,4 +79,4 @@ cd ../link_executable
 ./build/gfortran_debug/app/gomp_test
 
 # Cleanup
-rm -rf ./*/build
+rm -rf ./*/build

example_packages/README.md

@@ -13,6 +13,7 @@ the features demonstrated in each package and which versions of fpm are supporte
 | hello_complex_2     | Auto-discovery of tests and executables with modules          |            N            |  Y  |
 | hello_fpm           | App-only; local path dependency                               |            Y            |  Y  |
 | hello_world         | App-only                                                      |            Y            |  Y  |
+| with_examples       | Example-only                                                  |            N            |  Y  |
 | makefile_complex    | External build command (makefile); local path dependency      |            Y            |  N  |
 | program_with_module | App-only; module+program in single source file                |            Y            |  Y  |
 | submodules          | Lib-only; submodules (3 levels)                               |            N            |  Y  |

example_packages/with_examples/.gitignore

@@ -0,0 +1 @@
+/build/*

example_packages/with_examples/demo/prog.f90

@@ -0,0 +1,3 @@
+program demo
+  write(*, '(a)') "This is a simple demo program, but not a real application"
+end program demo

example_packages/with_examples/fpm.toml

@@ -0,0 +1,7 @@
+name = "with_examples"
+build.auto-examples = false
+
+[[example]]
+name = "demo-prog"
+source-dir = "demo"
+main = "prog.f90"

fpm/src/fpm.f90

@@ -6,8 +6,8 @@ module fpm
 use fpm_environment, only: run
 use fpm_filesystem, only: is_dir, join_path, number_of_rows, list_files, exists, basename
 use fpm_model, only: fpm_model_t, srcfile_t, build_target_t, &
-                    FPM_SCOPE_UNKNOWN, FPM_SCOPE_LIB, &
-                    FPM_SCOPE_DEP, FPM_SCOPE_APP, FPM_SCOPE_TEST, &
+                    FPM_SCOPE_UNKNOWN, FPM_SCOPE_LIB, FPM_SCOPE_DEP, &
+                    FPM_SCOPE_APP, FPM_SCOPE_EXAMPLE, FPM_SCOPE_TEST, &
                     FPM_TARGET_EXECUTABLE, FPM_TARGET_ARCHIVE
 use fpm_compiler, only: add_compile_flag_defaults
 
@@ -196,6 +196,15 @@ subroutine build_model(model, settings, package, error)
             return
         end if
 
+    end if
+    if (is_dir('example') .and. package%build%auto_examples) then
+        call add_sources_from_dir(model%sources,'example', FPM_SCOPE_EXAMPLE, &
+                                   with_executables=.true., error=error)
+
+        if (allocated(error)) then
+            return
+        end if
+
     end if
     if (is_dir('test') .and. package%build%auto_tests) then
         call add_sources_from_dir(model%sources,'test', FPM_SCOPE_TEST, &
@@ -215,6 +224,16 @@ subroutine build_model(model, settings, package, error)
             return
         end if
 
+    end if
+    if (allocated(package%example)) then
+        call add_executable_sources(model%sources, package%example, FPM_SCOPE_EXAMPLE, &
+                                     auto_discover=package%build%auto_executables, &
+                                     error=error)
+
+        if (allocated(error)) then
+            return
+        end if
+
     end if
     if (allocated(package%test)) then
         call add_executable_sources(model%sources, package%test, FPM_SCOPE_TEST, &
@@ -301,6 +320,7 @@ subroutine cmd_run(settings,test)
     type(string_t), allocatable :: executables(:)
     type(build_target_t), pointer :: exe_target
     type(srcfile_t), pointer :: exe_source
+    integer :: run_scope
 
     call get_package_data(package, "fpm.toml", error, apply_defaults=.true.)
     if (allocated(error)) then
@@ -314,6 +334,12 @@ subroutine cmd_run(settings,test)
         error stop 1
     end if
 
+    if (test) then
+       run_scope = FPM_SCOPE_TEST
+    else
+       run_scope = merge(FPM_SCOPE_EXAMPLE, FPM_SCOPE_APP, settings%example)
+    end if
+
     ! Enumerate executable targets to run
     col_width = -1
     found(:) = .false.
@@ -327,8 +353,7 @@ subroutine cmd_run(settings,test)
 
             exe_source => exe_target%dependencies(1)%ptr%source
 
-            if (exe_source%unit_scope == &
-                merge(FPM_SCOPE_TEST,FPM_SCOPE_APP,test)) then
+            if (exe_source%unit_scope == run_scope) then
 
                 col_width = max(col_width,len(basename(exe_target%output_file))+2)
 
@@ -391,8 +416,7 @@ subroutine cmd_run(settings,test)
 
                 exe_source => exe_target%dependencies(1)%ptr%source
 
-                if (exe_source%unit_scope == &
-                    merge(FPM_SCOPE_TEST,FPM_SCOPE_APP,test)) then
+                if (exe_source%unit_scope == run_scope) then
 
                     write(stderr,'(A)',advance=(merge("yes","no ",modulo(j,nCol)==0))) &
                                         & [character(len=col_width) :: basename(exe_target%output_file)]

fpm/src/fpm/manifest.f90

@@ -8,6 +8,7 @@
 !> to hide the actual implementation details.
 module fpm_manifest
     use fpm_manifest_build, only: build_config_t
+    use fpm_manifest_example, only : example_config_t
     use fpm_manifest_executable, only : executable_config_t
     use fpm_manifest_library, only : library_config_t
     use fpm_manifest_package, only : package_config_t, new_package
@@ -19,6 +20,7 @@ module fpm_manifest
     private
 
     public :: get_package_data, default_executable, default_library, default_test
+    public :: default_example
     public :: package_config_t
 
 
@@ -51,6 +53,21 @@ subroutine default_executable(self, name)
 
     end subroutine default_executable
 
+    !> Populate test in case we find the default example/ directory
+    subroutine default_example(self, name)
+
+        !> Instance of the executable meta data
+        type(example_config_t), intent(out) :: self
+
+        !> Name of the package
+        character(len=*), intent(in) :: name
+
+        self%name = name
+        self%source_dir = "example"
+        self%main = "main.f90"
+
+    end subroutine default_example
+
     !> Populate test in case we find the default test/ directory
     subroutine default_test(self, name)
 
@@ -126,14 +143,24 @@ subroutine package_defaults(package, error)
             call default_executable(package%executable(1), package%name)
         end if
 
+        ! Populate example in case we find the default example directory
+        if (.not.allocated(package%example) .and. &
+            exists(join_path("example","main.f90"))) then
+            allocate(package%example(1))
+            call default_example(package%example(1), package%name)
+        endif
+
         ! Populate test in case we find the default test directory
         if (.not.allocated(package%test) .and. &
             exists(join_path("test","main.f90"))) then
             allocate(package%test(1))
             call default_test(package%test(1), package%name)
         endif
 
-        if (.not.(allocated(package%library) .or. allocated(package%executable))) then
+        if (.not.(allocated(package%library) &
+            & .or. allocated(package%executable) &
+            & .or. allocated(package%example) &
+            & .or. allocated(package%test))) then
             call fatal_error(error, "Neither library nor executable found, there is nothing to do")
             return
         end if

fpm/src/fpm/manifest/build.f90

@@ -5,6 +5,7 @@
 !>```toml
 !>[build]
 !>auto-executables = bool
+!>auto-examples = bool
 !>auto-tests = bool
 !>link = ["lib"]
 !>```
@@ -24,6 +25,9 @@ module fpm_manifest_build
         !> Automatic discovery of executables
         logical :: auto_executables
 
+        !> Automatic discovery of examples
+        logical :: auto_examples
+
         !> Automatic discovery of tests
         logical :: auto_tests
 
@@ -72,6 +76,14 @@ subroutine new_build_config(self, table, error)
             return
         end if
 
+        call get_value(table, "auto-examples", self%auto_examples, .true., stat=stat)
+
+        if (stat /= toml_stat%success) then
+            call fatal_error(error,"Error while reading value for 'auto-examples' in fpm.toml, expecting logical")
+            return
+        end if
+
+
         call get_value(table, "link", self%link, error)
         if (allocated(error)) return
 
@@ -98,7 +110,7 @@ subroutine check(table, error)
         do ikey = 1, size(list)
             select case(list(ikey)%key)
 
-            case("auto-executables", "auto-tests", "link")
+            case("auto-executables", "auto-examples", "auto-tests", "link")
                 continue
 
             case default
@@ -136,6 +148,7 @@ subroutine info(self, unit, verbosity)
 
         write(unit, fmt) "Build configuration"
         write(unit, fmt) " - auto-discovery (apps) ", merge("enabled ", "disabled", self%auto_executables)
+        write(unit, fmt) " - auto-discovery (examples) ", merge("enabled ", "disabled", self%auto_examples)
         write(unit, fmt) " - auto-discovery (tests) ", merge("enabled ", "disabled", self%auto_tests)
         if (allocated(self%link)) then
             write(unit, fmt) " - link against"