From c9e1e78ce8519abd2f09efc5686db94cbdb3c887 Mon Sep 17 00:00:00 2001 From: Rockford Wei Date: Wed, 22 Feb 2017 10:57:45 -0500 Subject: [PATCH] Init --- .gitignore | 4 + LICENSE | 201 ++++++++++++++++++++++++++++++ Package.swift | 5 + README.md | 101 +++++++++++++++ README.zh_CN.md | 104 ++++++++++++++++ Sources/Regex.swift | 85 +++++++++++++ Tests/LinuxMain.swift | 6 + Tests/RegexTests/RegexTests.swift | 22 ++++ 8 files changed, 528 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 Package.swift create mode 100644 README.md create mode 100644 README.zh_CN.md create mode 100644 Sources/Regex.swift create mode 100644 Tests/LinuxMain.swift create mode 100644 Tests/RegexTests/RegexTests.swift diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..02c0875 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.DS_Store +/.build +/Packages +/*.xcodeproj diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/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. diff --git a/Package.swift b/Package.swift new file mode 100644 index 0000000..294fcc6 --- /dev/null +++ b/Package.swift @@ -0,0 +1,5 @@ +import PackageDescription + +let package = Package( + name: "Regex" +) diff --git a/README.md b/README.md new file mode 100644 index 0000000..c84e606 --- /dev/null +++ b/README.md @@ -0,0 +1,101 @@ +# String Extension of Regular Expression [简体中文](README.zh_CN.md) + +

+ + Get Involed with Perfect! + +

+ +

+ + Star Perfect On Github + + + Stack Overflow + + + Follow Perfect on Twitter + + + Join the Perfect Slack + +

+ +

+ + Swift 3.0 + + + Platforms OS X | Linux + + + License Apache + + + PerfectlySoft Twitter + + + Slack Status + +

+ + + +This project provides a light weight / simple regular expression extension for Swift String. + +This package builds with Swift Package Manager and is part of the [Perfect](https://github.com/PerfectlySoft/Perfect) project. It was written to be stand-alone and so does not require PerfectLib or any other components. + +Ensure you have installed and activated the latest Swift 3.0 tool chain. + +## Issues + +We are transitioning to using JIRA for all bugs and support related issues, therefore the GitHub issues has been disabled. + +If you find a mistake, bug, or any other helpful suggestion you'd like to make on the docs please head over to [http://jira.perfect.org:8080/servicedesk/customer/portal/1](http://jira.perfect.org:8080/servicedesk/customer/portal/1) and raise it. + +A comprehensive list of open issues can be found at [http://jira.perfect.org:8080/projects/ISS/issues](http://jira.perfect.org:8080/projects/ISS/issues) + +## Building +Add this project as a dependency in your Package.swift file. + +``` swift +.Package(url:"https://github.com/PerfectSideRepos/Perfect-RegEx.git", majorVersion: 1, minor: 0) +``` + +Then please add the following line to the beginning part of swift sources: +``` swift +import Regex +``` + +## Quick Start + +The following demo shows how to extract substrings with a pattern, for example, phone numbers: + +``` swift +let text = "this is a long test. The correct number is 123-456-7890 or 647-237-8888 but please don't deal because it's not my number. 我的电话我可不告诉你是 416-970-8888 🇨🇳 🇨🇦 " + +let found = text.matches() +print(found) +``` + +## API Info + +There is only one function in this library, called `matches()`: + +``` swift +extension String { + public func matches(pattern: String = "[0-9]{3}-[0-9]{3}-[0-9]{4}", limitation: Int = 32) + -> [(rangeBegin: Int, rangeEnd: Int, extraction: String)] +} +``` + +### Parameters: +- pattern: String, the regular expression; default value is a typical phone number, like 123-456-7890 +- limitation: Int, the maximum number of matches allowed to find; default is 32, which means the first 32 needles would be found and save from the stack + +### Returns: + +`[(rangeBegin: Int, rangeEnd: Int, extraction: String)]` - a tuple array, each element is the range begin / end mark, with the extraction value; if nothing found or error happened, the result set will be empty. + +## Further Information +For more information on the Perfect project, please visit [perfect.org](http://perfect.org). diff --git a/README.zh_CN.md b/README.zh_CN.md new file mode 100644 index 0000000..38b1ea5 --- /dev/null +++ b/README.zh_CN.md @@ -0,0 +1,104 @@ +# 字符串正则表达式扩展 [English](README.md) + +

+ + Get Involed with Perfect! + +

+ +

+ + Star Perfect On Github + + + Chat on Gitter + + + Follow Perfect on Twitter + + + Join the Perfect Slack + +

+ +

+ + Swift 3.0 + + + Platforms OS X | Linux + + + License Apache + + + PerfectlySoft Twitter + + + Join the chat at https://gitter.im/PerfectlySoft/Perfect + + + Slack Status + +

+ + +该项目实现了 Swift 字符串的一个非常轻量、简单的正则表达式扩展。 + +该软件使用SPM进行编译和测试，本软件也是[Perfect](https://github.com/PerfectlySoft/Perfect)项目的一部分。本软件包可独立使用，因此使用时可以脱离PerfectLib等其他组件。 + +请确保您已经安装并激活了最新版本的 Swift 3.0 tool chain 工具链。 + +### 问题报告、内容贡献和客户支持 + +我们目前正在过渡到使用JIRA来处理所有源代码资源合并申请、修复漏洞以及其它有关问题。因此，GitHub 的“issues”问题报告功能已经被禁用了。 + +如果您发现了问题，或者希望为改进本文提供意见和建议，[请在这里指出](http://jira.perfect.org:8080/servicedesk/customer/portal/1). + +在您开始之前，请参阅[目前待解决的问题清单](http://jira.perfect.org:8080/projects/ISS/issues). + +## 编译 +请在您的Package.swift 文件中增加如下依存关系： + +``` swift +.Package(url:"https://github.com/PerfectSideRepos/Perfect-RegEx.git", majorVersion: 1, minor: 0) +``` + +然后在源代码开头部分引用函数库： +``` swift +import Regex +``` + +## 快速上手 + +以下示范代码展示了如何从字符串内提取电话号码： + +``` swift +let text = "this is a long test. The correct number is 123-456-7890 or 647-237-8888 but please don't deal because it's not my number. 我的电话我可不告诉你是 416-970-8888 🇨🇳 🇨🇦 " + +let found = text.matches() +print(found) +``` + +## API 参考 + +本函数库内只有一个函数，名为`matches()`: + +``` swift +extension String { + public func matches(pattern: String = "[0-9]{3}-[0-9]{3}-[0-9]{4}", limitation: Int = 32) + -> [(rangeBegin: Int, rangeEnd: Int, extraction: String)] +} +``` + +### 参数: +- pattern: String, 正则表达式，默认为一个电话号码，比如 123-456-7890 +- limitation: Int, 允许检索的最大结果数量限制。默认为32，意味着只有前32个结果能够返回 + +### 返回值： + +`[(rangeBegin: Int, rangeEnd: Int, extraction: String)]` - 一个元组数组，每个元素分别有三个单元，依次为检索结果的起点为止、终点位置，以及随后提取的匹配字符串。如果没找到或者出错，返回值为空数组。 + + +## 更多信息 +关于本项目更多内容，请参考[perfect.org](http://perfect.org). diff --git a/Sources/Regex.swift b/Sources/Regex.swift new file mode 100644 index 0000000..0df06fe --- /dev/null +++ b/Sources/Regex.swift @@ -0,0 +1,85 @@ +#if os(Linux) +import SwiftGlibc +#else +import Darwin +#endif + +extension String { + + /// using regular expression to extract substrings + /// - parameters: + /// - pattern: String, the regular expression; default value is a typical phone number, like 123-456-7890 + /// - limitation: Int, the maximum number of matches allowed to find; default is 32, which means the first 32 needles would be found and save from the stack + /// - returns: + /// [(Int, Int, String)] - a turple array, each element is the range begin / end mark, with the extraction value; if nothing found or error happened, the result set will be empty. + public func matches(pattern: String = "[0-9]{3}-[0-9]{3}-[0-9]{4}", limitation: Int = 32) -> [(rangeBegin: Int, rangeEnd: Int, extraction: String)] { + + // set up an empty result set + var found = [(rangeBegin: Int, rangeEnd: Int, extraction: String)]() + + // prepare to compile the regular expression + var reg = regex_t() + let status = regcomp(®, pattern, REG_EXTENDED) + if status != 0 { + return found + }//end if + + // allocate a buffer for the outcomes + let m = UnsafeMutablePointer.allocate(capacity: limitation) + + // preform searching + var nomatch:Int32 = 1 + + // prepare pointers + let me = strdup(self) + var cursor = me + let copy = strdup(self) + let sz = Int(strlen(me!)) + + // loop until all matches were found + repeat { + + // perform the search + nomatch = regexec(®, cursor, limitation, m, 0) + + // no match was found, jump out + if nomatch != 0 { + break + }//end if + + + // retrieve each matches from the pointer buffer + for i in 0 ... limitation - 1 { + + // if reach the end, the position marker will be -1 + let p = m.advanced(by: i).pointee + guard p.rm_so > -1 else { + break + }//end guard + + // save the result into the duplicated string + memset(copy!, 0, Int(sz)) + memcpy(copy!, cursor!.advanced(by: Int(p.rm_so)), p.rm_eo - p.rm_so) + + // turn the pointer into string + let extraction = String(cString: copy!) + + // append outcomes to return set + found.append((Int(p.rm_so), Int(p.rm_eo), extraction)) + }//next i + + cursor = cursor!.advanced(by: Int(m.pointee.rm_eo)) + + // loop until nothing further was found + }while(nomatch == 0) + + // release temporary allocations + free(copy) + free(me) + // release resources before checking outcomes + regfree(®) + // release the pointer buffer + m.deallocate(capacity: limitation) + return found + }//end func +}//end extension diff --git a/Tests/LinuxMain.swift b/Tests/LinuxMain.swift new file mode 100644 index 0000000..98976ff --- /dev/null +++ b/Tests/LinuxMain.swift @@ -0,0 +1,6 @@ +import XCTest +@testable import RegexTests + +XCTMain([ + testCase(RegexTests.allTests), +]) diff --git a/Tests/RegexTests/RegexTests.swift b/Tests/RegexTests/RegexTests.swift new file mode 100644 index 0000000..9035955 --- /dev/null +++ b/Tests/RegexTests/RegexTests.swift @@ -0,0 +1,22 @@ +import XCTest +@testable import Regex + +class RegexTests: XCTestCase { + func testExample() { + let test = "this is a long test. The correct number is 123-456-7890 or 647-237-8888 but please don't deal because it's not my number. 我的电话我可不告诉你是 416-970-8888" + + let outcome = test.matches() + print(outcome) + XCTAssertEqual(outcome.count, 3) + XCTAssertEqual(outcome[0].2, "123-456-7890") + XCTAssertEqual(outcome[1].2, "647-237-8888") + XCTAssertEqual(outcome[2].2, "416-970-8888") + } + + + static var allTests : [(String, (RegexTests) -> () throws -> Void)] { + return [ + ("testExample", testExample), + ] + } +}