dcstringfprintf.f90

Go to the documentation of this file.

! -*- mode: f90; coding: utf-8 -*-
!-----------------------------------------------------------------------
! Copyright (c) 2000-2026 Gtool Development Group. All rights reserved.
!-----------------------------------------------------------------------
!>
!> @author    Yasuhiro MORIKAWA, Eizi TOYODA
!> @copyright Copyright (C) GFD Dennou Club, 2000-2026. All rights reserved. <br/>
!>            License is BSD-2-Clause. see [COPYRIGHT](@ref COPYRIGHT) in detail
!> @en
!> @brief Formatted output conversion to file unit
!> @details
!> Format a string like C sprintf(3) and output to a file unit.
!> Note that the implementation is quite different from C sprintf(3).
!> @enden
!>
!> @ja
!> @brief 書式変換出力 (装置番号版)
!> @details
!> C の sprintf(3) のように文字列をフォーマットして装置番号に出力します。
!> ただし、実装は C の sprintf(3) とは大分違うのでご注意ください。
!> @endja
!>
 
!> @en
!> @brief Format string and output to unit
!> @details
!> Return a formatted string according to format string `fmt` to unit `unit`.
!> If `unit` is omitted, output to standard output.
!> Use specifiers starting with '%' in `fmt`.
!> Use '%%' to output a literal '%'.
!> See dcstringsprintf.f90 for specifier details and examples.
!>
!> @param[in] unit Output unit number (default: standard output)
!> @param[in] fmt Format string with specifiers
!> @param[in] i Integer array data for %d, %o, %x
!> @param[in] r Single precision real array data for %r
!> @param[in] d Double precision real array data for %f
!> @param[in] L Logical array data for %b, %y
!> @param[in] n Repeat counts for %* specifier
!> @param[in] c1 First character string for %c
!> @param[in] c2 Second character string for %c
!> @param[in] c3 Third character string for %c
!> @param[in] ca Character array for %a
!> @enden
!>
!> @ja
!> @brief 書式変換して装置番号に出力
!> @details
!> フォーマット文字列 `fmt` に従って変換された文字列を
!> 装置番号 `unit` に出力します。`unit` を省略する場合には標準出力に出力します。
!> `fmt` には '%' で始まる指示子を含む文字列を与えます。
!> '%' を出力したい場合は '%%' と記述します。
!> 指示子および用例に関しての詳細は dcstringsprintf.f90 を参照ください。
!>
!> @param[in] unit 出力先の装置番号 (デフォルト: 標準出力)
!> @param[in] fmt 指示子を含むフォーマット文字列
!> @param[in] i %d, %o, %x 用の整数配列データ
!> @param[in] r %r 用の単精度実数配列データ
!> @param[in] d %f 用の倍精度実数配列データ
!> @param[in] L %b, %y 用の論理配列データ
!> @param[in] n %* 用の繰り返し回数
!> @param[in] c1 %c 用の1番目の文字列
!> @param[in] c2 %c 用の2番目の文字列
!> @param[in] c3 %c 用の3番目の文字列
!> @param[in] ca %a 用の文字配列
!> @endja
subroutine dcstringfprintf(unit, fmt, i, r, d, L, n, c1, c2, c3, ca)
 
  use dc_types, only: string, dp,sp
  use dc_string, only: printf
  implicit none
  integer, intent(in), optional:: unit
  character(*), intent(in):: fmt
  integer, intent(in), optional:: i(:), n(:)
  real(SP), intent(in), optional:: r(:)
  real(DP), intent(in), optional:: d(:)
  logical, intent(in), optional:: L(:)
  character(*), intent(in), optional:: c1, c2, c3
  character(*), intent(in), optional:: ca(:)
  character(STRING):: buf
  continue
  call printf(buf, fmt, i=i, r=r, d=d, l=l, n=n, &
    & c1=c1, c2=c2, c3=c3, ca=ca)
  if (present(unit)) then
    write(unit, '(A)') trim(buf)
  else
    write(*, '(A)') trim(buf)
  endif
end subroutine dcstringfprintf