Replace internal 'dsc' with public 'paramdsc' in the API. So far they're binary compatible and this breaks nothing. But it prevents problems when 'dsc' is to be extended.

dyemanov · dyemanov · commit 04081105d2e9 · 2025-03-27T14:57:26.000+03:00
diff --git a/src/common/dsc.h b/src/common/dsc.h
@@ -512,7 +512,19 @@ typedef struct dsc
 		d.dsc_length = dsc_length;
 		d.dsc_sub_type = dsc_sub_type;
 		d.dsc_flags = dsc_flags;
-		d.dsc_offset = (ULONG)(IPTR)dsc_address;
+		d.dsc_offset = (ULONG)(IPTR) dsc_address;
+		return d;
+	}
+
+	operator paramdsc() const
+	{
+		paramdsc d;
+		d.dsc_dtype = dsc_dtype;
+		d.dsc_scale = dsc_scale;
+		d.dsc_length = dsc_length;
+		d.dsc_sub_type = dsc_sub_type;
+		d.dsc_flags = dsc_flags;
+		d.dsc_address = dsc_address;
 		return d;
 	}
 
diff --git a/src/include/firebird/FirebirdInterface.idl b/src/include/firebird/FirebirdInterface.idl
@@ -1303,7 +1303,7 @@ interface XpbBuilder : Disposable
 // Database trace objects
 
 struct PerformanceInfo;
-struct dsc;
+struct paramdsc;
 
 interface TraceConnection : Versioned
 {
@@ -1350,7 +1350,7 @@ version: // 3.0.4 -> 3.0.5
 interface TraceParams : Versioned
 {
 	uint getCount();
-	const dsc* getParam(uint idx);
+	const paramdsc* getParam(uint idx);
 
 version:
 	const string getTextUTF8(Status status, uint idx);
diff --git a/src/include/firebird/IdlFbInterfaces.h b/src/include/firebird/IdlFbInterfaces.h
@@ -5477,7 +5477,7 @@ namespace Firebird
 		struct VTable : public IVersioned::VTable
 		{
 			unsigned (CLOOP_CARG *getCount)(ITraceParams* self) CLOOP_NOEXCEPT;
-			const dsc* (CLOOP_CARG *getParam)(ITraceParams* self, unsigned idx) CLOOP_NOEXCEPT;
+			const paramdsc* (CLOOP_CARG *getParam)(ITraceParams* self, unsigned idx) CLOOP_NOEXCEPT;
 			const char* (CLOOP_CARG *getTextUTF8)(ITraceParams* self, IStatus* status, unsigned idx) CLOOP_NOEXCEPT;
 		};
 
@@ -5500,9 +5500,9 @@ namespace Firebird
 			return ret;
 		}
 
-		const dsc* getParam(unsigned idx)
+		const paramdsc* getParam(unsigned idx)
 		{
-			const dsc* ret = static_cast<VTable*>(this->cloopVTable)->getParam(this, idx);
+			const paramdsc* ret = static_cast<VTable*>(this->cloopVTable)->getParam(this, idx);
 			return ret;
 		}
 
@@ -17551,7 +17551,7 @@ namespace Firebird
 			}
 		}
 
-		static const dsc* CLOOP_CARG cloopgetParamDispatcher(ITraceParams* self, unsigned idx) CLOOP_NOEXCEPT
+		static const paramdsc* CLOOP_CARG cloopgetParamDispatcher(ITraceParams* self, unsigned idx) CLOOP_NOEXCEPT
 		{
 			try
 			{
@@ -17560,7 +17560,7 @@ namespace Firebird
 			catch (...)
 			{
 				StatusType::catchException(0);
-				return static_cast<const dsc*>(0);
+				return static_cast<const paramdsc*>(0);
 			}
 		}
 
@@ -17594,7 +17594,7 @@ namespace Firebird
 		}
 
 		virtual unsigned getCount() = 0;
-		virtual const dsc* getParam(unsigned idx) = 0;
+		virtual const paramdsc* getParam(unsigned idx) = 0;
 		virtual const char* getTextUTF8(StatusType* status, unsigned idx) = 0;
 	};
 
diff --git a/src/include/gen/Firebird.pas b/src/include/gen/Firebird.pas
@@ -207,7 +207,7 @@ 	ISC_TIMESTAMP_TZ_EX = record
 	IntegerPtr = ^Integer;
 	NativeIntPtr = ^NativeInt;
 	PerformanceInfoPtr = ^PerformanceInfo;
-	dscPtr = ^dsc;
+	paramdscPtr = ^paramdsc;
 
 	IReferenceCounted_addRefPtr = procedure(this: IReferenceCounted); cdecl;
 	IReferenceCounted_releasePtr = function(this: IReferenceCounted): Integer; cdecl;
@@ -607,7 +607,7 @@ 	ISC_TIMESTAMP_TZ_EX = record
 	ITraceTransaction_getInitialIDPtr = function(this: ITraceTransaction): Int64; cdecl;
 	ITraceTransaction_getPreviousIDPtr = function(this: ITraceTransaction): Int64; cdecl;
 	ITraceParams_getCountPtr = function(this: ITraceParams): Cardinal; cdecl;
-	ITraceParams_getParamPtr = function(this: ITraceParams; idx: Cardinal): dscPtr; cdecl;
+	ITraceParams_getParamPtr = function(this: ITraceParams; idx: Cardinal): paramdscPtr; cdecl;
 	ITraceParams_getTextUTF8Ptr = function(this: ITraceParams; status: IStatus; idx: Cardinal): PAnsiChar; cdecl;
 	ITraceStatement_getStmtIDPtr = function(this: ITraceStatement): Int64; cdecl;
 	ITraceStatement_getPerfPtr = function(this: ITraceStatement): PerformanceInfoPtr; cdecl;
@@ -3067,15 +3067,15 @@ 	ITraceParams = class(IVersioned)
 		const VERSION = 3;
 
 		function getCount(): Cardinal;
-		function getParam(idx: Cardinal): dscPtr;
+		function getParam(idx: Cardinal): paramdscPtr;
 		function getTextUTF8(status: IStatus; idx: Cardinal): PAnsiChar;
 	end;
 
 	ITraceParamsImpl = class(ITraceParams)
 		constructor create;
 
 		function getCount(): Cardinal; virtual; abstract;
-		function getParam(idx: Cardinal): dscPtr; virtual; abstract;
+		function getParam(idx: Cardinal): paramdscPtr; virtual; abstract;
 		function getTextUTF8(status: IStatus; idx: Cardinal): PAnsiChar; virtual; abstract;
 	end;
 
@@ -8969,7 +8969,7 @@ function ITraceParams.getCount(): Cardinal;
 	Result := TraceParamsVTable(vTable).getCount(Self);
 end;
 
-function ITraceParams.getParam(idx: Cardinal): dscPtr;
+function ITraceParams.getParam(idx: Cardinal): paramdscPtr;
 begin
 	Result := TraceParamsVTable(vTable).getParam(Self, idx);
 end;
@@ -15196,7 +15196,7 @@ function ITraceParamsImpl_getCountDispatcher(this: ITraceParams): Cardinal; cdec
 	end
 end;
 
-function ITraceParamsImpl_getParamDispatcher(this: ITraceParams; idx: Cardinal): dscPtr; cdecl;
+function ITraceParamsImpl_getParamDispatcher(this: ITraceParams; idx: Cardinal): paramdscPtr; cdecl;
 begin
 	Result := nil;
 	try
diff --git a/src/jrd/trace/TraceObjects.cpp b/src/jrd/trace/TraceObjects.cpp
@@ -61,7 +61,7 @@ namespace
 
 // Convert text descriptor into UTF8 string.
 // Binary data converted into HEX representation.
-bool descToUTF8(const dsc* param, string& result)
+bool descToUTF8(const paramdsc* param, string& result)
 {
 	UCHAR* address;
 	USHORT length;
@@ -83,7 +83,7 @@ bool descToUTF8(const dsc* param, string& result)
 		return false;
 	}
 
-	if (param->getCharSet() == CS_BINARY)
+	if (param->dsc_sub_type == CS_BINARY)
 	{
 		// Convert OCTETS and [VAR]BINARY to HEX string
 
@@ -311,14 +311,11 @@ void TraceSQLStatementImpl::DSQLParamsImpl::fillParams()
 					null_flag = DSC_null;
 			}
 
-			dsc* desc = NULL;
-
 			const FB_SIZE_T idx = parameter->par_index - 1;
 			if (idx >= m_descs.getCount())
 				m_descs.getBuffer(idx + 1);
 
-			desc = &m_descs[idx];
-
+			paramdsc* const desc = &m_descs[idx];
 			*desc = parameter->par_desc;
 			desc->dsc_flags |= null_flag;
 
@@ -335,19 +332,19 @@ FB_SIZE_T TraceSQLStatementImpl::DSQLParamsImpl::getCount()
 	return m_descs.getCount();
 }
 
-const dsc* TraceSQLStatementImpl::DSQLParamsImpl::getParam(FB_SIZE_T idx)
+const paramdsc* TraceSQLStatementImpl::DSQLParamsImpl::getParam(FB_SIZE_T idx)
 {
 	fillParams();
 
-	if (idx >= 0 && idx < m_descs.getCount())
+	if (idx < m_descs.getCount())
 		return &m_descs[idx];
 
 	return NULL;
 }
 
 const char* TraceSQLStatementImpl::DSQLParamsImpl::getTextUTF8(CheckStatusWrapper* status, FB_SIZE_T idx)
 {
-	const dsc* param = getParam(idx);
+	const paramdsc* const param = getParam(idx);
 
 	if (descToUTF8(param, m_tempUTF8))
 		return m_tempUTF8.c_str();
@@ -377,14 +374,14 @@ FB_SIZE_T TraceParamsImpl::getCount()
 	return m_descs->getCount();
 }
 
-const dsc* TraceParamsImpl::getParam(FB_SIZE_T idx)
+const paramdsc* TraceParamsImpl::getParam(FB_SIZE_T idx)
 {
 	return m_descs->getParam(idx);
 }
 
 const char* TraceParamsImpl::getTextUTF8(CheckStatusWrapper* status, FB_SIZE_T idx)
 {
-	const dsc* param = getParam(idx);
+	const paramdsc* const param = getParam(idx);
 
 	if (descToUTF8(param, m_tempUTF8))
 		return m_tempUTF8.c_str();
@@ -465,7 +462,7 @@ void TraceDscFromMsg::fillParams()
 	const dsc* fmtDesc = m_format->fmt_desc.begin();
 	const dsc* const fmtEnd = m_format->fmt_desc.end();
 
-	dsc* desc = m_descs.getBuffer(m_format->fmt_count / 2);
+	paramdsc* desc = m_descs.getBuffer(m_format->fmt_count / 2);
 
 	for (; fmtDesc < fmtEnd; fmtDesc += 2, desc++)
 	{
@@ -477,7 +474,7 @@ void TraceDscFromMsg::fillParams()
 		const ULONG nullOffset = (IPTR) fmtDesc[1].dsc_address;
 		const SSHORT* const nullPtr = (const SSHORT*) (m_inMsg + nullOffset);
 		if (*nullPtr == -1)
-			desc->setNull();
+			desc->dsc_flags |= DSC_null;
 	}
 }
 
diff --git a/src/jrd/trace/TraceObjects.h b/src/jrd/trace/TraceObjects.h
@@ -258,15 +258,15 @@ class TraceSQLStatementImpl :
 		}
 
 		FB_SIZE_T getCount();
-		const dsc* getParam(FB_SIZE_T idx);
+		const paramdsc* getParam(FB_SIZE_T idx);
 		const char* getTextUTF8(Firebird::CheckStatusWrapper* status, FB_SIZE_T idx);
 
 	private:
 		void fillParams();
 
 		DsqlRequest* const m_stmt;
 		const Firebird::Array<dsql_par*>* m_params = nullptr;
-		Firebird::HalfStaticArray<dsc, 16> m_descs;
+		Firebird::HalfStaticArray<paramdsc, 16> m_descs;
 		Firebird::string m_tempUTF8;
 	};
 
@@ -335,7 +335,7 @@ class TraceParamsImpl :
 
 	// TraceParams implementation
 	FB_SIZE_T getCount();
-	const dsc* getParam(FB_SIZE_T idx);
+	const paramdsc* getParam(FB_SIZE_T idx);
 	const char* getTextUTF8(Firebird::CheckStatusWrapper* status, FB_SIZE_T idx);
 
 private:
@@ -358,11 +358,11 @@ class TraceDescriptors
 		return m_descs.getCount();
 	}
 
-	const dsc* getParam(FB_SIZE_T idx)
+	const paramdsc* getParam(FB_SIZE_T idx)
 	{
 		fillParams();
 
-		if (/*idx >= 0 &&*/ idx < m_descs.getCount())
+		if (idx < m_descs.getCount())
 			return &m_descs[idx];
 
 		return NULL;
@@ -376,7 +376,7 @@ class TraceDescriptors
 protected:
 	virtual void fillParams() = 0;
 
-	Firebird::HalfStaticArray<dsc, 16> m_descs;
+	Firebird::HalfStaticArray<paramdsc, 16> m_descs;
 
 private:
 	TraceParamsImpl	m_traceParams;
@@ -429,7 +429,7 @@ class TraceDscFromDsc : public TraceDescriptors
 		else
 		{
 			m_descs.grow(1);
-			m_descs[0].setNull();
+			m_descs[0].dsc_flags |= DSC_null;
 		}
 	}
 
diff --git a/src/utilities/ntrace/TracePluginImpl.cpp b/src/utilities/ntrace/TracePluginImpl.cpp
@@ -815,7 +815,7 @@ void TracePluginImpl::appendParams(ITraceParams* params)
 
 	for (FB_SIZE_T i = 0; i < paramcount; i++)
 	{
-		const struct dsc* parameters = params->getParam(i);
+		const paramdsc* const parameters = params->getParam(i);
 
 		// See if we need to print any more arguments
 		if (config.max_arg_count && i >= config.max_arg_count)
@@ -829,7 +829,7 @@ void TracePluginImpl::appendParams(ITraceParams* params)
 		switch (parameters->dsc_dtype)
 		{
 			case dtype_text:
-				if (parameters->getTextType() == fb_text_subtype_binary)
+				if (parameters->dsc_sub_type == fb_text_subtype_binary)
 					paramtype.printf("binary(%d)", parameters->dsc_length);
 				else
 					paramtype.printf("char(%d)", parameters->dsc_length);
@@ -838,7 +838,7 @@ void TracePluginImpl::appendParams(ITraceParams* params)
 				paramtype.printf("cstring(%d)", parameters->dsc_length - 1);
 				break;
 			case dtype_varying:
-				if (parameters->getTextType() == fb_text_subtype_binary)
+				if (parameters->dsc_sub_type == fb_text_subtype_binary)
 					paramtype.printf("varbinary(%d)", parameters->dsc_length - 2);
 				else
 					paramtype.printf("varchar(%d)", parameters->dsc_length - 2);

Original file line number	Diff line number	Diff line change
`@@ -1303,7 +1303,7 @@ interface XpbBuilder : Disposable`
`1303`	`1303`	`// Database trace objects`
`1304`	`1304`
`1305`	`1305`	`struct PerformanceInfo;`
`1306`		`-struct dsc;`
	`1306`	`+struct paramdsc;`
`1307`	`1307`
`1308`	`1308`	`interface TraceConnection : Versioned`
`1309`	`1309`	`{`
`@@ -1350,7 +1350,7 @@ version: // 3.0.4 -> 3.0.5`
`1350`	`1350`	`interface TraceParams : Versioned`
`1351`	`1351`	`{`
`1352`	`1352`	`uint getCount();`
`1353`		`- const dsc* getParam(uint idx);`
	`1353`	`+ const paramdsc* getParam(uint idx);`
`1354`	`1354`
`1355`	`1355`	`version:`
`1356`	`1356`	`const string getTextUTF8(Status status, uint idx);`
Original file line number	Diff line number	Diff line change
`@@ -5477,7 +5477,7 @@ namespace Firebird`
`5477`	`5477`	`struct VTable : public IVersioned::VTable`
`5478`	`5478`	`{`
`5479`	`5479`	`unsigned (CLOOP_CARG getCount)(ITraceParams self) CLOOP_NOEXCEPT;`
`5480`		`- const dsc* (CLOOP_CARG getParam)(ITraceParams self, unsigned idx) CLOOP_NOEXCEPT;`
	`5480`	`+ const paramdsc* (CLOOP_CARG getParam)(ITraceParams self, unsigned idx) CLOOP_NOEXCEPT;`
`5481`	`5481`	`const char* (CLOOP_CARG getTextUTF8)(ITraceParams self, IStatus* status, unsigned idx) CLOOP_NOEXCEPT;`
`5482`	`5482`	`};`
`5483`	`5483`
`@@ -5500,9 +5500,9 @@ namespace Firebird`
`5500`	`5500`	`return ret;`
`5501`	`5501`	`}`
`5502`	`5502`
`5503`		`- const dsc* getParam(unsigned idx)`
	`5503`	`+ const paramdsc* getParam(unsigned idx)`
`5504`	`5504`	`{`
`5505`		`- const dsc* ret = static_cast<VTable*>(this->cloopVTable)->getParam(this, idx);`
	`5505`	`+ const paramdsc* ret = static_cast<VTable*>(this->cloopVTable)->getParam(this, idx);`
`5506`	`5506`	`return ret;`
`5507`	`5507`	`}`
`5508`	`5508`
`@@ -17551,7 +17551,7 @@ namespace Firebird`
`17551`	`17551`	`}`
`17552`	`17552`	`}`
`17553`	`17553`
`17554`		`- static const dsc* CLOOP_CARG cloopgetParamDispatcher(ITraceParams* self, unsigned idx) CLOOP_NOEXCEPT`
	`17554`	`+ static const paramdsc* CLOOP_CARG cloopgetParamDispatcher(ITraceParams* self, unsigned idx) CLOOP_NOEXCEPT`
`17555`	`17555`	`{`
`17556`	`17556`	`try`
`17557`	`17557`	`{`
`@@ -17560,7 +17560,7 @@ namespace Firebird`
`17560`	`17560`	`catch (...)`
`17561`	`17561`	`{`
`17562`	`17562`	`StatusType::catchException(0);`
`17563`		`- return static_cast<const dsc*>(0);`
	`17563`	`+ return static_cast<const paramdsc*>(0);`
`17564`	`17564`	`}`
`17565`	`17565`	`}`
`17566`	`17566`
`@@ -17594,7 +17594,7 @@ namespace Firebird`
`17594`	`17594`	`}`
`17595`	`17595`
`17596`	`17596`	`virtual unsigned getCount() = 0;`
`17597`		`- virtual const dsc* getParam(unsigned idx) = 0;`
	`17597`	`+ virtual const paramdsc* getParam(unsigned idx) = 0;`
`17598`	`17598`	`virtual const char* getTextUTF8(StatusType* status, unsigned idx) = 0;`
`17599`	`17599`	`};`
`17600`	`17600`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ namespace`
`61`	`61`
`62`	`62`	`// Convert text descriptor into UTF8 string.`
`63`	`63`	`// Binary data converted into HEX representation.`
`64`		`-bool descToUTF8(const dsc* param, string& result)`
	`64`	`+bool descToUTF8(const paramdsc* param, string& result)`
`65`	`65`	`{`
`66`	`66`	`UCHAR* address;`
`67`	`67`	`USHORT length;`
`@@ -83,7 +83,7 @@ bool descToUTF8(const dsc* param, string& result)`
`83`	`83`	`return false;`
`84`	`84`	`}`
`85`	`85`
`86`		`- if (param->getCharSet() == CS_BINARY)`
	`86`	`+ if (param->dsc_sub_type == CS_BINARY)`
`87`	`87`	`{`
`88`	`88`	`// Convert OCTETS and [VAR]BINARY to HEX string`
`89`	`89`
`@@ -311,14 +311,11 @@ void TraceSQLStatementImpl::DSQLParamsImpl::fillParams()`
`311`	`311`	`null_flag = DSC_null;`
`312`	`312`	`}`
`313`	`313`
`314`		`- dsc* desc = NULL;`
`315`		`-`
`316`	`314`	`const FB_SIZE_T idx = parameter->par_index - 1;`
`317`	`315`	`if (idx >= m_descs.getCount())`
`318`	`316`	`m_descs.getBuffer(idx + 1);`
`319`	`317`
`320`		`- desc = &m_descs[idx];`
`321`		`-`
	`318`	`+ paramdsc* const desc = &m_descs[idx];`
`322`	`319`	`*desc = parameter->par_desc;`
`323`	`320`	`desc->dsc_flags \|= null_flag;`
`324`	`321`
`@@ -335,19 +332,19 @@ FB_SIZE_T TraceSQLStatementImpl::DSQLParamsImpl::getCount()`
`335`	`332`	`return m_descs.getCount();`
`336`	`333`	`}`
`337`	`334`
`338`		`-const dsc* TraceSQLStatementImpl::DSQLParamsImpl::getParam(FB_SIZE_T idx)`
	`335`	`+const paramdsc* TraceSQLStatementImpl::DSQLParamsImpl::getParam(FB_SIZE_T idx)`
`339`	`336`	`{`
`340`	`337`	`fillParams();`
`341`	`338`
`342`		`- if (idx >= 0 && idx < m_descs.getCount())`
	`339`	`+ if (idx < m_descs.getCount())`
`343`	`340`	`return &m_descs[idx];`
`344`	`341`
`345`	`342`	`return NULL;`
`346`	`343`	`}`
`347`	`344`
`348`	`345`	`const char* TraceSQLStatementImpl::DSQLParamsImpl::getTextUTF8(CheckStatusWrapper* status, FB_SIZE_T idx)`
`349`	`346`	`{`
`350`		`- const dsc* param = getParam(idx);`
	`347`	`+ const paramdsc* const param = getParam(idx);`
`351`	`348`
`352`	`349`	`if (descToUTF8(param, m_tempUTF8))`
`353`	`350`	`return m_tempUTF8.c_str();`
`@@ -377,14 +374,14 @@ FB_SIZE_T TraceParamsImpl::getCount()`
`377`	`374`	`return m_descs->getCount();`
`378`	`375`	`}`
`379`	`376`
`380`		`-const dsc* TraceParamsImpl::getParam(FB_SIZE_T idx)`
	`377`	`+const paramdsc* TraceParamsImpl::getParam(FB_SIZE_T idx)`
`381`	`378`	`{`
`382`	`379`	`return m_descs->getParam(idx);`
`383`	`380`	`}`
`384`	`381`
`385`	`382`	`const char* TraceParamsImpl::getTextUTF8(CheckStatusWrapper* status, FB_SIZE_T idx)`
`386`	`383`	`{`
`387`		`- const dsc* param = getParam(idx);`
	`384`	`+ const paramdsc* const param = getParam(idx);`
`388`	`385`
`389`	`386`	`if (descToUTF8(param, m_tempUTF8))`
`390`	`387`	`return m_tempUTF8.c_str();`
`@@ -465,7 +462,7 @@ void TraceDscFromMsg::fillParams()`
`465`	`462`	`const dsc* fmtDesc = m_format->fmt_desc.begin();`
`466`	`463`	`const dsc* const fmtEnd = m_format->fmt_desc.end();`
`467`	`464`
`468`		`- dsc* desc = m_descs.getBuffer(m_format->fmt_count / 2);`
	`465`	`+ paramdsc* desc = m_descs.getBuffer(m_format->fmt_count / 2);`
`469`	`466`
`470`	`467`	`for (; fmtDesc < fmtEnd; fmtDesc += 2, desc++)`
`471`	`468`	`{`
`@@ -477,7 +474,7 @@ void TraceDscFromMsg::fillParams()`
`477`	`474`	`const ULONG nullOffset = (IPTR) fmtDesc[1].dsc_address;`
`478`	`475`	`const SSHORT* const nullPtr = (const SSHORT*) (m_inMsg + nullOffset);`
`479`	`476`	`if (*nullPtr == -1)`
`480`		`- desc->setNull();`
	`477`	`+ desc->dsc_flags \|= DSC_null;`
`481`	`478`	`}`
`482`	`479`	`}`
`483`	`480`