scheme/impl/scheme_impl.cpp

/*

Copyright (c) 2002-2008, Yauheni Akhotnikau
Copyright (c) 2008-2016, The SObjectizer Project
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

- Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

- Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

- The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.

*/

#include <algorithm>

#include <oess_2/defs/h/ex.hpp>

#include <oess_2/scheme/h/errno.hpp>
#include <oess_2/scheme/h/builtin_names.hpp>

#include <oess_2/scheme/impl/h/scheme_impl.hpp>

namespace oess_2 {

namespace scheme {

namespace impl {

//FIXME it is necessary to provide as much information as possible
//in exceptions related to illegal or invalid type names.
//(something like name of attribute for which invalid type name was
//specified).

//
// std_attr_editor_t
//
std_attr_editor_t::std_attr_editor_t(
	std_scheme_t & scheme ) :
	m_scheme( scheme )
{
}

std_attr_editor_t::~std_attr_editor_t()
{
}

void
std_attr_editor_t::def(
	const std::string & attr_name,
	const std::string & type_name,
	size_t extension_level )
{
	m_ref_attr = ref_std_attr_t( new std_attr_t(
		attr_name,
		find_type( type_name ),
		extension_level ) );
}

ref_attr_t
std_attr_editor_t::query_ref_attr() const
{
	return m_ref_attr;
}

void
std_attr_editor_t::make_ptr_kind()
{
	m_ref_attr->set_type_kind( attr_type_t::PTR );
}

void
std_attr_editor_t::make_extension_kind()
{
	m_ref_attr->set_type_kind( attr_type_t::EXTENSION );
}

void
std_attr_editor_t::make_stl_vector_kind(
	packing_format_t packing_format )
{
	m_ref_attr->set_container_info(
			container_info_t::make_as_ordinal(
					container_info_t::VECTOR,
					packing_format ) );
}

void
std_attr_editor_t::make_stl_list_kind(
	packing_format_t packing_format )
{
	m_ref_attr->set_container_info(
			container_info_t::make_as_ordinal(
					container_info_t::LIST,
					packing_format ) );
}

void
std_attr_editor_t::make_stl_deque_kind(
	packing_format_t packing_format )
{
	m_ref_attr->set_container_info(
			container_info_t::make_as_ordinal(
					container_info_t::DEQUE,
					packing_format ) );
}

void
std_attr_editor_t::make_stl_set_kind(
	packing_format_t packing_format )
{
	m_ref_attr->set_container_info(
			container_info_t::make_as_ordinal(
					container_info_t::SET,
					packing_format ) );
}

void
std_attr_editor_t::make_stl_multiset_kind(
	packing_format_t packing_format )
{
	m_ref_attr->set_container_info(
			container_info_t::make_as_ordinal(
					container_info_t::MULTI_SET,
					packing_format ) );
}

void
std_attr_editor_t::make_stl_map_kind(
	const std::string & key_type_name,
	packing_format_t packing_format  )
{
	const type_t & type = find_type( key_type_name );
	m_ref_attr->set_container_info(
			container_info_t::make_as_map(
					type,
					packing_format ) );
}

void
std_attr_editor_t::make_stl_multimap_kind(
	const std::string & key_type_name,
	packing_format_t packing_format  )
{
	const type_t & type = find_type( key_type_name );
	m_ref_attr->set_container_info(
			container_info_t::make_as_multimap(
					type,
					packing_format ) );
}

void
std_attr_editor_t::make_fixed_vector_kind(
	size_t capacity )
{
	m_ref_attr->set_container_info(
			container_info_t::make_as_fixed_size_vector(
					capacity ) );
}

void
std_attr_editor_t::set_default_existence(
	bool is_optional )
{
	m_ref_attr->make_std_attr_default( is_optional );
}

void
std_attr_editor_t::set_cpp_default(
	const std::string & expr )
{
	m_ref_attr->std_attr_default().set_cpp( expr );
}

void
std_attr_editor_t::set_cpp_present_if(
	const std::string & expr )
{
	m_ref_attr->std_attr_default().std_present_if().set_cpp( expr );
}

const type_t &
std_attr_editor_t::find_type(
	const std::string & type_name ) const
{
	const ref_std_type_t & ref_type =
		m_scheme.find_or_create_type( type_name );

	return *( ref_type.get() );
}


//
// std_cpp_mapping_editor_t
//
std_cpp_mapping_editor_t::std_cpp_mapping_editor_t(
	std_cpp_mapping_t & cpp_mapping ) :
	m_cpp_mapping( cpp_mapping )
{
}

std_cpp_mapping_editor_t::~std_cpp_mapping_editor_t()
{
}

void
std_cpp_mapping_editor_t::set_name(
	const std::string & name )
{
	m_cpp_mapping.set_name( name );
}

//
// std_type_editor_t
//
std_type_editor_t::std_type_editor_t(
	std_scheme_t & scheme )
:	m_scheme( scheme )
,	m_extension_deep( 0 )
{
}

std_type_editor_t::~std_type_editor_t()
{
}

void
std_type_editor_t::def( const std::string & name )
{
	m_ref_type = m_scheme.find_or_create_type( name );
	if( m_ref_type->is_defined() )
		OESS_THROW_LOGIC(
			oess_2::scheme::err::c_type_already_defined,
			"type: " << name )

	m_ref_cpp_mapping_editor = ref_std_cpp_mapping_editor_t(
		new std_cpp_mapping_editor_t(
			m_ref_type->query_cpp_mapping() ) );
}

void
std_type_editor_t::make_defined()
{
	m_ref_type->make_defined();
}

void
std_type_editor_t::make_abstract()
{
	m_ref_type->make_abstract();
}

void
std_type_editor_t::make_extensible()
{
	m_ref_type->make_extensible();
}

void
std_type_editor_t::turn_subclassing_by_extension_on()
{
	m_ref_type->turn_subclassing_by_extension_on();
}

void
std_type_editor_t::add_base(
	const std::string & name,
	bool is_virtual )
{
	const ref_std_type_t & ref_type =
		m_scheme.find_or_create_type( name );

	if( ref_type->is_builtin() )
		OESS_THROW_LOGIC(
			oess_2::scheme::err::c_builtin_type_as_base,
			"builtin type: " << name << " as base for: "
			<< m_ref_type->query_name() )

	ref_base_t ref_base( new std_base_t(
		*( ref_type.get() ), is_virtual ) );
	m_ref_type->add_base( ref_base );
}

void
std_type_editor_t::add_base_as_extension(
	const std::string & name )
{
	const ref_std_type_t & ref_type =
		m_scheme.find_or_create_type( name );

	if( ref_type->is_builtin() )
		OESS_THROW_LOGIC(
			oess_2::scheme::err::c_builtin_type_as_base,
			"builtin type: " << name << " as base for: "
			<< m_ref_type->query_name() )

	ref_base_t ref_base( new std_base_t(
		*ref_type,
		std_base_t::subclassing_by_extension ) );
	m_ref_type->add_base_as_extension( ref_base );
}

attr_editor_t &
std_type_editor_t::start_attr_def(
	const std::string & attr_name,
	const std::string & type_name )
{
	if( m_ref_attr_editor.get() )
		OESS_THROW_PHYSIC( oess_2::scheme::err::c_attr_editor_exists,
			"std_type_editor_t::start_attr_def( \""
			<< attr_name << "\", \""
			<< type_name << "\")" )

	ref_std_attr_editor_t ref_editor(
		new std_attr_editor_t( m_scheme ) );
	ref_editor->def( attr_name, type_name, m_extension_deep );

	// If we are here then editor is successfully created.
	m_ref_attr_editor = ref_editor;

	return *( m_ref_attr_editor.get() );
}

void
std_type_editor_t::commit_attr_def()
{
	if( !m_ref_attr_editor.get() )
		OESS_THROW_PHYSIC( oess_2::scheme::err::c_attr_editor_not_exists,
			"std_type_editor_t::commit_attr_def()" )

	ref_std_attr_editor_t ref_editor( m_ref_attr_editor );
	m_ref_attr_editor.reset();

	m_ref_type->add_attr(
		ref_editor->query_ref_attr(), m_extension_deep );
}

void
std_type_editor_t::rollback_attr_def()
{
	if( !m_ref_attr_editor.get() )
		OESS_THROW_PHYSIC( oess_2::scheme::err::c_attr_editor_not_exists,
			"std_type_editor_t::rollback_attr_def()" )

	m_ref_attr_editor.reset();
}

cpp_mapping_editor_t &
std_type_editor_t::cpp_mapping()
{
	return *( m_ref_cpp_mapping_editor.get() );
}

void
std_type_editor_t::start_extension()
{
	if( m_ref_attr_editor.get() )
		OESS_THROW_PHYSIC( oess_2::scheme::err::c_attr_editor_exists,
			"unable to start extension when unfinished attr exists" )

	++m_extension_deep;
	m_ref_type->start_extension();
}

const type_id_value_t &
std_type_editor_t::query_type_id() const
{
	return m_ref_type->query_type_id();
}

void
std_type_editor_t::set_type_id( type_id_value_t && type_id )
{
	m_ref_type->set_type_id( std::move(type_id) );
}

void
std_type_editor_t::turn_on_bitmask_use()
{
	m_ref_type->turn_on_bitmask_use();
}

void
std_type_editor_t::ensure_correctness() const
{
	m_ref_type->ensure_correctness();
}

//
// std_scheme_t
//
std_scheme_t::std_scheme_t()
{
	fill_builtin_types();
}

std_scheme_t::~std_scheme_t()
{
}

size_t
std_scheme_t::query_type_count() const
{
	return m_user_types.size();
}

const type_t &
std_scheme_t::query_type( size_t index ) const
{
	if( index >= m_user_types.size() )
		OESS_THROW_LOGIC( oess_2::scheme::err::c_invalid_index_of_type,
			"type count: " << m_user_types.size()
			<< ", index: " << index )

	return *( m_user_types[ index ].get() );
}

const type_t *
std_scheme_t::find_type( const std::string & name ) const
{
	type_map_t::const_iterator it = m_type_map.find( name );
	if( it != m_type_map.end() )
		return (*it).second;
	else
		return 0;
}

type_editor_t &
std_scheme_t::start_type_def(
	const std::string & name )
{
	if( m_ref_type_editor.get() )
		OESS_THROW_PHYSIC( oess_2::scheme::err::c_type_editor_exists,
			"std_scheme_t::start_type_def( \""
			<< name << "\")" )

	ref_std_type_editor_t ref_editor(
		new std_type_editor_t( *this ) );
	ref_editor->def( name );

	// If we are here then type editor is created.
	m_ref_type_editor = ref_editor;

	return *m_ref_type_editor;
}

void
std_scheme_t::commit_type_def()
{
	if( !m_ref_type_editor.get() )
		OESS_THROW_PHYSIC( oess_2::scheme::err::c_type_editor_not_exists,
			"std_scheme_t::commit_type_def()" )

	ref_std_type_editor_t ref_editor( m_ref_type_editor );
	m_ref_type_editor.reset();

	ref_editor->make_defined();
}

void
std_scheme_t::rollback_type_def()
{
	if( !m_ref_type_editor.get() )
		OESS_THROW_PHYSIC( oess_2::scheme::err::c_type_editor_not_exists,
			"std_scheme_t::rollback_type_def()" )

	m_ref_type_editor.reset();
}

const ref_std_type_t &
std_scheme_t::find_or_create_type(
	const std::string & name )
{
	const auto finder = [&name]( const ref_std_type_t & t ) {
		return name == t->query_name();
	};

	ref_std_type_deque_t::iterator it = std::find_if(
		m_builtin_types.begin(), m_builtin_types.end(), finder );
	if( it != m_builtin_types.end() )
		return (*it);

	it = std::find_if(
		m_user_types.begin(), m_user_types.end(), finder );
	if( it != m_user_types.end() )
		return (*it);

	// A new type should be created and added to the list of user types.
	ref_std_type_t ref_type(
			new std_type_t( name, OESS_1_FIXED_SIZE_FORMAT ) );
	m_user_types.push_back( ref_type );
	add_to_map( *ref_type );

	return (*(m_user_types.rbegin()));
}

void
std_scheme_t::add_to_map( std_type_t & type )
{
	m_type_map.insert( type_map_t::value_type(
		type.query_name(), &type ) );
}

void
std_scheme_t::fill_builtin_types()
{
	add_builtin_type( builtin_char(), OESS_1_FIXED_SIZE_FORMAT );
	add_builtin_type( builtin_schar(), OESS_1_FIXED_SIZE_FORMAT );
	add_builtin_type( builtin_uchar(), OESS_1_FIXED_SIZE_FORMAT );
	add_builtin_type( builtin_short(), OESS_1_FIXED_SIZE_FORMAT );
	add_builtin_type( builtin_ushort(), OESS_1_FIXED_SIZE_FORMAT );
	add_builtin_type( builtin_int(), OESS_1_FIXED_SIZE_FORMAT );
	add_builtin_type( builtin_uint(), OESS_1_FIXED_SIZE_FORMAT );
	add_builtin_type( builtin_single(), OESS_1_FIXED_SIZE_FORMAT );
	add_builtin_type( builtin_double(), OESS_1_FIXED_SIZE_FORMAT );
	add_builtin_type( builtin_std_string(), OESS_1_FIXED_SIZE_FORMAT );
	add_builtin_type(
			builtin_small_std_string(),
			OESS_2_VARIABLE_SIZE_FORMAT,
			"std::string" );

	add_builtin_serializable_t();
}

void
std_scheme_t::add_builtin_type(
	const std::string & name,
	packing_format_t packing_format,
	const std::string & cpp_type_name )
{
	std_type_t * ptr = new std_type_t( name, packing_format, true );
	if( !cpp_type_name.empty() )
		ptr->query_cpp_mapping().set_name( cpp_type_name );
	ptr->make_defined();

	ref_std_type_t ref_type( ptr );
	m_builtin_types.push_back( ref_type );
	add_to_map( *ref_type );
}

void
std_scheme_t::add_builtin_serializable_t()
{
	std_type_t * ptr = new std_type_t(
		builtin_stdsn_serializable(), OESS_1_FIXED_SIZE_FORMAT, true );
	ptr->make_defined();
	ptr->make_abstract();

	ref_std_type_t ref_type( ptr );
	m_builtin_types.push_back( ref_type );
	add_to_map( *ref_type );
}

//
// create_std_scheme
//
scheme_t *
create_std_scheme() {
	return new std_scheme_t();
}

//
// destroy_std_scheme
//
void
destroy_std_scheme( scheme_t * ptr ) {
	delete ptr;
}

} /* namespace impl */

} /* namespace scheme */

} /* namespace oess_2 */