Obtain os from cmake and python script and make is_windows and path_separator parameters

Author: minhqdao

CMakeLists.txt

@@ -65,6 +65,7 @@ list(
   "-DPROJECT_VERSION_MAJOR=${PROJECT_VERSION_MAJOR}"
   "-DPROJECT_VERSION_MINOR=${PROJECT_VERSION_MINOR}"
   "-DPROJECT_VERSION_PATCH=${PROJECT_VERSION_PATCH}"
+  "-DOS=\\\"${CMAKE_SYSTEM_NAME}\\\""
   "-I${PROJECT_SOURCE_DIR}/include"
 )
 

config/fypp_deployment.py

@@ -1,4 +1,5 @@
 import os
+import platform
 import fypp
 import argparse
 from joblib import Parallel, delayed
@@ -42,6 +43,7 @@ def pre_process_fypp(args):
         kwd.append("-DWITH_QP=True")
     if args.with_xdp:
         kwd.append("-DWITH_XDP=True")
+    kwd.append("-DOS=\"{}\"".format(platform.system()))
 
     optparser = fypp.get_option_parser()
     options, leftover = optparser.parse_args(args=kwd)

doc/specs/stdlib_io.md

@@ -123,42 +123,6 @@ Provides a text file called `filename` that contains the rank-2 `array`.
 {!example/io/example_savetxt.f90!}
 ```
 
-## `is_windows`
-
-### Status
-
-Experimental
-
-### Description
-
-Returns a logical value indicating whether the current operating system is Windows.
-
-### Syntax
-
-`is_windows = ` [[stdlib_io_filesystem(module):is_windows(function)]] `()`
-
-### Return value
-
-A logical value indicating whether the current operating system is Windows.
-
-## `path_separator`
-
-### Status
-
-Experimental
-
-### Description
-
-Returns the path separator for the current operating system.
-
-### Syntax
-
-`separator = ` [[stdlib_io_filesystem(module):path_separator(function)]] `()`
-
-### Return value
-
-A character value containing the path separator for the current operating system.
-
 ## `exists`
 
 ### Status

src/CMakeLists.txt

@@ -17,6 +17,7 @@ set(fppFiles
     stdlib_hash_64bit_pengy.fypp
     stdlib_hash_64bit_spookyv2.fypp
     stdlib_io.fypp
+    stdlib_io_filesystem.fypp
     stdlib_io_npy.fypp
     stdlib_io_npy_load.fypp
     stdlib_io_npy_save.fypp
@@ -109,7 +110,6 @@ set(SRC
     stdlib_hashmaps.f90
     stdlib_hashmap_chaining.f90
     stdlib_hashmap_open.f90
-    stdlib_io_filesystem.F90
     stdlib_logger.f90
     stdlib_sorting_radix_sort.f90
     stdlib_system.F90

src/stdlib_io_filesystem.F90 renamed to src/stdlib_io_filesystem.fypp

@@ -1,50 +1,24 @@
 ! SPDX-Identifier: MIT
 
- !> Interaction with the filesystem.
+!> Interaction with the filesystem.
 module stdlib_io_filesystem
     use stdlib_string_type, only: string_type
     implicit none
     private
 
     public :: temp_dir, is_windows, exists, path_separator, list_dir, mkdir, rmdir, run
 
+#: if OS == 'Windows'
+    logical, parameter :: is_windows = .true.
+    character, parameter :: path_separator = '\'
+#: else
+    logical, parameter :: is_windows = .false.
+    character, parameter :: path_separator = '/'
+#: endif
+
     character(*), parameter :: temp_dir = 'temp'
 
 contains
-
-    !> Version: experimental
-    !>
-    !> Whether the operating system is Windows.
-    !> [Specification](../page/specs/stdlib_io.html#is_windows)
-    logical function is_windows()
-        character(len=255) :: value
-        integer :: length, stat
-
-        call get_environment_variable('OSTYPE', value, length, stat)
-        if (stat == 0 .and. length > 0 .and. (index(value, 'win') > 0 .or. index(value, 'msys') > 0)) then
-            is_windows = .true.; return
-        end if
-
-        call get_environment_variable('OS', value, length, stat)
-        if (stat == 0 .and. length > 0 .and. index(value, 'Windows_NT') > 0) then
-            is_windows = .true.; return
-        end if
-
-        is_windows = .false.
-    end function
-
-    !> Version: experimental
-    !>
-    !> Returns the path separator for the current operating system.
-    !> [Specification](../page/specs/stdlib_io.html#path_separator)
-    character function path_separator()
-        if (is_windows()) then
-            path_separator = '\'
-        else
-            path_separator = '/'
-        end if
-    end function
-
     !> Version: experimental
     !>
     !> Whether a file or directory exists at the given path.
@@ -89,9 +63,9 @@ subroutine list_dir(dir, files, iostat, iomsg)
             end if
         end if
 
-        listed_contents = temp_dir//path_separator()//'listed_contents.txt'
+        listed_contents = temp_dir//path_separator//'listed_contents.txt'
 
-        if (is_windows()) then
+        if (is_windows) then
             call run('dir /b '//dir//' > '//listed_contents, stat)
         else
             call run('ls '//dir//' > '//listed_contents, stat)
@@ -127,7 +101,7 @@ subroutine mkdir(dir, iostat, iomsg)
         integer, optional, intent(out) :: iostat
         character(len=:), allocatable, optional, intent(out) :: iomsg
 
-        if (is_windows()) then
+        if (is_windows) then
             call run('mkdir '//dir, iostat, iomsg)
         else
             call run('mkdir -p '//dir, iostat, iomsg)
@@ -141,7 +115,7 @@ subroutine mkdir(dir, iostat, iomsg)
     subroutine rmdir(dir)
         character(len=*), intent(in) :: dir
 
-        if (is_windows()) then
+        if (is_windows) then
             call run('rmdir /s/q '//dir)
         else
             call run('rm -rf '//dir)

test/io/test_filesystem.f90

@@ -41,7 +41,7 @@ subroutine fs_is_windows(error)
         integer :: length, stat
 
         call get_environment_variable('HOMEDRIVE', value, length, stat)
-        if (is_windows()) then
+        if (is_windows) then
             call check(error, stat == 0 .and. length > 0, "Windows should be detected.")
         else
             call check(error, stat /= 0 .and. length == 0, "Windows should not be detected.")
@@ -91,8 +91,8 @@ subroutine fs_path_separator(error)
         call check(error, .not. exists(outer_dir), "Directory should not exist.")
         call mkdir(outer_dir)
         call check(error, exists(outer_dir), "Outer directory should now exist.")
-        call mkdir(outer_dir//path_separator()//inner_dir)
-        call check(error, exists(outer_dir//path_separator()//inner_dir), "Inner directory should now exist.")
+        call mkdir(outer_dir//path_separator//inner_dir)
+        call check(error, exists(outer_dir//path_separator//inner_dir), "Inner directory should now exist.")
         call rmdir(outer_dir)
     end subroutine
 
@@ -223,7 +223,7 @@ subroutine fs_list_dir_one_file_one_dir(error)
             call test_failed(error, "Creating file 1 in directory '"//temp_list_dir//"' failed."); return
         end if
 
-        if (is_windows()) then
+        if (is_windows) then
             call mkdir(temp_list_dir//'\'//dir, stat)
         else
             call mkdir(temp_list_dir//'/'//dir, stat)
@@ -263,7 +263,7 @@ subroutine fs_rmdir_with_contents(error)
         call check(error, .not. exists(dir), "Directory should not exist.")
         call mkdir(dir)
         call check(error, exists(dir), "Directory should exist.")
-        if (is_windows()) then
+        if (is_windows) then
             call mkdir(dir//'\'//'another_dir')
         else
             call mkdir(dir//'/'//'another_dir')