Merge pull request #81 from kean/69-display-globals

Author: mattt

Changelog.md

@@ -14,6 +14,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added asset pipeline for CSS assets.
   #49 by @kaishin.
 
+### Changed
+
+- Changed Home page to display globals for HTML format.
+  #81 by @kean.
+
 ### Fixed
 
 - Fixed relationship handling for members of nested types.

Sources/swift-doc/Supporting Types/Pages/HomePage.swift

@@ -10,10 +10,10 @@ struct HomePage: Page {
     var enumerations: [Symbol] = []
     var structures: [Symbol] = []
     var protocols: [Symbol] = []
-    var operatorNames: Set<String> = []
-    var globalTypealiasNames: Set<String> = []
-    var globalFunctionNames: Set<String> = []
-    var globalVariableNames: Set<String> = []
+    var operators: [Symbol] = []
+    var globalTypealias: [Symbol] = []
+    var globalFunctions: [Symbol] = []
+    var globalVariables: [Symbol] = []
 
     init(module: Module) {
         self.module = module
@@ -28,16 +28,16 @@ struct HomePage: Page {
                 structures.append(symbol)
             case is Protocol:
                 protocols.append(symbol)
-            case let `typealias` as Typealias:
-                globalTypealiasNames.insert(`typealias`.name)
-            case let `operator` as Operator:
-                operatorNames.insert(`operator`.name)
+            case is Typealias:
+                globalTypealias.append(symbol)
+            case is Operator:
+                operators.append(symbol)
             case let function as Function where function.isOperator:
-                operatorNames.insert(function.name)
-            case let function as Function:
-                globalFunctionNames.insert(function.name)
-            case let variable as Variable:
-                globalVariableNames.insert(variable.name)
+                operators.append(symbol)
+            case is Function:
+                globalFunctions.append(symbol)
+            case is Variable:
+                globalVariables.append(symbol)
             default:
                 continue
             }
@@ -54,6 +54,11 @@ struct HomePage: Page {
         let types = classes + enumerations + structures
         let typeNames = Set(types.map { $0.id.description })
         let protocolNames = Set(protocols.map { $0.id.description })
+        let operatorNames = Set(operators.map { $0.id.description })
+
+        let globalTypealiasNames = Set(globalTypealias.map { $0.id.description })
+        let globalFunctionNames = Set(globalFunctions.map { $0.id.description })
+        let globalVariableNames = Set(globalVariables.map { $0.id.description })
 
         return Document {
             ForEach(in: [
@@ -107,24 +112,67 @@ struct HomePage: Page {
             return #"""
             <section id=\#(heading.lowercased())>
                 <h2>\#(heading)</h2>
-                <dl>
-                    \#(symbols.sorted().map { symbol ->  HypertextLiteral.HTML in
-                    let descriptor = String(describing: type(of: symbol.api)).lowercased()
-                    return #"""
-                    <dt class="\#(descriptor)">
-                        <a href=\#(path(for: symbol)) title="\#(descriptor) - \#(symbol.id.description)">
-                            \#(softbreak(symbol.id.description))
-                        </a>
-                    </dt>
-                    <dd>
-                        \#(commonmark: symbol.documentation?.summary ?? "")
-                    </dd>
-                    """# as HypertextLiteral.HTML
-                    })
-                </dl>
+                \#(listHTML(symbols: symbols))
             </section>
-        """# as HypertextLiteral.HTML
+        """#
         })
+        \#(globalsHTML)
+        """#
+    }
+
+    private var globalsHTML: HypertextLiteral.HTML {
+        guard !globalTypealias.isEmpty ||
+            !globalFunctions.isEmpty ||
+            !globalVariables.isEmpty else {
+                return ""
+        }
+
+        let heading = "Globals"
+        return #"""
+        <section id=\#(heading.lowercased())>
+            <h2>\#(heading)</h2>
+            \#(globalsListHTML)
+        </section>
+        """#
+    }
+
+    private var globalsListHTML: HypertextLiteral.HTML {
+        let globals = [
+            ("Typealiases", globalTypealias),
+            ("Functions", globalFunctions),
+            ("Variables", globalVariables),
+        ]
+        return #"""
+        \#(globals.compactMap { (heading, symbols) -> HypertextLiteral.HTML? in
+            guard !symbols.isEmpty else { return nil }
+
+            return #"""
+            <section id=\#(heading.lowercased())>
+                <h3>\#(heading)</h3>
+                \#(listHTML(symbols: symbols))
+            </section>
+        """#
+        })
+        """#
+    }
+
+    private func listHTML(symbols: [Symbol]) -> HypertextLiteral.HTML {
+        #"""
+        <dl>
+            \#(symbols.sorted().map { symbol ->  HypertextLiteral.HTML in
+            let descriptor = String(describing: type(of: symbol.api)).lowercased()
+            return #"""
+            <dt class="\#(descriptor)">
+                <a href=\#(path(for: symbol)) title="\#(descriptor) - \#(symbol.id.description)">
+                    \#(softbreak(symbol.id.description))
+                </a>
+            </dt>
+            <dd>
+                \#(commonmark: symbol.documentation?.summary ?? "")
+            </dd>
+            """#
+            })
+        </dl>
         """#
     }
 }