Profile.h

Go to the documentation of this file.

/*
 * Copyright(c) Sophist Solutions, Inc. 1990-2025.  All rights reserved
 */
#ifndef _Stroika_Foundation_DataExchange_INI_Profile_h_
#define _Stroika_Foundation_DataExchange_INI_Profile_h_ 1
 
#include "Stroika/Foundation/StroikaPreComp.h"
 
#include "Stroika/Foundation/Characters/String.h"
#include "Stroika/Foundation/Common/Common.h"
#include "Stroika/Foundation/Containers/Mapping.h"
#include "Stroika/Foundation/DataExchange/VariantValue.h"
 
/**
 *  \file
 */
 
namespace Stroika::Foundation::DataExchange::Variant::INI {
 
    using Containers::Mapping;
 
    /**
     *  Each 'section' of an INI file consists of name/value pairs.
     */
    struct Section {
        Mapping<String, String> fProperties;
 
        bool operator== (const Section& rhs) const = default;
 
        /**
         *  @see Characters::ToString ();
         */
        nonvirtual String ToString () const;
    };
 
    /**
     *  An INI file is a series of sections - one of which maybe unnamed, and the remaining are named.
     */
    struct Profile {
        Section                  fUnnamedSection;
        Mapping<String, Section> fNamedSections;
 
        bool operator== (const Profile& rhs) const = default;
 
        /**
         *  @see Characters::ToString ();
         */
        nonvirtual String ToString () const;
    };
 
    /**
     *  Map back and forth between Profile object, and structured VariantValue. If the VariantValue is not
     *  in the format of a legal Profile, this function (arg VariantValue) will throw.
     */
    Profile      Convert (const VariantValue& v);
    VariantValue Convert (const Profile& p);
 
}
 
/*
 ********************************************************************************
 ***************************** Implementation Details ***************************
 ********************************************************************************
 */
#include "Profile.inl"
 
#endif /*_Stroika_Foundation_DataExchange_INI_Profile_h_*/