8000 Addition of a default flag --markdown by jvdp1 · Pull Request #109 · szaghi/FLAP · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Addition of a default flag --markdown #109

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 4 commits into from
Feb 23, 2024
Merged

Addition of a default flag --markdown #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
84e0100
Addition of the default flag --markdown
jvdp1 Sep 22, 2023
ba2c727
Merge branch 'markdown' into combi
jvdp1 Sep 23, 2023
7f86bb4
Merge branch 'improve_markdown' into combi
jvdp1 Sep 23, 2023
e64c5c4
Merge branch 'improve_markdown' into combi
jvdp1 Sep 27, 2023
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
3 changes: 3 additions & 0 deletions src/lib/flap_command_line_argument_t.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ module flap_command_line_argument_t
public :: ACTION_STORE_TRUE
public :: ACTION_STORE_FALSE
public :: ACTION_PRINT_HELP
public :: ACTION_PRINT_MARK
public :: ACTION_PRINT_VERS
public :: ARGS_SEP
public :: ERROR_UNKNOWN
Expand Down Expand Up @@ -102,6 +103,7 @@ module flap_command_line_argument_t
character(len=*), parameter :: ACTION_STORE_TRUE = 'STORE_TRUE' !< Store .true. without the necessity of a value.
character(len=*), parameter :: ACTION_STORE_FALSE = 'STORE_FALSE' !< Store .false. without the necessity of a value.
character(len=*), parameter :: ACTION_PRINT_HELP = 'PRINT_HELP' !< Print help message.
character(len=*), parameter :: ACTION_PRINT_MARK = 'PRINT_MARKDOWN'!< Print help to Markdown file.
character(len=*), parameter :: ACTION_PRINT_VERS = 'PRINT_VERSION' !< Print version.
character(len=*), parameter :: ARGS_SEP = '||!||' !< Arguments separator for multiple valued (list) CLA.

Expand Down Expand Up @@ -667,6 +669,7 @@ subroutine check_action_consistency(self, pref)
self%act/=ACTION_STORE_TRUE.and. & 8000 ;
self%act/=ACTION_STORE_FALSE.and.&
self%act/=ACTION_PRINT_HELP.and. &
self%act/=ACTION_PRINT_MARK.and. &
self%act/=ACTION_PRINT_VERS) then
call self%errored(pref=pref, error=ERROR_ACTION_UNKNOWN)
return
Expand Down
5 changes: 5 additions & 0 deletions src/lib/flap_command_line_arguments_group_t.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ module flap_command_line_arguments_group_t
use face, only : colorize
use flap_command_line_argument_t, only : command_line_argument, &
ACTION_PRINT_HELP, &
ACTION_PRINT_MARK, &
ACTION_PRINT_VERS, &
ACTION_STORE, &
ACTION_STORE_STAR, &
Expand All @@ -18,6 +19,7 @@ module flap_command_line_arguments_group_t
public :: command_line_arguments_group
public :: STATUS_PRINT_V
public :: STATUS_PRINT_H
public :: STATUS_PRINT_M

type, extends(object) :: command_line_arguments_group
!< Command Line Arguments Group (CLAsG) class.
@@ -54,6 +56,7 @@ module flap_command_line_arguments_group_t
! status codes
integer(I4P), parameter :: STATUS_PRINT_V = -1 !< Print version status.
integer(I4P), parameter :: STATUS_PRINT_H = -2 !< Print help status.
integer(I4P), parameter :: STATUS_PRINT_M = -3 !< Print help status to Markdown file.

! errors codes
integer(I4P), parameter :: ERROR_CONSISTENCY = 100 !< CLAs group consistency error.
Expand Down Expand Up @@ -393,6 +396,8 @@ subroutine parse(self, args, ignore_unknown_clas, pref, error_unknown_clas)
endif
elseif (self%cla(a)%act==action_print_help) then
self%error = STATUS_PRINT_H
elseif (self%cla(a)%act==action_print_mark) then
self%error = STATUS_PRINT_M
elseif (self%cla(a)%act==action_print_vers) then
self%error = STATUS_PRINT_V
endif
Expand Down
17 changes: 15 additions & 2 deletions src/lib/flap_command_line_interface_t.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ module flap_command_line_interface_t

use face, only : colorize
use flap_command_line_argument_t, only : command_line_argument, ACTION_STORE, ERROR_UNKNOWN
use flap_command_line_arguments_group_t, only : command_line_arguments_group, STATUS_PRINT_H, STATUS_PRINT_V
use flap_command_line_arguments_group_t, only : command_line_arguments_group, STATUS_PRINT_H, STATUS_PRINT_M, STATUS_PRINT_V
use flap_object_t, only : object
use flap_utils_m
use penf
Expand Down Expand Up @@ -453,7 +453,7 @@ subroutine parse(self, pref, args, error)
if (present(error)) error = 0
if (self%is_parsed_) return

! add help and version switches if not done by user
! add help, markdown and version switches if not done by user
if (.not.self%disable_hv) then
do g=0,size(self%clasg,dim=1)-1
if (.not.(self%is_defined(group=self%clasg(g)%group, switch='--help').and.&
Expand All @@ -466,6 +466,16 @@ subroutine parse(self, pref, args, error)
required = .false., &
def = '', &
act = 'print_help')
if (.not.(self%is_defined(group=self%clasg(g)%group, switch='--markdown').and.&
self%is_defined(group=self%clasg(g)%group, switch='-md'))) &
call self%add(pref = pref, &
group_index = g, &
switch = '--markdown', &
switch_ab = '-md', &
help = 'Save this help message in a Markdown file', &
required = .false., &
def = '', &
act = 'print_markdown')
if (.not.(self%is_defined(group=self%clasg(g)%group, switch='--version').and. &
self%is_defined(group=self%clasg(g)%group, switch='-v'))) &
call self%add(pref = pref, &
Expand Down Expand Up @@ -549,6 +559,9 @@ subroutine parse(self, pref, args, error)
stop
endif
enddo
elseif (self%error == STATUS_PRINT_M) then
call self%save_usage_to_markdown(trim(self%progname)//'.md')
stop
endif

! check if all required CLAs have been passed
Expand Down
0