diff options
| -rw-r--r-- | include/llvm/Support/IncludeFile.h | 39 | ||||
| -rw-r--r-- | include/llvm/System/IncludeFile.h | 39 |
2 files changed, 62 insertions, 16 deletions
diff --git a/include/llvm/Support/IncludeFile.h b/include/llvm/Support/IncludeFile.h index 2e4f12dbbf..8e96f7571f 100644 --- a/include/llvm/Support/IncludeFile.h +++ b/include/llvm/Support/IncludeFile.h @@ -7,12 +7,39 @@ // //===----------------------------------------------------------------------===// // -// This file defines the IncludeFile class. +// This file defines the FORCE_DEFINING_FILE_TO_BE_LINKED and DEFINE_FILE_FOR +// macros. // //===----------------------------------------------------------------------===// -/// This class is used as a facility to make sure that the implementation of a -/// header file is included into a tool that uses the header. This is solely +#ifndef LLVM_SUPPORT_INCLUDEFILE_H +#define LLVM_SUPPORT_INCLUDEFILE_H + +/// This macro is the public interface that IncludeFile.h exports. This gives +/// us the option to implement the "link the definition" capability in any +/// manner that we choose. All header files that depend on a specific .cpp +/// file being linked at run time should use this macro instead of the +/// IncludeFile class directly. +/// +/// For example, foo.h would use:<br/> +/// <tt>FORCE_DEFINING_FILE_TO_BE_LINKED(foo)</tt><br/> +/// +/// And, foo.cp would use:<br/> +/// <tt>DEFINING_FILE_FOR(foo)</tt><br/> +#define FORCE_DEFINING_FILE_TO_BE_LINKED(name) \ + extern char name ## LinkVar; \ + static IncludeFile name ## LinkObj ( &name ## LinkVar ) + +/// This macro is the counterpart to FORCE_DEFINING_FILE_TO_BE_LINKED. It should +/// be used in a .cpp file to define the name referenced in a header file that +/// will cause linkage of the .cpp file. It should only be used at extern level. +#define DEFINING_FILE_FOR(name) char name + +namespace llvm { + +/// This class is used in the implementation of FORCE_DEFINING_FILE_TO_BE_LINKED +/// macro to make sure that the implementation of a header file is included +/// into a tool that uses the header. This is solely /// to overcome problems linking .a files and not getting the implementation /// of compilation units we need. This is commonly an issue with the various /// Passes but also occurs elsewhere in LLVM. We like to use .a files because @@ -27,14 +54,10 @@ /// <tt>extern int LinkMyCodeStub;</tt><br/> /// <tt>static IncludeFile LinkMyModule(&LinkMyCodeStub);</tt><br/> /// @brief Class to ensure linking of corresponding object file. - -#ifndef LLVM_SUPPORT_INCLUDEFILE_H -#define LLVM_SUPPORT_INCLUDEFILE_H - -namespace llvm { struct IncludeFile { IncludeFile(void *); }; + } #endif diff --git a/include/llvm/System/IncludeFile.h b/include/llvm/System/IncludeFile.h index 2e4f12dbbf..8e96f7571f 100644 --- a/include/llvm/System/IncludeFile.h +++ b/include/llvm/System/IncludeFile.h @@ -7,12 +7,39 @@ // //===----------------------------------------------------------------------===// // -// This file defines the IncludeFile class. +// This file defines the FORCE_DEFINING_FILE_TO_BE_LINKED and DEFINE_FILE_FOR +// macros. // //===----------------------------------------------------------------------===// -/// This class is used as a facility to make sure that the implementation of a -/// header file is included into a tool that uses the header. This is solely +#ifndef LLVM_SUPPORT_INCLUDEFILE_H +#define LLVM_SUPPORT_INCLUDEFILE_H + +/// This macro is the public interface that IncludeFile.h exports. This gives +/// us the option to implement the "link the definition" capability in any +/// manner that we choose. All header files that depend on a specific .cpp +/// file being linked at run time should use this macro instead of the +/// IncludeFile class directly. +/// +/// For example, foo.h would use:<br/> +/// <tt>FORCE_DEFINING_FILE_TO_BE_LINKED(foo)</tt><br/> +/// +/// And, foo.cp would use:<br/> +/// <tt>DEFINING_FILE_FOR(foo)</tt><br/> +#define FORCE_DEFINING_FILE_TO_BE_LINKED(name) \ + extern char name ## LinkVar; \ + static IncludeFile name ## LinkObj ( &name ## LinkVar ) + +/// This macro is the counterpart to FORCE_DEFINING_FILE_TO_BE_LINKED. It should +/// be used in a .cpp file to define the name referenced in a header file that +/// will cause linkage of the .cpp file. It should only be used at extern level. +#define DEFINING_FILE_FOR(name) char name + +namespace llvm { + +/// This class is used in the implementation of FORCE_DEFINING_FILE_TO_BE_LINKED +/// macro to make sure that the implementation of a header file is included +/// into a tool that uses the header. This is solely /// to overcome problems linking .a files and not getting the implementation /// of compilation units we need. This is commonly an issue with the various /// Passes but also occurs elsewhere in LLVM. We like to use .a files because @@ -27,14 +54,10 @@ /// <tt>extern int LinkMyCodeStub;</tt><br/> /// <tt>static IncludeFile LinkMyModule(&LinkMyCodeStub);</tt><br/> /// @brief Class to ensure linking of corresponding object file. - -#ifndef LLVM_SUPPORT_INCLUDEFILE_H -#define LLVM_SUPPORT_INCLUDEFILE_H - -namespace llvm { struct IncludeFile { IncludeFile(void *); }; + } #endif |