dc_args::dcargshelp Interface Reference

Public Member Functions
subroutine	dcargshelp0 (arg, force)

Detailed Description

Definition at line 247 of file dc_args.f90.

Member Function/Subroutine Documentation

dcargshelp0()

subroutine dc_args::dcargshelp::dcargshelp0	(	type(args), intent(inout)	arg,
		logical, intent(in), optional	force
	)

Definition at line 555 of file dc_args.f90.

    !
    ! ヘルプオプションの自動設定を行います. 
    !
    ! -h, -H, --help のいづれかが指定された際, 自動的に *arg* 内に設定された
    ! 情報をヘルプメッセージとして表示した後, プログラムを終了させます.
    ! 原則的に, このサブルーチンよりも前に DCArgsOption, DCArgsDebug 
    ! のサブルーチンを呼んで下さい.
    !
    ! *force* に .true. が指定される場合, -H, --help オプションが与え
    ! られない場合でもヘルプメッセージを表示した後, プログラムを終了さ
    ! せます.
    !
    ! ヘルプメッセージに表示される情報は, DCArgsOption, DCArgsHelpMsg
    ! サブルーチンによって付加することが可能です.
    !
    use dc_types, only: string, stdout
    use dc_string, only: stoa, stoi, printf, concat, joinchar, uchar, lchar
    use dc_present, only: present_and_true
    use dc_message, only: messagenotify
    use dc_hash, only: dchashget, dchashdelete, dchashrewind, dchashnext
    implicit none
    type(ARGS), intent(inout) :: arg
    logical, intent(in), optional :: force
    logical :: OPT_help, found, end
    character(STRING) :: VAL_help, options_msg, help_msg, category
    character(STRING), pointer :: localopts(:) => null()
    integer :: unit, i
    character(len = *), parameter  :: subname = 'DCArgsHelp'
  continue
    if (.not. arg % initialized) then
      call messagenotify('W', subname, 'Call Open before Help in dc_args.')
      call dcargsopen(arg)
    end if
    call dcargsoption(arg, stoa('-h', '-H', '--help'), opt_help, val_help, &
      & help="display this help and exit. " // &
      & "VAL is unit number (default is standard output)")
    if (.not. opt_help .and. .not. present_and_true(force)) then
      return
    end if
    if (trim(val_help) == '') then
      unit = stdout
    else
      unit = stoi(val_help)
    end if
 
    call printf(unit, '')
 
    call dchashget(arg % helpmsg, 'TITLE', help_msg, found)
    if (found) then
      call printf(unit, '%c', c1=trim(help_msg))
      call printf(unit, '')
      call dchashdelete(arg % helpmsg, 'TITLE')
    end if
 
    call dchashget(arg % helpmsg, 'OVERVIEW', help_msg, found)
    if (found) then
      call printf(unit, 'Overview::')
      call printautolinefeed(unit, help_msg, indent='     ')
      call printf(unit, '')
      call dchashdelete(arg % helpmsg, 'OVERVIEW')
    end if
 
    call dchashget(arg % helpmsg, 'USAGE', help_msg, found)
    if (found) then
      call printf(unit, 'Usage::')
      call printautolinefeed(unit, help_msg, indent='     ')
      call printf(unit, '')
      call dchashdelete(arg % helpmsg, 'USAGE')
    end if
 
    call printf(unit, 'Options::')
    if ( associated(arg % opt_table) ) then
      do i = 1, size(arg % opt_table)
        options_msg = ' '
        if (arg % opt_table(i) % optvalue_flag) then
          call concat(arg % opt_table(i) % options, '=VAL', localopts)
        else
          allocate(localopts(size(arg % opt_table(i) % options)))
          localopts = arg % opt_table(i) % options
        end if
        options_msg = trim(options_msg) // trim(joinchar(localopts))
        deallocate(localopts)
        call printf(unit, ' %c', c1=trim(options_msg))
        call printautolinefeed(unit, &
          & arg % opt_table(i) % help_message, indent='     ')
        call printf(unit, '')
      end do
    end if
 
    call dchashrewind(arg % helpmsg)
    do
      call dchashnext(arg % helpmsg, category, help_msg, end)
      if (end) exit
 
      call printf(unit, '%c%c::', &
        & c1=trim(uchar(category(1:1))), c2=trim(lchar(category(2:))))
      call printautolinefeed(unit, help_msg, indent='     ')
      call printf(unit, '')
 
    enddo
 
    call dcargsclose(arg)
 
    stop

References dc_types::stdout, and dc_types::string.

---

The documentation for this interface was generated from the following file:

• dc_utils/dc_args.f90