added specs

Author: wassup05

doc/specs/stdlib_system.md

@@ -418,6 +418,83 @@ Returns one of the `integer` `OS_*` parameters representing the OS type, from th
 
 ---
 
+## `fs_error` - Helper function for error handling
+
+### Status
+
+Experimental
+
+### Description
+
+A helper function for returning the `type(state_type)` with the flag `STDLIB_FS_ERROR` set.
+
+### Syntax
+
+`err = fs_error([a1,a2,a3,a4...... a20])`
+
+### Class
+Pure Function
+
+### Arguments
+
+`a1,a2,a3.....a20`(optional) : They are of type `class(*), dimension(..), optional, intent(in)`. 
+An arbitrary list of `integer`, `real`, `complex`, or `character` variables. Numeric variables may be provided as either scalars or rank-1 (array) inputs.
+
+### Behavior
+
+Formats all the arguments into a nice error message, utilising the constructor of [[stdlib_system(module):state_type(type)]]
+
+### Return values
+
+`type(state_type)`
+
+### Example
+
+```fortran
+{!example/system/example_fs_error.f90!}
+```
+
+---
+
+## `fs_error_code` - Helper function for error handling (with error code)
+
+### Status
+
+Experimental
+
+### Description
+
+A helper function for returning the `type(state_type)` with the flag `STDLIB_FS_ERROR` set.
+It also formats and prefixes the `code` passed to it as the first argument.
+
+### Syntax
+
+`err = fs_error(code [, a1,a2,a3,a4...... a19])`
+
+### Class
+Pure Function
+
+### Arguments
+
+`a1,a2,a3.....a19`: They are of type `class(*), dimension(..), optional, intent(in)`.
+An arbitrary list of `integer`, `real`, `complex`, or `character` variables. Numeric variables may be provided as either scalars or rank-1 (array) inputs.
+
+### Behavior
+
+Formats all the arguments into a nice error message, utilising the constructor of [[stdlib_system(module):state_type(type)]]
+
+### Return values
+
+`type(state_type)`
+
+### Example
+
+```fortran
+{!example/system/example_fs_error.f90!}
+```
+
+---
+
 ## `is_directory` - Test if a path is a directory
 
 ### Status

src/stdlib_system.F90

@@ -137,12 +137,15 @@ module stdlib_system
 !! version: experimental
 !!
 !! A helper function for returning the `type(state_type)` with the flag `STDLIB_FS_ERROR` set.
+!! ([Specification](../page/specs/stdlib_system.html#fs_error))
 !!
 public :: fs_error
+
 !! version: experimental
 !!
 !! A helper function for returning the `type(state_type)` with the flag `STDLIB_FS_ERROR` set.
 !! It also formats and prefixes the `code` passed to it as the first argument
+!! ([Specification](../page/specs/stdlib_system.html#fs_error_code))
 !!
 public :: fs_error_code
 
@@ -783,21 +786,21 @@ subroutine delete_file(path, err)
 end subroutine delete_file
 
 pure function fs_error_code(code,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10, & 
-        a11,a12,a13,a14,a15,a16,a17,a18) result(state)
+        a11,a12,a13,a14,a15,a16,a17,a18, a19) result(state)
 
     type(state_type) :: state
     !> Platform specific error code
     integer, intent(in) :: code
     !> Optional rank-agnostic arguments
     class(*), intent(in), optional, dimension(..) :: a1,a2,a3,a4,a5,a6,a7,a8,a9,a10, &
-        a11,a12,a13,a14,a15,a16,a17,a18
+        a11,a12,a13,a14,a15,a16,a17,a18, a19
 
-    character(:), allocatable :: code_str
+    character(32) :: code_msg
 
-    code_str = to_string(code) // ","
+    write(code_msg, "('code - ', i0, ',')") code
 
-    state = state_type(STDLIB_FS_ERROR, "code -",code_str,a1,a2,a3,a4,a5,a6,a7,a8, & 
-        a9,a10,a11,a12,a13,a14,a15,a16,a17,a18)
+    state = state_type(STDLIB_FS_ERROR, code_msg,a1,a2,a3,a4,a5,a6,a7,a8, &
+        a9,a10,a11,a12,a13,a14,a15,a16,a17,a18, a19)
 end function fs_error_code
 
 pure function fs_error(a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11, &