#include <portability.h>
#include "xml.h"
#include "agent.h"
#include "soar_TraceNames.h"
#include "XMLTrace.h"
#include "ElementXML.h"
#include "print.h"
#include "wmem.h"
#include "assert.h"

Functions
void	xml_att_val (agent pAgent, char const pAttribute, uint64_t value)
void	xml_att_val (agent pAgent, char const pAttribute, int value)
void	xml_att_val (agent pAgent, char const pAttribute, int64_t value)
void	xml_att_val (agent pAgent, char const pAttribute, double value)
void	xml_att_val (agent pAgent, char const pAttribute, char const *pValue)
void	xml_att_val (agent pAgent, char const pAttribute, Symbol *pSymbol)
void	xml_begin_command_mode (agent *pAgent)
void	xml_begin_tag (agent pAgent, char const pTag)
void	xml_create (agent *pAgent)
void	xml_destroy (agent *pAgent)
soarxml::ElementXML *	xml_end_command_mode (agent *pAgent)
void	xml_end_tag (agent pAgent, char const pTag)
void	xml_generate_error (agent pAgent, const char pMessage)
void	xml_generate_message (agent pAgent, const char pMessage)
void	xml_generate_verbose (agent pAgent, const char pMessage)
void	xml_generate_warning (agent pAgent, const char pMessage)
soarxml::ElementXML *	xml_get_xml (agent *pAgent)
void	xml_invoke_callback (agent *pAgent)
void	xml_move_current_to_child (agent *pAgent, int index)
void	xml_move_current_to_last_child (agent *pAgent)
void	xml_move_current_to_parent (agent *pAgent)
void	xml_object (agent pAgent, char const pTag)
void	xml_object (agent pAgent, char const pTag, char const pAttribute, char const pValue)
void	xml_object (agent pAgent, char const pTag, char const *pAttribute, uint64_t value)
void	xml_object (agent pAgent, char const pTag, char const *pAttribute, int64_t value)
void	xml_object (agent pAgent, char const pTag, char const *pAttribute, double value)
void	xml_object (agent pAgent, wme pWME, bool printTimetag)
void	xml_reset (agent *pAgent)

Function Documentation

void xml_att_val	(	agent *	pAgent,
		char const *	pAttribute,
		uint64_t	value
	)

Definition at line 132 of file xml.cpp.

References agent_struct::xml_destination.

Referenced by add_wme_to_gds(), backtrace_through_instantiation(), chunk_instantiation(), do_buffered_wm_changes(), do_preference_phase(), do_working_memory_phase(), exploration_boltzmann_select(), exploration_epsilon_greedy_select(), gds_invalid_so_remove_goal(), print_action_list(), print_condition_list(), print_instantiation_with_wmes(), print_phase(), print_preference(), print_production(), print_stack_trace_xml(), xml_aux(), xml_condition_list(), xml_instantiation_with_wmes(), xml_match_set(), xml_object(), xml_partial_match_information(), and xml_whole_token().

{
 char buf[51];
 SNPRINTF(buf, 50, "%llu", static_cast<long long unsigned>(value));
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 pXML->AddAttribute( pAttribute, buf ) ;
}

void xml_att_val	(	agent *	pAgent,
		char const *	pAttribute,
		int	value
	)

Definition at line 141 of file xml.cpp.

References agent_struct::xml_destination.

{
 char buf[51];
 SNPRINTF(buf, 50, "%d", value);
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 pXML->AddAttribute( pAttribute, buf ) ;
}

void xml_att_val	(	agent *	pAgent,
		char const *	pAttribute,
		int64_t	value
	)

Definition at line 150 of file xml.cpp.

References agent_struct::xml_destination.

{
 char buf[51];
 SNPRINTF(buf, 50, "%lld", static_cast<long long>(value));
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 pXML->AddAttribute( pAttribute, buf ) ;
}

void xml_att_val	(	agent *	pAgent,
		char const *	pAttribute,
		double	value
	)

Definition at line 159 of file xml.cpp.

References agent_struct::xml_destination.

{
 char buf[51];
 SNPRINTF(buf, 50, "%f", value);
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 pXML->AddAttribute( pAttribute, buf ) ;
}

void xml_att_val	(	agent *	pAgent,
		char const *	pAttribute,
		char const *	pValue
	)

Definition at line 168 of file xml.cpp.

References agent_struct::xml_destination.

{
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 pXML->AddAttribute( pAttribute, pValue ) ;
}

void xml_att_val	(	agent *	pAgent,
		char const *	pAttribute,
		Symbol *	pSymbol
	)

Definition at line 174 of file xml.cpp.

References symbol_to_string(), and agent_struct::xml_destination.

{
 // Passing 0, 0 as buffer to symbol to string causes it to use internal, temporary buffers
 // which is fine because we immediately copy that string in XMLAddAttribute.
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 pXML->AddAttribute( pAttribute, symbol_to_string( pAgent, pSymbol, true, 0, 0 ) ) ;
}

void xml_begin_command_mode ( agent * pAgent )

Definition at line 320 of file xml.cpp.

References agent_struct::xml_commands, agent_struct::xml_destination, and agent_struct::xml_trace.

{
 if ( !pAgent || !pAgent->xml_trace || !pAgent->xml_commands )
 {
  assert( pAgent );
  assert( pAgent->xml_trace );
  assert( pAgent->xml_commands );
  return;
 }
 pAgent->xml_destination = pAgent->xml_commands;
}

void xml_begin_tag	(	agent *	pAgent,
		char const *	pTag
	)

Definition at line 100 of file xml.cpp.

References agent_struct::xml_destination.

Referenced by add_wme_to_gds(), backtrace_through_instantiation(), chunk_instantiation(), do_buffered_wm_changes(), do_preference_phase(), do_working_memory_phase(), exploration_boltzmann_select(), exploration_epsilon_greedy_select(), filtered_print_wme_add(), filtered_print_wme_remove(), gds_invalid_so_remove_goal(), print_action_list(), print_condition_list(), print_instantiation_with_wmes(), print_phase(), print_preference(), print_production(), print_stack_trace_xml(), report_local_negation(), trace_grounded_potentials(), trace_locals(), trace_ungrounded_potentials(), xml_aux(), xml_condition_list(), xml_instantiation_with_wmes(), xml_match_set(), and xml_partial_match_information().

{
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 pXML->BeginTag( pTag ) ;
}

void xml_create ( agent * pAgent )

Definition at line 44 of file xml.cpp.

References agent_struct::xml_commands, agent_struct::xml_destination, and agent_struct::xml_trace.

Referenced by create_soar_agent().

{
 if ( !pAgent )
 {
  assert( pAgent );
  return;
 }
 soarxml::XMLTrace* pTrace = new soarxml::XMLTrace();
 soarxml::XMLTrace* pCommands = new soarxml::XMLTrace();
 
 pAgent->xml_trace = static_cast< xml_handle >( pTrace );
 pAgent->xml_commands = static_cast< xml_handle >( pCommands );
 
 pAgent->xml_destination = pAgent->xml_trace;
}

void xml_destroy ( agent * pAgent )

Definition at line 78 of file xml.cpp.

References agent_struct::xml_commands, agent_struct::xml_destination, and agent_struct::xml_trace.

Referenced by destroy_soar_agent().

{
 if ( !pAgent || !pAgent->xml_trace || !pAgent->xml_commands )
 {
  assert( pAgent );
  assert( pAgent->xml_trace );
  assert( pAgent->xml_commands );
  return;
 }
 soarxml::XMLTrace* pTrace = static_cast< soarxml::XMLTrace* >( pAgent->xml_trace );
 soarxml::XMLTrace* pCommands = static_cast< soarxml::XMLTrace* >( pAgent->xml_commands );
 delete pTrace;
 delete pCommands;
 pAgent->xml_trace = 0;
 pAgent->xml_commands = 0;
 pAgent->xml_destination = 0;
}

soarxml::ElementXML* xml_end_command_mode ( agent * pAgent )

Definition at line 333 of file xml.cpp.

References agent_struct::xml_destination, xml_get_xml(), and agent_struct::xml_trace.

{
 if ( !pAgent )
 {
  assert( pAgent );
  return 0;
 }
 soarxml::ElementXML* pReturn = xml_get_xml( pAgent );
 pAgent->xml_destination = pAgent->xml_trace;
 return pReturn;
}

void xml_end_tag	(	agent *	pAgent,
		char const *	pTag
	)

Definition at line 106 of file xml.cpp.

References agent_struct::xml_destination.

Referenced by add_wme_to_gds(), backtrace_through_instantiation(), chunk_instantiation(), do_buffered_wm_changes(), do_preference_phase(), do_working_memory_phase(), exploration_boltzmann_select(), exploration_epsilon_greedy_select(), filtered_print_wme_add(), filtered_print_wme_remove(), gds_invalid_so_remove_goal(), print_action_list(), print_condition_list(), print_instantiation_with_wmes(), print_phase(), print_preference(), print_production(), print_stack_trace_xml(), report_local_negation(), trace_grounded_potentials(), trace_locals(), trace_ungrounded_potentials(), xml_aux(), xml_condition_list(), xml_instantiation_with_wmes(), xml_match_set(), and xml_partial_match_information().

{
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 pXML->EndTag( pTag ) ;
}

void xml_generate_error	(	agent *	pAgent,
		const char *	pMessage
	)

Definition at line 256 of file xml.cpp.

References xml_object().

Referenced by abort_with_fatal_error(), and do_one_top_level_phase().

{
 xml_object( pAgent, stn::kTagError, stn::kTypeString, pMessage );
}

void xml_generate_message	(	agent *	pAgent,
		const char *	pMessage
	)

Definition at line 261 of file xml.cpp.

References xml_object().

Referenced by rl_perform_update(), smem_path_param::set_value(), epmem_path_param::set_value(), and wma_go().

{
 xml_object( pAgent, stn::kTagMessage, stn::kTypeString, pMessage );
}

void xml_generate_verbose	(	agent *	pAgent,
		const char *	pMessage
	)

Definition at line 266 of file xml.cpp.

References xml_object().

Referenced by assert_new_preferences(), calculate_compile_time_o_support(), calculate_support_for_instantiation_preferences(), create_instantiation(), p_node_left_addition(), p_node_left_removal(), and should_variablize().

{
 xml_object( pAgent, stn::kTagVerbose, stn::kTypeString, pMessage );
}

void xml_generate_warning	(	agent *	pAgent,
		const char *	pMessage
	)

Definition at line 251 of file xml.cpp.

References xml_object().

Referenced by add_production_to_rete(), calculate_support_for_instantiation_preferences(), chunk_instantiation(), collect_root_variables(), create_new_context(), determine_highest_active_production_level_in_stack_apply(), determine_highest_active_production_level_in_stack_propose(), determine_type_of_constituent_string(), epmem_init_db(), epmem_new_episode(), epmem_process_query(), generate_chunk_name_sym_constant(), highest_active_goal_apply(), highest_active_goal_propose(), p_node_left_addition(), p_node_left_removal(), parse_head_of_conds_for_one_id(), parse_preferences_soar8_non_operator(), print_identifier_ref_info(), reorder_simplified_conditions(), reset_id_counters(), reset_wme_timetags(), restore_and_deallocate_saved_tests(), rl_perform_update(), rl_store_data(), smem_init_db(), smem_store_chunk(), stats_init_db(), wma_activate_wme(), wma_remove_decay_element(), and wma_update_decay_histories().

{
 xml_object( pAgent, stn::kTagWarning, stn::kTypeString, pMessage );
}

soarxml::ElementXML* xml_get_xml ( agent * pAgent )

Definition at line 303 of file xml.cpp.

References agent_struct::xml_destination.

Referenced by xml_end_command_mode().

{
 if ( !pAgent || !pAgent->xml_destination )
 {
  assert( pAgent );
  assert( pAgent->xml_destination );
  return 0;
 }
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 soarxml::ElementXML* pReturn = pXML->DetatchObject();
 pXML->Reset();
 return pReturn;
}

void xml_invoke_callback ( agent * pAgent )

Definition at line 271 of file xml.cpp.

References callback_struct::data, callback_struct::eventid, callback_struct::function, NIL, agent_struct::soar_callbacks, agent_struct::xml_destination, and XML_GENERATION_CALLBACK.

Referenced by do_one_top_level_phase().

{
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 if ( pXML->IsEmpty() )
 {
  return;
 }
 soarxml::ElementXML* pResult = pXML->DetatchObject();
 pXML->Reset();
#ifdef _DEBUG
 char* pStr = pResult->GenerateXMLString( true ) ;
 pResult->DeleteString( pStr ) ;
#endif // _DEBUG
 // We need to call the handler explicitly here instead of using soar_invoke_callbacks
 // because we need to create a new ElementXML object for each handler that gets called.
 for ( cons* c = pAgent->soar_callbacks[XML_GENERATION_CALLBACK]; c != NIL; c = c->rest )
 {
  soarxml::ElementXML* pCallbackData = new soarxml::ElementXML( pResult->GetXMLHandle() );
  pCallbackData->AddRefOnHandle();
  soar_callback* cb = static_cast< soar_callback* >( c->first );
  // handler responsible for deleting pCallbackData
  cb->function( pAgent, cb->eventid, cb->data, static_cast< soar_call_data >( pCallbackData ) );
 }
 delete pResult;
}

void xml_move_current_to_child	(	agent *	pAgent,
		int	index
	)

Definition at line 120 of file xml.cpp.

References agent_struct::xml_destination.

{
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 pXML->MoveCurrentToChild( index );
}

void xml_move_current_to_last_child ( agent * pAgent )

Definition at line 126 of file xml.cpp.

References agent_struct::xml_destination.

Referenced by xml_aux().

{
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 pXML->MoveCurrentToLastChild();
}

void xml_move_current_to_parent ( agent * pAgent )

Definition at line 114 of file xml.cpp.

References agent_struct::xml_destination.

Referenced by xml_aux().

{
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 pXML->MoveCurrentToParent();
}

void xml_object	(	agent *	pAgent,
		char const *	pTag
	)

Definition at line 182 of file xml.cpp.

References agent_struct::xml_destination.

Referenced by create_instantiation(), print_wme(), print_wme_without_timetag(), retract_instantiation(), write_rhs_function_code(), xml_aux(), xml_generate_error(), xml_generate_message(), xml_generate_verbose(), xml_generate_warning(), xml_instantiation_with_wmes(), and xml_whole_token().

{
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 pXML->BeginTag( pTag ) ;
 pXML->EndTag( pTag ) ;
}

void xml_object	(	agent *	pAgent,
		char const *	pTag,
		char const *	pAttribute,
		char const *	pValue
	)

Definition at line 190 of file xml.cpp.

References agent_struct::xml_destination.

{
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 pXML->BeginTag( pTag ) ;
 pXML->AddAttribute( pAttribute, pValue ) ;
 pXML->EndTag( pTag ) ;
}

void xml_object	(	agent *	pAgent,
		char const *	pTag,
		char const *	pAttribute,
		uint64_t	value
	)

Definition at line 199 of file xml.cpp.

References xml_att_val(), and agent_struct::xml_destination.

{
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 pXML->BeginTag( pTag ) ;
 xml_att_val( pAgent, pAttribute, value );
 pXML->EndTag( pTag ) ;
}

void xml_object	(	agent *	pAgent,
		char const *	pTag,
		char const *	pAttribute,
		int64_t	value
	)

Definition at line 208 of file xml.cpp.

References xml_att_val(), and agent_struct::xml_destination.

{
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 pXML->BeginTag( pTag ) ;
 xml_att_val( pAgent, pAttribute, value );
 pXML->EndTag( pTag ) ;
}

void xml_object	(	agent *	pAgent,
		char const *	pTag,
		char const *	pAttribute,
		double	value
	)

Definition at line 217 of file xml.cpp.

References xml_att_val(), and agent_struct::xml_destination.

{
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 pXML->BeginTag( pTag ) ;
 xml_att_val( pAgent, pAttribute, value );
 pXML->EndTag( pTag ) ;
}

void xml_object	(	agent *	pAgent,
		wme *	pWME,
		bool	printTimetag
	)

Definition at line 226 of file xml.cpp.

References wme_struct::acceptable, wme_struct::attr, wme_struct::id, symbol_to_typeString(), wme_struct::timetag, wme_struct::value, xml_att_val(), and agent_struct::xml_destination.

                                                               {
 // <wme tag="123" id="s1" attr="foo" attrtype="string" val="123" valtype="string"></wme>
 soarxml::XMLTrace* pXML = static_cast< soarxml::XMLTrace* >( pAgent->xml_destination );
 pXML->BeginTag( stn::kTagWME ) ;
 // BADBAD: These calls are redundantly converting pXML again. Possibly optimize.
 if ( printTimetag )
 {
  xml_att_val( pAgent, kWME_TimeTag, pWME->timetag );
 }
 xml_att_val( pAgent, kWME_Id, pWME->id );
 xml_att_val( pAgent, kWME_Attribute, pWME->attr );
 xml_att_val( pAgent, kWME_Value, pWME->value );
 xml_att_val( pAgent, kWME_ValueType, symbol_to_typeString( pAgent, pWME->value ) );
 if ( pWME->acceptable ) 
 {
  xml_att_val( pAgent, kWMEPreference, "+" );
 }
 pXML->EndTag( stn::kTagWME ) ;
}

void xml_reset ( agent * pAgent )

Definition at line 61 of file xml.cpp.

References agent_struct::xml_commands, and agent_struct::xml_trace.

Referenced by reinitialize_soar().

{
 if ( !pAgent || !pAgent->xml_trace || !pAgent->xml_commands )
 {
  assert( pAgent );
  assert( pAgent->xml_trace );
  assert( pAgent->xml_commands );
  return;
 }
 soarxml::XMLTrace* pTrace = static_cast< soarxml::XMLTrace* >( pAgent->xml_trace );
 soarxml::XMLTrace* pCommands = static_cast< soarxml::XMLTrace* >( pAgent->xml_commands );
 pTrace->Reset();
 pCommands->Reset();
}

Functions

Function Documentation