(Proposal) Adjustments to "decomp" language (#308)

* Adjustments to "decomp" language * Fix a comment * Fix accidental clang-formatting * Fix order * Fix order * Remove junk * Fix OFFSET * Adjustments based on new suggestions * Annotate globals * Globals in ISLE * More globals * Merge from parser2 branch * Allow prepending space for exact marker match * To eliminate noise, require the 0x prefix on offset for marker match * fix test from previous * Count tab stops for indented functions to reduce MISSED_END_OF_FUNCTION noise * FUNCTION to SYNTHETIC where needed * Missed marker conversion on SetAtomId * pylint cleanup, remove unused code * Fix unexpected function end, add more unit tests * Be more strict about synthetic name syntax * Revert "Missed marker conversion on SetAtomId" This reverts commit d87d665127. * Revert "FUNCTION to SYNTHETIC where needed" This reverts commit 8c815418d2. * Implicit lookup by name for functions * Fix VTABLE SYNTHETIC and other decomp markers * Get vtable class name * Vtable marker should identify struct * No colon for SIZE comment * Update README.md * Update README.md * Update CONTRIBUTING.md * Update README.md * Update README.md * Update CONTRIBUTING.md * Update README.md * Update CONTRIBUTING.md * Fix destructor/annotation * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md --------- Co-authored-by: disinvite <disinvite@users.noreply.github.com>
2025-10-24 08:54:15 +00:00 · 2023-12-06 07:10:45 -05:00
parent 4f5b70013f
commit 494a556f8e
407 changed files with 3505 additions and 2493 deletions
--- a/LEGO1/realtime/vector.cpp
+++ b/LEGO1/realtime/vector.cpp
@@ -12,58 +12,58 @@ DECOMP_SIZE_ASSERT(Vector4Impl, 0x8);
 DECOMP_SIZE_ASSERT(Vector3Data, 0x14);
 DECOMP_SIZE_ASSERT(Vector4Data, 0x18);

-// OFFSET: LEGO1 0x10001f80
+// FUNCTION: LEGO1 0x10001f80
 void Vector2Impl::AddVectorImpl(float* p_value)
 {
 	m_data[0] += p_value[0];
 	m_data[1] += p_value[1];
 }

-// OFFSET: LEGO1 0x10001fa0
+// FUNCTION: LEGO1 0x10001fa0
 void Vector2Impl::AddScalarImpl(float p_value)
 {
 	m_data[0] += p_value;
 	m_data[1] += p_value;
 }

-// OFFSET: LEGO1 0x10001fc0
+// FUNCTION: LEGO1 0x10001fc0
 void Vector2Impl::SubVectorImpl(float* p_value)
 {
 	m_data[0] -= p_value[0];
 	m_data[1] -= p_value[1];
 }

-// OFFSET: LEGO1 0x10001fe0
+// FUNCTION: LEGO1 0x10001fe0
 void Vector2Impl::MullVectorImpl(float* p_value)
 {
 	m_data[0] *= p_value[0];
 	m_data[1] *= p_value[1];
 }

-// OFFSET: LEGO1 0x10002000
+// FUNCTION: LEGO1 0x10002000
 void Vector2Impl::MullScalarImpl(float* p_value)
 {
 	m_data[0] *= *p_value;
 	m_data[1] *= *p_value;
 }

-// OFFSET: LEGO1 0x10002020
+// FUNCTION: LEGO1 0x10002020
 void Vector2Impl::DivScalarImpl(float* p_value)
 {
 	m_data[0] /= *p_value;
 	m_data[1] /= *p_value;
 }

-// OFFSET: LEGO1 0x10002040
+// FUNCTION: LEGO1 0x10002040
 float Vector2Impl::DotImpl(float* p_a, float* p_b) const
 {
 	return p_b[0] * p_a[0] + p_b[1] * p_a[1];
 }

-// OFFSET: LEGO1 0x10002060 TEMPLATE
+// FUNCTION: LEGO1 0x10002060
 // Vector2Impl::SetData

-// OFFSET: LEGO1 0x10002070
+// FUNCTION: LEGO1 0x10002070
 void Vector2Impl::EqualsImpl(float* p_data)
 {
 	float* vec = m_data;
@@ -71,19 +71,19 @@ void Vector2Impl::EqualsImpl(float* p_data)
 	vec[1] = p_data[1];
 }

-// OFFSET: LEGO1 0x10002090
+// FUNCTION: LEGO1 0x10002090
 float* Vector2Impl::GetData()
 {
 	return m_data;
 }

-// OFFSET: LEGO1 0x100020a0
+// FUNCTION: LEGO1 0x100020a0
 const float* Vector2Impl::GetData() const
 {
 	return m_data;
 }

-// OFFSET: LEGO1 0x100020b0
+// FUNCTION: LEGO1 0x100020b0
 void Vector2Impl::Clear()
 {
 	float* vec = m_data;
@@ -91,37 +91,37 @@ void Vector2Impl::Clear()
 	vec[1] = 0.0f;
 }

-// OFFSET: LEGO1 0x100020d0
+// FUNCTION: LEGO1 0x100020d0
 float Vector2Impl::Dot(float* p_a, float* p_b) const
 {
 	return DotImpl(p_a, p_b);
 }

-// OFFSET: LEGO1 0x100020f0
+// FUNCTION: LEGO1 0x100020f0
 float Vector2Impl::Dot(Vector2Impl* p_a, Vector2Impl* p_b) const
 {
 	return DotImpl(p_a->m_data, p_b->m_data);
 }

-// OFFSET: LEGO1 0x10002110
+// FUNCTION: LEGO1 0x10002110
 float Vector2Impl::Dot(float* p_a, Vector2Impl* p_b) const
 {
 	return DotImpl(p_a, p_b->m_data);
 }

-// OFFSET: LEGO1 0x10002130
+// FUNCTION: LEGO1 0x10002130
 float Vector2Impl::Dot(Vector2Impl* p_a, float* p_b) const
 {
 	return DotImpl(p_a->m_data, p_b);
 }

-// OFFSET: LEGO1 0x10002150
+// FUNCTION: LEGO1 0x10002150
 float Vector2Impl::LenSquared() const
 {
 	return m_data[0] * m_data[0] + m_data[1] * m_data[1];
 }

-// OFFSET: LEGO1 0x10002160
+// FUNCTION: LEGO1 0x10002160
 int Vector2Impl::Unitize()
 {
 	float sq = LenSquared();
@@ -135,73 +135,73 @@ int Vector2Impl::Unitize()
 	return -1;
 }

-// OFFSET: LEGO1 0x100021c0
+// FUNCTION: LEGO1 0x100021c0
 void Vector2Impl::AddScalar(float p_value)
 {
 	AddScalarImpl(p_value);
 }

-// OFFSET: LEGO1 0x100021d0
+// FUNCTION: LEGO1 0x100021d0
 void Vector2Impl::AddVector(float* p_other)
 {
 	AddVectorImpl(p_other);
 }

-// OFFSET: LEGO1 0x100021e0
+// FUNCTION: LEGO1 0x100021e0
 void Vector2Impl::AddVector(Vector2Impl* p_other)
 {
 	AddVectorImpl(p_other->m_data);
 }

-// OFFSET: LEGO1 0x100021f0
+// FUNCTION: LEGO1 0x100021f0
 void Vector2Impl::SubVector(float* p_other)
 {
 	SubVectorImpl(p_other);
 }

-// OFFSET: LEGO1 0x10002200
+// FUNCTION: LEGO1 0x10002200
 void Vector2Impl::SubVector(Vector2Impl* p_other)
 {
 	SubVectorImpl(p_other->m_data);
 }

-// OFFSET: LEGO1 0x10002210
+// FUNCTION: LEGO1 0x10002210
 void Vector2Impl::MullVector(float* p_other)
 {
 	MullVectorImpl(p_other);
 }

-// OFFSET: LEGO1 0x10002220
+// FUNCTION: LEGO1 0x10002220
 void Vector2Impl::MullVector(Vector2Impl* p_other)
 {
 	MullVectorImpl(p_other->m_data);
 }

-// OFFSET: LEGO1 0x10002230
+// FUNCTION: LEGO1 0x10002230
 void Vector2Impl::MullScalar(float* p_value)
 {
 	MullScalarImpl(p_value);
 }

-// OFFSET: LEGO1 0x10002240
+// FUNCTION: LEGO1 0x10002240
 void Vector2Impl::DivScalar(float* p_value)
 {
 	DivScalarImpl(p_value);
 }

-// OFFSET: LEGO1 0x10002250
+// FUNCTION: LEGO1 0x10002250
 void Vector2Impl::SetVector(float* p_other)
 {
 	EqualsImpl(p_other);
 }

-// OFFSET: LEGO1 0x10002260
+// FUNCTION: LEGO1 0x10002260
 void Vector2Impl::SetVector(Vector2Impl* p_other)
 {
 	EqualsImpl(p_other->m_data);
 }

-// OFFSET: LEGO1 0x10002270
+// FUNCTION: LEGO1 0x10002270
 void Vector3Impl::EqualsCrossImpl(float* p_a, float* p_b)
 {
 	m_data[0] = p_a[1] * p_b[2] - p_a[2] * p_b[1];
@@ -209,25 +209,25 @@ void Vector3Impl::EqualsCrossImpl(float* p_a, float* p_b)
 	m_data[2] = p_a[0] * p_b[1] - p_a[1] * p_b[0];
 }

-// OFFSET: LEGO1 0x100022c0
+// FUNCTION: LEGO1 0x100022c0
 void Vector3Impl::EqualsCross(Vector3Impl* p_a, Vector3Impl* p_b)
 {
 	EqualsCrossImpl(p_a->m_data, p_b->m_data);
 }

-// OFFSET: LEGO1 0x100022e0
+// FUNCTION: LEGO1 0x100022e0
 void Vector3Impl::EqualsCross(Vector3Impl* p_a, float* p_b)
 {
 	EqualsCrossImpl(p_a->m_data, p_b);
 }

-// OFFSET: LEGO1 0x10002300
+// FUNCTION: LEGO1 0x10002300
 void Vector3Impl::EqualsCross(float* p_a, Vector3Impl* p_b)
 {
 	EqualsCrossImpl(p_a, p_b->m_data);
 }

-// OFFSET: LEGO1 0x10002870
+// FUNCTION: LEGO1 0x10002870
 void Vector4Impl::AddVectorImpl(float* p_value)
 {
 	m_data[0] += p_value[0];
@@ -236,7 +236,7 @@ void Vector4Impl::AddVectorImpl(float* p_value)
 	m_data[3] += p_value[3];
 }

-// OFFSET: LEGO1 0x100028b0
+// FUNCTION: LEGO1 0x100028b0
 void Vector4Impl::AddScalarImpl(float p_value)
 {
 	m_data[0] += p_value;
@@ -245,7 +245,7 @@ void Vector4Impl::AddScalarImpl(float p_value)
 	m_data[3] += p_value;
 }

-// OFFSET: LEGO1 0x100028f0
+// FUNCTION: LEGO1 0x100028f0
 void Vector4Impl::SubVectorImpl(float* p_value)
 {
 	m_data[0] -= p_value[0];
@@ -254,7 +254,7 @@ void Vector4Impl::SubVectorImpl(float* p_value)
 	m_data[3] -= p_value[3];
 }

-// OFFSET: LEGO1 0x10002930
+// FUNCTION: LEGO1 0x10002930
 void Vector4Impl::MullVectorImpl(float* p_value)
 {
 	m_data[0] *= p_value[0];
@@ -263,7 +263,7 @@ void Vector4Impl::MullVectorImpl(float* p_value)
 	m_data[3] *= p_value[3];
 }

-// OFFSET: LEGO1 0x10002970
+// FUNCTION: LEGO1 0x10002970
 void Vector4Impl::MullScalarImpl(float* p_value)
 {
 	m_data[0] *= *p_value;
@@ -272,7 +272,7 @@ void Vector4Impl::MullScalarImpl(float* p_value)
 	m_data[3] *= *p_value;
 }

-// OFFSET: LEGO1 0x100029b0
+// FUNCTION: LEGO1 0x100029b0
 void Vector4Impl::DivScalarImpl(float* p_value)
 {
 	m_data[0] /= *p_value;
@@ -281,13 +281,13 @@ void Vector4Impl::DivScalarImpl(float* p_value)
 	m_data[3] /= *p_value;
 }

-// OFFSET: LEGO1 0x100029f0
+// FUNCTION: LEGO1 0x100029f0
 float Vector4Impl::DotImpl(float* p_a, float* p_b) const
 {
 	return p_a[0] * p_b[0] + p_a[2] * p_b[2] + (p_a[1] * p_b[1] + p_a[3] * p_b[3]);
 }

-// OFFSET: LEGO1 0x10002a20
+// FUNCTION: LEGO1 0x10002a20
 void Vector4Impl::EqualsImpl(float* p_data)
 {
 	float* vec = m_data;
@@ -297,7 +297,7 @@ void Vector4Impl::EqualsImpl(float* p_data)
 	vec[3] = p_data[3];
 }

-// OFFSET: LEGO1 0x10002a40
+// FUNCTION: LEGO1 0x10002a40
 void Vector4Impl::SetMatrixProductImpl(float* p_vec, float* p_mat)
 {
 	m_data[0] = p_vec[0] * p_mat[0] + p_vec[1] * p_mat[4] + p_vec[2] * p_mat[8] + p_vec[3] * p_mat[12];
@@ -306,13 +306,13 @@ void Vector4Impl::SetMatrixProductImpl(float* p_vec, float* p_mat)
 	m_data[3] = p_vec[0] * p_mat[3] + p_vec[1] * p_mat[7] + p_vec[2] * p_mat[11] + p_vec[4] * p_mat[15];
 }

-// OFFSET: LEGO1 0x10002ae0
+// FUNCTION: LEGO1 0x10002ae0
 void Vector4Impl::SetMatrixProduct(Vector4Impl* p_a, float* p_b)
 {
 	SetMatrixProductImpl(p_a->m_data, p_b);
 }

-// OFFSET: LEGO1 0x10002b00
+// FUNCTION: LEGO1 0x10002b00
 void Vector4Impl::Clear()
 {
 	float* vec = m_data;
@@ -322,13 +322,13 @@ void Vector4Impl::Clear()
 	vec[3] = 0.0f;
 }

-// OFFSET: LEGO1 0x10002b20
+// FUNCTION: LEGO1 0x10002b20
 float Vector4Impl::LenSquared() const
 {
 	return m_data[1] * m_data[1] + m_data[0] * m_data[0] + m_data[2] * m_data[2] + m_data[3] * m_data[3];
 }

-// OFFSET: LEGO1 0x10002b40
+// FUNCTION: LEGO1 0x10002b40
 void Vector4Impl::EqualsScalar(float* p_value)
 {
 	m_data[0] = *p_value;
@@ -339,7 +339,7 @@ void Vector4Impl::EqualsScalar(float* p_value)

 // Note close yet, included because I'm at least confident I know what operation
 // it's trying to do.
-// OFFSET: LEGO1 0x10002b70 STUB
+// STUB: LEGO1 0x10002b70
 int Vector4Impl::NormalizeQuaternion()
 {
 	float* v = m_data;
@@ -357,7 +357,7 @@ int Vector4Impl::NormalizeQuaternion()
 	return -1;
 }

-// OFFSET: LEGO1 0x10002bf0
+// FUNCTION: LEGO1 0x10002bf0
 void Vector4Impl::UnknownQuaternionOp(Vector4Impl* p_a, Vector4Impl* p_b)
 {
 	float* bDat = p_b->m_data;
@@ -373,7 +373,7 @@ void Vector4Impl::UnknownQuaternionOp(Vector4Impl* p_a, Vector4Impl* p_b)
 	m_data[2] = p_b->m_data[2] * p_a->m_data[3] + p_a->m_data[2] * p_b->m_data[3] + m_data[2];
 }

-// OFFSET: LEGO1 0x10003a60
+// FUNCTION: LEGO1 0x10003a60
 void Vector3Impl::AddVectorImpl(float* p_value)
 {
 	m_data[0] += p_value[0];
@@ -381,7 +381,7 @@ void Vector3Impl::AddVectorImpl(float* p_value)
 	m_data[2] += p_value[2];
 }

-// OFFSET: LEGO1 0x10003a90
+// FUNCTION: LEGO1 0x10003a90
 void Vector3Impl::AddScalarImpl(float p_value)
 {
 	m_data[0] += p_value;
@@ -389,7 +389,7 @@ void Vector3Impl::AddScalarImpl(float p_value)
 	m_data[2] += p_value;
 }

-// OFFSET: LEGO1 0x10003ac0
+// FUNCTION: LEGO1 0x10003ac0
 void Vector3Impl::SubVectorImpl(float* p_value)
 {
 	m_data[0] -= p_value[0];
@@ -397,7 +397,7 @@ void Vector3Impl::SubVectorImpl(float* p_value)
 	m_data[2] -= p_value[2];
 }

-// OFFSET: LEGO1 0x10003af0
+// FUNCTION: LEGO1 0x10003af0
 void Vector3Impl::MullVectorImpl(float* p_value)
 {
 	m_data[0] *= p_value[0];
@@ -405,7 +405,7 @@ void Vector3Impl::MullVectorImpl(float* p_value)
 	m_data[2] *= p_value[2];
 }

-// OFFSET: LEGO1 0x10003b20
+// FUNCTION: LEGO1 0x10003b20
 void Vector3Impl::MullScalarImpl(float* p_value)
 {
 	m_data[0] *= *p_value;
@@ -413,7 +413,7 @@ void Vector3Impl::MullScalarImpl(float* p_value)
 	m_data[2] *= *p_value;
 }

-// OFFSET: LEGO1 0x10003b50
+// FUNCTION: LEGO1 0x10003b50
 void Vector3Impl::DivScalarImpl(float* p_value)
 {
 	m_data[0] /= *p_value;
@@ -421,13 +421,13 @@ void Vector3Impl::DivScalarImpl(float* p_value)
 	m_data[2] /= *p_value;
 }

-// OFFSET: LEGO1 0x10003b80
+// FUNCTION: LEGO1 0x10003b80
 float Vector3Impl::DotImpl(float* p_a, float* p_b) const
 {
 	return p_a[0] * p_b[0] + p_a[2] * p_b[2] + p_a[1] * p_b[1];
 }

-// OFFSET: LEGO1 0x10003ba0
+// FUNCTION: LEGO1 0x10003ba0
 void Vector3Impl::EqualsImpl(float* p_data)
 {
 	float* vec = m_data;
@@ -436,7 +436,7 @@ void Vector3Impl::EqualsImpl(float* p_data)
 	vec[2] = p_data[2];
 }

-// OFFSET: LEGO1 0x10003bc0
+// FUNCTION: LEGO1 0x10003bc0
 void Vector3Impl::Clear()
 {
 	float* vec = m_data;
@@ -445,13 +445,13 @@ void Vector3Impl::Clear()
 	vec[2] = 0.0f;
 }

-// OFFSET: LEGO1 0x10003bd0
+// FUNCTION: LEGO1 0x10003bd0
 float Vector3Impl::LenSquared() const
 {
 	return m_data[1] * m_data[1] + m_data[0] * m_data[0] + m_data[2] * m_data[2];
 }

-// OFFSET: LEGO1 0x10003bf0
+// FUNCTION: LEGO1 0x10003bf0
 void Vector3Impl::EqualsScalar(float* p_value)
 {
 	m_data[0] = *p_value;