renderer: rewrite GLimp_LogComment() calls

[illwieckz]

Rewrite GLimp_LogComment() calls.

Also don't require an ending \n on every call.

Also only call GLimp_LogComment() when the function doesn't return early.

No more noisy:

if ( r_logFile->integer )
{
	GLimp_LogComment( va( "bla: %d\n", bla ) );
}

if ( condition )
{
	return;
}

Just this:

if ( condition )
{
	return;
}

GLIMP_LOGCOMMENT( "bla: %d", bla );

Edit: GLIMP_LOGCOMMENT() is a macro wrapping both the if ( r_logFile->integer ) test and a Str::Format() call.

[DolceTriade]

Hm, maybe reaper and slipher can disagree, but I'm not sure I agree with the premise of the PR.

Keep in mind that your change isn't 1:1 with the old behavior.

GLimp_LogComment("%d", SomeVeryExpensiveCall())

SomeVeryExpensiveCall will now be run unconditionally. We do have DoDebugCode for this reason, but in that case, I'd like to see all calls to GLimp_LogComment wrapped in that function (which from a noisy-ness perspective, does not really get us much).

[illwieckz]

@DolceTriade this is the part you look for:

inline bool GLimp_isLogging() {
	return r_logFile.Get() && GLEW_ARB_debug_output;
}

#define GLimp_LogComment( ... ) { \
	if ( GLimp_isLogging() ) \
	{ \
		GLimp_LogComment_( Str::Format( __VA_ARGS__ ) ); \
	} \
}

[illwieckz]

Well, I can rename GLimp_LogComment as upper case GLIMP_LOGCOMMENT to hint this is now a macro.

[illwieckz]

Well, I can rename GLimp_LogComment as upper case GLIMP_LOGCOMMENT to hint this is now a macro.

Now done.

[illwieckz]

I also added a commit asserting that the GLimp_LogComment() function is never called directly and not wrapped by GLIMP_LOGCOMMENT().

There is actually one place where we can call it directly, but the extra calls of GLimp_isLogging() will be optimized out by the compiler anyway.

So we better make sure GLIMP_LOGCOMMENT() is always used instead.

[DolceTriade]

I see. I missed that it was converted into a macro

[illwieckz]

I see. I missed that it was converted into a macro

My fault, I forgot to mention it in the first post. 😊️

[VReaperV]

LGTM