| Summary: | Library headers should use fully qualified #include paths | ||
|---|---|---|---|
| Product: | TAO | Reporter: | J.T. Conklin <jtc> |
| Component: | other | Assignee: | J.T. Conklin <jtc> |
| Status: | ASSIGNED --- | ||
| Severity: | normal | ||
| Priority: | P3 | ||
| Version: | 1.5 | ||
| Hardware: | All | ||
| OS: | All | ||
I have made the required change for all files under ${TAO_ROOT}/tao and
${TAO_ROOT}/orbsvcs/orbsvcs.
accept JT, you also modified generated files, the problem is that those changes do get reverted with the next regeneration of these files. Yes, the generated files were modified; and yes, those changes will be lost when those files are regenerated. This was a side effect of the automated scripting used. Given the timeframe, it was easier to apply it globally than it was to separate out the generated files. While we could add diffs for this, I think a better strategy is to add support to the tao_idl compiler to specify a directory prefix for #include paths. Something like this is going to be needed for the orbsvcs includes, since they are all generated at compile time. Ive mentioned this to Jeff, but we havent spent any real thought on it because of the x.5.1 freeze. |
For the most part ACE+TAO+CIAO uses #include "..." instead of #include <...>. The C standard doesn't make much of a distinction between the two (cf ISO/IEC 9899:1999, section 6.10.2 "Source File Inclusion"). #include <...> searches a sequence of implementation defined places for the header; while #include "..." searches for the file in an "implementation defined manner", and if the search fails, it is reprocessed as if it read #include <...>. A common implemented behavior is that header files #included by <...> use the system include path (possibly augmented by -I directives on the command line), while headers #included with "..." are first looked up in the current directory and then the the same directories used by #include <...>. In most cases, the current directory is the directory of the #including file (This is traditional "UNIX" behavior), but the C Language FAQ implies that some implementations use the current working directory where the compiler was invoked. Until now, ACE, TAO, and CIAO have silently depended on "UNIX" behavior. For example, orbsvcs/Naming/Naming_Service.h would #include "nsconf.h" instead of #include "orbsvcs/Naming/nsconf.h". Users have reported problems with this. A workaround is to add ${TAO_ROOT}/tao and ${TAO_ROOT}/orbsvcs (or ${prefix}/include for installed autoconf builds) to the compiler search path. But the right thing to do is to change ACE, TAO, and CIAO to work with the most conservative #include search path semantics. Each #include of a *.h, *.i, *.inl, or template *.cpp file should be changed so it is #included relative to it's root: tao/... for files under ${TAO_ROOT}/tao, orbsvcs/... for files under ${TAO_ROOT}/orbsvcs/orbsvcs, etc.