to_c_string -> to_c_char: rename

Author: perazz

doc/specs/stdlib_strings.md

@@ -537,7 +537,7 @@ The result is an `allocatable` length `character` scalar with up to `128` cached
 ```
 
 <!-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -->
-### `to_c_string`
+### `to_c_char`
 
 #### Description
 
@@ -546,7 +546,7 @@ This function converts a Fortran string into a C-style array of characters, ensu
 
 #### Syntax
 
-`cstr = ` [[stdlib_strings(module):to_c_string(function)]] ` (value)`
+`cstr = ` [[stdlib_strings(module):to_c_char(function)]] ` (value)`
 
 #### Status
 
@@ -568,5 +568,5 @@ The result is a `character(kind=c_char)` array with a dimension of `len(value) +
 #### Example
 
 ```fortran
-{!example/strings/example_to_c_string.f90!}
+{!example/strings/example_to_c_char.f90!}
 ```

example/strings/CMakeLists.txt

@@ -10,7 +10,7 @@ ADD_EXAMPLE(slice)
 ADD_EXAMPLE(starts_with)
 ADD_EXAMPLE(strip)
 ADD_EXAMPLE(to_string)
-ADD_EXAMPLE(to_c_string)
+ADD_EXAMPLE(to_c_char)
 ADD_EXAMPLE(zfill)
 ADD_EXAMPLE(string_to_number)
 ADD_EXAMPLE(stream_of_strings_to_numbers)

example/strings/example_to_c_string.f90 renamed to example/strings/example_to_c_char.f90

@@ -1,5 +1,5 @@
-program example_to_c_string
-  use stdlib_strings, only: to_c_string
+program example_to_c_char
+  use stdlib_strings, only: to_c_char
   use stdlib_string_type, only: string_type
   use stdlib_kinds, only: c_char
   implicit none
@@ -8,15 +8,15 @@ program example_to_c_string
   character(*), parameter :: hello = "Hello, World!"
 
   ! Convert character array
-  cstr = to_c_string(hello)
+  cstr = to_c_char(hello)
 
   ! Convert string type  
-  cstr2 = to_c_string(string_type(hello))
+  cstr2 = to_c_char(string_type(hello))
 
   if (size(cstr)==size(cstr2) .and. all(cstr==cstr2)) then 
      stop 0
   else
      error stop 'String conversion error'
   end if
 
-end program example_to_c_string
+end program example_to_c_char

src/stdlib_strings.fypp

@@ -13,7 +13,7 @@ module stdlib_strings
     private
 
     public :: to_string
-    public :: to_c_string
+    public :: to_c_char
     public :: strip, chomp
     public :: starts_with, ends_with
     public :: slice, find, replace_all, padl, padr, count, zfill, join
@@ -48,11 +48,11 @@ module stdlib_strings
     !> Version: experimental
     !>
     !> Format or transfer other types as a string.
-    !> ([Specification](../page/specs/stdlib_strings.html#to_c_string))
-    interface to_c_string
-        module procedure to_c_string_from_char
-        module procedure to_c_string_from_string
-    end interface to_c_string
+    !> ([Specification](../page/specs/stdlib_strings.html#to_c_char))
+    interface to_c_char
+        module procedure to_c_char_from_char
+        module procedure to_c_char_from_string
+    end interface to_c_char
 
     !> Remove leading and trailing whitespace characters.
     !>
@@ -968,7 +968,7 @@ contains
     !> Convert a Fortran character string to a C character array
     !>
     !> Version: experimental    
-    pure function to_c_string_from_char(value) result(cstr)
+    pure function to_c_char_from_char(value) result(cstr)
        character(len=*), intent(in) :: value
        character(kind=c_char) :: cstr(len(value)+1)
        integer :: i,lv
@@ -977,12 +977,12 @@ contains
            cstr(i) = value(i:i)
        end do 
        cstr(lv+1) = c_null_char
-    end function to_c_string_from_char
+    end function to_c_char_from_char
 
     !> Convert a Fortran string type to a C character array
     !>
     !> Version: experimental    
-    pure function to_c_string_from_string(value) result(cstr)
+    pure function to_c_char_from_string(value) result(cstr)
        type(string_type), intent(in) :: value
        character(kind=c_char) :: cstr(len(value)+1)
        integer :: i,lv
@@ -991,7 +991,7 @@ contains
            cstr(i) = char(value,pos=i)
        end do 
        cstr(lv+1) = c_null_char
-    end function to_c_string_from_string    
+    end function to_c_char_from_string    
 
     !> Joins a list of strings with a separator (default: space).
     !> Returns a new string

test/string/test_string_to_string.f90

@@ -1,7 +1,7 @@
 ! SPDX-Identifier: MIT
 module test_string_to_string
 
-    use stdlib_strings, only: to_string, to_c_string, starts_with
+    use stdlib_strings, only: to_string, to_c_char, starts_with
     use testdrive, only : new_unittest, unittest_type, error_type, check
     use stdlib_optval, only: optval
     implicit none
@@ -23,7 +23,7 @@ subroutine collect_string_to_string(testsuite)
             new_unittest("to_string-limit-i2", test_string_i2), &
             new_unittest("to_string-limit-i4", test_string_i4), &
             new_unittest("to_string-limit-i8", test_string_i8), &
-            new_unittest("to_c_string", test_to_c_string) &
+            new_unittest("to_c_char", test_to_c_char) &
             ]
     end subroutine collect_string_to_string
 
@@ -150,7 +150,7 @@ subroutine test_to_string_logical(error)
 
     end subroutine test_to_string_logical
 
-    subroutine test_to_c_string(error)
+    subroutine test_to_c_char(error)
         use stdlib_kinds, only : c_char
         use stdlib_string_type, only: string_type, len, char
         use iso_c_binding, only: c_size_t
@@ -172,27 +172,27 @@ end function c_strlen
         integer :: i
 
         ! Convert character array
-        cstr = to_c_string(hello)
-        call check(error, len(hello)==c_strlen(cstr), 'to_c_string_from_char: invalid C length')
+        cstr = to_c_char(hello)
+        call check(error, len(hello)==c_strlen(cstr), 'to_c_char_from_char: invalid C length')
         if (allocated(error)) return
 
         do i=1,len(hello)
-            call check(error, hello(i:i)==cstr(i), 'to_c_string_from_char: character mismatch')
+            call check(error, hello(i:i)==cstr(i), 'to_c_char_from_char: character mismatch')
             if (allocated(error)) return
         end do
 
         ! Convert string type
         shello = string_type(hello)
-        cstr = to_c_string(shello)
-        call check(error, len(shello)==c_strlen(cstr), 'to_c_string_from_string: invalid C length')
+        cstr = to_c_char(shello)
+        call check(error, len(shello)==c_strlen(cstr), 'to_c_char_from_string: invalid C length')
         if (allocated(error)) return
 
         do i=1,len(shello)
-            call check(error, char(shello,pos=i)==cstr(i), 'to_c_string_from_string: character mismatch')
+            call check(error, char(shello,pos=i)==cstr(i), 'to_c_char_from_string: character mismatch')
             if (allocated(error)) return
         end do
 
-    end subroutine test_to_c_string
+    end subroutine test_to_c_char
 
     subroutine test_string_i1(error)
         use stdlib_kinds, only : i1 => int8