sexpr_test_utils.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2019 KiCad Developers, see AUTHORS.TXT for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#ifndef TEST_SEXPR_TEST_UTILS__H
#define TEST_SEXPR_TEST_UTILS__H
 
#include <sexpr/sexpr.h>
 
#include <qa_utils/wx_utils/unit_test_utils.h>
 
namespace KI_TEST
{
 
 
inline SEXPR::SEXPR_TYPE getType( const SEXPR::SEXPR& aSexpr )
{
 if( aSexpr.IsList() )
 return SEXPR::SEXPR_TYPE::SEXPR_TYPE_LIST;
 else if( aSexpr.IsSymbol() )
 return SEXPR::SEXPR_TYPE::SEXPR_TYPE_ATOM_SYMBOL;
 else if( aSexpr.IsString() )
 return SEXPR::SEXPR_TYPE::SEXPR_TYPE_ATOM_STRING;
 else if( aSexpr.IsDouble() )
 return SEXPR::SEXPR_TYPE::SEXPR_TYPE_ATOM_DOUBLE;
 else if( aSexpr.IsInteger() )
 return SEXPR::SEXPR_TYPE::SEXPR_TYPE_ATOM_INTEGER;
 
 throw( std::invalid_argument( "<Unknown S-Expression Type!>" ) );
}
 
inline std::string getDebugType( SEXPR::SEXPR_TYPE aType )
{
 switch( aType )
 {
 case SEXPR::SEXPR_TYPE::SEXPR_TYPE_LIST:
 return "List";
 case SEXPR::SEXPR_TYPE::SEXPR_TYPE_ATOM_SYMBOL:
 return "Symbol";
 case SEXPR::SEXPR_TYPE::SEXPR_TYPE_ATOM_STRING:
 return "String";
 case SEXPR::SEXPR_TYPE::SEXPR_TYPE_ATOM_DOUBLE:
 return "Double";
 case SEXPR::SEXPR_TYPE::SEXPR_TYPE_ATOM_INTEGER:
 return "Integer";
 }
 
 return "<Unknown S-Expression Type!>";
}
 
inline std::string GetSexprDebugType( const SEXPR::SEXPR& aSexpr )
{
 return getDebugType( getType( aSexpr ) );
}
 
inline bool IsSexprOfType( const SEXPR::SEXPR& aSexpr, SEXPR::SEXPR_TYPE aType )
{
 if( getType( aSexpr ) != aType )
 {
 BOOST_TEST_MESSAGE( "Sexpr is not of type: " << getDebugType( aType ) );
 return false;
 }
 
 return true;
}
 
template <typename VAL_T>
bool IsSexprValueEqual( const VAL_T& aGot, const VAL_T& aExpected )
{
 if( aGot != aExpected )
 {
 BOOST_TEST_MESSAGE( "Sexpr value not equal: got " << aGot << ", expected " << aExpected );
 return false;
 }
 
 return true;
}
 
inline bool SexprIsSymbol( const SEXPR::SEXPR& aSexpr )
{
 return IsSexprOfType( aSexpr, SEXPR::SEXPR_TYPE::SEXPR_TYPE_ATOM_SYMBOL );
}
 
inline bool SexprIsSymbolWithValue( const SEXPR::SEXPR& aSexpr, const std::string& aVal )
{
 return IsSexprOfType( aSexpr, SEXPR::SEXPR_TYPE::SEXPR_TYPE_ATOM_SYMBOL )
 && IsSexprValueEqual( aSexpr.GetSymbol(), aVal );
}
 
inline bool SexprIsString( const SEXPR::SEXPR& aSexpr )
{
 return IsSexprOfType( aSexpr, SEXPR::SEXPR_TYPE::SEXPR_TYPE_ATOM_STRING );
}
 
inline bool SexprIsStringWithValue( const SEXPR::SEXPR& aSexpr, const std::string& aVal )
{
 return IsSexprOfType( aSexpr, SEXPR::SEXPR_TYPE::SEXPR_TYPE_ATOM_STRING )
 && IsSexprValueEqual( aSexpr.GetString(), aVal );
}
 
inline bool SexprIsInteger( const SEXPR::SEXPR& aSexpr )
{
 return IsSexprOfType( aSexpr, SEXPR::SEXPR_TYPE::SEXPR_TYPE_ATOM_INTEGER );
}
 
inline bool SexprIsIntegerWithValue( const SEXPR::SEXPR& aSexpr, std::int64_t aVal )
{
 return IsSexprOfType( aSexpr, SEXPR::SEXPR_TYPE::SEXPR_TYPE_ATOM_INTEGER )
 && IsSexprValueEqual( aSexpr.GetLongInteger(), aVal );
}
 
inline bool SexprIsDouble( const SEXPR::SEXPR& aSexpr )
{
 return IsSexprOfType( aSexpr, SEXPR::SEXPR_TYPE::SEXPR_TYPE_ATOM_DOUBLE );
}
 
inline bool SexprIsDoubleWithValue( const SEXPR::SEXPR& aSexpr, double aVal )
{
 return IsSexprOfType( aSexpr, SEXPR::SEXPR_TYPE::SEXPR_TYPE_ATOM_DOUBLE )
 && IsSexprValueEqual( aSexpr.GetDouble(), aVal );
}
 
inline bool SexprIsList( const SEXPR::SEXPR& aSexpr )
{
 return IsSexprOfType( aSexpr, SEXPR::SEXPR_TYPE::SEXPR_TYPE_LIST );
}
 
inline bool SexprIsListOfLength( const SEXPR::SEXPR& aSexpr, size_t aExpectedLength )
{
 if( !IsSexprOfType( aSexpr, SEXPR::SEXPR_TYPE::SEXPR_TYPE_LIST ) )
 return false;
 
 if( aSexpr.GetNumberOfChildren() != aExpectedLength )
 {
 BOOST_TEST_MESSAGE( "List is wrong length: got " << aSexpr.GetNumberOfChildren()
 << ", expected " << aExpectedLength );
 return false;
 }
 
 return true;
}
 
inline bool SexprConvertsToString( const SEXPR::SEXPR& aSexpr, const std::string& aExpStr )
{
 const std::string converted = aSexpr.AsString();
 
 bool ok = true;
 
 if( converted != aExpStr )
 {
 BOOST_TEST_INFO( "Sexpr string conversion mismatch: got '" << converted << "', expected '"
 << aExpStr << "'" );
 ok = false;
 }
 
 return ok;
}
 
} // namespace KI_TEST
 
namespace BOOST_TEST_PRINT_NAMESPACE_OPEN
{
 
template <>
struct print_log_value<SEXPR::SEXPR>
{
 inline void operator()( std::ostream& os, const SEXPR::SEXPR& aSexpr )
 {
 os << "SEXPR [ " << KI_TEST::GetSexprDebugType( aSexpr ) << " ]\n " << aSexpr.AsString();
 }
};
}
BOOST_TEST_PRINT_NAMESPACE_CLOSE
 
#endif // TEST_SEXPR_TEST_UTILS__H