Add comments for some of the methods

Author: aciidgh

Sources/Build/Buildable.swift

@@ -17,7 +17,8 @@ protocol Buildable {
 }
 
 extension CModule {
-    func workingDirectory(prefix: String) -> String {
+    ///Returns the build directory path of a CModule
+    func buildDirectory(prefix: String) -> String {
         return Path.join(prefix, "\(c99name).build")
     }
 }
@@ -27,24 +28,20 @@ extension Module: Buildable {
         return self is TestModule
     }
 
-    func XccFlagsForPrefix(prefix: String) -> [String] {
+    func XccFlags(prefix: String) -> [String] {
         return recursiveDependencies.flatMap { module -> [String] in
             if let module = module as? ClangModule {
-                var moduleMap: String? = nil
-                
+                ///For ClangModule we check if there is a user provided module map
+                ///otherwise we return with path of generated one.
+                ///We will fail before this is ever called if there is no module map.
+                ///FIXME: The user provided modulemap should be copied to build dir
+                ///but that requires copying the complete include dir because it'll
+                ///mostly likely contain relative paths.
                 if module.moduleMapPath.isFile {
-                    moduleMap = module.moduleMapPath
+                    return ["-Xcc", "-fmodule-map-file=\(module.moduleMapPath)"]
                 }
-    
-                let genModuleMap = Path.join(module.workingDirectory(prefix), module.moduleMap)
-                if genModuleMap.isFile {
-                    moduleMap = genModuleMap
-                }
-                //No module map found, return with no args
-                if let moduleMap = moduleMap {
-                    return ["-Xcc", "-fmodule-map-file=\(moduleMap)"]
-                }
-                return []
+                let genModuleMap = Path.join(module.buildDirectory(prefix), module.moduleMap)
+                return ["-Xcc", "-fmodule-map-file=\(genModuleMap)"]
             } else if let module = module as? CModule {
                 return ["-Xcc", "-fmodule-map-file=\(module.moduleMapPath)"]
             } else {

Sources/Build/Command.compile(ClangModule).swift

@@ -69,7 +69,7 @@ private extension Sources {
 extension Command {
     static func compile(clangModule module: ClangModule, externalModules: Set<Module>, configuration conf: Configuration, prefix: String, CC: String) throws -> ([Command], Command) {
 
-        let wd = module.workingDirectory(prefix)
+        let wd = module.buildDirectory(prefix)
 
         if module.type == .Library {
             try module.generateModuleMap(inDir: wd)

Sources/Build/Command.compile(SwiftModule).swift

@@ -14,7 +14,7 @@ import Utility
 extension Command {
     static func compile(swiftModule module: SwiftModule, configuration conf: Configuration, prefix: String, otherArgs: [String], SWIFT_EXEC: String) throws -> (Command, [Command]) {
 
-        let otherArgs = otherArgs + module.XccFlagsForPrefix(prefix)
+        let otherArgs = otherArgs + module.XccFlags(prefix)
 
         func cmd(tool: ToolProtocol) -> Command {
             return Command(node: module.targetName, tool: tool)

Sources/Build/misc.swift

@@ -50,14 +50,14 @@ extension ClangModule {
 
     public func generateModuleMap(inDir wd: String) throws {
 
-        //Return if module map is already present
+        ///Return if module map is already present
         guard !moduleMapPath.isFile else {
             return
         }
 
         let includeDir = path
 
-        //Warn and return if no include directory
+        ///Warn and return if no include directory
         guard includeDir.isDirectory else {
             print("warning: No include directory found, a library can not be imported without any public headers.")
             return
@@ -68,17 +68,31 @@ extension ClangModule {
         let files = walked.filter{$0.isFile && $0.hasSuffix(".h")}
         let dirs = walked.filter{$0.isDirectory}
 
+        ///There are three possible cases for which we will generate modulemaps:
+        ///Flat includes dir with only header files, in that case we generate
+        /// `umbrella "path/to/includes/"`
+        ///Module name dir is the only dir in includes, in that case we generate
+        /// `umbrella header "path/to/includes/modulename/modulename.h"` if there is a `modulename.h`
+        ///inside that directory, otherwise we generate
+        /// `umbrella "path/to/includes/modulename"`
+        
         if dirs.isEmpty {
             guard !files.isEmpty else { throw ModuleMapError.UnsupportedIncludeLayoutForModule(name) }
             try createModuleMap(inDir: wd, type: .FlatHeaderLayout)
             return
         }
 
-        guard let moduleHeaderDir = dirs.first where moduleHeaderDir.basename == name && files.isEmpty else {
+        guard let moduleHeaderDir = dirs.first where moduleHeaderDir.basename == c99name && files.isEmpty else {
             throw ModuleMapError.UnsupportedIncludeLayoutForModule(name)
         }
 
-        let umbrellaHeader = Path.join(moduleHeaderDir, "\(name).h")
+        let umbrellaHeader = Path.join(moduleHeaderDir, "\(c99name).h")
+        
+        let invalidUmbrellaHeader = Path.join(moduleHeaderDir, "\(name).h")
+        if c99name != name && invalidUmbrellaHeader.isFile {
+            print("warning: \(invalidUmbrellaHeader) should be renamed to \(umbrellaHeader) to be used as Umbrella header")
+        }
+        
         if umbrellaHeader.isFile {
             try createModuleMap(inDir: wd, type: .HeaderFile)
         } else {
@@ -98,24 +112,22 @@ extension ClangModule {
         let moduleMap = try fopen(moduleMapFile, mode: .Write)
         defer { fclose(moduleMap) }
 
-        try fputs("module \(name) {\n", moduleMap)
-        try fputs("    umbrella ", moduleMap)
-        
+        var output = "module \(c99name) {\n"
         switch type {
         case .FlatHeaderLayout:
-            try fputs("\"\(path)\"\n", moduleMap)
+            output += "    umbrella \"\(path)\"\n"
         case .ModuleNameDir:
-            let path = Path.join(self.path, name)
-            try fputs("\"\(path)\"\n", moduleMap)
+            let path = Path.join(self.path, c99name)
+            output += "    umbrella \"\(path)\"\n"
         case .HeaderFile:
-            let path = Path.join(self.path, name, "\(name).h")
-            try fputs("header \"\(path)\"\n", moduleMap)
-            
+            let path = Path.join(self.path, c99name, "\(c99name).h")
+            output += "    umbrella header \"\(path)\"\n"
         }
-        
-        try fputs("    link \"\(name)\"\n", moduleMap)
-        try fputs("    export *\n", moduleMap)
-        try fputs("}\n", moduleMap)
+        output += "    link \"\(c99name)\"\n"
+        output += "    export *\n"
+        output += "}\n"
+
+        try fputs(output, moduleMap)
     }
 }