LogFile.h

Go to the documentation of this file.

// Copyright (c) 2024 FrostBit Software Lab at the Lapland University of Applied Sciences
//
// This work is licensed under the terms of the MIT license.
// For a copy, see <https://opensource.org/licenses/MIT>.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/Object.h"
 
#include <fstream>
 
#include "LogFile.generated.h"
 
UENUM(BlueprintType)
enum class FFileCreationOptions : uint8
{
    Overwrite = 0 UMETA(DisplayName = "Overwrite"),
    Append = 1 UMETA(DisplayName = "Append"),
    CreateUnique = 2 UMETA(DisplayName = "CreateUnique")
};
 
UENUM(BlueprintType)
enum class FFileWriteOptions : uint8
{
    Immediate = 0 UMETA(DisplayName = "Immediate"),
    Queue = 1 UMETA(DisplayName = "Queue")
};
 
USTRUCT(Blueprintable)
struct AGRARSENSE_API FLogFileSettings
{
    GENERATED_BODY()
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    FFileCreationOptions FileCreationOptions = FFileCreationOptions::Overwrite;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    bool Timestamp = true;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    bool KeepFileOpen = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    FFileWriteOptions FileWriteOptions = FFileWriteOptions::Immediate;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    int32 QueueLength = 10;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    bool OverrideFilePath = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    FString FilePath;
};
 
UCLASS(Blueprintable)
class AGRARSENSE_API ULogFile : public UObject
{
    GENERATED_BODY()
 
public:
 
    ULogFile();
 
    ~ULogFile();
 
    static ULogFile* CreateLogFile(const FString& FileNameWithoutExtension, FLogFileSettings Settings = FLogFileSettings());
 
    UFUNCTION(BlueprintCallable, Category = "Logging")
    void Create(const FString& FileNameWithoutExtension, FLogFileSettings Settings);
 
    UFUNCTION(BlueprintCallable, Category = "Logging")
    void Write(const FString& Text);
 
    UFUNCTION(BlueprintCallable, Category = "Logging")
    void Close();
 
    UFUNCTION(BlueprintCallable, Category = "Logging")
    void Clear();
 
    UFUNCTION(BlueprintCallable, Category = "Logging")
    void Destroy();
 
    UFUNCTION(BlueprintCallable, Category = "Logging")
    void OpenFilePath();
 
    UFUNCTION(BlueprintCallable, BlueprintPure, Category = "Logging")
    FString GetLogFilePath()
    {
        return FilePath;
    }
 
private:
 
    void WriteQueuedMessages();
 
    void WriteToFile(const FString& Text, bool UseTimestamp);
 
    UPROPERTY()
    TArray<FString> MessageQueue;
 
    FLogFileSettings CurrentSettings;
 
    FString FilePath;
 
    std::ofstream LogFileStream;
};