dc_args Module Reference

Data Types
type	args
interface	close
type	cmd_opts_internal
interface	dcargsclose
interface	dcargsdebug
interface	dcargsget
interface	dcargshelp
interface	dcargshelpmsg
interface	dcargsnumber
interface	dcargsopen
interface	dcargsoption
interface	dcargsputline
interface	dcargsstrict
interface	debug
interface	get
interface	help
interface	helpmsg
interface	number
interface	open
type	opt_entry
interface	option
interface	putline
interface	strict

Functions/Subroutines
subroutine	dcargsopen0 (arg)
subroutine	dcargsclose0 (arg)
subroutine	dcargsoption0 (arg, options, flag, value, help)
subroutine	dcargsdebug0 (arg)
subroutine	dcargshelp0 (arg, force)
subroutine	dcargshelpmsg0 (arg, category, msg)
subroutine	dcargsstrict0 (arg, severe)
subroutine	dcargsget0 (arg, argv)
integer function	dcargsnumber0 (arg)
subroutine	dcargsputline0 (arg)
subroutine	printautolinefeed (unit, fmt, length, indent)
subroutine	sortargtable
subroutine	buildargtable
logical function	dcoptionformc (argument, name, value)

Variables
character(string), dimension(:), allocatable, save	argstr_table
integer, save	argind_count = -1
type(cmd_opts_internal), dimension(:), allocatable, save	cmd_opts_list
character(string), dimension(:), allocatable, save	cmd_argv_list

Function/Subroutine Documentation

buildargtable()

subroutine dc_args::buildargtable

(

)

Definition at line 1003 of file dc_args.f90.

References argind_count, argstr_table, dc_types::string, sysdepargcount(), and sysdepargget().

Referenced by dcargsopen0().

    !
    ! 内部向けコマンドライン引数処理のサブルーチンです. 
    !
    ! モジュール sysdep の sysdep#SysdepArgCount, sysdep#ArgGet
    ! を呼び出し, その内容を argind_count と argstr_table に格納します.
    !
    ! 既に一度でも呼ばれている場合, 何もせずに終了します.
    !
    use sysdep, only: sysdepargcount, sysdepargget
    use dc_types, only: string
    implicit none
    integer:: i, narg, nargmax
    character(len = STRING):: value
    character(len = STRING), allocatable:: localtab(:)
  continue
    if (argind_count >= 0) return
    nargmax = sysdepargcount()
    allocate(localtab(nargmax))
    narg = 0
    do, i = 1, nargmax
      call sysdepargget(i, value)
      narg = narg + 1
      localtab(narg) = value
    enddo
    argind_count = narg
    allocate(argstr_table(narg))
    argstr_table(1: narg) = localtab(1: narg)
    deallocate(localtab)

Here is the call graph for this function:

Here is the caller graph for this function:

dcargsclose0()

subroutine dc_args::dcargsclose0

(

type(args), intent(inout)

arg

)

Definition at line 368 of file dc_args.f90.

References argstr_table, cmd_argv_list, and cmd_opts_list.

    !
    ! ARGS 型の変数の終了処理を行います. 
    !
    use dc_hash, only: dchashdelete
    implicit none
    type(args), intent(inout) :: arg
    integer :: i
  continue
    if (arg % initialized) then
      if ( associated( arg % opt_table ) ) then
        do i = 1, size(arg % opt_table)
          deallocate(arg % opt_table(i) % options)
        end do

        deallocate(arg % opt_table)
      end if

      deallocate(arg % cmd_opts_list)
      deallocate(argstr_table)
      deallocate(cmd_argv_list)
      deallocate(cmd_opts_list)

      call dchashdelete(arg % helpmsg)
    end if

dcargsdebug0()

subroutine dc_args::dcargsdebug0

(

type(args), intent(inout)

arg

)

Definition at line 521 of file dc_args.f90.

References dc_trace::setdebug(), and dc_types::string.

    !
    ! デバッグオプションの自動設定を行います. 
    !
    ! -D もしくは --debug が指定された際, 自動的に
    ! dc_trace#SetDebug を呼び出すよう *arg* を設定します.
    !
    use dc_types, only: string
    use dc_string, only: stoa, stoi
    use dc_trace, only: setdebug
    use dc_message, only: messagenotify
    implicit none
    type(args), intent(inout) :: arg
    logical :: opt_debug
    character(STRING) :: val_debug
    character(len = *), parameter  :: subname = 'DCArgsDebug'
  continue
    if (.not. arg % initialized) then
      call messagenotify('W', subname, 'Call Open before Debug in dc_args.')
      call dcargsopen(arg)
    end if
    call option(arg, stoa('-D', '--debug'), opt_debug, val_debug, &
      & help="call dc_trace#SetDebug (display a lot of messages for debug). " // &
      & "VAL is unit number (default is standard output)")
    if (opt_debug) then
      if (trim(val_debug) == '') then
        call setdebug
      else
        call setdebug(stoi(val_debug))
      end if
    end if
    return

Here is the call graph for this function:

dcargsget0()

subroutine dc_args::dcargsget0	(	type(args), intent(inout)	arg,
		character(*), dimension(:), pointer	argv
	)

Definition at line 789 of file dc_args.f90.

References cmd_argv_list, dc_string::joinchar(), dc_present::present_and_true(), and dc_types::string.

    !
    ! コマンドライン引数のうち, オプションではないものを
    ! *argv* に返します.
    !
    ! *argv* は文字型配列のポインタです.
    ! 引数として与える場合には必ず空状態して与えてください.
    !
    use dc_types, only: string
    use dc_string, only: stoa, stoi, printf, concat, joinchar
    use dc_present, only: present_and_true
    use dc_message, only: messagenotify
    implicit none
    type(args), intent(inout) :: arg
    character(*), pointer :: argv(:) !(out)
    integer :: i, cmd_argv_max
    character(len = *), parameter  :: subname = 'DCArgsGet'
  continue
    if (.not. arg % initialized) then
      call messagenotify('W', subname, 'Call Open before Help in dc_args.')
      call dcargsopen(arg)
    end if
    cmd_argv_max = size(cmd_argv_list)
    allocate(argv(cmd_argv_max))
    do i = 1, cmd_argv_max
      argv(i) = cmd_argv_list(i)
    end do

Here is the call graph for this function:

dcargshelp0()

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

Definition at line 556 of file dc_args.f90.

References dc_string::joinchar(), dc_present::present_and_true(), printautolinefeed(), dc_types::stdout, and dc_types::string.

    !
    ! ヘルプオプションの自動設定を行います. 
    !
    ! -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

Here is the call graph for this function:

dcargshelpmsg0()

subroutine dc_args::dcargshelpmsg0	(	type(args), intent(inout)	arg,
		character(*), intent(in)	category,
		character(*), intent(in)	msg
	)

Definition at line 663 of file dc_args.f90.

    !
    ! ヘルプメッセージを追加します. 
    !
    ! サブルーチン DCArgsHelp を使用した際に出力されるメッセージを
    ! 付加します. *category* に +Title+, +Overview+, +Usage+ が
    ! 指定されたものは +Options+ よりも上部に,
    ! それ以外のものは下部に表示されます.
    ! *msg* にはメッセージを与えてください.
    !
    !=== 例
    !
    !     program dc_args_sample3
    !       use dc_types
    !       use dc_string, only: StoA
    !       use dc_args
    !       implicit none
    !       type(ARGS) :: arg
    !       logical :: OPT_namelist
    !       character(STRING) :: VAL_namelist
    !       character(STRING), pointer :: argv(:) => null()
    !       integer :: i
    !
    !       call DCArgsOpen( arg = arg )   ! (out)
    !       call DCArgsHelpMsg( arg = arg, &              ! (inout)
    !         & category = 'Title', &                     ! (in)
    !         & msg = 'dcargs $Revision: 1.2 $ ' // &
    !         &       ':: Test program of dc_args' )      ! (in)
    !       call DCArgsHelpMsg( arg = arg, &              ! (inout)
    !         & category = 'Usage', &                     ! (in)
    !         & msg = 'dcargs [Options] arg1, arg2, ...') ! (in)
    !       call DCArgsOption( arg = arg, &           ! (inout)
    !         & options = StoA('-N', '--namelist'), & ! (in)
    !         & flag = OPT_namelist, &                ! (out)
    !         & value = VAL_namelist, &               ! (out)
    !         & help = "Namelist filename")           ! (in)
    !       call DCArgsHelpMsg( arg = arg, &          ! (inout)
    !         & category = 'DESCRIPTION', &           ! (in)
    !         & msg = '(1) Define type "HASH". ' // &
    !         &       '(2) Open the variable. ' // &
    !         &       '(3) set HelpMsg. ' // &
    !         &       '(4) set Options. ' // &
    !         &       '(5) call Debug. ' // &
    !         &       '(6) call Help. ' // &
    !         &       '(7) call Strict.')             ! (in)
    !       call DCArgsHelpMsg( arg = arg, &                         ! (inout)
    !         & category = 'Copyright', &                            ! (in)
    !         & msg = 'Copyright (C) ' // &
    !         &       'GFD Dennou Club, 2008. All rights reserved.') ! (in)
    !       call DCArgsDebug( arg = arg )  ! (inout)
    !       call DCArgsHelp( arg = arg )   ! (inout)
    !       call DCArgsStrict( arg = arg ) ! (inout)
    !       call DCArgsGet( arg = arg, &   ! (inout)
    !         & argv = argv )              ! (out)
    !       write(*,*) '--namelist=', trim( VAL_namelist )
    !       do i = 1, size(argv)
    !         write(*,*) argv(i)
    !       end do
    !       deallocate( argv )
    !       call DCArgsClose( arg = arg )  ! (inout)
    !     program dc_args_sample3
    !
    ! コマンドライン引数に '-h', '-H', '--help' のいづれかのオプション
    ! を指定することで, HelpMsg で与えたメッセージと, オプションの一覧
    ! が標準出力に表示されます.
    !
    use dc_hash, only: dchashput
    use dc_string, only: uchar
    use dc_message, only: messagenotify
    implicit none
    type(args), intent(inout) :: arg
    character(*), intent(in) :: category
    character(*), intent(in) :: msg
    character(len = *), parameter  :: subname = 'DCArgsHelpMsg'
  continue
    if (.not. arg % initialized) then
      call messagenotify('W', subname, 'Call Open before Help in dc_args.')
      call dcargsopen(arg)
    end if
    call dchashput(arg % helpmsg, key=uchar(category), value=msg)

dcargsnumber0()

integer function dc_args::dcargsnumber0

(

type(args), intent(inout)

arg

)

Definition at line 818 of file dc_args.f90.

References cmd_argv_list.

    !
    ! コマンドライン引数として与えられた引数の数を返します.
    !
    use dc_message, only: messagenotify
    implicit none
    type(args), intent(inout) :: arg
    integer :: result
    character(len = *), parameter  :: subname = 'DCArgsNumber'
  continue
    if (.not. arg % initialized) then
      call messagenotify('W', subname, 'Call Open before Help in dc_args.')
      call dcargsopen(arg)
    end if
    result = size(cmd_argv_list)

dcargsopen0()

subroutine dc_args::dcargsopen0 ( type(args), intent(out)  arg )

private

Definition at line 337 of file dc_args.f90.

References buildargtable(), cmd_opts_list, sortargtable(), and dc_types::string.

    !
    ! ARGS 型の変数を初期設定します. 
    !
    ! ARGS 型の変数を利用する際にはまずこのサブルーチンによって
    ! 初期設定を行ってください.
    !
    ! このサブルーチンは, より下層のサブルーチン内で IARGC や GETARG
    ! を用いて得られたコマンドライン引数の情報を引数 *arg*
    ! へと格納します.
    !
    use dc_message, only: messagenotify
    use dc_types, only: string
    implicit none
    type(args), intent(out) :: arg
    integer:: cmd_opts_max
    character(len = *), parameter :: subname = 'DCArgsOpen'
  continue
    if (arg % initialized) then
      call messagenotify('W', subname, 'This argument (type ARGS) is already opend.')
      return
    end if
    call buildargtable
    call sortargtable
    cmd_opts_max = size(cmd_opts_list)
    allocate(arg % cmd_opts_list(cmd_opts_max))
    arg % cmd_opts_list = cmd_opts_list
    nullify( arg % opt_table )
    arg % initialized = .true.

Here is the call graph for this function:

dcargsoption0()

subroutine dc_args::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
	)

Definition at line 395 of file dc_args.f90.

References dcoptionformc().

    !
    ! オプション情報の登録と取得を行います. 
    !
    ! コマンドライン引数のうち, *options* に与えるオプションに関する情
    ! 報を *flag* と *value* に取得します. *options* がコマンドライン
    ! 引数に与えられていれば *flag* に .true. が, そうでない場合は 
    ! .false. が返ります. オプションに値が指定される場合は *value* に
    ! その値が返ります. オプション自体が与えられていない場合には
    ! *value* には空文字が返ります.
    !
    ! *help* には *options* に関するヘルプメッセージを *arg* に
    ! 登録します. サブルーチン DCArgsHelp を
    ! 用いた際に, このメッセージが出力されます.
    ! *value* を与えているかどうかでこのメッセージは変化します.
    !
    !=== オプションの書式
    !
    ! コマンドライン引数のうち, オプションと判定されるのは以下の場合です.
    !
    ! * 1 文字目が '-' の場合. この場合は短いオプションとなり, '-'
    !   の次の一文字のみがオプションとして有効になります.
    !
    ! * 1-2文字目が '--' (ハイフン 2 文字) の場合.
    !   この場合は長いオプションとなり,
    !   '--' 以降の文字列がオプションとして有効になります.
    !
    ! オプションの値は, "=" よりも後ろの文字列になります.
    !
    ! 例
    !
    ! <b>コマンドライン引数</b>  :: <b>オプション名, 値      </b>
    ! -h                         ::    -h,           無し
    ! --help                     ::    --help,       無し
    ! -D=6                       ::    -D,            6
    ! -debug=                    ::    -d,           無し
    ! --include=/usr             ::    --include,    /usr
    !

    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

Here is the call graph for this function:

dcargsputline0()

subroutine dc_args::dcargsputline0

(

type(args), intent(in)

arg

)

Definition at line 835 of file dc_args.f90.

References cmd_argv_list, dc_string::joinchar(), and dc_types::stdout.

    !
    ! *arg* に関する情報を標準出力に表示します.
    !
    use dc_types, only: stdout
    use dc_string, only: printf, joinchar
    implicit none
    type(args), intent(in) :: arg
    integer :: i
  continue
    if (.not. arg % initialized) then
      call printf(stdout, '#<ARGS:: @initialized=%y>', l=(/arg % initialized/))
      return
    end if
    call printf(stdout, '#<ARGS:: @initialized=%y,', l=(/arg % initialized/))
    call printf(stdout, '  @opt_table(:)=')
    if ( associated(arg % opt_table) ) then
      do i = 1, size(arg % opt_table)
        call printf(stdout, '    #<OPT_ENTRY:: ')
        call printf(stdout, '      @options=%c, @help_message=%c, @optvalue_flag=%y', &
          & c1=trim(joinchar(arg % opt_table(i) % options)), &
          & c2=trim(arg % opt_table(i) % help_message), &
          & l=(/arg % opt_table(i) % optvalue_flag/))
        call printf(stdout, '    >')
      end do
    end if
    call printf(stdout, '  ,')
    call printf(stdout, '  @cmd_opts_list(:)=')
    do i = 1, size(arg % cmd_opts_list)
      call printf(stdout, '    #<CMD_OPTS_INTERNAL:: ')
      call printf(stdout, '      @name=%c, @value=%c, @flag_called=%y', &
        & c1=trim(arg % cmd_opts_list(i) % name), &
        & c2=trim(arg % cmd_opts_list(i) % value), &
        & l=(/arg % cmd_opts_list(i) % flag_called/))
      call printf(stdout, '    >')
    end do
    call printf(stdout, '  ,')
    call printf(stdout, '  @cmd_argv_list(:)=%c', &
      & c1=trim(joinchar(cmd_argv_list)))
    call printf(stdout, '>')

Here is the call graph for this function:

dcargsstrict0()

subroutine dc_args::dcargsstrict0	(	type(args), intent(inout)	arg,
		logical, intent(in), optional	severe
	)

Definition at line 746 of file dc_args.f90.

References dc_present::present_and_true(), and dc_types::string.

    !
    ! オプションチェックを行います. 
    !
    ! コマンドライン引数のオプションとして指定されたものの内,
    ! DCArgsOption サブルーチンで設定されていないものが存在する
    ! 場合には警告を返します. *severe* に .true. を指定すると
    ! エラーを返して終了します.
    ! このサブルーチンを呼ぶ前に, DCArgsOption, DCArgsDebug, 
    ! DCArgsHelp サブルーチンを呼んでください.
    !
    ! 構造体 ARGS の変数に対してこのサブルーチンを適用しておく
    ! ことで, コマンドライン引数として与えたオプションが正しく
    ! プログラムが認識しているかどうかをチェックすることができます.
    !
    !
    use dc_types, only: string
    use dc_present, only: present_and_true
    use dc_message, only: messagenotify
    implicit none
    type(args), intent(inout) :: arg
    logical, intent(in), optional :: severe
    character(STRING) :: err_mess
    integer :: i
    character(len = *), parameter  :: subname = 'DCArgsStrict'
  continue
    if (.not. arg % initialized) then
      call messagenotify('W', subname, 'Call Open before Help in dc_args.')
      call dcargsopen(arg)
    end if
    do i = 1, size(arg % cmd_opts_list)
      err_mess = trim(arg % cmd_opts_list(i) % name) // ' is invalid option.'
      if (.not. arg % cmd_opts_list(i) % flag_called) then
        if (present_and_true(severe)) then
          call messagenotify('E', subname, err_mess)
        else
          call messagenotify('W', subname, err_mess)
        end if
      end if
    end do

Here is the call graph for this function:

dcoptionformc()

logical function dc_args::dcoptionformc	(	character(len = *), intent(in)	argument,
		character(len = *), intent(out)	name,
		character(len = *), intent(out)	value
	)

Definition at line 1034 of file dc_args.f90.

Referenced by dcargsoption0(), and sortargtable().

    !
    ! 引数としてで得られた文字列を *argument* に渡すことで,
    ! それがオプションなのかそうでないのかを判別し, もしも
    ! オプションと判別した場合には戻り値に .true. を返し,
    ! name にオプション名, *value* にその値を返す.
    ! オプションに値が付加されない場合は *value* には空白を返す.
    !
    ! オプションではない場合は戻り値に .false. を返し,
    ! *name*, *value* には空白を返す.
    !
    ! オプションと判定されるのは以下の場合です.
    !
    ! * 一文字目が '-' の場合. この場合は短いオプションとなり, '-'
    !   の次の一文字のみがオプションとして有効になります.
    !
    ! * 1-2文字目が '--' の場合. この場合は長いオプションとなり,
    !   '--' 以降の文字列がオプションとして有効になります.
    !
    ! オプションの値は, "=" よりも後ろの文字列になります.
    !
    !=== 例
    !
    ! *argument*    :: <b>name,      value, 返り値</b>
    ! arg           ::    空白,      空白,  .false.
    ! -O            ::    -O,        空白,  .true.
    ! -debug        ::    -d,        空白,  .true.
    ! --debug       ::    --debug,   空白,  .true.
    ! -I=/usr       ::    -I,        /usr,  .true.
    ! --include=/usr::    --include, /usr,  .true.
    !
    implicit none
    character(len = *), intent(in):: argument
    character(len = *), intent(out):: name, value
    logical :: result
    integer:: equal
  continue
    equal = index(argument, '=')
    if (argument(1:1) == '-' .and. argument(2:2) /= '-') then
      ! Short Option
      if (equal == 0) then
        name = argument(1:2)
        value = ""
      else
        name = argument(1:2)
        value = argument(equal+1: )
      endif
      result = .true.
    elseif (argument(1:2) == '--') then
      ! Long Option
      if (equal == 0) then
        name = argument
        value = ""
      else
        name = argument(1:equal-1)
        value = argument(equal+1: )
      endif
      result = .true.
!    elseif (equal == 0 .and. &
!      &     verify(argument(1:equal-1), WORDCHARS) == 0) then
!      ! ???
!      name = argument(1:equal-1)
!      value = argument(equal+1: )
!      result = .true.
    else
      ! No Option (normal arguments)
      name = ""
      value = ""
      result = .false.
    endif

Here is the caller graph for this function:

printautolinefeed()

subroutine dc_args::printautolinefeed	(	integer, intent(in), optional	unit,
		character(*), intent(in)	fmt,
		integer, intent(in), optional	length,
		character(*), intent(in), optional	indent
	)

Definition at line 878 of file dc_args.f90.

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

Referenced by dcargshelp0().

    !
    ! 文字列を自動改行して出力します. 
    ! このモジュール内部で用いるためのサブルーチンです.
    !
    ! *fmt* に与えられた文章を文字数 *length* (指定されない場合 70)
    ! 以内に改行し, 出力します. 出力の際, *indent* が指定されていると
    ! その文字列を行頭に挿入して出力を行います.
    ! 出力先はデフォルトは標準出力となります. *unit* に出力装置番号
    ! を設定することで出力先を変更できます.
    !
    use dc_types, only: string, stdout
    use dc_string, only: split
    implicit none
    character(*), intent(in) :: fmt
    integer,      intent(in), optional :: length ! 一行の長さ
    character(*), intent(in), optional :: indent ! 字下げ文字列
    integer,      intent(in), optional :: unit   ! 出力装置
    character(STRING), pointer :: carray_tmp(:) => null()
    character(STRING) :: store_str
    integer, parameter :: default_len = 70
    integer :: i, split_len, indent_len, unit_num
    logical :: new_line_flag
  continue
    if (present(unit)) then
      unit_num = unit
    else
      unit_num = stdout
    end if

    if (present(indent)) then
      indent_len = len(indent)
    else
      indent_len = 0
    end if

    if (present(length)) then
      split_len = length - indent_len
    else
      split_len = default_len - indent_len
    end if


    nullify(carray_tmp)
    call split(fmt, carray_tmp, '')
    store_str = ''
    new_line_flag = .true.
    i = 1
    do
      if (i > size(carray_tmp)) then
        write(unit_num, '(A)') trim(store_str)
        exit
      end if

      if (len(trim(store_str)) + len(trim(carray_tmp(i))) > split_len) then
        if (new_line_flag) then
          write(unit_num, '(A)') trim(carray_tmp(i))
          i = i + 1
        else
          write(unit_num, '(A)') trim(store_str)
          store_str = ''
          new_line_flag = .true.
        end if
        cycle
      end if

      if (new_line_flag .and. present(indent)) then
        store_str = indent // trim(carray_tmp(i))
      else
        store_str = trim(store_str) // ' ' // trim(carray_tmp(i))
      end if
      new_line_flag = .false.
      i = i + 1
    end do

Here is the caller graph for this function:

sortargtable()

subroutine dc_args::sortargtable

(

)

Definition at line 955 of file dc_args.f90.

References argind_count, argstr_table, cmd_argv_list, cmd_opts_list, dcoptionformc(), and dc_types::string.

Referenced by dcargsopen0().

    !
    ! 内部向けの引数振り分けのためのサブルーチンです. 
    !
    ! BuildArgTable で設定された argind_count, argstr_table を
    ! 用い, cmd_argv_list, cmd_opts_list を設定します.
    !
    ! 既に一度でも呼ばれている場合, 何もせずに終了します.
    !
    use dc_types, only: string
    implicit none
    character(STRING):: raw_arg, name, value
    integer:: i, cmd_argv_count, cmd_opts_count, cmd_argv_max, cmd_opts_max
  continue
    if (allocated(cmd_opts_list)) return
    cmd_argv_count = 0
    cmd_opts_count = 0
    check_count: do, i = 1, argind_count
      raw_arg = argstr_table(i)
      if (dcoptionformc(raw_arg, name, value)) then
        cmd_opts_count = cmd_opts_count + 1
      else
        cmd_argv_count = cmd_argv_count + 1
      end if
    end do check_count

    cmd_argv_max = cmd_argv_count
    cmd_opts_max = cmd_opts_count

    allocate(cmd_argv_list(cmd_argv_max))
    allocate(cmd_opts_list(cmd_opts_max))

    cmd_argv_count = 0
    cmd_opts_count = 0
    arg_get : do, i = 1, argind_count
      raw_arg = argstr_table(i)
      if (dcoptionformc(raw_arg, name, value)) then
        cmd_opts_count = cmd_opts_count + 1
        cmd_opts_list(cmd_opts_count) % name = name
        cmd_opts_list(cmd_opts_count) % value = value
        cmd_opts_list(cmd_opts_count) % flag_called = .false.
      else
        cmd_argv_count = cmd_argv_count + 1
        cmd_argv_list(cmd_argv_count) = raw_arg
      end if
    end do arg_get

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

argind_count

integer, save dc_args::argind_count = -1

private

Definition at line 318 of file dc_args.f90.

Referenced by buildargtable(), and sortargtable().

  integer, save:: argind_count = -1

argstr_table

character(string), dimension(:), allocatable, save dc_args::argstr_table

private

Definition at line 313 of file dc_args.f90.

Referenced by buildargtable(), dcargsclose0(), and sortargtable().

  character(STRING), allocatable, save:: argstr_table(:)

cmd_argv_list

character(string), dimension(:), allocatable, save dc_args::cmd_argv_list

private

Definition at line 329 of file dc_args.f90.

Referenced by dcargsclose0(), dcargsget0(), dcargsnumber0(), dcargsputline0(), and sortargtable().

  character(STRING), allocatable, save:: cmd_argv_list(:)

cmd_opts_list

type(cmd_opts_internal), dimension(:), allocatable, save dc_args::cmd_opts_list

private

Definition at line 324 of file dc_args.f90.

Referenced by dcargsclose0(), dcargsopen0(), and sortargtable().

  type(cmd_opts_internal), allocatable, save :: cmd_opts_list(:)