TIniFile Class

module: IniObjects file: IniObjects
Generics
  • Read
    Procedures:
    • Ini_Read_Real_Change
    • Ini_Read_Double_Change
    • Ini_Read_Int_Change
Subroutines
  • Close(this)
  • EmptyCheckDefault(this, Key, Default)
    • TIniFile   :: this
    • character(len=*) intent(in) :: Key
    • class(*) intent(in), optional :: Default
  • Ini_Read_Double_Change(this, Key, Current, min, max)
    • TIniFile   :: this
    • character(len=*) intent(in) :: Key
    • double precision intent(inout) :: Current
    • double precision intent(in), optional :: min
    • double precision intent(in), optional :: max
  • Ini_Read_Int_Change(this, Key, Current, min, max)
    • TIniFile   :: this
    • character(len=*) intent(in) :: Key
    • integer intent(inout) :: Current
    • integer intent(in), optional :: min
    • integer intent(in), optional :: max
  • Ini_Read_Logical_Change(this, Key, Current)
    • TIniFile   :: this
    • character(len=*) intent(in) :: Key
    • logical intent(inout) :: Current
  • Ini_Read_Real_Change(this, Key, Current, min, max)
    • TIniFile   :: this
    • character(len=*) intent(in) :: Key
    • real intent(inout) :: Current
    • real intent(in), optional :: min
    • real intent(in), optional :: max
  • Ini_Read_String_Change(this, Key, Current)
    • TIniFile   :: this
    • character(len=*) intent(in) :: Key
    • character(len=:) allocatable, intent(inout) :: Current
  • NameValue_AddLine(this, AInLine, only_if_undefined)
    • TIniFile   :: this
    • character (len=*) intent(in) :: AInLine
    • logical intent(in), optional :: only_if_undefined
  • Open(this, filename, error, slash_comments, append, only_if_undefined)
    • TIniFile   :: this
    • character (len=*) intent(in) :: filename
    • logical intent(out), optional :: error
    • logical intent(in), optional :: slash_comments
    • logical intent(in), optional :: append
    • logical intent(in), optional :: only_if_undefined
  • Open_Fromlines(this, NumLines, Lines, slash_comments)
    • TIniFile   :: this
    • integer intent(in) :: NumLines
    • character (len=*) dimension(NumLines), intent(in) :: Lines
    • logical intent(in), optional :: slash_comments
  • Read_Enumeration_List(this, Key, Names, Enums, Default, nvalues, max_enums)
    • TIniFile   :: this
    • character(len=*) intent(in) :: Key
    • character(len=Ini_Enumeration_Len) intent(in) :: Names(:)
    • integer allocatable, intent(out) :: Enums(:)
    • character(len=*) intent(in), optional :: Default
    • integer intent(in), optional :: nvalues
    • integer intent(in), optional :: max_enums
  • SaveReadValues(this, afile)
    • TIniFile   :: this
    • character(len=*) intent(in) :: afile
Functions
  • integer
    EnumerationValue(this, S, Names)
    • TIniFile   :: this
    • character(len=*)  :: S
    • character(len=Ini_Enumeration_Len) intent(in) :: Names(:)
  • character(len=:) allocatable
    ExpandEnvironment(this, InValue)
    expand $(PLACEHOLDER) with environment variables, as Makefile
    • TIniFile   :: this
    • character(len=:) allocatable, intent(in) :: InValue
  • character(len=:) allocatable
    Key_To_Arraykey(this, Key, index)
    • TIniFile intent(in)  :: this
    • character (len=*) intent(in) :: Key
    • integer intent(in) :: index
  • double precision
    Read_Double(this, Default, min, max, Key)
    • TIniFile   :: this
    • double precision intent(in), optional :: Default
    • double precision intent(in), optional :: min
    • double precision intent(in), optional :: max
    • character (len=*) intent(in) :: Key
  • double precision
    Read_Double_Array(this, Default, min, max, index, Key)
    Reads Key(1), Key(2), etc.
    • TIniFile   :: this
    • double precision intent(in), optional :: Default
    • double precision intent(in), optional :: min
    • double precision intent(in), optional :: max
    • integer intent(in) :: index
    • character(len=*) intent(in) :: Key
  • integer
    Read_Enumeration(this, Key, Names, Default)
    • TIniFile   :: this
    • character(len=*) intent(in) :: Key
    • character(len=Ini_Enumeration_Len) intent(in) :: Names(:)
    • integer intent(in), optional :: Default
  • integer
    Read_Int(this, Default, min, max, OK, Key)
    • TIniFile   :: this
    • integer intent(in), optional :: Default
    • integer intent(in), optional :: min
    • integer intent(in), optional :: max
    • logical intent(out), optional :: OK
    • character(len=*) intent(in) :: Key
  • integer
    Read_Int_Array(this, Default, index, Key)
    Reads Key(1), Key(2), etc.
    • TIniFile   :: this
    • integer intent(in), optional :: Default
    • integer intent(in) :: index
    • character(len=*) intent(in) :: Key
  • logical
    Read_Logical(this, Default, Key)
    • TIniFile   :: this
    • logical intent(in), optional :: Default
    • character(len=*) intent(in) :: Key
  • real
    Read_Real(this, Default, min, max, Key)
    • TIniFile   :: this
    • real intent(in), optional :: Default
    • real intent(in), optional :: min
    • real intent(in), optional :: max
    • character(len=*) intent(in) :: Key
  • real
    Read_Real_Array(this, Default, min, max, index, Key)
    Reads Key(1), Key(2), etc.
    • TIniFile   :: this
    • real intent(in), optional :: Default
    • real intent(in), optional :: min
    • real intent(in), optional :: max
    • integer intent(in) :: index
    • character(len=*) intent(in) :: Key
  • character(len=:) pointer
    Read_String(this, Key, NotFoundFail)
    • TIniFile   :: this
    • character (len=*) intent(in) :: Key
    • logical intent(in), optional :: NotFoundFail
  • character(len=:) pointer
    Read_String_Array(this, index, Key, NotFoundFail)
    • TIniFile   :: this
    • integer intent(in) :: index
    • character (len=*) intent(in) :: Key
    • logical intent(in), optional :: NotFoundFail
  • character(len=:) allocatable
    Read_String_Default(this, Key, Default, AllowBlank, EnvDefault)
    Returns from this first; if not found tries environment variable if EnvDefault is true, If not found returns Default (unless not present, in which case gives error) AllBlank specifies whether an empty string counts as a valid result to give instead of Default
    • TIniFile   :: this
    • character (len=*) intent(in) :: Key
    • character (len=*) intent(in), optional :: Default
    • logical intent(in), optional :: AllowBlank
    • logical intent(in), optional :: EnvDefault
  • character(len=:) allocatable
    ResolveLinkedFile(this, name, thisfilename)
    • TIniFile   :: this
    • character(len=*) intent(in) :: name
    • character(len=*) intent(in) :: thisfilename
  • logical
    TestEqual(this, Key, value, EmptyOK)
    • TIniFile   :: this
    • character (len=*) intent(in) :: Key
    • character (len=*) intent(in) :: value
    • logical intent(in), optional :: EmptyOK
Properties
  • logical :: SlashComments
  • logical :: Echo_Read
  • logical :: Fail_on_not_found
  • logical :: ExpandEnvironmentVariables
  • character(len=:) :: Original_filename allocatable
  • TNameValueList :: ReadValues

Tree Diagrams