ConfigUtilities.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*-----------------------------------------------------------------------------
    Config cache.
-----------------------------------------------------------------------------*/
 
#pragma once
 
#include "Containers/Map.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "Delegates/Delegate.h"
#include "Templates/Function.h"
 
class FString;
class IConsoleVariable;
 
 
namespace UE::ConfigUtilities
{
    /**
     * Single function to set a cvar from ini (handing friendly names, cheats for shipping and message about cheats in non shipping)
     */
    void OnSetCVarFromIniEntry(const TCHAR* IniFile, const TCHAR* Key, const TCHAR* Value, uint32 SetBy, bool bAllowCheating=false, bool bNoLogging=false);
 
    /**
     * Helper function to read the contents of an ini file and a specified group of cvar parameters, where sections in the ini file are marked [InName]
     * @param InSectionBaseName - The base name of the section to apply cvars from
     * @param InIniFilename - The ini filename
     * @param SetBy anything in ECVF_LastSetMask e.g. ECVF_SetByScalability
     */
    void ApplyCVarSettingsFromIni(const TCHAR* InSectionBaseName, const TCHAR* InIniFilename, uint32 SetBy, bool bAllowCheating=false);
 
    /**
     * Helper function to operate a user defined function for each CVar key/value pair in the specified section in an ini file
     * @param InSectionName - The name of the section to apply cvars from
     * @param InIniFilename - The ini filename
     * @param InEvaluationFunction - The evaluation function to be called for each key/value pair
     */
    void ForEachCVarInSectionFromIni(const TCHAR* InSectionName, const TCHAR* InIniFilename, TFunction<void(IConsoleVariable* CVar, const FString& KeyString, const FString& ValueString)> InEvaluationFunction);
 
    /**
     * CVAR Ini history records all calls to ApplyCVarSettingsFromIni and can re run them
     */
 
     /**
      * Helper function to start recording ApplyCVarSettings function calls
      * uses these to generate a history of applied ini settings sections
      */
    void RecordApplyCVarSettingsFromIni();
 
    /**
     * Helper function to reapply inis which have been applied after RecordCVarIniHistory was called
     */
    void ReapplyRecordedCVarSettingsFromIni();
 
    /**
     * Helper function to clean up ini history
     */
    void DeleteRecordedCVarSettingsFromIni();
 
    /**
     * Helper function to start recording config reads
     */
    void RecordConfigReadsFromIni();
 
    /**
     * Helper function to dump config reads to csv after RecordConfigReadsFromIni was called
     */
    void DumpRecordedConfigReadsFromIni();
 
    /**
     * Helper function to clean up config read history
     */
    void DeleteRecordedConfigReadsFromIni();
 
    /**
     * Helper function to deal with "True","False","Yes","No","On","Off"
     */
    const TCHAR* ConvertValueFromHumanFriendlyValue(const TCHAR* Value);
}