{"id":56,"date":"2007-08-17T07:57:10","date_gmt":"2007-08-17T11:57:10","guid":{"rendered":"http:\/\/www.jrtwine.com\/blog\/?p=56"},"modified":"2007-09-17T11:21:21","modified_gmt":"2007-09-17T15:21:21","slug":"cstring-misuse-1","status":"publish","type":"post","link":"https:\/\/jrtwine.com\/blog\/cstring-misuse-1\/","title":{"rendered":"CString misuse #1"},"content":{"rendered":"

This is the first of many examples of ways to misuse and\/or abuse MFC’s CString<\/strong> class. While this example (and following ones) are specific to MFC, they likely apply to all string classes (mutable or not). Here is the offending code:<\/p>\n

\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/
\nCString str( \"First Part Of Message\\n\" );
\nstr = str + \"Second Part Of Message\\n\";
\nstr = str + \"Third Part Of Message\";<\/p>\n

MessageBox( str );
\n\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/<\/code><\/p>\n

If you write code like this, stop now and back slowly away from the keyboard – You’re Doing It Wrong!<\/em><\/strong><\/p>\n

First, the developer is adding (concatenating) strings together, but these are static\/constant strings! They always add up to the same string, and as such can be made into a single constant string:<\/p>\n

\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/
\n\"First Part Of Message\\nSecond Part Of Message\\nThird Part Of Message\"
\n\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/<\/code><\/p>\n

So at a minimum, the start of the code should read:<\/p>\n

\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/
\nCString str( \"First Part Of Message\\nSecond Part Of Message\\nThird Part Of Message\" );
\n\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/<\/code><\/p>\n

Why not add up the strings separately like the original code did? Two reasons – overhead and exception opportunity. Each use of CString::operator+(…)<\/strong> can result in dynamic memory operations (allocation and deallocation). So you are looking at six potential heap operations (three potential allocations and deallocations including destruction, although in release builds of CString<\/strong>, the number of operations is less). Each operation has the potential to raise an exception and in the absence of per-thread heaps, can effectively bottleneck a multi-threaded application to the performance of a single-threaded one because the heap operations have to be serialized.<\/p>\n

So by manually putting the strings together we have reduced heap operations from 6 to 2 – one allocation and one deallocation. That is a pretty good improvement, but we can do better!<\/p>\n

The MessageBox(…)<\/strong> function does not take CString<\/strong>s, it takes pointers to constant strings (LPCTSTR<\/strong>). So why is a CString needed here at all? <\/p>\n

\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/
\nMessageBox( \"First Part Of Message\\nSecond Part Of Message\\nThird Part Of Message\" );
\n\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/<\/code><\/p>\n

This final version of the code is simpler, will execute faster, and is more robust. Sounds like a winner to me!<\/p>\n

Note: Some of you may be thinking about the preprocessor’s ability to automatically concatenate static strings. Yes it does, but it cannot automatically coalesce the above strings because they are separate – they are being passed (separately) as parameters to a function. If the +<\/strong> operator was not present in-between the parts of the string, they would be coalesced to a single string, but the unnecessary CString<\/strong> would still be there.<\/p>\n","protected":false},"excerpt":{"rendered":"

This is the first of many examples of ways to misuse and\/or abuse MFC’s CString class. While this example (and following ones) are specific to MFC, they likely apply to all string classes (mutable or not). Here is the offending code: \/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/ CString str( “First Part Of Message\\n” ); str = str + “Second Part […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[4,19],"tags":[],"class_list":["post-56","post","type-post","status-publish","format-standard","hentry","category-developing","category-youre-doing-it-wrong"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t