egetopt.h

Go to the documentation of this file.

/*
* Copyright (c) 2009-2019 Brian Waters
* Copyright (c) 2019 Sprint
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

#ifndef __egetopt_h_included
#define __egetopt_h_included

#include "eerror.h"
#include "estring.h"

class EGetOpt
{
public:
   enum ArgType
   {
      no_argument,
      required_argument,
      optional_argument
   };

   enum DataType
   {
      dtNone,
      dtString,
      dtInt32,
      dtInt64,
      dtUInt32,
      dtUInt64,
      dtDouble,
      dtBool
   };

   struct Option
   {
      EString shortName;
      EString longName;
      ArgType argType;
      DataType dataType;
   };

   EGetOpt();
   ~EGetOpt();

   Void setPrefix(const EString &path) { setPrefix(path.c_str()); }
   Void setPrefix(cpStr path = "") { m_prefix = path; }

   Void loadCmdLine(Int argc, pStr *argv, const EGetOpt::Option *options);
   Void loadFile(cpStr filename);

   Long getCmdLine(cpStr path, Long def) const;
   LongLong getCmdLine(cpStr path, LongLong def) const;
   ULong getCmdLine(cpStr path, ULong def) const;
   ULongLong getCmdLine(cpStr path, ULongLong def) const;
   Double getCmdLine(cpStr path, Double def) const;
   cpStr getCmdLine(cpStr path, cpStr def) const;
   Bool getCmdLine(cpStr path, Bool def) const;

   std::vector<EString> getCmdLineArgs() const;

   std::vector<EString> getCmdLineRaw() const;

   std::vector<EString> getMembers(cpStr path) const;
   std::vector<EString> getMembers(UInt idx, cpStr path, cpStr member) const;

   Long get(cpStr path, Long def) const;
   LongLong get(cpStr path, LongLong def) const;
   ULong get(cpStr path, ULong def) const;
   ULongLong get(cpStr path, ULongLong def) const;
   Double get(cpStr path, Double def) const;
   cpStr get(cpStr path, cpStr def) const;
   Bool get(cpStr path, Bool def) const;

   UInt getCount(cpStr path) const;
   template<typename T>
   T get(UInt idx, cpStr path, cpStr member, T def) const
   {
      EString mbr;
      mbr.format("%u/%s", idx, member);
      EString pth = combinePath(path, mbr.c_str());
      return get(pth, def);
   }
   template<typename T>
   std::vector<T> getArray(cpStr path) const;
   template<typename T>
   std::vector<T> getArray(UInt idx, cpStr path, cpStr member) const
   {
      EString mbr;
      mbr.format("%u/%s", idx, member);
      EString pth = combinePath(path, mbr.c_str());
      return getArray<T>(pth);
   }

   Void print() const;

private:
   EString combinePath(cpStr path1, cpStr path2) const;
   const Option *findOption(cpStr name, const Option *options);

   pVoid m_json;
   EString m_prefix;
};


class EGetOptError_MissingRequiredArgument : public EError
{
public:
   EGetOptError_MissingRequiredArgument(cpStr pszFile);
   virtual const cpStr Name() const { return "EGetOptError_MissingRequiredArgument"; }
};

class EGetOptError_UnsupportedArgType : public EError
{
public:
   EGetOptError_UnsupportedArgType(EGetOpt::ArgType argType);
   virtual const cpStr Name() const { return "EGetOptError_UnsupportedArgType"; }
};

class EGetOptError_UnsupportedDataType : public EError
{
public:
   EGetOptError_UnsupportedDataType(EGetOpt::DataType argType);
   virtual const cpStr Name() const { return "EGetOptError_UnsupportedDataType"; }
};

class EGetOptError_UnsupportedBooleanValue : public EError
{
public:
   EGetOptError_UnsupportedBooleanValue(cpStr val);
   virtual const cpStr Name() const { return "EGetOptError_UnsupportedBooleanValue"; }
};

class EGetOptError_FileParsing : public EError
{
public:
   EGetOptError_FileParsing(cpStr val);
   virtual const cpStr Name() const { return "EGetOptError_FileParsing"; }
};

class EGetOptError_UnsupportedArrayType : public EError
{
public:
   EGetOptError_UnsupportedArrayType(cpStr val);
   virtual const cpStr Name() const { return "EGetOptError_UnsupportedArrayType"; }
};

class EGetOptError_UnexpectedArrayElementType : public EError
{
public:
   EGetOptError_UnexpectedArrayElementType(cpStr rcvd, cpStr expctd);
   virtual const cpStr Name() const { return "EGetOptError_UnexpectedArrayElementType"; }
};

class EGetOptError_NotArray : public EError
{
public:
   EGetOptError_NotArray();
   virtual const cpStr Name() const { return "EGetOptError_NotArray"; }
};

#endif // #define __egetopt_h_included