CommandLineOptions.h

#pragma once
 
#include <Foundation/Basics.h>
#include <Foundation/Math/Math.h>
#include <Foundation/Utilities/CommandLineUtils.h>
#include <Foundation/Utilities/EnumerableClass.h>
 
class plStringBuilder;
class plLogInterface;
 
class PL_FOUNDATION_DLL plCommandLineOption : public plEnumerable<plCommandLineOption>
{
  PL_DECLARE_ENUMERABLE_CLASS(plCommandLineOption);
 
public:
  enum class LogAvailableModes
  {
    Always,         
    IfHelpRequested 
  };
 
  enum class LogMode
  {
    Never,                
    FirstTime,            
    FirstTimeIfSpecified, 
    Always,               
    AlwaysIfSpecified,    
  };
 
  static bool IsHelpRequested(const plCommandLineUtils* pUtils = plCommandLineUtils::GetGlobalInstance()); // [tested]
 
  static plResult RequireOptions(plStringView sRequiredOptions, plString* pMissingOption = nullptr, const plCommandLineUtils* pUtils = plCommandLineUtils::GetGlobalInstance()); // [tested]
 
  static bool LogAvailableOptions(LogAvailableModes mode, plStringView sGroupFilter = {}, const plCommandLineUtils* pUtils = plCommandLineUtils::GetGlobalInstance()); // [tested]
 
  static bool LogAvailableOptionsToBuffer(plStringBuilder& out_sBuffer, LogAvailableModes mode, plStringView sGroupFilter = {}, const plCommandLineUtils* pUtils = plCommandLineUtils::GetGlobalInstance()); // [tested]
 
public:
  plCommandLineOption(plStringView sSortingGroup) { m_sSortingGroup = sSortingGroup; }
 
  virtual void GetSortingGroup(plStringBuilder& ref_sOut) const;
 
  virtual void GetOptions(plStringBuilder& ref_sOut) const = 0;
 
  void GetSplitOptions(plStringBuilder& out_sAll, plDynamicArray<plStringView>& ref_splitOptions) const;
 
  virtual void GetParamShortDesc(plStringBuilder& ref_sOut) const = 0;
 
  virtual void GetParamDefaultValueDesc(plStringBuilder& ref_sOut) const = 0;
 
  virtual void GetLongDesc(plStringBuilder& ref_sOut) const = 0;
 
  virtual plStringView GetType() = 0;
 
protected:
  plStringView m_sSortingGroup;
};
 
 
class PL_FOUNDATION_DLL plCommandLineOptionDoc : public plCommandLineOption
{
public:
  plCommandLineOptionDoc(plStringView sSortingGroup, plStringView sArgument, plStringView sParamShortDesc, plStringView sLongDesc, plStringView sDefaultValue, bool bCaseSensitive = false);
 
  virtual void GetOptions(plStringBuilder& ref_sOut) const override;               // [tested]
 
  virtual void GetParamShortDesc(plStringBuilder& ref_sOut) const override;        // [tested]
 
  virtual void GetParamDefaultValueDesc(plStringBuilder& ref_sOut) const override; // [tested]
 
  virtual void GetLongDesc(plStringBuilder& ref_sOut) const override;              // [tested]
 
  virtual plStringView GetType() override { return "Doc"; }
 
  bool IsOptionSpecified(plStringBuilder* out_pWhich = nullptr, const plCommandLineUtils* pUtils = plCommandLineUtils::GetGlobalInstance()) const; // [tested]
 
protected:
  bool ShouldLog(LogMode mode, bool bWasSpecified) const;
  void LogOption(plStringView sOption, plStringView sValue, bool bWasSpecified) const;
 
  plStringView m_sArgument;
  plStringView m_sParamShortDesc;
  plStringView m_sParamDefaultValue;
  plStringView m_sLongDesc;
  bool m_bCaseSensitive = false;
  mutable bool m_bLoggedOnce = false;
};
 
 
class PL_FOUNDATION_DLL plCommandLineOptionBool : public plCommandLineOptionDoc
{
public:
  plCommandLineOptionBool(plStringView sSortingGroup, plStringView sArgument, plStringView sLongDesc, bool bDefaultValue, bool bCaseSensitive = false);
 
  bool GetOptionValue(LogMode logMode, const plCommandLineUtils* pUtils = plCommandLineUtils::GetGlobalInstance()) const; // [tested]
 
  void SetDefaultValue(bool value)
  {
    m_bDefaultValue = value;
  }
 
  bool GetDefaultValue() const { return m_bDefaultValue; }
 
  virtual plStringView GetType() override { return "Bool"; }
 
protected:
  bool m_bDefaultValue = false;
};
 
 
class PL_FOUNDATION_DLL plCommandLineOptionInt : public plCommandLineOptionDoc
{
public:
  plCommandLineOptionInt(plStringView sSortingGroup, plStringView sArgument, plStringView sLongDesc, int iDefaultValue, int iMinValue = plMath::MinValue<int>(), int iMaxValue = plMath::MaxValue<int>(), bool bCaseSensitive = false);
 
  virtual void GetParamDefaultValueDesc(plStringBuilder& ref_sOut) const override; // [tested]
 
  virtual void GetParamShortDesc(plStringBuilder& ref_sOut) const override;        // [tested]
 
  int GetOptionValue(LogMode logMode, const plCommandLineUtils* pUtils = plCommandLineUtils::GetGlobalInstance()) const; // [tested]
 
  void SetDefaultValue(plInt32 value)
  {
    m_iDefaultValue = value;
  }
 
  virtual plStringView GetType() override { return "Int"; }
 
  plInt32 GetMinValue() const { return m_iMinValue; }
 
  plInt32 GetMaxValue() const { return m_iMaxValue; }
 
  plInt32 GetDefaultValue() const { return m_iDefaultValue; }
 
protected:
  plInt32 m_iDefaultValue = 0;
  plInt32 m_iMinValue = 0;
  plInt32 m_iMaxValue = 0;
};
 
 
class PL_FOUNDATION_DLL plCommandLineOptionFloat : public plCommandLineOptionDoc
{
public:
  plCommandLineOptionFloat(plStringView sSortingGroup, plStringView sArgument, plStringView sLongDesc, float fDefaultValue, float fMinValue = plMath::MinValue<float>(), float fMaxValue = plMath::MaxValue<float>(), bool bCaseSensitive = false);
 
  virtual void GetParamDefaultValueDesc(plStringBuilder& ref_sOut) const override; // [tested]
 
  virtual void GetParamShortDesc(plStringBuilder& ref_sOut) const override;        // [tested]
 
  float GetOptionValue(LogMode logMode, const plCommandLineUtils* pUtils = plCommandLineUtils::GetGlobalInstance()) const; // [tested]
 
  void SetDefaultValue(float value)
  {
    m_fDefaultValue = value;
  }
 
  virtual plStringView GetType() override { return "Float"; }
 
  float GetMinValue() const { return m_fMinValue; }
 
  float GetMaxValue() const { return m_fMaxValue; }
 
  float GetDefaultValue() const { return m_fDefaultValue; }
 
protected:
  float m_fDefaultValue = 0;
  float m_fMinValue = 0;
  float m_fMaxValue = 0;
};
 
 
class PL_FOUNDATION_DLL plCommandLineOptionString : public plCommandLineOptionDoc
{
public:
  plCommandLineOptionString(plStringView sSortingGroup, plStringView sArgument, plStringView sLongDesc, plStringView sDefaultValue, bool bCaseSensitive = false);
 
  plStringView GetOptionValue(LogMode logMode, const plCommandLineUtils* pUtils = plCommandLineUtils::GetGlobalInstance()) const; // [tested]
 
  void SetDefaultValue(plStringView sValue)
  {
    m_sDefaultValue = sValue;
  }
 
  plStringView GetDefaultValue() const { return m_sDefaultValue; }
 
  virtual plStringView GetType() override { return "String"; }
 
protected:
  plStringView m_sDefaultValue;
};
 
 
class PL_FOUNDATION_DLL plCommandLineOptionPath : public plCommandLineOptionDoc
{
public:
  plCommandLineOptionPath(plStringView sSortingGroup, plStringView sArgument, plStringView sLongDesc, plStringView sDefaultValue, bool bCaseSensitive = false);
 
  plString GetOptionValue(LogMode logMode, const plCommandLineUtils* pUtils = plCommandLineUtils::GetGlobalInstance()) const; // [tested]
 
  void SetDefaultValue(plStringView sValue)
  {
    m_sDefaultValue = sValue;
  }
 
  plStringView GetDefaultValue() const { return m_sDefaultValue; }
 
  virtual plStringView GetType() override { return "Path"; }
 
protected:
  plStringView m_sDefaultValue;
};
 
 
class PL_FOUNDATION_DLL plCommandLineOptionEnum : public plCommandLineOptionDoc
{
public:
  plCommandLineOptionEnum(plStringView sSortingGroup, plStringView sArgument, plStringView sLongDesc, plStringView sEnumKeysAndValues, plInt32 iDefaultValue, bool bCaseSensitive = false);
 
  plInt32 GetOptionValue(LogMode logMode, const plCommandLineUtils* pUtils = plCommandLineUtils::GetGlobalInstance()) const; // [tested]
 
  virtual void GetParamShortDesc(plStringBuilder& ref_sOut) const override;                                                  // [tested]
 
  virtual void GetParamDefaultValueDesc(plStringBuilder& ref_sOut) const override;                                           // [tested]
 
  struct EnumKeyValue
  {
    plStringView m_Key;
    plInt32 m_iValue = 0;
  };
 
  void GetEnumKeysAndValues(plDynamicArray<EnumKeyValue>& out_keysAndValues) const;
 
  void SetDefaultValue(plInt32 value)
  {
    m_iDefaultValue = value;
  }
 
  plInt32 GetDefaultValue() const { return m_iDefaultValue; }
 
  virtual plStringView GetType() override { return "Enum"; }
 
protected:
  plInt32 m_iDefaultValue = 0;
  plStringView m_sEnumKeysAndValues;
};