dc_args::option Interface Reference

Public Member Functions
subroutine	dcargsoption0 (arg, options, flag, value, help)

Detailed Description

Definition at line 334 of file dc_args.f90.

Member Function/Subroutine Documentation

dcargsoption0()

subroutine dc_args::option::dcargsoption0	(	type(args), intent(inout)	arg,
		character(len = *), dimension(:), intent(in)	options,
		logical, intent(out)	flag,
		character(len = *), intent(out), optional	value,
		character(len = *), intent(in), optional	help )

Configure for getting command line option

Registers and retrieves option information.

Among command line arguments, retrieves information about options given in options to flag and value. If options is given in command line arguments, .true. is returned to flag, otherwise .false. is returned. If the option has a value specified, that value is returned to value. If the option itself is not given, an empty string is returned to value.

help registers a help message about options in arg. This message is output when using subroutine DCArgsHelp. The message changes depending on whether value is given.

Option Format

Among command line arguments, the following are judged as options:

• When the first character is '-'. In this case it becomes a short option, and only one character after '-' is valid as the option.
• When the first two characters are '–' (two hyphens). In this case it becomes a long option, and the string after '–' is valid as the option.

The option value is the string after "=".

Parameters

[in,out]	arg	ARGS derived type variable
[in]	options	Array of option names (e.g., '-s', '–size')
[out]	flag	Returns .true. if option is found
[out]	value	Returns option value if specified (optional)
[in]	help	Help message for this option (optional)

Definition at line 558 of file dc_args.f90.

    use dc_message, only: messagenotify
    implicit none
    type(ARGS), intent(inout) :: arg
    character(len = *), intent(in) :: options(:)
    logical, intent(out) :: flag
    character(len = *), intent(out), optional :: value
    character(len = *), intent(in), optional :: help
    integer :: i, j, options_size, table_size
    type(OPT_ENTRY), allocatable :: local_tables(:)
    character(len = STRING) :: opt_name, opt_value, opt_full
    character(len = *), parameter  :: subname = 'DCArgsOption'
  continue
    flag = .false.
    if (present(value)) value = ''
    if (.not. arg % initialized) then
      call messagenotify('W', subname, 'Call Open before Option in dc_args.')
      call dcargsopen(arg)
    end if
    options_size = size(options)
    if (options_size < 1) then
      return
    end if
 
    !-----------------------------------
    ! 構造体 ARGS へのヘルプメッセージ用の情報登録
    ! * まずはテーブル arg % opt_table を一つ広げる.
    !-----------------------------------
    if ( .not. associated( arg % opt_table ) ) then
      ! 1 つめのオプション指定
      !
      table_size = 0
      allocate(arg % opt_table(table_size + 1))
    else
      ! 2 つめ以降のオプション指定
      !
      table_size = size(arg % opt_table)
      allocate(local_tables(table_size))
      local_tables(1:table_size) = arg % opt_table(1:table_size)
      deallocate(arg % opt_table)
      allocate(arg % opt_table(table_size + 1))
      arg % opt_table(1:table_size) = local_tables(1:table_size)
      deallocate(local_tables)
    end if
 
    !----- 値の代入 -----
    allocate(arg % opt_table(table_size + 1) % options(options_size))
    arg % opt_table(table_size + 1) % options = options
    arg % opt_table(table_size + 1) % help_message = ''
    if (present(help)) then
      arg % opt_table(table_size + 1) % help_message = help
    end if
    arg % opt_table(table_size + 1) % optvalue_flag = present(value)
 
 
    !----- options の正規化 -----
    do i = 1, options_size
      opt_full = arg % opt_table(table_size + 1) % options(i)
      if (dcoptionformc(opt_full, opt_name, opt_value)) then
        arg % opt_table(table_size + 1) % options(i) = opt_name
      else
        if (len(trim(adjustl(opt_full))) < 2) then
          arg % opt_table(table_size + 1) % options(i) = &
            & '-' // trim(adjustl(opt_full))
        else
          arg % opt_table(table_size + 1) % options(i) = &
            & '--' // trim(adjustl(opt_full))
        end if
      end if
    end do
 
    ! arg % cmd_opts_list 内の探査と flag, value への代入
    ! 呼ばれたものに関しては arg % cmd_opts_list % flag_called を
    ! .true. に
    do i = 1, options_size
      do j = 1, size(arg % cmd_opts_list)
        if (trim(arg % opt_table(table_size + 1) % options(i)) &
          &             == trim(arg % cmd_opts_list(j) % name)) then
          flag = .true.
          if (present(value)) then
            value = arg % cmd_opts_list(j) % value
          end if
          arg % cmd_opts_list(j) % flag_called = .true.
        end if
      end do
    end do

---

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

• dc_utils/dc_args.f90