gtsam/wrap/tests/testSpirit.cpp

/* ----------------------------------------------------------------------------

 * 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 testSpirit.cpp
 * @brief Unit test for Boost's awesome Spirit parser
 * @author Frank Dellaert
 **/

#include <boost/spirit/include/classic_core.hpp>
#include <boost/spirit/include/classic_push_back_actor.hpp>
#include <CppUnitLite/TestHarness.h>
#include <wrap/utilities.h>

using namespace std;
using namespace BOOST_SPIRIT_CLASSIC_NS;

typedef rule<BOOST_SPIRIT_CLASSIC_NS::phrase_scanner_t> Rule;

/* ************************************************************************* */
// lexeme_d turns off white space skipping
// http://www.boost.org/doc/libs/1_37_0/libs/spirit/classic/doc/directives.html
Rule name_p       = lexeme_d[alpha_p >> *(alnum_p | '_')];
Rule className_p  = lexeme_d[upper_p >> *(alnum_p | '_')];
Rule methodName_p = lexeme_d[lower_p >> *(alnum_p | '_')];

Rule basisType_p = (str_p("string") | "bool" | "size_t" | "int" | "double" | "Vector" | "Matrix");

/* ************************************************************************* */
TEST( spirit, real ) {
  // check if we can parse 8.99 as a real
  EXPECT(parse("8.99", real_p, space_p).full);
  // make sure parsing fails on this one
  EXPECT(!parse("zztop", real_p, space_p).full);
}

/* ************************************************************************* */
TEST( spirit, string ) {
  // check if we can parse a string
  EXPECT(parse("double", str_p("double"), space_p).full);
}

/* ************************************************************************* */
TEST( spirit, sequence ) {
  // check that we skip white space
  EXPECT(parse("int int", str_p("int") >> *str_p("int"), space_p).full);
  EXPECT(parse("int --- - -- -", str_p("int") >> *ch_p('-'), space_p).full);
  EXPECT(parse("const \t string", str_p("const") >> str_p("string"), space_p).full);

  // note that (see spirit FAQ) the vanilla rule<> does not deal with whitespace
  rule<>vanilla_p = str_p("const") >> str_p("string");
  EXPECT(!parse("const \t string", vanilla_p, space_p).full);

  // to fix it, we need to use <phrase_scanner_t>
  rule<phrase_scanner_t>phrase_level_p = str_p("const") >> str_p("string");
  EXPECT(parse("const \t string", phrase_level_p, space_p).full);
}

/* ************************************************************************* */
// parser for interface files

// const string reference reference
Rule constStringRef_p =
  str_p("const") >> "string" >> '&';

// class reference
Rule classRef_p = className_p >> '&';

// const class reference
Rule constClassRef_p = str_p("const") >> classRef_p;

// method parsers
Rule constMethod_p = basisType_p >> methodName_p >> '(' >> ')' >> "const" >> ';';

/* ************************************************************************* */
TEST( spirit, basisType_p ) {
  EXPECT(!parse("Point3", basisType_p, space_p).full);
  EXPECT(parse("string", basisType_p, space_p).full);
}

/* ************************************************************************* */
TEST( spirit, className_p ) {
  EXPECT(parse("Point3", className_p, space_p).full);
}

/* ************************************************************************* */
TEST( spirit, classRef_p ) {
  EXPECT(parse("Point3 &", classRef_p, space_p).full);
  EXPECT(parse("Point3&", classRef_p, space_p).full);
}

/* ************************************************************************* */
TEST( spirit, constMethod_p ) {
  EXPECT(parse("double norm() const;", constMethod_p, space_p).full);
}


/* ************************************************************************* */
/* See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=56665
   GCC compiler issues with -O2 and -fno-strict-aliasing results in undefined
   behaviour when spirit uses assign_a with a literal.
   GCC versions 4.7.2 -> 5.4 inclusive */

TEST( spirit, return_value_p ) {
  static const bool T = true;
  static const bool F = false;

  bool isEigen = T;

  string actual_return_type;
  string actual_function_name;

  Rule basisType_p =
    (str_p("string") | "bool" | "size_t" | "int" | "double");

  Rule eigenType_p =
    (str_p("Vector") | "Matrix");

  Rule className_p  = lexeme_d[upper_p >> *(alnum_p | '_')] - eigenType_p - basisType_p;

  Rule funcName_p  = lexeme_d[lower_p >> *(alnum_p | '_')];

  Rule returnType_p =
      (basisType_p[assign_a(actual_return_type)][assign_a(isEigen, T)]) |
      (className_p[assign_a(actual_return_type)][assign_a(isEigen, F)]) |
      (eigenType_p[assign_a(actual_return_type)][assign_a(isEigen, T)]);

  Rule testFunc_p = returnType_p >> funcName_p[assign_a(actual_function_name)] >> str_p("();");

  EXPECT(parse("VectorNotEigen doesNotReturnAnEigenVector();", testFunc_p, space_p).full);
  EXPECT(!isEigen);
  EXPECT(actual_return_type == "VectorNotEigen");
  EXPECT(actual_function_name == "doesNotReturnAnEigenVector");

  EXPECT(parse("Vector actuallyAVector();", testFunc_p, space_p).full);
  EXPECT(isEigen);
  EXPECT(actual_return_type == "Vector");
  EXPECT(actual_function_name == "actuallyAVector");
}

/* ************************************************************************* */
int main() { TestResult tr; return TestRegistry::runAllTests(tr); }
/* ************************************************************************* */