Rename Module -> PCModule (pre-compiled module).

Fortran has its own use of the term Module, and we'll want to use
some of the PCModule infrastructure to support Fortran module
interface files.

Author: Hal Finkel

docs/PCHInternals.rst

@@ -1,5 +1,5 @@
 ========================================
-Precompiled Header and Modules Internals
+Precompiled Header and PCModules Internals
 ========================================
 
 .. contents::
@@ -56,7 +56,7 @@ A precompiled header implementation improves performance when:
   important on multi-core systems, because PCH file generation serializes the
   build when all compilations require the PCH file to be up-to-date.
 
-Modules, as implemented in LFort, use the same mechanisms as precompiled
+PCModules, as implemented in LFort, use the same mechanisms as precompiled
 headers to save a serialized AST file (one per module) and use those AST
 modules.  From an implementation standpoint, modules are a generalization of
 precompiled headers, lifting a number of restrictions placed on precompiled
@@ -518,10 +518,10 @@ Update records
 
 .. _pchinternals-modules:
 
-Modules
+PCModules
 -------
 
-Modules generalize the chained precompiled header model yet further, from a
+PCModules generalize the chained precompiled header model yet further, from a
 linear chain of precompiled headers to an arbitrary directed acyclic graph
 (DAG) of AST files.  All of the same techniques used to make chained
 precompiled headers work --- ID number, name lookup, update records --- are
@@ -556,7 +556,7 @@ Declaration merging
   is as if one of the headers had been included before the other.
 
 Name Visibility
-  Modules allow certain names that occur during module creation to be "hidden",
+  PCModules allow certain names that occur during module creation to be "hidden",
   so that they are not part of the public interface of the module and are not
   visible to its clients.  The AST reader maintains a "visible" bit on various
   AST nodes (declarations, macros, etc.) to indicate whether that particular

examples/lfort-interpreter/main.cpp

@@ -60,7 +60,7 @@ static int Execute(llvm::Module *Mod, char * const *envp) {
 
   // FIXME: Support passing arguments.
   std::vector<std::string> Args;
-  Args.push_back(Mod->getModuleIdentifier());
+  Args.push_back(Mod->getPCModuleIdentifier());
 
   return EE->runSubprogramAsMain(EntrySubPgm, Args, envp);
 }
@@ -145,8 +145,8 @@ int main(int argc, const char **argv, char * const *envp) {
     return 1;
 
   int Res = 255;
-  if (llvm::Module *Module = Act->takeModule())
-    Res = Execute(Module, envp);
+  if (llvm::Module *PCModule = Act->takePCModule())
+    Res = Execute(PCModule, envp);
 
   // Shutdown.
 

include/lfort-c/Index.h

@@ -2075,9 +2075,9 @@ enum CXCursorKind {
   /**
    * \brief A module import declaration.
    */
-  CXCursor_ModuleImportDecl              = 600,
-  CXCursor_FirstExtraDecl                = CXCursor_ModuleImportDecl,
-  CXCursor_LastExtraDecl                 = CXCursor_ModuleImportDecl
+  CXCursor_PCModuleImportDecl              = 600,
+  CXCursor_FirstExtraDecl                = CXCursor_PCModuleImportDecl,
+  CXCursor_LastExtraDecl                 = CXCursor_PCModuleImportDecl
 };
 
 /**
@@ -3279,59 +3279,59 @@ CINDEX_LINKAGE CXComment lfort_Cursor_getParsedComment(CXCursor C);
  */
 
 /**
- * \defgroup CINDEX_MODULE Module introspection
+ * \defgroup CINDEX_MODULE PCModule introspection
  *
  * The functions in this group provide access to information about modules.
  *
  * @{
  */
 
-typedef void *CXModule;
+typedef void *CXPCModule;
 
 /**
- * \brief Given a CXCursor_ModuleImportDecl cursor, return the associated module.
+ * \brief Given a CXCursor_PCModuleImportDecl cursor, return the associated module.
  */
-CINDEX_LINKAGE CXModule lfort_Cursor_getModule(CXCursor C);
+CINDEX_LINKAGE CXPCModule lfort_Cursor_getPCModule(CXCursor C);
 
 /**
- * \param Module a module object.
+ * \param PCModule a module object.
  *
  * \returns the parent of a sub-module or NULL if the given module is top-level,
  * e.g. for 'std.vector' it will return the 'std' module.
  */
-CINDEX_LINKAGE CXModule lfort_Module_getParent(CXModule Module);
+CINDEX_LINKAGE CXPCModule lfort_PCModule_getParent(CXPCModule PCModule);
 
 /**
- * \param Module a module object.
+ * \param PCModule a module object.
  *
  * \returns the name of the module, e.g. for the 'std.vector' sub-module it
  * will return "vector".
  */
-CINDEX_LINKAGE CXString lfort_Module_getName(CXModule Module);
+CINDEX_LINKAGE CXString lfort_PCModule_getName(CXPCModule PCModule);
 
 /**
- * \param Module a module object.
+ * \param PCModule a module object.
  *
  * \returns the full name of the module, e.g. "std.vector".
  */
-CINDEX_LINKAGE CXString lfort_Module_getFullName(CXModule Module);
+CINDEX_LINKAGE CXString lfort_PCModule_getFullName(CXPCModule PCModule);
 
 /**
- * \param Module a module object.
+ * \param PCModule a module object.
  *
  * \returns the number of top level headers associated with this module.
  */
-CINDEX_LINKAGE unsigned lfort_Module_getNumTopLevelHeaders(CXModule Module);
+CINDEX_LINKAGE unsigned lfort_PCModule_getNumTopLevelHeaders(CXPCModule PCModule);
 
 /**
- * \param Module a module object.
+ * \param PCModule a module object.
  *
  * \param Index top level header index (zero-based).
  *
  * \returns the specified top level header associated with the module.
  */
 CINDEX_LINKAGE
-CXFile lfort_Module_getTopLevelHeader(CXModule Module, unsigned Index);
+CXFile lfort_PCModule_getTopLevelHeader(CXPCModule PCModule, unsigned Index);
 
 /**
  * @}
@@ -5060,7 +5060,7 @@ typedef struct {
    * \brief Non-zero if the directive was automatically turned into a module
    * import.
    */
-  int isModuleImport;
+  int isPCModuleImport;
 } CXIdxIncludedFileInfo;
 
 /**
@@ -5074,7 +5074,7 @@ typedef struct {
   /**
    * \brief The imported module or NULL if the AST file is a PCH.
    */
-  CXModule module;
+  CXPCModule module;
   /**
    * \brief Location where the file is imported. Applicable only for modules.
    */

include/lfort/AST/Decl.h

@@ -35,7 +35,7 @@ class SubprogramTemplateDecl;
 class SubprogramTemplateSpecializationInfo;
 class LabelStmt;
 class MemberSpecializationInfo;
-class Module;
+class PCModule;
 class NestedNameSpecifier;
 class Stmt;
 class StringLiteral;
@@ -189,8 +189,8 @@ class NamedDecl : public Decl {
   /// \brief Determine whether this declaration has linkage.
   bool hasLinkage() const;
 
-  using Decl::isModulePrivate;
-  using Decl::setModulePrivate;
+  using Decl::isPCModulePrivate;
+  using Decl::setPCModulePrivate;
 
   /// \brief Determine whether this declaration is hidden from name lookup.
   bool isHidden() const { return Hidden; }
@@ -3296,7 +3296,7 @@ class ImportDecl : public Decl {
   ///
   /// When the bit is false, we only have a single source location for the
   /// end of the import declaration.
-  llvm::PointerIntPair<Module *, 1, bool> ImportedAndComplete;
+  llvm::PointerIntPair<PCModule *, 1, bool> ImportedAndComplete;
 
   /// \brief The next import in the list of imports local to the translation
   /// unit being parsed (not loaded from an AST file).
@@ -3306,32 +3306,32 @@ class ImportDecl : public Decl {
   friend class ASTDeclReader;
   friend class ASTContext;
 
-  ImportDecl(DeclContext *DC, SourceLocation StartLoc, Module *Imported,
+  ImportDecl(DeclContext *DC, SourceLocation StartLoc, PCModule *Imported,
              ArrayRef<SourceLocation> IdentifierLocs);
 
-  ImportDecl(DeclContext *DC, SourceLocation StartLoc, Module *Imported,
+  ImportDecl(DeclContext *DC, SourceLocation StartLoc, PCModule *Imported,
              SourceLocation EndLoc);
 
   ImportDecl(EmptyShell Empty) : Decl(Import, Empty), NextLocalImport() { }
 
 public:
   /// \brief Create a new module import declaration.
   static ImportDecl *Create(ASTContext &C, DeclContext *DC, 
-                            SourceLocation StartLoc, Module *Imported,
+                            SourceLocation StartLoc, PCModule *Imported,
                             ArrayRef<SourceLocation> IdentifierLocs);
 
   /// \brief Create a new module import declaration for an implicitly-generated
   /// import.
   static ImportDecl *CreateImplicit(ASTContext &C, DeclContext *DC, 
-                                    SourceLocation StartLoc, Module *Imported, 
+                                    SourceLocation StartLoc, PCModule *Imported, 
                                     SourceLocation EndLoc);
 
   /// \brief Create a new, deserialized module import declaration.
   static ImportDecl *CreateDeserialized(ASTContext &C, unsigned ID, 
                                         unsigned NumLocations);
 
   /// \brief Retrieve the module that was imported by the import declaration.
-  Module *getImportedModule() const { return ImportedAndComplete.getPointer(); }
+  PCModule *getImportedPCModule() const { return ImportedAndComplete.getPointer(); }
 
   /// \brief Retrieves the locations of each of the identifiers that make up
   /// the complete module name in the import declaration.

include/lfort/AST/DeclBase.h

@@ -193,15 +193,15 @@ class Decl {
 
     /// \brief Whether this declaration is private to the module in which it was
     /// defined.
-    ModulePrivateFlag = 0x02
+    PCModulePrivateFlag = 0x02
   };
 
   /// \brief The next declaration within the same lexical
   /// DeclContext. These pointers form the linked list that is
   /// traversed via DeclContext's decls_begin()/decls_end().
   ///
   /// The extra two bits are used for the TopLevelDeclInObjCContainer and
-  /// ModulePrivate bits.
+  /// PCModulePrivate bits.
   llvm::PointerIntPair<Decl *, 2, unsigned> NextInContextAndBits;
 
 private:
@@ -504,23 +504,23 @@ class Decl {
 protected:
   /// \brief Whether this declaration was marked as being private to the
   /// module in which it was defined.
-  bool isModulePrivate() const { 
-    return NextInContextAndBits.getInt() & ModulePrivateFlag;
+  bool isPCModulePrivate() const { 
+    return NextInContextAndBits.getInt() & PCModulePrivateFlag;
   }
 
   /// \brief Specify whether this declaration was marked as being private
   /// to the module in which it was defined.
-  void setModulePrivate(bool MP = true) {
+  void setPCModulePrivate(bool MP = true) {
     unsigned Bits = NextInContextAndBits.getInt();
     if (MP)
-      Bits |= ModulePrivateFlag;
+      Bits |= PCModulePrivateFlag;
     else
-      Bits &= ~ModulePrivateFlag;
+      Bits &= ~PCModulePrivateFlag;
     NextInContextAndBits.setInt(Bits);
   }
 
   /// \brief Set the owning module ID.
-  void setOwningModuleID(unsigned ID) {
+  void setOwningPCModuleID(unsigned ID) {
     assert(isFromASTFile() && "Only works on a deserialized declaration");
     *((unsigned*)this - 2) = ID;
   }
@@ -587,7 +587,7 @@ class Decl {
 
   /// \brief Retrieve the global ID of the module that owns this particular
   /// declaration.
-  unsigned getOwningModuleID() const {
+  unsigned getOwningPCModuleID() const {
     if (isFromASTFile())
       return *((const unsigned*)this - 2);
 

include/lfort/Basic/Attr.td

@@ -554,7 +554,7 @@ def Ownership : InheritableAttr {
   let Args = [EnumArgument<"OwnKind", "OwnershipKind",
                     ["ownership_holds", "ownership_returns", "ownership_takes"],
                     ["Holds", "Returns", "Takes"]>,
-              StringArgument<"Module">, VariadicUnsignedArgument<"Args">];
+              StringArgument<"PCModule">, VariadicUnsignedArgument<"Args">];
 }
 
 def Packed : InheritableAttr {

include/lfort/Basic/DiagnosticLexKinds.td

@@ -462,7 +462,7 @@ def err_pp_include_in_arc_cf_code_audited : Error<
 def err_pp_eof_in_arc_cf_code_audited : Error<
   "'#pragma lfort arc_cf_code_audited' was not ended within this file">;
 
-// Module map parsing
+// PCModule map parsing
 def err_mmap_unknown_token : Error<"skipping stray token">;
 def err_mmap_expected_module : Error<"expected module declaration">;
 def err_mmap_expected_module_name : Error<"expected module name">;

include/lfort/Basic/DiagnosticParseKinds.td

@@ -770,7 +770,7 @@ def err_seh___finally_block : Error<
 
 } // end of Parse Issue category.
 
-let CategoryName = "Modules Issue" in {
+let CategoryName = "PCModules Issue" in {
 def err_module_expected_ident : Error<
   "expected a module name after module import">;
 def err_module_expected_semi : Error<

include/lfort/Basic/DiagnosticSemaKinds.td

@@ -6062,7 +6062,7 @@ def note_related_result_type_inferred : Note<
 
 }
 
-let CategoryName = "Modules Issue" in {
+let CategoryName = "PCModules Issue" in {
 def err_module_private_specialization : Error<
   "%select{template|partial|member}0 specialization cannot be "
   "declared __module_private__">;

include/lfort/Basic/IdentifierTable.h

@@ -68,7 +68,7 @@ class IdentifierInfo {
   bool OutOfDate              : 1; // True if there may be additional
                                    // information about this identifier
                                    // stored externally.
-  bool IsModulesImport        : 1; // True if this is the 'import' contextual
+  bool IsPCModulesImport        : 1; // True if this is the 'import' contextual
                                    // keyword.
   // 32-bit word is filled.
 
@@ -298,12 +298,12 @@ class IdentifierInfo {
 
   /// \brief Determine whether this is the contextual keyword
   /// 'import'.
-  bool isModulesImport() const { return IsModulesImport; }
+  bool isPCModulesImport() const { return IsPCModulesImport; }
 
   /// \brief Set whether this identifier is the contextual keyword 
   /// 'import'.
-  void setModulesImport(bool I) {
-    IsModulesImport = I;
+  void setPCModulesImport(bool I) {
+    IsPCModulesImport = I;
     if (I)
       NeedsHandleIdentifier = true;
     else
@@ -322,7 +322,7 @@ class IdentifierInfo {
     NeedsHandleIdentifier =
       (isPoisoned() | hasMacroDefinition() | isCPlusPlusOperatorKeyword() |
        isExtensionToken() | isCXX11CompatKeyword() || isOutOfDate() ||
-       isModulesImport());
+       isPCModulesImport());
   }
 };
 
@@ -508,7 +508,7 @@ class IdentifierTable {
 
       // If this is the 'import' contextual keyword, mark it as such.
       if (Name.equals("import"))
-        II->setModulesImport(true);
+        II->setPCModulesImport(true);
     }
 
     return *II;

include/lfort/Basic/LangOptions.def

@@ -98,7 +98,7 @@ LANGOPT(Blocks            , 1, 0, "blocks extension to C")
 BENIGN_LANGOPT(EmitAllDecls      , 1, 0, "support for emitting all declarations")
 LANGOPT(MathErrno         , 1, 1, "errno support for math functions")
 BENIGN_LANGOPT(HeinousExtensions , 1, 0, "Extensions that we really don't like and may be ripped out at any time")
-LANGOPT(Modules           , 1, 0, "modules extension to C")
+LANGOPT(PCModules           , 1, 0, "modules extension to C")
 LANGOPT(Optimize          , 1, 0, "__OPTIMIZE__ predefined macro")
 LANGOPT(OptimizeSize      , 1, 0, "__OPTIMIZE_SIZE__ predefined macro")
 LANGOPT(Static            , 1, 0, "__STATIC__ predefined macro (as opposed to __DYNAMIC__)")

include/lfort/Basic/LangOptions.h

@@ -68,7 +68,7 @@ class LangOptions : public RefCountedBase<LangOptions>, public LangOptionsBase {
   std::string OverflowHandler;
 
   /// \brief The name of the current module.
-  std::string CurrentModule;
+  std::string CurrentPCModule;
 
   LangOptions();
 
@@ -119,7 +119,7 @@ enum ProgramKind {
   /// not complete.
   PGM_Prefix,
   /// \brief The program is a module.
-  PGM_Module
+  PGM_PCModule
 };
 
 }  // end namespace lfort