BigIntegerFormatterLibrary.h

// Copyright (C)2023 Smiling Cat Entertainment, LTD. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "Format/BigIntegerFormatter.h"
#include "Format/DecimalInvariantFormatter.h"
#include "Format/DecimalFullFormatter.h"
#include "Format/DecimalScalingFormatter.h"
#include "Format/HexadecimalInvariantFormatter.h"
#include "Format/ScientificGroupLabeler.h"
#include "Format/NamedGroupLabeler.h"
#include "Format/SIUnitsGroupLabeler.h"
#include "BigIntegerFormatterLibrary.generated.h"
 
UENUM(BlueprintType)
enum class EDefaultFormatterType : uint8
{
    DecimalInvariant,
    DecimalFull,
    DecimalScaledNamed,
    DecimalScaledScientific,
    DecimalScaledEngineering,
    DecimalScaledSIName,
    DecimalScaledSISymbol,
    HexadecimalInvariant,
};
 
UENUM(BlueprintType)
enum class EDefaultGroupLabelerType : uint8
{
    Scientific,
    Named,
    SIName,
    SISymbol,
};
 
UCLASS()
class DUKESBIGNUMBERS_API UBigIntegerFormatterLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
 
public:
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "To Invariant Decimal String", CompactNodeTitle = "->DEC$"), Category = "Math|BigInteger")
    static FString ToDecimalInvariantString(const FBigInteger& Number);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Append Invariant Decimal To String", CompactNodeTitle = "+DEC$"), Category = "Math|BigInteger")
    static FString& AppendDecimalInvariantToString(const FBigInteger& Number, UPARAM(ref) FString& AppendTo);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "To Full Decimal String", CompactNodeTitle = "->FMTDEC$"), Category = "Math|BigInteger")
    static FString ToDecimalFullString(const FBigInteger& Number);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Append Full Decimal To String", CompactNodeTitle = "+FMTDEC$"), Category = "Math|BigInteger")
    static FString& AppendDecimalFullToString(const FBigInteger& Number, UPARAM(ref) FString& AppendTo);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "To Scientific String", CompactNodeTitle = "->SCI$"), Category = "Math|BigInteger")
    static FString ToScientificString(const FBigInteger& Number);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Append Scientific To String", CompactNodeTitle = "+SCI$"), Category = "Math|BigInteger")
    static FString& AppendScientificToString(const FBigInteger& Number, UPARAM(ref) FString& AppendTo);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "To Engineering String", CompactNodeTitle = "->ENG$"), Category = "Math|BigInteger")
    static FString ToEngineeringString(const FBigInteger& Number);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Append Engineering To String", CompactNodeTitle = "+ENG$"), Category = "Math|BigInteger")
    static FString& AppendEngineeringToString(const FBigInteger& Number, UPARAM(ref) FString& AppendTo);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "To Named String", CompactNodeTitle = "->thous$"), Category = "Math|BigInteger")
    static FString ToNamedString(const FBigInteger& Number);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Append Named To String", CompactNodeTitle = "+thous$"), Category = "Math|BigInteger")
    static FString& AppendNamedToString(const FBigInteger& Number, UPARAM(ref) FString& AppendTo);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "To SIName String", CompactNodeTitle = "->kilo$"), Category = "Math|BigInteger")
    static FString ToSINameString(const FBigInteger& Number);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Append SIName To String", CompactNodeTitle = "+kilo$"), Category = "Math|BigInteger")
    static FString& AppendSINameToString(const FBigInteger& Number, UPARAM(ref) FString& AppendTo);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "To SISymbol String", CompactNodeTitle = "->k$"), Category = "Math|BigInteger")
    static FString ToSISymbolString(const FBigInteger& Number);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Append SISymbol To String", CompactNodeTitle = "+k$"), Category = "Math|BigInteger")
    static FString& AppendSISymbolToString(const FBigInteger& Number, UPARAM(ref) FString& AppendTo);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "To Invariant Hexadecimal String", CompactNodeTitle = "->HEX$"), Category = "Math|BigInteger")
    static FString ToHexadecimalInvariantString(const FBigInteger& Number);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Append Invariant Hexadecimal To String", CompactNodeTitle = "+HEX$"), Category = "Math|BigInteger")
    static FString& AppendHexadecimalInvariantToString(const FBigInteger& Number, UPARAM(ref) FString& AppendTo);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get Default Formatter"), Category = "Math|BigInteger")
    static UBigIntegerFormatter* GetDefaultFormatter(EDefaultFormatterType Type);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get Scientific Group Label"), Category = "Math|BigInteger")
    static FString GetScientificGroupLabel(int32 PowerOfTen);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Append Scientific Group Label"), Category = "Math|BigInteger")
    static FString& AppendScientificGroupLabel(int32 PowerOfTen, UPARAM(ref) FString& AppendTo, int32& Remainder);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get Named Group Label"), Category = "Math|BigInteger")
    static FString GetNamedGroupLabel(int32 PowerOfTen);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Append Named Group Label"), Category = "Math|BigInteger")
    static FString& AppendNamedGroupLabel(int32 PowerOfTen, UPARAM(ref) FString& AppendTo, int32& Remainder);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get SI Name Group Label"), Category = "Math|BigInteger")
    static FString GetSINameGroupLabel(int32 PowerOfTen);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Append SI Name Group Label"), Category = "Math|BigInteger")
    static FString& AppendSINameGroupLabel(int32 PowerOfTen, UPARAM(ref) FString& AppendTo, int32& Remainder);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get SI Symbol Group Label"), Category = "Math|BigInteger")
    static FString GetSISymbolGroupLabel(int32 PowerOfTen);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Append SI Symbol Group Label"), Category = "Math|BigInteger")
    static FString& AppendSISymbolGroupLabel(int32 PowerOfTen, UPARAM(ref) FString& AppendTo, int32& Remainder);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get Default Group Labeler"), Category = "Math|BigInteger")
    static UGroupLabeler* GetDefaultGroupLabeler(EDefaultGroupLabelerType Type);
 
};
 
// If conditional inlining is ON, include inlinable functions here.
#if DBN_INLINE_ENABLED
#include "BigIntegerFormatterLibrary.inl"
#endif