dcdatetimeparseunits.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
!> @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 Parse strings that mean units
!> @details
!> This file contains the implementation procedure for parsing
!> date/time unit strings.
!> @enden
!>
!> @ja
!> @brief 単位を表す文字列の解析
!> @details
!> このファイルには日時単位の文字列を解析する実装手続きが含まれています。
!> @endja
!>
 
!> @en
!> @brief Parse a unit string and return the corresponding symbol
!> @details
!> Parse the string given in `str` and return a symbol representing
!> the date/time unit. The following strings are interpreted as
!> date/time units. Case is not distinguished.
!>
!> | Unit                  | String constant                |
!> |-----------------------|--------------------------------|
!> | Year                  | dc_date_types#UNIT_YEAR        |
!> | Month                 | dc_date_types#UNIT_MONTH       |
!> | Day                   | dc_date_types#UNIT_DAY         |
!> | Hour                  | dc_date_types#UNIT_HOUR        |
!> | Minute                | dc_date_types#UNIT_MIN         |
!> | Second                | dc_date_types#UNIT_SEC         |
!> | Non-dimensional time  | dc_date_types#UNIT_NONDIM      |
!>
!> The returned symbols (integer type) are as follows.
!>
!> | Unit                  | Symbol constant                      |
!> |-----------------------|--------------------------------------|
!> | Year                  | dc_date_types#UNIT_SYMBOL_YEAR       |
!> | Month                 | dc_date_types#UNIT_SYMBOL_MONTH      |
!> | Day                   | dc_date_types#UNIT_SYMBOL_DAY        |
!> | Hour                  | dc_date_types#UNIT_SYMBOL_HOUR       |
!> | Minute                | dc_date_types#UNIT_SYMBOL_MIN        |
!> | Second                | dc_date_types#UNIT_SYMBOL_SEC        |
!> | Non-dimensional time  | dc_date_types#UNIT_SYMBOL_NONDIM     |
!>
!> If a string not matching these is given to `str`,
!> dc_date_types#UNIT_SYMBOL_ERR is returned.
!>
!> @param[in] str String to parse
!> @return Symbol representing the date/time unit
!> @enden
!>
!> @ja
!> @brief 単位文字列を解析して対応するシンボルを返す
!> @details
!> 引数 `str` に与えられた文字列を解釈し, 日時の単位を示す
!> シンボルを返します. それぞれ以下の文字列が日時の単位として解釈されます.
!> 大文字と小文字は区別されません.
!>
!> | 単位       | 文字列定数                     |
!> |------------|--------------------------------|
!> | 年         | dc_date_types#UNIT_YEAR        |
!> | 月         | dc_date_types#UNIT_MONTH       |
!> | 日         | dc_date_types#UNIT_DAY         |
!> | 時         | dc_date_types#UNIT_HOUR        |
!> | 分         | dc_date_types#UNIT_MIN         |
!> | 秒         | dc_date_types#UNIT_SEC         |
!> | 無次元時間 | dc_date_types#UNIT_NONDIM      |
!>
!> 返るシンボル (整数型) は以下の通りです.
!>
!> | 単位       | シンボル定数                         |
!> |------------|--------------------------------------|
!> | 年         | dc_date_types#UNIT_SYMBOL_YEAR       |
!> | 月         | dc_date_types#UNIT_SYMBOL_MONTH      |
!> | 日         | dc_date_types#UNIT_SYMBOL_DAY        |
!> | 時         | dc_date_types#UNIT_SYMBOL_HOUR       |
!> | 分         | dc_date_types#UNIT_SYMBOL_MIN        |
!> | 秒         | dc_date_types#UNIT_SYMBOL_SEC        |
!> | 無次元時間 | dc_date_types#UNIT_SYMBOL_NONDIM     |
!>
!> これらに該当しない文字列を `str` に与えた場合,
!> dc_date_types#UNIT_SYMBOL_ERR が返ります.
!>
!> @param[in] str 解析する文字列
!> @return 日時の単位を示すシンボル
!> @endja
function dcdatetimeparseunits(str) result(symbol)
 
  use dc_types, only: token
  use dc_date_types, only: unit_year, unit_month, unit_day, &
    & unit_hour, unit_min, unit_sec, unit_nondim, &
    & unit_symbol_year, unit_symbol_month, unit_symbol_day, &
    & unit_symbol_hour, unit_symbol_min, unit_symbol_sec, &
    & unit_symbol_nondim, unit_symbol_err
  use dc_string, only: strieq
  implicit none
  character(*), intent(in):: str
  integer:: symbol
  integer:: unit_str_size, i
  character(TOKEN):: unit
continue
  unit = adjustl(str)
  unit_str_size = size(unit_nondim)
  do i = 1, unit_str_size
    if (strieq(trim(unit), trim(unit_nondim(i)))) then
      symbol = unit_symbol_nondim
      return
    end if
  end do
 
  unit_str_size = size(unit_sec)
  do i = 1, unit_str_size
    if (strieq(trim(unit), trim(unit_sec(i)))) then
      symbol = unit_symbol_sec
      return
    end if
  end do
 
  unit_str_size = size(unit_min)
  do i = 1, unit_str_size
    if (strieq(trim(unit), trim(unit_min(i)))) then
      symbol = unit_symbol_min
      return
    end if
  end do
 
  unit_str_size = size(unit_hour)
  do i = 1, unit_str_size
    if (strieq(trim(unit), trim(unit_hour(i)))) then
      symbol = unit_symbol_hour
      return
    end if
  end do
 
  unit_str_size = size(unit_day)
  do i = 1, unit_str_size
    if (strieq(trim(unit), trim(unit_day(i)))) then
      symbol = unit_symbol_day
      return
    end if
  end do
 
  unit_str_size = size(unit_month)
  do i = 1, unit_str_size
    if (strieq(trim(unit), trim(unit_month(i)))) then
      symbol = unit_symbol_month
      return
    end if
  end do
 
  unit_str_size = size(unit_year)
  do i = 1, unit_str_size
    if (strieq(trim(unit), trim(unit_year(i)))) then
      symbol = unit_symbol_year
      return
    end if
  end do
 
  symbol = unit_symbol_err
 
end function dcdatetimeparseunits