Click here to Skip to main content
Click here to Skip to main content

Sealing Classes in C++

By , 2 Sep 2009
 

Introduction

Some recent languages like C# and Java allow you to seal your classes easily using a keyword like sealed or final respectively. C++ doesn't have any such keyword for this purpose. However, it's possible to still do it using a trick. When using virtual inheritance, the initialization list of the most-derived-class's constructor directly invokes the virtual base class's constructor. This means that if we can hide access to the virtual base class's constructor, then we can prevent any class from deriving from it. This mimics the effect of being sealed.

Solution Attempt #1

To provide an easy way to seal classes, we can write a header file Sealed.h like this:

class SealedBase
{
protected:
    SealedBase()
    {
    }
};

#define Sealed private virtual SealedBase 

Now to seal a class, say Penguin, we just need to derive it from Sealed, like this:

#include "Sealed.h"

class Penguin : Sealed
{
}; 

That's it. Penguin is now a sealed class. Let's try deriving another class, BigZ (Surf's Up (2007), anyone?) from Penguin

class BigZ : Penguin
{
};

BigZ bigZ; // error C2248 

Instantiating an object of BigZ should yield a compiler error. The MSVC++ 2005 compiler gives me the following error message:

error C2248: 'SealedBase::SealedBase' : cannot access inaccessible member 
declared in class 'SealedBase'

A Serious Flaw

All seems to be working well. However, one of my fellow programmers, Angelo Rohit, pointed out to me that this method has a serious flaw in it. Angelo says that if BigZ derives from Penguin and Sealed, then it will be possible to create objects of BigZ:

class BigZ : Penguin, Sealed
{
};

BigZ bigZ; // OK; no compiler error 

Why does this happen? BigZ derives from Sealed just like Penguin does, which means that it now has access to Sealed's constructor. And since Sealed is inherited virtually by both Penguin and BigZ, there is only one copy of it - which is now also accessible to BigZ. Bummer. We need to have a mechanism by which BigZ is forced to call the constructor of a class which it doesn't have access to.

Solution Attempt #2

After pondering over this for a while, I realized that if we can somehow generate different base classes every time Sealed is derived from, then it would work.

Let's rewrite the Sealed.h header to look like this:

template <int T>
class SealedBase
{
protected:
    SealedBase()
    {
    }
};

#define Sealed private virtual SealedBase<__COUNTER__>

What does this do? SealedBase is now a templated class which takes an integer as an argument. __COUNTER__ is a predefined macro which expands to an integer starting with 0 and incrementing by 1 every time it is used in a compiland. So every time Sealed is derived from, it generates a new SealedBase class using the incremental number which __COUNTER__ expands to.

Now let's go back to our BigZ class which derives from both Penguin and Sealed:

class BigZ : Penguin, Sealed
{
};

BigZ bigZ; // error C2248

This time around though, BigZ can't escape from the compiler. Penguin derives from SealedBase<number1> and BigZ derives from SealedBase<number2>, where number1 and number2 are two non-identical integers. So now BigZ has to invoke the constructor of SealedBase<number1>, which it doesn't have access to.

The MSVC++ 2005 compiler gives me the following error message:

error C2248: 'SealedBase<T>::SealedBase' : cannot access inaccessible member 
declared in class 'SealedBase<T>'
1> with
1> [
1> T=0
1> ]

Portability Issues

However, you might be thinking that since we're using a special predefined macro __COUNTER__ in our implementation, this code is not portable. Well, it's supported by MSVC++ (which I used to test the above code) and also by GCC (http://www.gnu.org/software/gcc/gcc-4.3/changes.html).

But what about compilers which don't?

A Portable Solution 

After a little thought, I came up with the following way:

In Sealed.h:

template <class T>
class SealedBase
{
protected:
    SealedBase()
    {
    }
};

#define Sealed(_CLASS_NAME_) private virtual SealedBase<_CLASS_NAME_>

And to seal a class:

#include "Sealed.h"

class Penguin : Sealed(Penguin)
{
};

When sealing a class, we need to mention that class's name to the Sealed macro. This enables the Sealed macro to generate a new version of SealedBase. This is less elegant than simply having to derive from Sealed, but is more portable, making it a good alternative for compilers which don't support the __COUNTER__ predefined macro.

Final Words

People who use MSVC++ or GCC can simply use Solution Attempt #2, as it is cleaner. People on other compilers, can use the Portable Solution. If you have any questions, suggestions, improvements, or simply want to say hi, please email me.

Thanks for reading!
Francis Xavier

References

  1. C++ Q&A: List View Mode, SetForegroundWindow, and Class Protection
  2. Vladislav Lazarenko: "[boost] Sealed C++ class"

History

  • 2nd September, 2009: Initial post

License

This article, along with any associated source code and files, is licensed under The MIT License

About the Author

FrancisXavier
Software Developer
India India
Member
Francis Xavier likes to watch sci-fi/fantasy movies, listen to rock music, play video-games, and hang out with his better half. After being exposed to a few video-games, he developed an interest in computer programming. He currently holds a Bachelor's degree in Computer Applications.

Sign Up to vote   Poor Excellent
Add a reason or comment to your vote: x
Votes of 3 or less require a comment

Comments and Discussions

 
You must Sign In to use this message board.
Search this forum  
    Spacing  Noise  Layout  Per page   
GeneralsealedmemberGoran Mitrovic2 Sep '09 - 8:08 
If you constrain yourself to MSVC, rather use keyword sealed which also works in unmanaged C++.
 
- Goran.

AnswerRe: sealedmemberRich Berlint7 Sep '09 - 20:06 
The "Portable Solution" Francis Xavier gave has the same flaw as "Solution Attempt 1" -- you can multiply derive from Penguin and Sealed(Penguin):
 
class BigZ : public Penguin, Sealed(Penguin)
{
};
 
Looking around the Boost discussions the solutions all seemed to rely on friend-ing a template parameter through various workarounds see: http://lists.boost.org/Archives/boost/2006/04/102840.php[^], for example.
 
In that thread there is a reference to Stroustrop's http://www.research.att.com/~bs/bs_faq2.html#no-derivation [^] solution which I generalized using a macro. It seems pretty good given all the compiler dependent tricks required by the Boost approaches.
 
#define SEALED( ClassName )                                 \
class ClassName;                                            \
                                                            \
namespace Sealed_##ClassName##_                             \
{                                                           \
   class Sealed_##ClassName                                 \
   {                                                        \
      friend class ClassName;                               \
   private:                                                 \
      Sealed_##ClassName() {}                               \
      Sealed_##ClassName(const Sealed_##ClassName&) {}      \
   };                                                       \
}                                                           \
                                                            \
class ClassName : public virtual Sealed_##ClassName##_::Sealed_##ClassName
 
SEALED( Usable )
{
   // ...
public:
   Usable();
   Usable(char*);
   // ...
};
 

class DD : public Usable { };
Usable a;
DD dd;  // error: DD::DD() cannot access

 
Richard R Berlint

GeneralRe: sealedmemberFrancisXavier7 Sep '09 - 22:16 
I like your method; thanks for sharing. Thumbs Up | :thumbsup:
 
And as for the portable solution, it's not my favorite either; Solution Attempt #2 is cleaner.
I just included the portable solution for the sake of completeness. Smile | :)
 
"Empty your cup so that it may be filled; become devoid to gain totality." - Bruce Lee, 1975, Tao of Jeet Kune Do

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Permalink | Advertise | Privacy | Mobile
Web01 | 2.6.130523.1 | Last Updated 2 Sep 2009
Article Copyright 2009 by FrancisXavier
Everything else Copyright © CodeProject, 1999-2013
Terms of Use
Layout: fixed | fluid