241 lines
6.9 KiB
C++
241 lines
6.9 KiB
C++
/* ----------------------------------------------------------------------------
|
|
|
|
* GTSAM Copyright 2010, Georgia Tech Research Corporation,
|
|
* Atlanta, Georgia 30332-0415
|
|
* All Rights Reserved
|
|
* Authors: Frank Dellaert, et al. (see THANKS for the full author list)
|
|
|
|
* See LICENSE for the license information
|
|
|
|
* -------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* @file Argument.h
|
|
* @brief arguments to constructors and methods
|
|
* @author Frank Dellaert
|
|
* @author Andrew Melim
|
|
* @author Richard Roberts
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include "TemplateSubstitution.h"
|
|
#include "FileWriter.h"
|
|
#include "ReturnValue.h"
|
|
|
|
namespace wrap {
|
|
|
|
/// Argument class
|
|
struct Argument {
|
|
Qualified type;
|
|
std::string name;
|
|
bool is_const, is_ref, is_ptr;
|
|
|
|
Argument() :
|
|
is_const(false), is_ref(false), is_ptr(false) {
|
|
}
|
|
|
|
Argument(const Qualified& t, const std::string& n) :
|
|
type(t), name(n), is_const(false), is_ref(false), is_ptr(false) {
|
|
}
|
|
|
|
bool isSameSignature(const Argument& other) const {
|
|
return type == other.type
|
|
&& is_const == other.is_const && is_ref == other.is_ref
|
|
&& is_ptr == other.is_ptr;
|
|
}
|
|
|
|
bool operator==(const Argument& other) const {
|
|
return type == other.type && name == other.name
|
|
&& is_const == other.is_const && is_ref == other.is_ref
|
|
&& is_ptr == other.is_ptr;
|
|
}
|
|
|
|
Argument expandTemplate(const TemplateSubstitution& ts) const;
|
|
|
|
/// return MATLAB class for use in isa(x,class)
|
|
std::string matlabClass(const std::string& delim = "") const;
|
|
|
|
/// MATLAB code generation, MATLAB to C++
|
|
void matlab_unwrap(FileWriter& file, const std::string& matlabName) const;
|
|
|
|
/**
|
|
* emit checking argument to MATLAB proxy
|
|
* @param proxyFile output stream
|
|
*/
|
|
void proxy_check(FileWriter& proxyFile, const std::string& s) const;
|
|
|
|
/**
|
|
* emit arguments for cython pxd
|
|
* @param file output stream
|
|
*/
|
|
void emit_cython_pxd(FileWriter& file, const std::string& className,
|
|
const std::vector<std::string>& templateArgs) const;
|
|
void emit_cython_pyx(FileWriter& file) const;
|
|
std::string pyx_asParam() const;
|
|
|
|
friend std::ostream& operator<<(std::ostream& os, const Argument& arg) {
|
|
os << (arg.is_const ? "const " : "") << arg.type << (arg.is_ptr ? "*" : "")
|
|
<< (arg.is_ref ? "&" : "");
|
|
return os;
|
|
}
|
|
|
|
};
|
|
|
|
/// Argument list is just a container with Arguments
|
|
struct ArgumentList: public std::vector<Argument> {
|
|
|
|
/// create a comma-separated string listing all argument types (not used)
|
|
std::string types() const;
|
|
|
|
/// create a short "signature" string
|
|
std::string signature() const;
|
|
|
|
/// create a comma-separated string listing all argument names, used in m-files
|
|
std::string names() const;
|
|
|
|
/// Check if all arguments scalar
|
|
bool allScalar() const;
|
|
|
|
ArgumentList expandTemplate(const TemplateSubstitution& ts) const;
|
|
|
|
bool isSameSignature(const ArgumentList& other) const {
|
|
for(size_t i = 0; i<size(); ++i)
|
|
if (!at(i).isSameSignature(other[i])) return false;
|
|
return true;
|
|
}
|
|
|
|
// MATLAB code generation:
|
|
|
|
/**
|
|
* emit code to unwrap arguments
|
|
* @param file output stream
|
|
* @param start initial index for input array, set to 1 for method
|
|
*/
|
|
void matlab_unwrap(FileWriter& file, int start = 0) const; // MATLAB to C++
|
|
|
|
/**
|
|
* emit MATLAB prototype
|
|
* @param file output stream
|
|
* @param name of method or function
|
|
*/
|
|
void emit_prototype(FileWriter& file, const std::string& name) const;
|
|
|
|
/**
|
|
* emit arguments for cython pxd
|
|
* @param file output stream
|
|
*/
|
|
void emit_cython_pxd(FileWriter& file, const std::string& className,
|
|
const std::vector<std::string>& templateArgs) const;
|
|
void emit_cython_pyx(FileWriter& file) const;
|
|
std::string pyx_asParams() const;
|
|
std::string pyx_paramsList() const;
|
|
std::string pyx_castParamsToPythonType() const;
|
|
|
|
/**
|
|
* emit checking arguments to MATLAB proxy
|
|
* @param proxyFile output stream
|
|
*/
|
|
void proxy_check(FileWriter& proxyFile) const;
|
|
|
|
/// Output stream operator
|
|
friend std::ostream& operator<<(std::ostream& os,
|
|
const ArgumentList& argList) {
|
|
os << "(";
|
|
if (argList.size() > 0)
|
|
os << argList.front();
|
|
if (argList.size() > 1)
|
|
for (size_t i = 1; i < argList.size(); i++)
|
|
os << ", " << argList[i];
|
|
os << ")";
|
|
return os;
|
|
}
|
|
|
|
};
|
|
|
|
/* ************************************************************************* */
|
|
// http://boost-spirit.com/distrib/spirit_1_8_2/libs/spirit/doc/grammar.html
|
|
struct ArgumentGrammar: public classic::grammar<ArgumentGrammar> {
|
|
|
|
wrap::Argument& result_; ///< successful parse will be placed in here
|
|
TypeGrammar argument_type_g; ///< Type parser for Argument::type
|
|
|
|
/// Construct type grammar and specify where result is placed
|
|
ArgumentGrammar(wrap::Argument& result) :
|
|
result_(result), argument_type_g(result.type) {
|
|
}
|
|
|
|
/// Definition of type grammar
|
|
template<typename ScannerT>
|
|
struct definition: BasicRules<ScannerT> {
|
|
|
|
typedef classic::rule<ScannerT> Rule;
|
|
|
|
Rule argument_p;
|
|
|
|
definition(ArgumentGrammar const& self) {
|
|
using namespace classic;
|
|
|
|
// NOTE: allows for pointers to all types
|
|
// Slightly more permissive than before on basis/eigen type qualification
|
|
// Also, currently parses Point2*&, can't make it work otherwise :-(
|
|
argument_p = !str_p("const")[assign_a(self.result_.is_const, T)] //
|
|
>> self.argument_type_g //
|
|
>> !ch_p('*')[assign_a(self.result_.is_ptr, T)]
|
|
>> !ch_p('&')[assign_a(self.result_.is_ref, T)]
|
|
>> BasicRules<ScannerT>::name_p[assign_a(self.result_.name)];
|
|
}
|
|
|
|
Rule const& start() const {
|
|
return argument_p;
|
|
}
|
|
|
|
};
|
|
};
|
|
// ArgumentGrammar
|
|
|
|
/* ************************************************************************* */
|
|
// http://boost-spirit.com/distrib/spirit_1_8_2/libs/spirit/doc/grammar.html
|
|
struct ArgumentListGrammar: public classic::grammar<ArgumentListGrammar> {
|
|
|
|
wrap::ArgumentList& result_; ///< successful parse will be placed in here
|
|
|
|
/// Construct type grammar and specify where result is placed
|
|
ArgumentListGrammar(wrap::ArgumentList& result) :
|
|
result_(result) {
|
|
}
|
|
|
|
/// Definition of type grammar
|
|
template<typename ScannerT>
|
|
struct definition {
|
|
|
|
const Argument arg0; ///< used to reset arg
|
|
Argument arg; ///< temporary argument for use during parsing
|
|
ArgumentGrammar argument_g; ///< single Argument parser
|
|
|
|
classic::rule<ScannerT> argument_p, argumentList_p;
|
|
|
|
definition(ArgumentListGrammar const& self) :
|
|
argument_g(arg) {
|
|
using namespace classic;
|
|
|
|
argument_p = argument_g //
|
|
[classic::push_back_a(self.result_, arg)] //
|
|
[assign_a(arg, arg0)];
|
|
|
|
argumentList_p = '(' >> !argument_p >> *(',' >> argument_p) >> ')';
|
|
}
|
|
|
|
classic::rule<ScannerT> const& start() const {
|
|
return argumentList_p;
|
|
}
|
|
|
|
};
|
|
};
|
|
// ArgumentListGrammar
|
|
|
|
/* ************************************************************************* */
|
|
|
|
}// \namespace wrap
|
|
|