Reliable class design

Posted on 2000-02-27
Last Modified: 2013-12-03
Hi dudes,

I'm currently on the learning curve of C++. However, many years of regular C programming leave me with the notion that I may be up to some bad habits... I wonder if you could provide any suggestions...

I'm currently working on a simple hex dump class: It works, but is there a smarter, more bulletproof way of doing it? The way I've designed it is that it takes a constant pointer to a constant byte:

myDump.LookAt((reinterpret_cast<const char * const>(pBuffer)));

Pretty ugly, to say the least. Is it possible to, say, use void pointers to make the LookAt member function accept any type of pointer without the foul casting and no subsequent whining from the compiler?

In addition, the class has these two member functions:

void DumpClass::OutputHex(unsigned char *pszOutput, int nBytesToGet);
void DumpClass::OutputASCII(unsigned char *pszOutput, int nBytesToGet);

These take a pointer to a string and output the corresponding hex dump data to that string, eg.

const int nBytesToGet=16;
char outputbuff[64];
DumpClass myDump;
myDump.OutputHex(outputbuff, nBytesToGet);

It troubles me that it is up to the programmer to make sure that the output buffer is big enough to hold the dump output... What would be a better way?

Since this is really 2 questions, I've doubled the points...

Question by:baldrick
  • 3
  • 3

Author Comment

ID: 2563426
Adjusted points to 200
LVL 22

Accepted Solution

nietod earned 200 total points
ID: 2563460
>> Pretty ugly, to say the least.
Well, there''s not to much that you can do about this.  You are--intentionally--breaking the rules by treating non-character-array data types as character arrays and that is goign to be messy and always a bit risky too.  But that is pretty much unavoidable.  You could use a C-style cast instead of the reinterpret_cast<>.  There is no difference between these except that the reinterpret_cast is uglier and that is intentional.  it is hard to miss and that was the goal.

>> it troubles me that it is up to the programmer
>> to make sure that the output buffer is big
>> enough to hold the dump
>> output... What would be a better way?
Good.  It should trouble you.  You shoudl be prepared to say goodbye to that sort of code and mor importantly to "char *" strings too!  Switch to using a string class, like the STL string.  (Or write your own string class, it is a great learnign experience.)

Then make this procedure return a string.  The string will be as long as is needed to represent the data.  1 character or 10,000 characters.  Much easier for the class's client to use your class that way!  And if the string is reference counted, it is still very efficient to return in this manner.
LVL 22

Expert Comment

ID: 2563468
An example of this would be the STL's global getline() function this reads a line from a file and returns it in a string.  The string will be as long as is needed to return the line (assuming you don't run out of memory).  I might be 0 characters, 1 character, or 10,000 characters.

In your case you would do something like

string DumpClass::OutputHex(int nBytesToGet = 16)
  string S;
  const char *CnvAry = "0123456789ABCDEF";
  while (nBytesToGet--)
     unsigned char Byt = *SomePtr++

     if (S.length())  // If this is not the first character.
        S += ' '; // Add a space after previous char.
     S +=  CnvAry[(Byt >> 4) & 0x0F];
     S+= CnvAry[Byt  & 0x0F];
  return S;

Let me know if you have any questions.
IT, Stop Being Called Into Every Meeting

Highfive is so simple that setting up every meeting room takes just minutes and every employee will be able to start or join a call from any room with ease. Never be called into a meeting just to get it started again. This is how video conferencing should work!


Author Comment

ID: 2563669
Thank you for your prompt answer, which has certainly answered my question (I was afraid you'd recommend using the STL, something I've been a bit lax in learning about).

On the first point about getting rid of the casting: I changed the LookAt parameter type to a constant void pointer and the client no longer needs the cast. Is this a safe thing to do?
LVL 22

Expert Comment

ID: 2564603
Honestly, I wouldn't recommend rushing into the STL. If you are just starting out try doing some of it yourself.  You will learn more and you will also develope an appreciation for the STL if you decide to use it.  (I personally don't use it, except to answer questions here.)  I do recommend you learn ABOUT it at sometime, but not necessarily at the start.  I can't begin to say how important it is to have a good string class and possibly other container classes too, it has so many advantages it would take another 200 points for me to list them, but it doesn't have to be the STL ones.

>> Is this a safe thing to do?
It is not any less safe than what you had.   But basically what you are doing is intrinsically unsafe and may cause problems at times--though you really have no choice.

For example, If you are on a protected mode OS, then this design may be used to try access protected memory or invalid memory addresses and this will result in a crash.  Like if you allocate an object that is 16 bytes in length and try to display it for a length of 32 bytes you don't know what is in the 16 bytes after the object, it may be a protected memory segment and the OS will termiante your app.   Another example might be using this to display the contents of an object that has a virtual base class.  Such an object may not be stored in contiquous bytes in memory (i.e. it may be stored in seperate memory blocks with spaces between tham) so this could be displaying garbage (or again protected memory) when it tries to display parts of the object.

Author Comment

ID: 2565883

Once again, thanks for the great advice and valuable insights.

Featured Post

Free Trending Threat Insights Every Day

Enhance your security with threat intelligence from the web. Get trending threat insights on hackers, exploits, and suspicious IP addresses delivered to your inbox with our free Cyber Daily.

Join & Write a Comment

  Included as part of the C++ Standard Template Library (STL) is a collection of generic containers. Each of these containers serves a different purpose and has different pros and cons. It is often difficult to decide which container to use and …
Go is an acronym of golang, is a programming language developed Google in 2007. Go is a new language that is mostly in the C family, with significant input from Pascal/Modula/Oberon family. Hence Go arisen as low-level language with fast compilation…
The viewer will be introduced to the technique of using vectors in C++. The video will cover how to define a vector, store values in the vector and retrieve data from the values stored in the vector.
The viewer will be introduced to the member functions push_back and pop_back of the vector class. The video will teach the difference between the two as well as how to use each one along with its functionality.

746 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question

Need Help in Real-Time?

Connect with top rated Experts

8 Experts available now in Live!

Get 1:1 Help Now