[RESOLVED] how should I arrange classes in files?

Do you know some "good practices"?

I've came across certain situations where I had to add things to classes that required certain headers and the project could not have been compiled anymore because of things like: file1.h requires files2.h which requires file1.h.

The last problem with things like this was this:
File1.h contained the definition of Class1
File2.h contained the definition of Class2
File1.h declared Class2 as friend (which meant I had to #include File2.h in it)
File2.h required data and data types from File1.h (which meant I had to #include File1.h in it)
And it didn't compile.

And I lose time trying to figure out how to make it work. Can anyone give some suggestions of "good practices" to avoid situations like this or to be able to solve them quicklier?

You don't have to include any file for the friend declaration just use friend class XXX;

When to classes share definitions like that why not have the shared stuff in a separate header?

Quote:

---

Originally Posted by Feoggou

Can anyone give some suggestions of "good practices" to avoid situations like this or to be able to solve them quicklier?

---

One way to avoid/break recursive dependencies is to follow these steps. The first step is to forward declare Class2 before the definition of Class1 in File1.h. This may require some fiddling but the goal is to reach a situation where File2.h doesn't need to be included in File1.h.

Since this means File1.h cannot be use without File2.h also being included eventually, and since Class1 and Class2 are recursively dependent anyway, the second step is to introduce a new include file to reflect this, like,

File3.h:
#include "File1.h"
#include "File2.h"

Then File3.h is included whenever Class1 and/or Class2 are wanted.

To reduce the number of include files I sometimes resort to skipping File1.h and File2.h altogether and put both class definitions on File3.h. (but the forward declaration is still needed)

Still a much better way to resolve circular dependencies is by the way of design. The end result is that Class1 and Class2 aren't recursively dependent anymore and thus their include files won't conflict. So in fact a large number of conflicting include files may indicate a too tightly coupled design.

ok, and if Class2 belongs to myNamespace, and thus, File2.h contains myNamespace which contains Class2, what is it best to do? Is there a way I can share a namespace without including the actual header file that contains it?

for instance, a function member of a class requires a class defined in a namespace. Where should I declare the namespace?
I have declared it in a header file, with:

Code:

---

class ClassX;
class ClassY;

---

but when I try to use ClassX, for instance, it tells me that the class has no constructor, though it has!

Quote:

---

Originally Posted by S_M_A

When to classes share definitions like that why not have the shared stuff in a separate header?

---

I don't understand what you mean. As far as I know, the definition of a class in c++ can belong in one header file only.

a.h:

Code:

---

namespace a_
{
class a
{
};
}

---

b.h:

Code:

---

namespace a_
{
  class a;
}

namespace b_
{
  class b
  {
  };
}

---

well, in my little bit complicated project, I use: I'll re-check and write:

in general.h (general.h includes different header files):

Code:

---

namespace na
{
      class ca;
}

---

bheader:

Code:

---

#include "general.h"

class cb
{
    void DoX()
    {
        na::ca obj(parameters);
    }
};

---

but I get the following errors:

Code:

---

error C2079: 'obj' uses undefined class 'na::ca'

---

(a few of them)
and then an intellisense error that says:

Code:

---

IntelliSense: no default constructor exists for class "na::ca"

---

if I use this, instead, in bheader:

Code:

---


#include "general.h"//general.h does not contain namespace na anymore, here.

namespace na
{
      class ca;
}

class cb
{
    void DoX()
    {
        na::ca obj(parameters);
    }
};

---

I get the following errors:

Code:

---

error C2757: 'na' :  a symbol with this name already exists and therefore this name cannot be used as a namespace name
error C2027: use of undefined type 'na'
error C2079: 'ca' uses undefined class 'na'
error C2027: use of undefined type 'na'
error C2146: syntax error : missing ';' before identifier 'obj'
error C2065: 'obj' : undeclared identifier

---

I don't understand what exactly the problem is.

class ca is also declared in another header file - if I don't declare it there, the latter errors happen. If it is declared there, the foremost errors happen - in its namespace, na, and its contents is defined in a .cpp file.

you get the error because you only forward declared it. If you 'use' a type in a header, you MUST include it!

Quote:

---

Originally Posted by Amleto

you get the error because you only forward declared it. If you 'use' a type in a header, you MUST include it!

---

if I do that I receive the following error:

Code:

---

error C2757: 'na' : a symbol with this name already exists and therefore this name cannot be used as a namespace name

---

perhaps because that header file is included more than once.

yes, you cannot include a header file more than once. are you using header gurads? It might be simplest to post all of your code in one post

header guards? you mean, as the Microsoft's #pragma once ? Then, yes. Otherwise, perhaps not.

I don't know if I can post all my code in one post. Can I know the order in which files are included to draw on paper a scheme and see where the problem is and how to solve it? I know that the .cpp file the contains the main or WinMain function is the first one, but then there are the header fles it includes and the other .cpp files which I have no idea when they are included or if it should matter to me.

just make sure that #pragma once is the first line in every header. The absolute first line.

Not sure what the problem is:

a.h

Code:

---

#pragma once

namespace aa
{
  class ClassA
  {
  };
}

---

b.h

Code:

---

#pragma once

#include "a.h"

namespace bb
{
  class ClassB
  {
  public:
    void MakeA()
    {
      aa::ClassA objA;
    }
  };
}

---

main

Code:

---


#include "b.h"

int main()
{
  bb::ClassB aB;
  aB.MakeA();
}

---

if it gets more complicated, then remove the implementation of MakeA from the header and put it in a .cpp. then there is no need to include a.h in the b.h header!

b.h

Code:

---

#pragma once

//#include "a.h"

namespace aa
{
  class ClassA;
}

namespace bb
{
  class ClassB
  {
  public:
    void MakeA();
  };
}

---

b.cpp

Code:

---

#include "b.h"

#include "a.h"

namespace bb
{
  void ClassB::MakeA()
  {
    aa::ClassA a;
  }
}

---

I do use #pragma once at the beginning of every header file.

I've changed my code in a few places. Now I've gotten to a situation like this:

file1.h:

Code:

---

namespace one
{
        class class1
        {
                int x;

                friend class class2;
        };
}

---

file2:

Code:

---

#include "file1.h"

class class2
{
public:
        int y;
        class class2()
        {
                one::class1 obj;
                obj.x = 3;
        }
};

---

main.cpp:

Code:

---

#include "file2.h"
....
//in the main function:
class2 obj;

---

And I get these errors in file2:

Code:

---

error C2248: 'one::class1::x' : cannot access private member declared in class 'one::class1'
IntelliSense: member "one::class1::x" (declared at line 6 of "d:\my projects\testslearn\testslearn\file1.h") is inaccessible

---

Why does the friendship not work? well... I assume it expects the class to belong in the same namespace. But, isn't there a way to do it without putting class2 in a namespace?

it seems that friend class ::class2; does not work, even if class2 is global.
It says:

Code:

---

error C2039: 'class2' : is not a member of '`global namespace''
error C2248: 'one::class1::x' : cannot access private member declared in class 'one::class1'

---

I dont see that you have put pragma once anywhere. Anyway, this solves your problem:

Code:

---

#pragma once

class class2;
namespace one
{
        class class1
        {
                int x;

                friend class2;
        };
}

---

thanks a lot.

When I was writing friend class class2; I was thinking that it is the same as a class class2; + declare it as friend.

As about the #pragma, I was in a hurry to put these sample code in a test project to test it, that's why I didn't included it then.

It seems I've moved forward a bit... however, there is something left (due to a bit of modification to the code). Perhaps you can explain me why my class is not recognized:

the files are like this:
main.cpp contains WinMain, and includes:

Code:

---

#include "General.h"
#include "Exceptions.h"

---

General.h includes:

Code:

---

namespace App
{
        class MainWnd;
        class VideoEngine;

        extern MainWnd                        mainWnd;
        extern VideoEngine                m_Video;
}

#include "VideoEngine.h"
#include "MainWnd.h"

---

VideoEngine.h includes:

Code:

---

#include "General.h"
#include "GameFont.h"
//also, VideoEngine of App namespace is defined here (obviously)

---

GameFont.h includes:

Code:

---

#include "General.h"
#include "GraphicElement.h"
#include "Exceptions.h"

---

GraphicElement.h includes:

Code:

---

#include "General.h"
//the error remains even if I #include "VideoEngine.h"
//there is also a class GraphicElement which has an inline function:
ID3D10Device* GetDevice() {return App::m_Video.m_pDevice;}

---

but the problem is that I receive the error "error C2027: use of undefined type 'App::VideoEngine'"

Exceptions.h includes:

Code:

---

#include General.h

---

MainWnd.h includes:

Code:

---

#include General.h

---

I supposes that VideoEngine.h should have already been included when it reached GraphicElement.h, but it doesn't work even if I #include "VideoEngine.h" specifically in it (as I've shown in comment above). Also, a class of the Exceptions.h file does not see the VideoEngine class, not even if I included specifically in Exceptions.h.

Any suggestion why is not working? Please.

where is VideoEngine m_Video defined? where is it instantiated?

Can you see that we are just going round a nd round in circles because you are not posting enough code?

You should post a small and COMPLTE sample that reproduces your problem. Nobody can reproduce your problem because you keep leaving bits out!

m_Video is instantiated in main.cpp but General.h declared it as extern (about this extern I have shown in the previous post)
But that is meaningless, because if I write:

Code:

---

ID3D10Device* GetDevice() {return App::m_Video.m_pDevice; App::VideoEngine ve;}

---

(the thing added is in blue) then it tells me "error C2079: 've' uses undefined class 'App::VideoEngine'". The problem is not with m_Video but with App::VideoEngine.

I have attached a zip containing the files of the project.

a solution would be to define the GetDevice() function in a .cpp file (that would cause no error), but I don't understand the problem. :(

below is what you have stated. It works fine. You aren't telling the whole story. post a small complete example that shows the problem. I looked your zip - it's not complete since it requires third party libs to build.

gen

Code:

---

#pragma once

namespace App
{
        class MainWnd;
        class VideoEngine;

        extern MainWnd                        mainWnd;
        extern VideoEngine        m_Video;
}

#include "Vid.h"

---

vid

Code:

---

#pragma once

#include "gen.h"

namespace App
{
  class VideoEngine
  {
  };
}

---

elem

Code:

---

#pragma once
#include "gen.h"

void func()
{
  App::VideoEngine eng;
  App::m_Video = eng;
}

---

main

Code:

---


#include "elem.h"
//#include "gen.h"
int main()
{
  func();
}

---

no errors.

I've made a simple example.

the compile error is in Exceptions.h, in the constructor, where it calls:

Code:

---

App::VideoEngine ve;

---

the compile error is:

Code:

---

error C2079: 've' uses undefined class 'App::VideoEngine'

---

The error seems to be caused by the inclusions of header files. For instance, if GameFont.h does not include any header file, the problem dissappears.

I hope you can find the logic why it can't see the App::VideoEngine class, because I can't find it.

Quote:

---

Originally Posted by Feoggou

I've made a simple example.

the compile error is in Exceptions.h, in the constructor, where it calls:

Code:

---

App::VideoEngine ve;

---

---

Why are you writing implementation code in a header? Forward declaring lets you get away without #include-ing. BUT it means you cant use the type. You cant have your cake and eat it. Use of the type should be in a .cpp file where the type is 'fully' #include-ed

The zip is empty.

Quote:

---

Originally Posted by Amleto

Why are you writing implementation code in a header? Forward declaring lets you get away without #include-ing. BUT it means you cant use the type. You cant have your cake and eat it. Use of the type should be in a .cpp file where the type is 'fully' #include-ed

---

Well, it was an easy thing to put the inline functions in the header and don't use another .cpp file for one or two short inline functions.

Ok. thanks for helping me. The problem is solved. Perhaps I should care only not to use inline functions in headers if they require files included, rather than caring about why the headers get messed up.