├── .gitignore ├── Sources └── SyllableCounter │ ├── Resources │ └── SyllableCounter-Exceptions.txt │ └── SyllableCounter.swift ├── Package.swift ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | /.build 3 | /Packages 4 | /*.xcodeproj 5 | xcuserdata/ 6 | -------------------------------------------------------------------------------- /Sources/SyllableCounter/Resources/SyllableCounter-Exceptions.txt: -------------------------------------------------------------------------------- 1 | 1 brutes 2 | 1 chummed 3 | 1 flapped 4 | 1 foamed 5 | 1 gaped 6 | 1 h'm 7 | 1 lb 8 | 1 mimes 9 | 1 ms 10 | 1 peeped 11 | 1 sheered 12 | 1 st 13 | 1 queue 14 | 1 none 15 | 1 leaves 16 | 2 awesome 17 | 2 60 18 | 2 bepatched 19 | 2 capered 20 | 2 caressed 21 | 2 clattered 22 | 2 deafened 23 | 2 dr 24 | 2 effaced 25 | 2 effaces 26 | 2 fringed 27 | 2 gravesend 28 | 2 greyish 29 | 2 jr 30 | 2 mangroves 31 | 2 messieurs 32 | 2 motioned 33 | 2 moustaches 34 | 2 mr 35 | 2 mrs 36 | 2 pencilled 37 | 2 poleman 38 | 2 quivered 39 | 2 reclined 40 | 2 shivered 41 | 2 sidespring 42 | 2 slandered 43 | 2 sombre 44 | 2 sr 45 | 2 stammered 46 | 2 suavely 47 | 2 tottered 48 | 2 trespassed 49 | 2 truckle 50 | 2 unstained 51 | 2 therefore 52 | 3 businesses 53 | 3 bottleful 54 | 3 discoloured 55 | 3 disinterred 56 | 3 hemispheres 57 | 3 manoeuvred 58 | 3 sepulchre 59 | 3 shamefully 60 | 3 unexpressed 61 | 3 veriest 62 | 3 wyoming 63 | 4 etc 64 | 4 sailmaker 65 | 4 satiated 66 | 4 sententiously 67 | 5 particularized 68 | 5 unostentatious 69 | 6 propitiatory 70 | -------------------------------------------------------------------------------- /Package.swift: -------------------------------------------------------------------------------- 1 | // swift-tools-version:5.3 2 | // The swift-tools-version declares the minimum version of Swift required to build this package. 3 | 4 | import PackageDescription 5 | 6 | let package = Package( 7 | name: "syllable-counter-swift", 8 | products: [ 9 | // Products define the executables and libraries produced by a package, and make them visible to other packages. 10 | .library( 11 | name: "SyllableCounter", 12 | targets: ["SyllableCounter"] 13 | ), 14 | ], 15 | dependencies: [ 16 | // Dependencies declare other packages that this package depends on. 17 | // .package(url: /* package url */, from: "1.0.0"), 18 | ], 19 | targets: [ 20 | // Targets are the basic building blocks of a package. A target can define a module or a test suite. 21 | // Targets can depend on other targets in this package, and on products in packages which this package depends on. 22 | .target( 23 | name: "SyllableCounter", 24 | dependencies: [], 25 | resources: [.process("Resources")] 26 | ), 27 | ] 28 | ) 29 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # syllable-counter-swift 2 | Lightweight library to count syllables in words, based on the excellent Java implementation found at https://github.com/m09/syllable-counter 3 | 4 | ## Requirements 5 | Swift 5.3 or newer on macOS or Linux. 6 | 7 | ## Installation 8 | Add the following dependency to your project's `Package.swift`: 9 | 10 | ```swift 11 | .package(url: "https://github.com/wfreitag/syllable-counter-swift.git", .revision("08cd024da5f30ac32939e718a2a964445a4aab4a")) 12 | ``` 13 | 14 | ## How to use 15 | SyllableCounter uses a shared instance that is initialized on first use. 16 | There is one public method: `count()`, which takes a string. 17 | 18 | ```swift 19 | let syllableCount = SyllableCounter.shared.count(word: "wonderful") 20 | print("There are \(syllableCount) syllables in 'wonderful'.") 21 | ``` 22 | 23 | ... or you can use the extension on `String`: 24 | 25 | ```swift 26 | let syllableCount = "wonderful".syllables 27 | print("There are \(syllableCount) syllables in 'wonderful'.) 28 | ``` 29 | 30 | The original [Java implementation](https://github.com/m09/syllable-counter) has a caching option. This feature was not ported over to this implementation. 31 | 32 | ## License 33 | Licensed under the Apache 2.0 License. Feel free to use and modify according to the terms expressed in the license. Contributions welcome. 34 | -------------------------------------------------------------------------------- /Sources/SyllableCounter/SyllableCounter.swift: -------------------------------------------------------------------------------- 1 | // 2 | // SyllableCounter.swift 3 | // 4 | // Created by Warren Freitag on 2/14/16. 5 | // Copyright © 2016 Warren Freitag. All rights reserved. 6 | // Licensed under the Apache 2.0 License. 7 | // 8 | // Adapted from a Java implementation created by Hugo "m09" Mougard. 9 | // https://github.com/m09/syllable-counter 10 | // 11 | 12 | import Foundation 13 | 14 | public class SyllableCounter { 15 | 16 | // MARK: - Shared instance 17 | 18 | public static let shared = SyllableCounter() 19 | 20 | // MARK: - Private properties 21 | 22 | private var exceptions: [String: Int]! 23 | 24 | private var addSyllables: [NSRegularExpression]! 25 | private var subSyllables: [NSRegularExpression]! 26 | 27 | private let vowels: Set = ["a", "e", "i", "o", "u", "y"] 28 | 29 | // MARK: - Error enum 30 | 31 | private enum SyllableCounterError: Error { 32 | case badRegex(String) 33 | case missingExceptionsDataAsset 34 | case badExceptionsData(String) 35 | } 36 | 37 | // MARK: - Constructors 38 | 39 | private init() { 40 | do { 41 | try populateAddSyllables() 42 | try populateSubSyllables() 43 | try populateExceptions() 44 | } 45 | catch SyllableCounterError.badRegex(let pattern) { 46 | print("Bad Regex pattern: \(pattern)") 47 | } 48 | catch SyllableCounterError.missingExceptionsDataAsset { 49 | print("Missing exceptions dataset.") 50 | } 51 | catch SyllableCounterError.badExceptionsData(let info) { 52 | print("Problem parsing exceptions dataset: \(info)") 53 | } 54 | catch { 55 | print("An unexpected error occured while initializing the syllable counter.") 56 | } 57 | } 58 | 59 | // MARK: - Setup 60 | 61 | private func populateAddSyllables() throws { 62 | try addSyllables = buildRegexes(forPatterns: [ 63 | "ia", "riet", "dien", "iu", "io", "ii", 64 | "[aeiouy]bl$", "mbl$", "tl$", "sl$", "[aeiou]{3}", 65 | "^mc", "ism$", "(.)(?!\\1)([aeiouy])\\2l$", "[^l]llien", "^coad.", 66 | "^coag.", "^coal.", "^coax.", "(.)(?!\\1)[gq]ua(.)(?!\\2)[aeiou]", "dnt$", 67 | "thm$", "ier$", "iest$", "[^aeiou][aeiouy]ing$"]) 68 | } 69 | 70 | private func populateSubSyllables() throws { 71 | try subSyllables = buildRegexes(forPatterns: [ 72 | "cial", "cian", "tia", "cius", "cious", 73 | "gui", "ion", "iou", "sia$", ".ely$", 74 | "ves$", "geous$", "gious$", "[^aeiou]eful$", ".red$"]) 75 | } 76 | 77 | private func populateExceptions() throws { 78 | guard let exceptionsResourcePath = Bundle.module.path(forResource: "SyllableCounter-Exceptions", ofType: "txt") else { 79 | throw SyllableCounterError.missingExceptionsDataAsset 80 | } 81 | 82 | let exceptionsList = try String(contentsOfFile: exceptionsResourcePath, encoding: .utf8) 83 | 84 | exceptions = [String: Int]() 85 | 86 | for exception in exceptionsList.components(separatedBy: .newlines) { 87 | if !exception.isEmpty && exception.first != "#" { // skip empty lines and lines beginning with # 88 | let exceptionItemParts = exception.components(separatedBy: " ") 89 | if exceptionItemParts.count != 2 { 90 | throw SyllableCounterError.badExceptionsData("Unexpected line: \(exception)") 91 | } 92 | 93 | let key = exceptionItemParts[1] 94 | let value = Int(exceptionItemParts[0]) 95 | 96 | exceptions[key] = value 97 | } 98 | } 99 | } 100 | 101 | private func buildRegexes(forPatterns patterns: [String]) throws -> [NSRegularExpression] { 102 | return try patterns.map { pattern -> NSRegularExpression in 103 | do { 104 | let regex = try NSRegularExpression(pattern: pattern, options: [.caseInsensitive, .anchorsMatchLines]) 105 | return regex 106 | } 107 | catch { 108 | throw SyllableCounterError.badRegex(pattern) 109 | } 110 | } 111 | } 112 | 113 | // MARK: - Public methods 114 | 115 | public func count(word: String) -> Int { 116 | if word.count <= 1 { 117 | return word.count 118 | } 119 | 120 | var mutatedWord = word.lowercased(with: Locale(identifier: "en_US")).trimmingCharacters(in: .punctuationCharacters) 121 | 122 | if let exceptionValue = exceptions[mutatedWord] { 123 | return exceptionValue 124 | } 125 | 126 | if mutatedWord.last == "e" { 127 | mutatedWord = String(mutatedWord.dropLast()) 128 | } 129 | 130 | var count = 0 131 | var previousIsVowel = false 132 | 133 | for character in mutatedWord { 134 | let isVowel = vowels.contains(character) 135 | if isVowel && !previousIsVowel { 136 | count += 1 137 | } 138 | previousIsVowel = isVowel 139 | } 140 | 141 | for pattern in addSyllables { 142 | let matches = pattern.matches(in: mutatedWord, options: NSRegularExpression.MatchingOptions(rawValue: 0), range: NSRange(location: 0, length: mutatedWord.count)) 143 | if !matches.isEmpty { 144 | count += 1 145 | } 146 | } 147 | 148 | for pattern in subSyllables { 149 | let matches = pattern.matches(in: mutatedWord, options: NSRegularExpression.MatchingOptions(rawValue: 0), range: NSRange(location: 0, length: mutatedWord.count)) 150 | if !matches.isEmpty { 151 | count -= 1 152 | } 153 | } 154 | 155 | return (count > 0) ? count : 1 156 | } 157 | 158 | } 159 | 160 | extension String { 161 | public var syllables: Int { 162 | return SyllableCounter.shared.count(word: self) 163 | } 164 | } 165 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------