0

I am currently working on a C++ project with a source file structure like this (headers excluded):

src/
├── namespace1/
│   ├── namespace1_base.cpp
│   ├── namespace1_derived1.cpp
│   └── namespace1_derived2.cpp
├── namespace2/
│   ├── namespace2_base.cpp
│   ├── namespace2_derived3.cpp
│   └── namespace2_derived4.cpp
├── other.cpp
└── files.cpp

The only annoying thing using this convention is including the files because I need to use

#include "src/namespace1/namespace1_derived1.cpp"

It seems weird and unnecessary to type the namespace twice. Is it considered good practice or should I organize my source files differently?

  • 2
    Is there any particular reason why you are including the namespace in the file name? – amon Nov 10 '18 at 22:50
  • I've got told that multiple source files with the same name might cause future probablems. Apart from that I am using Qt (and their IDE) which has some problems with duplicate files name. – jsmolka Nov 10 '18 at 22:52
  • In many languages, it can be required to have files with the same name (__init__.py in each folder of a Python project, or package.scala in multiple places in Scala), so that is something an IDE should support. As long as you're using namespaces, you should have no issues with the imports, even when the names are the same. – Silvio Mayolo Nov 11 '18 at 1:12
  • 2
    btw, that's called smurf naming convention (blog.codinghorror.com/new-programming-jargon, #21) – Aganju Nov 11 '18 at 1:32
  • Why separate directories, if you have prefixed filenames? You should decide for just one of these. – Frax Nov 11 '18 at 13:10
2

As far as C++ the language is concerned, duplicate file names are no problem at all. A tangential problem is that of include guards which must indeed be unique per translation unit, so using a filename as the header include guard's macro's name is not sufficient. However, using the nonstandard yet widely supported #pragma once directive completely sidesteps that problem.

But if other tools cannot deal with duplicate filenames in a project, and you have to use those tools, then you will have to live with that restriction. For example, a broken build system might want to compile both foo/myclass.cpp and bar/myclass.cpp to a build/myclass.o file. Ideally the build system can be configured to avoid that problem (e.g. by building each namespace as a separate project), and if not then prefixing your filenames as in your question is an ugly but acceptable solution.

|improve this answer|||||

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.