First commit

.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

Package.swift

@@ -0,0 +1,5 @@
+import PackageDescription
+
+let package = Package(
+    name: "CSwift"
+)

README.md

@@ -0,0 +1,148 @@
+# Swift调用C语言自建函数库的方法
+
+Rockford Wei，2017-01-17
+
+本程序示范了如何用Swift调用自定义C语言模块的方法。您可以直接下载本程序，或者按照以下教程逐步完成。
+
+## 简介
+
+示范程序中有一个C语言的源程序CSwift.C和一个头文件CSwift.h，我们的目标是构造一个CSwift的函数库，能够让swift源程序执行CSwift程序中的函数。
+
+## 快速上手
+
+本程序需要Swift 3.0以上版本。
+
+### 下载、编译和测试
+
+```
+$ git clone https://github.com/RockfordWei/CSwift.git
+$ cd CSwift
+$ ./build.lib.sh
+$ swift test
+```
+源程序采用C语言写成，测试程序则是Swift语言编写。因此如果通过测试，则恭喜您，已经成功实现了Swift语言调用C语言的整个过程。
+
+## 详细步骤
+
+您可以完全不依赖所有上述内容，而一步一步从零开始制作C函数库和调用C库的Swift代码：
+
+### 构造空白的函数库
+
+仍然假定函数库名称为CSwift。首先找一个空白目录，然后执行：
+
+```
+$ mkdir CSwift
+$ cd CSwift
+$ swift package init --type=system-module
+$ mkdir CSwift
+$ cd CSwift
+$ swift package init
+$ mv Tests ..
+$ cd ..
+$ rm -rf CSwift
+$ mkdir Sources
+```
+
+细心的读者会发现，上面的bash 命令行在CSwift 文件夹下面建立了第二个CSwift文件夹，但是使用了不同的`swift package`了命令。第一个命令是“创建swift空白项目，而且项目类型是系统模块”；而第二个命令是“创建swift 空白项目，项目类型是函数库”。这种做法主要是为了能够在同一个项目中用Swift去测试C语言的模块。
+
+### Module Map
+
+下一步是修理一下目标的模块映射表。请把module.modulemap修改为如下程序：
+
+``` swift
+module CSwift [system] {
+  header "./Sources/CSwift.h"
+  link "CSwift"
+  export *
+}
+```
+
+### C模块编程
+
+好了，现在请在Source文件夹下面建立两个C语言文件：CSwift.c和CSwift.h，内容如下：
+
+#### Sources/CSwift.h
+
+``` c
+extern int c_add(int, int);
+#define C_TEN 10
+```
+
+#### Sources/CSwift.c
+
+``` c
+int c_add(int a, int b) { return a + b ; }
+```
+
+### C模块的编译和库函数链接
+
+上述步骤完成后，可以开始进行C函数库的编译了。首先准备一个编译脚本build.lib.sh，内容如下：
+
+#### build.lib.sh
+
+```
+export LIB_BUILD=.build/debug
+cd Sources
+clang -c CSwift.c
+cd ..
+mv Sources/CSwift.o $LIB_BUILD
+ar -r $LIB_BUILD/libCSwift.a $LIB_BUILD/CSwift.o
+export LIB_BUILD=
+```
+
+上面的程序首先把CSwift.c用clang 编译器（也就是swift的母编译器）链接为一个.o目标文件，然后通过`ar -r` 命令链接为静态函数库，关键是函数库的位置一定要与swift 的目标库目录路径一致。
+
+如果您准备发行，则用.build/release代替上面程序中的`$LIB_BUILD`变量。
+
+保存后执行下列命令：
+
+```
+$ cd CSwift
+$ chmod +x build.lib.sh
+$ swift build
+$ ./build.lib.sh
+```
+
+到此为止，C语言函数库就应该准备好了。
+
+### Swift 程序调用
+
+请修改Tests/CSwiftTests/CSwiftTests.swift文件，内容如下：
+
+``` swift
+
+import XCTest
+@testable import CSwift
+
+class CSwiftTests: XCTestCase {
+    func testExample() {
+        // 测试调用 C 函数
+        let three = c_add(1, 2)
+        XCTAssertEqual(three, 3)
+        // 测试调用 C 语言的符号
+        XCTAssertEqual(C_TEN, 10)
+    }
+
+
+    static var allTests : [(String, (CSwiftTests) -> () throws -> Void)] {
+        return [
+            ("testExample", testExample),
+        ]
+    }
+}
+
+```
+
+### 测试
+
+最后一步最简单，直接执行：
+
+```
+$ swift test
+```
+
+如果没有问题，那就一切OK了！
+
+## 其他
+
+如果您在使用Xcode，则需要使用`swift package generate-xcodeproj`，但是需要调整上述build.lib.sh内容的编译目标目录，并配合Xcode偏好设置选择匹配的目录，否则无法测试。

Sources/CSwift.c

@@ -0,0 +1 @@
+int c_add(int a, int b) { return a + b ; }

Sources/CSwift.h

@@ -0,0 +1,2 @@
+extern int c_add(int, int);
+#define C_TEN 10

Tests/CSwiftTests/CSwiftTests.swift

@@ -0,0 +1,17 @@
+import XCTest
+@testable import CSwift
+
+class CSwiftTests: XCTestCase {
+    func testExample() {
+        let three = c_add(1, 2)
+        XCTAssertEqual(three, 3)
+        XCTAssertEqual(C_TEN, 10)
+    }
+
+
+    static var allTests : [(String, (CSwiftTests) -> () throws -> Void)] {
+        return [
+            ("testExample", testExample),
+        ]
+    }
+}

Tests/LinuxMain.swift

@@ -0,0 +1,6 @@
+import XCTest
+@testable import CSwiftTests
+
+XCTMain([
+     testCase(CSwiftTests.allTests),
+])

build.lib.sh

@@ -0,0 +1,7 @@
+export LIB_BUILD=.build/debug
+cd Sources
+clang -c CSwift.c
+cd ..
+mv Sources/CSwift.o $LIB_BUILD
+ar -r $LIB_BUILD/libCSwift.a $LIB_BUILD/CSwift.o
+export LIB_BUILD=