BT411/engine/MUNGA/WATCHER.cpp

#include <cstdlib>
#include "munga.h"
#pragma hdrstop

#include "watcher.h"
#include "entity.h"
#include "cstr.h"
#include "objstrm.h"
#include "namelist.h"
#include "subsystm.h"

//#############################################################################
//##########################    AttributeWatcher    ###########################
//#############################################################################

//
//#############################################################################
//#############################################################################
//
AttributeWatcher::~AttributeWatcher()
{
}

//
//#############################################################################
//#############################################################################
//
AttributeWatcher::AttributeWatcher(
	PlugStream *stream,
	Entity *entity
):
	Component(stream)
{
	Check(stream);
	Check(entity);

#if 0
	//
	// Get attribute ptr
	//
	int subsystem_ID;
	DynamicMemoryStream_Read(stream, &subsystem_ID);

	Simulation *simulation;
	if ((simulation = entity->GetSubsystem(subsystem_ID)) == NULL)
	{
		simulation = entity;
	}
	Check(simulation);

	Simulation::AttributeID attribute_ID;
	DynamicMemoryStream_Read(stream, &attribute_ID);
	attributePointer = simulation->GetAttributePointer(attribute_ID);
	Check_Pointer(attributePointer);
#else
	//
	// HACK - Get attribute pointer using names
	//
	CString subsystem_name;
	*stream >> subsystem_name;

	if ((simulation = entity->FindSubsystem(subsystem_name)) == NULL)
	{
		#if DEBUG_LEVEL>0
		{
			CString entity_name("Entity");
			if (!(subsystem_name == entity_name))
			{
				Dump(subsystem_name);
			}
			Verify(subsystem_name == entity_name);
		}
		#else
		{
			CString entity_name("Entity");
			if (!(subsystem_name == entity_name))
			{
				DEBUG_STREAM <<
					"AttributeWatcher::AttributeWatcher - subsystem " <<
					subsystem_name <<
					"\n";
				Fail("AttributeWatcher::AttributeWatcher - subsystem not found\n");
			}
		}
		#endif
		simulation = entity;
	}
	Check(simulation);

	CString attribute_name;
	*stream >> attribute_name;

	#if DEBUG_LEVEL>2
		Tell("AttributeWatcher::AttributeWatcher - " << attribute_name << "\n");
	#endif

	attributePointer = simulation->GetAttributePointer(attribute_name);

	// The bound attribute's NAME, visible to derived ctors (the stream layout
	// puts the trigger fields AFTER the base bind, so a derived ctor that needs
	// to know WHICH attribute it just bound -- the #154 GeneratorState fixup --
	// reads it from here).  Valid only during construction.
	{
		extern char g_lastBoundAttrName[64];
		const char *an = (const char *)attribute_name;
		int i = 0;
		for (; an != 0 && an[i] != '\0' && i < 63; ++i)
			g_lastBoundAttrName[i] = an[i];
		g_lastBoundAttrName[i] = '\0';
	}

	if (getenv("BT_ATTRBIND_LOG"))
	{
		extern int g_curAudioWatcherClass;
		DEBUG_STREAM << "[attrbind] class=" << g_curAudioWatcherClass
			<< " subsys=[" << subsystem_name
			<< "] attr=[" << attribute_name << "] -> ptr=" << attributePointer
			<< " vtbl=" << (attributePointer ? *(void**)attributePointer : (void*)0)
			<< "\n" << std::flush;
	}

	// BRING-UP GUARD [T3, temporary]: audio references attributes on subsystems that
	// are not fully reconstructed yet (GeneratorState/On, CondenserState, ReportLeak,
	// Torso SpeedOfTorsoHorizontal/MotionState, Reservoir/Avionics/ControlsMapper ...).
	// GetAttributePointer returns NULL for those, and the original engine Fail()s
	// (fatal) -- which would abort every audio-enabled run.  Redirect NULL to a shared
	// inert zero pad so scalar/vector watchers read 0 (that sound stays silent) instead
	// of crashing; state watchers on it are skipped by the AudioStateWatcher guard.
	// Self-clearing: a registered attribute resolves to its real member.  Remove once
	// the subsystem attribute tables are reconstructed (the audio subsystem wave).
	if (attributePointer == NULL)
	{
		static char s_missingAttrPad[64] = {0};
		// TYPED pad: ConfigureActivePress is the held-configure-button INDEX whose
		// authored idle is -1 (none) -- NINE audio triggers gate the configure-mode
		// ticker on it with threshold -1 across the configurable subsystems.  The
		// zero pad read as "button 0 held" and started the ticker at load (the
		// eternal 2.7/s chirp).  Redirect this attribute to a -1 pad; others keep 0.
		static int s_configureIdlePad = -1;
		CString configure_name("ConfigureActivePress");
		if (attribute_name == configure_name)
			attributePointer = &s_configureIdlePad;
		else
			attributePointer = s_missingAttrPad;
		if (getenv("BT_AUDIO_LOG"))
			DEBUG_STREAM << "[attrnull] " << subsystem_name << "." << attribute_name
				<< " not reconstructed -> "
				<< (attributePointer == (void*)&s_configureIdlePad ? "-1 pad" : "inert pad")
				<< "\n" << std::flush;
	}

	Check_Pointer(attributePointer);
#endif

	//
	// Get other fields
	//
	*stream >> sendNotificationOnChange;
	attributeChanged = False;
}

//
//#############################################################################
// BuildFromPage
//#############################################################################
//
void
   AttributeWatcher::BuildFromPage(
      PlugStream *stream,
      NameList *name_list,
      ClassID class_ID,
      ObjectID object_ID
   )
{
   Component::BuildFromPage(stream, name_list, class_ID, object_ID);

   //
   // HACK - Store attribute pointer using names
	//
	MEM_STRM_WRITE_ENTRY(*stream, name_list, CString, subsystem);
	MEM_STRM_WRITE_ENTRY(*stream, name_list, CString, attribute);

   //
   // Store other fields
   //
	Logical send_notification_on_change = True;
	*stream << send_notification_on_change;
}

//
//#############################################################################
//#############################################################################
//
Logical
	AttributeWatcher::TestInstance() const
{
	Component::TestInstance();
   Check(simulation);
	Check_Pointer(attributePointer);
   return True;
}

//
//#############################################################################
//#############################################################################
//
Logical
	AttributeWatcher::DidAttributeChange()
{
	if (attributeChanged)
	{
		attributeChanged = False;
		return True;
	}
	return False;
}

//
//#############################################################################
//#############################################################################
//
void
	AttributeWatcher::SendNotificationOfChange()
{
	Fail("AttributeWatcher::SendNotificationOfChange - Should never reach here");
}

#ifdef TEST_CLASS
#	include "watcher.tcp"
#endif