[CORE] Change StringClass::Peek_Buffer functions to mutable Peek_Buffer and immutable str (#996)

Caball009 · web-flow · commit df099f6bb8c8 · 2025-06-03T17:55:57.000+02:00
diff --git a/Core/Libraries/Source/WWVegas/WW3D2/animatedsoundmgr.cpp b/Core/Libraries/Source/WWVegas/WW3D2/animatedsoundmgr.cpp
@@ -228,7 +228,7 @@ Is_In_Param_List
 			// OutputDebugString( "\n" );
 
 			// if ( stricmp( string.Peek_Buffer(), param_to_check ) == 0 ) // Breaks with whitespaces
-			if ( strstr( string.Peek_Buffer(), param_to_check ) != 0 )
+			if ( strstr( string.str(), param_to_check ) != 0 )
 			{
 			 	return( true );
 			}
@@ -447,7 +447,7 @@ AnimatedSoundMgrClass::Get_Embedded_Sound_Name (HAnimClass *anim)
 		return NULL;
 	}
 
-	return list->BoneName.Peek_Buffer();
+	return list->BoneName.str();
 }
 
 
@@ -527,7 +527,7 @@ AnimatedSoundMgrClass::Trigger_Sound
 						//
 						// Stop the audio
 						//
-						SoundLibrary->Stop_Playing_Audio( sound_list->List[index]->SoundName.Peek_Buffer() );
+						SoundLibrary->Stop_Playing_Audio( sound_list->List[index]->SoundName.str() );
 					}
 					else
 					{
@@ -536,11 +536,11 @@ AnimatedSoundMgrClass::Trigger_Sound
 						//
 						if (sound_list->List[index]->Is2D == true) 
 						{
-							SoundLibrary->Play_2D_Audio(sound_list->List[index]->SoundName.Peek_Buffer());
+							SoundLibrary->Play_2D_Audio(sound_list->List[index]->SoundName.str());
 						} 
 						else 
 						{
-							SoundLibrary->Play_3D_Audio(sound_list->List[index]->SoundName.Peek_Buffer(), tm);
+							SoundLibrary->Play_3D_Audio(sound_list->List[index]->SoundName.str(), tm);
 						}
 					}
 
diff --git a/Core/Libraries/Source/WWVegas/WW3D2/statistics.cpp b/Core/Libraries/Source/WWVegas/WW3D2/statistics.cpp
@@ -113,7 +113,7 @@ static void Record_Texture_End()
 //				if (tfc->Get_Texture_Flash()) flash="F";
 //			}
 
-			working_string.Format("%4.4d  %3.3d   %3.3d     %s ",id,texture_statistics[a].usage_count,texture_statistics[a].change_count,flash.Peek_Buffer());
+			working_string.Format("%4.4d  %3.3d   %3.3d     %s ",id,texture_statistics[a].usage_count,texture_statistics[a].change_count,flash.str());
 			texture_statistics_string+=working_string;
 
 			StringClass error="";
diff --git a/Core/Libraries/Source/WWVegas/WW3D2/w3dexclusionlist.cpp b/Core/Libraries/Source/WWVegas/WW3D2/w3dexclusionlist.cpp
@@ -86,9 +86,9 @@ bool	W3DExclusionListClass::Is_Excluded(HAnimClass * hanim) const
 {
 	// For HAnims, the name to check is the one trailing the '.'
 	StringClass copy = hanim->Get_Name();
-	char * root_name = copy.Peek_Buffer();
+	const char * root_name = copy.str();
 
-	char * tmp = strchr(root_name,'.');
+	const char * tmp = strchr(root_name,'.');
 	if (tmp) {
 		return Is_Excluded(tmp + 1);
 	} else { 
diff --git a/Core/Libraries/Source/WWVegas/WWDebug/wwprofile.cpp b/Core/Libraries/Source/WWVegas/WWDebug/wwprofile.cpp
@@ -202,7 +202,7 @@ void WWProfileHierachyNodeClass::Write_To_File(FileClass* file,int recursion)
 		for (i=0;i<recursion;++i) { string+="\t"; }
 		work.Format("%s\t%d\t%f\r\n",Name,TotalCalls,TotalTime*1000.0f);
 		string+=work;
-		file->Write(string.Peek_Buffer(),string.Get_Length());
+		file->Write(string.str(),string.Get_Length());
 	}
 	if (Child) {
 		Child->Write_To_File(file,recursion+1);
@@ -577,7 +577,7 @@ void	WWProfileManager::End_Collecting(const char* filename)
 				"Total frames: %d, average frame time: %fms\r\n"
 				"All frames taking more than twice the average frame time are marked with keyword SPIKE.\r\n\r\n",
 				ProfileCollectVector.Count(),avg_frame_time*1000.0f);
-			file->Write(str.Peek_Buffer(),str.Get_Length());
+			file->Write(str.str(),str.Get_Length());
 
 			HashTemplateIterator<StringClass,unsigned> ite(ProfileStringHash);
 			for (ite.First();!ite.Is_Done();ite.Next()) {
@@ -591,18 +591,18 @@ void	WWProfileManager::End_Collecting(const char* filename)
 					if (name[i]==';') name[i]=':';
 				}
 				str.Format("ID: %d %s\r\n",ite.Peek_Value(),name);
-				file->Write(str.Peek_Buffer(),str.Get_Length());
+				file->Write(str.str(),str.Get_Length());
 			}
 
 			str.Format("\r\n\r\n");
-			file->Write(str.Peek_Buffer(),str.Get_Length());
+			file->Write(str.str(),str.Get_Length());
 
 			for (i=0;i<ProfileCollectVector.Count();++i) {
 				float frame_time=ProfileCollectVector[i]->Get_Total_Time();
 				str.Format("FRAME: %d %2.2f %s ",i,frame_time*1000.0f,frame_time>avg_frame_time*2.0f ? "SPIKE" : "OK");
 				ProfileCollectVector[i]->Add_To_String_Compact(str,0);
 				str+="\r\n";
-				file->Write(str.Peek_Buffer(),str.Get_Length());
+				file->Write(str.str(),str.Get_Length());
 			}
 		
 			//
diff --git a/Core/Libraries/Source/WWVegas/WWLib/cpudetect.cpp b/Core/Libraries/Source/WWVegas/WWLib/cpudetect.cpp
@@ -792,7 +792,7 @@ void CPUDetectClass::Init_Processor_String()
 			case INTEL_PROCESSOR_PENTIUM4:						str+="Pentium4"; break;
 			}
 		}
-		strncpy(ProcessorString,str.Peek_Buffer(),sizeof(ProcessorString));
+		strncpy(ProcessorString,str.str(),sizeof(ProcessorString));
 	}
 
 }
@@ -959,7 +959,7 @@ void CPUDetectClass::Init_Processor_Log()
 #ifdef WIN32
    SYSLOG(("OS-Info: %s\r\n", OSVersionExtraInfo));
 #elif defined(_UNIX)
-   SYSLOG(("OS-Info: %s\r\n", OSVersionExtraInfo.Peek_Buffer()));
+   SYSLOG(("OS-Info: %s\r\n", OSVersionExtraInfo.str()));
 #endif
 
 	SYSLOG(("Processor: %s\r\n",CPUDetectClass::Get_Processor_String()));
@@ -974,7 +974,7 @@ void CPUDetectClass::Init_Processor_Log()
 #ifdef WIN32
    SYSLOG(("Processor type: %s\r\n", cpu_type));
 #elif defined(_UNIX)
-   SYSLOG(("Processor type: %s\r\n", cpu_type.Peek_Buffer()));
+   SYSLOG(("Processor type: %s\r\n", cpu_type.str()));
 #endif
 
 	SYSLOG(("\r\n"));
diff --git a/Core/Libraries/Source/WWVegas/WWLib/ffactory.cpp b/Core/Libraries/Source/WWVegas/WWLib/ffactory.cpp
@@ -285,7 +285,7 @@ FileClass * SimpleFileFactoryClass::Get_File( char const *filename )
 				const char *tok;
 				while((tok=strtok(tokstart, ";")) != NULL) {
 					tokstart=NULL;
-					new_name.Format("%s%s",tok,stripped_name.Peek_Buffer());
+					new_name.Format("%s%s",tok,stripped_name.str());
 					file->Set_Name( new_name );	// Call Set_Name to force an allocated name
 					if (file->Open()) {
 						file->Close();
diff --git a/Core/Libraries/Source/WWVegas/WWLib/hashtemplate.h b/Core/Libraries/Source/WWVegas/WWLib/hashtemplate.h
@@ -415,7 +415,7 @@ template <class KeyType, class ValueType> inline HashTemplateClass<KeyType,Value
 template <> inline unsigned int HashTemplateKeyClass<StringClass>::Get_Hash_Value(const StringClass& s)
 {
 	unsigned int len=s.Get_Length();
-	unsigned char* buffer=(unsigned char*)s.Peek_Buffer();
+	unsigned const char* buffer=(unsigned const char*)s.str();
 	if (len<8) {
 		unsigned int hval=0;
 		for (unsigned int a=0;a<len;++a) {
diff --git a/Core/Libraries/Source/WWVegas/WWLib/textfile.cpp b/Core/Libraries/Source/WWVegas/WWLib/textfile.cpp
@@ -134,7 +134,7 @@ TextFileClass::Read_Line (StringClass &string)
 	if (retval) {
 		
 		int len				= string.Get_Length ();
-		char *raw_string	= string.Peek_Buffer ();
+		const char *raw_string	= string.str();
 		
 		//
 		// Strip the CR\LF or LF from the string
diff --git a/Core/Libraries/Source/WWVegas/WWLib/wwstring.h b/Core/Libraries/Source/WWVegas/WWLib/wwstring.h
@@ -128,7 +128,7 @@ class StringClass
 
 	TCHAR *		Get_Buffer (int new_length);
 	TCHAR *		Peek_Buffer (void);
-	const TCHAR * Peek_Buffer (void) const;
+	const TCHAR * str (void) const;
 
 	bool Copy_Wide (const WCHAR *source);
 
@@ -562,10 +562,10 @@ StringClass::Peek_Buffer (void)
 }
 
 ///////////////////////////////////////////////////////////////////
-//	Peek_Buffer
+//	str (formerly Peek_Buffer)
 ///////////////////////////////////////////////////////////////////
 inline const TCHAR *
-StringClass::Peek_Buffer (void) const
+StringClass::str (void) const
 {
 	return m_Buffer;
 }
diff --git a/Core/Tools/W3DView/AnimatedSoundOptionsDialog.cpp b/Core/Tools/W3DView/AnimatedSoundOptionsDialog.cpp
@@ -211,7 +211,7 @@ AnimatedSoundOptionsDialogClass::Load_Animated_Sound_Settings (void)
 		file->Close ();
 		_TheFileFactory->Return_File (file);
 	} else {
-		WWDEBUG_SAY (("Failed to load file %s\n", sound_def_lib_path.Peek_Buffer ()));
+		WWDEBUG_SAY (("Failed to load file %s\n", sound_def_lib_path.str ()));
 	}
 
 	//
diff --git a/Generals/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DAssetManager.cpp b/Generals/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DAssetManager.cpp
@@ -977,7 +977,7 @@ bool W3DAssetManager::Load_3D_Assets( const char * filename )
 		{	
 			StringClass lower_case_name(filename,true);
 			_strlwr(lower_case_name.Peek_Buffer());
-			fprintf(logfile,"3D: %s\n",lower_case_name.Peek_Buffer());
+			fprintf(logfile,"3D: %s\n",lower_case_name.str());
 			fclose(logfile);
 		}
 	}
diff --git a/GeneralsMD/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DAssetManager.cpp b/GeneralsMD/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DAssetManager.cpp
@@ -216,7 +216,7 @@ TextureClass *W3DAssetManager::Get_Texture(
 	}
 
 	StringClass lower_case_name(filename,true);
-	_strlwr(lower_case_name.Peek_Buffer());
+	_strlwr(lower_case_name.str());
 
 	/*
 	** See if the texture has already been loaded.
@@ -1009,7 +1009,7 @@ bool W3DAssetManager::Load_3D_Assets( const char * filename )
 		{	
 			StringClass lower_case_name(filename,true);
 			_strlwr(lower_case_name.Peek_Buffer());
-			fprintf(logfile,"3D: %s\n",lower_case_name.Peek_Buffer());
+			fprintf(logfile,"3D: %s\n",lower_case_name.str());
 			fclose(logfile);
 		}
 	}
diff --git a/GeneralsMD/Code/Libraries/Source/WWVegas/WW3D2/dx8renderer.cpp b/GeneralsMD/Code/Libraries/Source/WWVegas/WW3D2/dx8renderer.cpp
@@ -1693,7 +1693,7 @@ void DX8TextureCategoryClass::Render(void)
 
 		for (unsigned i=0;i<MeshMatDescClass::MAX_TEX_STAGES;++i) 
 		{
-			SNAPSHOT_SAY(("Set_Texture(%d,%s)\n",i,Peek_Texture(i) ? Peek_Texture(i)->Get_Texture_Name().Peek_Buffer() : "NULL"));
+			SNAPSHOT_SAY(("Set_Texture(%d,%s)\n",i,Peek_Texture(i) ? Peek_Texture(i)->Get_Texture_Name().str() : "NULL"));
 			DX8Wrapper::Set_Texture(i,Peek_Texture(i));
 		}
 
diff --git a/GeneralsMD/Code/Libraries/Source/WWVegas/WW3D2/dx8wrapper.cpp b/GeneralsMD/Code/Libraries/Source/WWVegas/WW3D2/dx8wrapper.cpp
@@ -2273,7 +2273,7 @@ void DX8Wrapper::Apply_Render_State_Changes()
 	{
 		if (render_state_changed&mask) 
 		{
-			SNAPSHOT_SAY(("DX8 - apply texture %d (%s)\n",i,render_state.Textures[i] ? render_state.Textures[i]->Get_Full_Path().Peek_Buffer() : "NULL"));
+			SNAPSHOT_SAY(("DX8 - apply texture %d (%s)\n",i,render_state.Textures[i] ? render_state.Textures[i]->Get_Full_Path().str() : "NULL"));
 
 			if (render_state.Textures[i]) 
 			{

Original file line number	Diff line number	Diff line change
`@@ -228,7 +228,7 @@ Is_In_Param_List`
`228`	`228`	`// OutputDebugString( "\n" );`
`229`	`229`
`230`	`230`	`// if ( stricmp( string.Peek_Buffer(), param_to_check ) == 0 ) // Breaks with whitespaces`
`231`		`- if ( strstr( string.Peek_Buffer(), param_to_check ) != 0 )`
	`231`	`+ if ( strstr( string.str(), param_to_check ) != 0 )`
`232`	`232`	`{`
`233`	`233`	`return( true );`
`234`	`234`	`}`
`@@ -447,7 +447,7 @@ AnimatedSoundMgrClass::Get_Embedded_Sound_Name (HAnimClass *anim)`
`447`	`447`	`return NULL;`
`448`	`448`	`}`
`449`	`449`
`450`		`- return list->BoneName.Peek_Buffer();`
	`450`	`+ return list->BoneName.str();`
`451`	`451`	`}`
`452`	`452`
`453`	`453`
`@@ -527,7 +527,7 @@ AnimatedSoundMgrClass::Trigger_Sound`
`527`	`527`	`//`
`528`	`528`	`// Stop the audio`
`529`	`529`	`//`
`530`		`- SoundLibrary->Stop_Playing_Audio( sound_list->List[index]->SoundName.Peek_Buffer() );`
	`530`	`+ SoundLibrary->Stop_Playing_Audio( sound_list->List[index]->SoundName.str() );`
`531`	`531`	`}`
`532`	`532`	`else`
`533`	`533`	`{`
`@@ -536,11 +536,11 @@ AnimatedSoundMgrClass::Trigger_Sound`
`536`	`536`	`//`
`537`	`537`	`if (sound_list->List[index]->Is2D == true)`
`538`	`538`	`{`
`539`		`- SoundLibrary->Play_2D_Audio(sound_list->List[index]->SoundName.Peek_Buffer());`
	`539`	`+ SoundLibrary->Play_2D_Audio(sound_list->List[index]->SoundName.str());`
`540`	`540`	`}`
`541`	`541`	`else`
`542`	`542`	`{`
`543`		`- SoundLibrary->Play_3D_Audio(sound_list->List[index]->SoundName.Peek_Buffer(), tm);`
	`543`	`+ SoundLibrary->Play_3D_Audio(sound_list->List[index]->SoundName.str(), tm);`
`544`	`544`	`}`
`545`	`545`	`}`
`546`	`546`
Original file line number	Diff line number	Diff line change
`@@ -792,7 +792,7 @@ void CPUDetectClass::Init_Processor_String()`
`792`	`792`	`case INTEL_PROCESSOR_PENTIUM4: str+="Pentium4"; break;`
`793`	`793`	`}`
`794`	`794`	`}`
`795`		`- strncpy(ProcessorString,str.Peek_Buffer(),sizeof(ProcessorString));`
	`795`	`+ strncpy(ProcessorString,str.str(),sizeof(ProcessorString));`
`796`	`796`	`}`
`797`	`797`
`798`	`798`	`}`
`@@ -959,7 +959,7 @@ void CPUDetectClass::Init_Processor_Log()`
`959`	`959`	`#ifdef WIN32`
`960`	`960`	`SYSLOG(("OS-Info: %s\r\n", OSVersionExtraInfo));`
`961`	`961`	`#elif defined(_UNIX)`
`962`		`- SYSLOG(("OS-Info: %s\r\n", OSVersionExtraInfo.Peek_Buffer()));`
	`962`	`+ SYSLOG(("OS-Info: %s\r\n", OSVersionExtraInfo.str()));`
`963`	`963`	`#endif`
`964`	`964`
`965`	`965`	`SYSLOG(("Processor: %s\r\n",CPUDetectClass::Get_Processor_String()));`
`@@ -974,7 +974,7 @@ void CPUDetectClass::Init_Processor_Log()`
`974`	`974`	`#ifdef WIN32`
`975`	`975`	`SYSLOG(("Processor type: %s\r\n", cpu_type));`
`976`	`976`	`#elif defined(_UNIX)`
`977`		`- SYSLOG(("Processor type: %s\r\n", cpu_type.Peek_Buffer()));`
	`977`	`+ SYSLOG(("Processor type: %s\r\n", cpu_type.str()));`
`978`	`978`	`#endif`
`979`	`979`
`980`	`980`	`SYSLOG(("\r\n"));`
Original file line number	Diff line number	Diff line change
`@@ -415,7 +415,7 @@ template <class KeyType, class ValueType> inline HashTemplateClass<KeyType,Value`
`415`	`415`	`template <> inline unsigned int HashTemplateKeyClass<StringClass>::Get_Hash_Value(const StringClass& s)`
`416`	`416`	`{`
`417`	`417`	`unsigned int len=s.Get_Length();`
`418`		`- unsigned char* buffer=(unsigned char*)s.Peek_Buffer();`
	`418`	`+ unsigned const char* buffer=(unsigned const char*)s.str();`
`419`	`419`	`if (len<8) {`
`420`	`420`	`unsigned int hval=0;`
`421`	`421`	`for (unsigned int a=0;a<len;++a) {`
Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ class StringClass`
`128`	`128`
`129`	`129`	`TCHAR * Get_Buffer (int new_length);`
`130`	`130`	`TCHAR * Peek_Buffer (void);`
`131`		`- const TCHAR * Peek_Buffer (void) const;`
	`131`	`+ const TCHAR * str (void) const;`
`132`	`132`
`133`	`133`	`bool Copy_Wide (const WCHAR *source);`
`134`	`134`
`@@ -562,10 +562,10 @@ StringClass::Peek_Buffer (void)`
`562`	`562`	`}`
`563`	`563`
`564`	`564`	`///////////////////////////////////////////////////////////////////`
`565`		`-// Peek_Buffer`
	`565`	`+// str (formerly Peek_Buffer)`
`566`	`566`	`///////////////////////////////////////////////////////////////////`
`567`	`567`	`inline const TCHAR *`
`568`		`-StringClass::Peek_Buffer (void) const`
	`568`	`+StringClass::str (void) const`
`569`	`569`	`{`
`570`	`570`	`return m_Buffer;`
`571`	`571`	`}`
Original file line number	Diff line number	Diff line change
`@@ -211,7 +211,7 @@ AnimatedSoundOptionsDialogClass::Load_Animated_Sound_Settings (void)`
`211`	`211`	`file->Close ();`
`212`	`212`	`_TheFileFactory->Return_File (file);`
`213`	`213`	`} else {`
`214`		`- WWDEBUG_SAY (("Failed to load file %s\n", sound_def_lib_path.Peek_Buffer ()));`
	`214`	`+ WWDEBUG_SAY (("Failed to load file %s\n", sound_def_lib_path.str ()));`
`215`	`215`	`}`
`216`	`216`
`217`	`217`	`//`