almethodinfo.h

Go to the documentation of this file.

#pragma once
#ifndef _LIBALCOMMON_ALCOMMON_ALMETHODINFO_H_
#define _LIBALCOMMON_ALCOMMON_ALMETHODINFO_H_

# include <alcommon/alparamtype.h>
# include <boost/shared_ptr.hpp>


# define BLOCKINGFUNCTION     0 
# define ASYNCHRONOUSFUNCTION 1 
namespace AL
{
  class ALFunctorBase;

  class ALMethodInfo
  {
  public:
    ALMethodInfo() {
      mask = 0;
    }

    virtual ~ALMethodInfo() {}

    enum methodOption {
      CPPMethod           = 1, 
      AsynchronousMethod  = 2, 
      localMethod         = 4  
    };

    class ALParameterInfo
    {
    public:
      std::string paramError;  
      std::string name;        
      std::string description; 
      std::string strType;     
      bool        optional;    
    };

    template <typename T>
    class ALParameterInfoOptional: public ALParameterInfo {
    public:
      ALParameterInfoOptional(T defaultValue) {
        m_defaultValue = defaultValue;
      }
      T m_defaultValue; 
    };

    class ALExample {
    public:
      std::string language;   
      std::string strExample; 
    };

    std::string                      moduleName;        
    std::string                      methodName;        
    std::string                      methodDescription; 
    std::vector<ALParameterInfo>     parameters;        
    std::string                      returnValue;       
    std::vector<ALExample>           examples;          
    boost::shared_ptr<ALFunctorBase> ptrOnMethod;       
    ALParameterInfo                  returnInfo;        
    short                            mask;              
    bool isCpp(void) {
      return ((mask & CPPMethod) == CPPMethod);
    }

    bool isAsynchronous(void) {
      return (mask & AsynchronousMethod) > 0 ? true: false;
    }

    bool isLocalMethod(void) {
      return ((mask & localMethod) == localMethod);
    }

    void addOption(int pOption)
    {
      mask = mask | (short)pOption;
    }

    ALFunctorBase* getFunction() {
      return ptrOnMethod.get();
    }

    void clear(void) {
      parameters.clear();
      examples.clear();
    }
  };

  template <typename C, typename R>
  void completeAndCheck(R(C::*) (), ALMethodInfo & pDesc)
  {
    pDesc.returnInfo.strType = getParamStrType<R>();
  }

  template <typename C, typename P1, typename R>
  void completeAndCheck(R(C::*) (P1), ALMethodInfo & pDesc)
  {
    pDesc.returnInfo.strType = getParamStrType<R>();
    ALMethodInfo::ALParameterInfo param;
    param.description = "arg";
    std::string name = "arg0";
    for (int i = pDesc.parameters.size(); i < 1; ++i) {
      name[3] = (char) (i + '1');
      param.name = name;
      pDesc.parameters.push_back(param);
    }
    pDesc.parameters[0].strType =  getParamStrType<P1>();
  }

  template <typename C, typename P1, typename P2, typename R>
  void completeAndCheck(R(C::*) (P1, P2), ALMethodInfo & pDesc)
  {
    pDesc.returnInfo.strType = getParamStrType<R>();
    ALMethodInfo::ALParameterInfo param;
    std::string name = "arg0";
    param.description = "arg";
    for (int i = pDesc.parameters.size() ; i < 2; ++i) {
      name[3] = (char) (i + '1');
      param.name  = name;
      pDesc.parameters.push_back(param);
    }
    pDesc.parameters[0].strType =  getParamStrType<P1>();
    pDesc.parameters[1].strType =  getParamStrType<P2>();
  }

  template <typename C, typename P1, typename P2, typename P3, typename R>
  void completeAndCheck(R(C::*) (P1, P2, P3), ALMethodInfo & pDesc)
  {
    pDesc.returnInfo.strType = getParamStrType<R>();
    ALMethodInfo::ALParameterInfo param;
    std::string name = "arg0";
    param.description = "arg";
    for (int i = pDesc.parameters.size(); i < 3; ++i) {
      name[3] = i + '1';
      param.name = name;
      pDesc.parameters.push_back(param);
    }
    pDesc.parameters[0].strType =  getParamStrType<P1>();
    pDesc.parameters[1].strType =  getParamStrType<P2>();
    pDesc.parameters[2].strType =  getParamStrType<P3>();
  }

  template <typename C, typename P1, typename P2, typename P3, typename P4, typename R>
  void completeAndCheck(R(C::*) (P1, P2, P3, P4), ALMethodInfo & pDesc)
  {
    pDesc.returnInfo.strType = getParamStrType<R>();
    ALMethodInfo::ALParameterInfo param;
    std::string name = "arg0";
    param.description = "arg";
    for (int i = pDesc.parameters.size(); i < 4; ++i) {
      name[3] = i + '1';
      param.name = name;
      pDesc.parameters.push_back(param);
    }
    pDesc.parameters[0].strType =  getParamStrType<P1>();
    pDesc.parameters[1].strType =  getParamStrType<P2>();
    pDesc.parameters[2].strType =  getParamStrType<P3>();
    pDesc.parameters[3].strType =  getParamStrType<P4>();
  }

  template <typename C, typename P1, typename P2, typename P3, typename P4, typename P5, typename R>
  void completeAndCheck(R(C::*) (P1, P2, P3, P4, P5), ALMethodInfo & pDesc)
  {
    pDesc.returnInfo.strType = getParamStrType<R>();
    ALMethodInfo::ALParameterInfo param;
    std::string name = "arg0";
    param.description = "arg";
    for (int i = pDesc.parameters.size(); i < 5; ++i) {
      name[3] = i + '1';
      param.name = name;
      pDesc.parameters.push_back(param);
    }
    pDesc.parameters[0].strType =  getParamStrType<P1>();
    pDesc.parameters[1].strType =  getParamStrType<P2>();
    pDesc.parameters[2].strType =  getParamStrType<P3>();
    pDesc.parameters[3].strType =  getParamStrType<P4>();
    pDesc.parameters[4].strType =  getParamStrType<P5>();
  }

  template <typename C, typename P1, typename P2, typename P3, typename P4, typename P5, typename P6, typename R>
  void completeAndCheck(R(C::*) (P1, P2, P3, P4, P5, P6), ALMethodInfo & pDesc)
  {
    pDesc.returnInfo.strType = getParamStrType<R>();
    ALMethodInfo::ALParameterInfo param;
    std::string name = "arg0";
    param.description = "arg";
    for (int i = pDesc.parameters.size(); i < 6; ++i) {
      name[3] = i + '1';
      param.name = name;
      pDesc.parameters.push_back(param);
    }
    pDesc.parameters[0].strType =  getParamStrType<P1>();
    pDesc.parameters[1].strType =  getParamStrType<P2>();
    pDesc.parameters[2].strType =  getParamStrType<P3>();
    pDesc.parameters[3].strType =  getParamStrType<P4>();
    pDesc.parameters[4].strType =  getParamStrType<P5>();
    pDesc.parameters[5].strType =  getParamStrType<P6>();
  }

}
#endif  // _LIBALCOMMON_ALCOMMON_ALMETHODINFO_H_