8000 Allow hyphens in fpm project names in "fpm new" by milancurcic · Pull Request #337 · fortran-lang/fpm · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
8000

Allow hyphens in fpm project names in "fpm new" #337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jan 14, 2021
Merged

Allow hyphens in fpm project names in "fpm new" #337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7af51a6
add function to replace characters in strings
milancurcic Jan 12, 2021
2cb994d
add function to replace special characters to undercores
milancurcic Jan 12, 2021
75e870f
allow hypen in fpm new and update the error message
milancurcic Jan 12, 2021
efe54f4
make sure bname is a valid fortran name when inserting into source sn…
milancurcic Jan 12, 2021
27234a1
update error message
milancurcic Jan 12, 2021
dc1adcf
flip the no-no test to test-with-hyphens
milancurcic Jan 12, 2021
838ba4c
update the help message for fpm new
milancurcic Jan 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions fpm/src/fpm/cmd/new.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ module fpm_cmd_new

use fpm_command_line, only : fpm_new_settings
use fpm_environment, only : run, OS_LINUX, OS_MACOS, OS_WINDOWS
use fpm_filesystem, only : join_path, exists, basename, mkdir, is_dir
use fpm_filesystem, only : join_path, exists, basename, mkdir, is_dir, to_fortran_name
use,intrinsic :: iso_fortran_env, only : stderr=>error_unit
implicit none
private
Expand Down Expand Up @@ -70,7 +70,7 @@ subroutine cmd_new(settings)
&'']
! create placeholder module src/bname.f90
littlefile=[character(len=80) :: &
&'module '//bname, &
&'module '//to_fortran_name(bname), &
&' implicit none', &
&' private', &
&'', &
Expand All @@ -79,7 +79,7 @@ subroutine cmd_new(settings)
&' subroutine say_hello', &
&' print *, "Hello, '//bname//'!"', &
&' end subroutine say_hello', &
&'end module '//bname]
&'end module '//to_fortran_name(bname)]
! create NAME/src/NAME.f90
call warnwrite(join_path(settings%name, 'src', bname//'.f90'),&
& littlefile)
Expand Down Expand Up @@ -121,7 +121,7 @@ subroutine cmd_new(settings)
if(exists(bname//'/src/'))then
littlefile=[character(len=80) :: &
&'program main', &
&' use '//bname//', only: say_hello', &
&' use '//to_fortran_name(bname)//', only: say_hello', &
&' implicit none', &
&'', &
&' call say_hello()', &
Expand Down
16 changes: 6 additions & 10 deletions fpm/src/fpm_command_line.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ module fpm_command_line
OS_CYGWIN, OS_SOLARIS, OS_FREEBSD
use M_CLI2, only : set_args, lget, sget, unnamed, remaining, specified
use fpm_strings, only : lower, split
use fpm_filesystem, only : basename, canon_path
use fpm_filesystem, only : basename, canon_path, to_fortran_name
use,intrinsic :: iso_fortran_env, only : stdin=>input_unit, &
& stdout=>output_unit, &
& stderr=>error_unit
Expand Down Expand Up @@ -225,13 +225,10 @@ subroutine get_command_line_settings(cmd_settings)
end select
!*! canon_path is not converting ".", etc.
name=canon_path(name)
if( .not.is_fortran_name(basename(name)) )then
if( .not.is_fortran_name(to_fortran_name(basename(name))) )then
write(stderr,'(g0)') [ character(len=72) :: &
& '<ERROR>the new directory basename must be an allowed ', &
& ' Fortran name. It must be composed of 1 to 63 ASCII', &
& ' characters and start with a letter and be composed', &
& ' entirely of alphanumeric characters [a-zA-Z0-9]', &
& ' and underscores.']
& '<ERROR> the fpm project name must be made of up to 63 ASCII letters,', &
& ' numbers, underscores, or hyphens, and start with a letter.']
stop 4
endif

Expand Down Expand Up @@ -823,9 +820,8 @@ subroutine set_help()
' ', &
'OPTIONS ', &
' NAME the name of the project directory to create. The name ', &
' must be a valid Fortran name composed of 1 to 63 ', &
' ASCII alphanumeric 8000 characters and underscores, ', &
' starting with a letter. ', &
' must be made of up to 63 ASCII letters, digits, underscores, ', &
' or hyphens, and start with a letter. ', &
' ', &
' The default is to create all of the src/, app/, and test/ ', &
' directories. If any of the following options are specified ', &
Expand Down
15 changes: 13 additions & 2 deletions fpm/src/fpm_filesystem.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ module fpm_filesystem
use fpm_environment, only: get_os_type, &
OS_UNKNOWN, OS_LINUX, OS_MACOS, OS_WINDOWS, &
OS_CYGWIN, OS_SOLARIS, OS_FREEBSD
use fpm_strings, only: f_string, string_t, split
use fpm_strings, only: f_string, replace, string_t, split
implicit none
private
public :: basename, canon_path, dirname, is_dir, join_path, number_of_rows, read_lines, list_files, env_variable, &
mkdir, exists, get_temp_filename, windows_path, unix_path, getline, delete_file
mkdir, exists, get_temp_filename, windows_path, unix_path, getline, delete_file, to_fortran_name

integer, parameter :: LINE_BUFFER_LEN = 1000

Expand Down Expand Up @@ -465,4 +465,15 @@ subroutine delete_file(file)
end subroutine delete_file


pure function to_fortran_name(string) result(res)
! Returns string with special characters replaced with an underscore.
! For now, only a hyphen is treated as a special character, but this can be
! expanded to other characters if needed.
character(*), intent(in) :: string
character(len(string)) :: res
character, parameter :: SPECIAL_CHARACTERS(*) = ['-']
res = replace(string, SPECIAL_CHARACTERS, '_')
end function to_fortran_name


end module fpm_filesystem
16 changes: 15 additions & 1 deletion fpm/src/fpm_strings.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ module fpm_strings
private
public :: f_string, lower, split, str_ends_with, string_t
public :: string_array_contains, string_cat, len_trim, operator(.in.), fnv_1a
public :: resize, str
public :: replace, resize, str

type string_t
character(len=:), allocatable :: s
Expand Down Expand Up @@ -335,6 +335,20 @@ subroutine split(input_line,array,delimiters,order,nulls)
enddo
end subroutine split

pure function replace(string, charset, target_char) result(res)
! Returns string with characters in charset replaced with target_char.
character(*), intent(in) :: string
character, intent(in) :: charset(:), target_char
character(len(string)) :: res
integer :: n
res = string
do n = 1, len(string)
if (any(string(n:n) == charset)) then
res(n:n) = target_char
end if
end do
end function replace

subroutine resize_string(list, n)
!> Instance of the array to be resized
type(string_t), allocatable, intent(inout) :: list(:)
Expand Down
12 changes: 6 additions & 6 deletions fpm/test/new_test/new_test.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ program new_test
character(len=*),parameter :: cmds(*) = [character(len=80) :: &
! run a variety of "fpm new" variations and verify expected files are generated
' new', &
' new no-no', &
' new name-with-hyphens', &
' new '//scr//'A', &
' new '//scr//'B --lib', &
' new '//scr//'C --app', &
Expand Down Expand Up @@ -63,7 +63,7 @@ program new_test
if( is_dir(trim(directories(i))) ) then
write(*,*)'ERROR:',trim( directories(i) ),' already exists'
write(*,*)' you must remove scratch directories before performing this test'
write(*,'(*(g0:,1x))')'directories:',(trim(directories(j)),j=1,size(directories)),'no-no'
write(*,'(*(g0:,1x))')'directories:',(trim(directories(j)),j=1,size(directories)),'name-with-hyphens'
stop
endif
enddo
Expand All @@ -75,11 +75,11 @@ program new_test
write(*,'(*(g0))')'CMD=',trim(cmds(i)),' EXITSTAT=',estat,' CMDSTAT=',cstat,' MESSAGE=',trim(message)
enddo

if( is_dir('no-no') ) then
tally=[tally,.false.]
write(*,*)'ERROR: directory no-no/ exists'
else
if( is_dir('name-with-hyphens') ) then
tally=[tally,.true.]
else
write(*,*)'ERROR: directory name-with-hyphens/ exists'
tally=[tally,.false.]
endif

! assuming hidden files in .git and .gitignore are ignored for now
Expand Down
0