dc_args::dcargshelpmsg Interface Reference

Public Member Functions
subroutine	dcargshelpmsg0 (arg, category, msg)

Detailed Description

Definition at line 307 of file dc_args.f90.

Member Function/Subroutine Documentation

dcargshelpmsg0()

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

ヘルプメッセージを追加

サブルーチン 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 )
  call dcargshelpmsg( arg = arg, category = 'Title', &
    & msg = 'dcargs :: Test program of dc_args' )
  call dcargshelpmsg( arg = arg, category = 'Usage', &
    & msg = 'dcargs [Options] arg1, arg2, ...')
  call dcargsoption( arg = arg, options = stoa('-N', '--namelist'), &
    & flag = opt_namelist, value = val_namelist, help = )
  call dcargshelpmsg( arg = arg, category = 'DESCRIPTION', &
    & msg = '(1) Define type . (2) Open the variable. ...')
  call dcargshelpmsg( arg = arg, category = 'Copyright', &
    & msg = 'Copyright (C) GFD Dennou Club, 2008. All rights reserved.')
  call dcargsdebug( arg = arg )
  call dcargshelp( arg = arg )
  call dcargsstrict( arg = arg )
  call dcargsget( arg = arg, argv = argv )
  write(*,*) '--namelist=', trim( val_namelist )
  do i = 1, size(argv)
    write(*,*) argv(i)
  end do
  deallocate( argv )
  call dcargsclose( arg = arg )
end program dc_args_sample3

コマンドライン引数に '-h', '-H', '–help' のいづれかのオプション を指定することで, HelpMsg で与えたメッセージと, オプションの一覧 が標準出力に表示されます.

Parameters

[in,out]	arg	ARGS 型変数
[in]	category	カテゴリ名 ("Title", "Overview", "Usage" など)
[in]	msg	追加するヘルプメッセージ

Definition at line 939 of file dc_args.f90.

    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)

---

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

• dc_utils/dc_args.f90