front/swiftGrammar
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
oscarz
2024-08-12 10:49:20 +08:00
parent 3002510aaf
commit 00fd0adf89
331 changed files with 53210 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

177
Pods/LoggerAPI/LICENSE.txt generated Normal file
View File

@ -0,0 +1,177 @@
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

94
Pods/LoggerAPI/README.md generated Normal file
View File

@ -0,0 +1,94 @@
<p align="center">
<a href="http://kitura.dev/">
<img src="https://raw.githubusercontent.com/Kitura/Kitura/master/Sources/Kitura/resources/kitura-bird.svg?sanitize=true" height="100" alt="Kitura">
</a>
</p>
<p align="center">
<a href="https://ibm-swift.github.io/LoggerAPI/index.html">
<img src="https://img.shields.io/badge/apidoc-LoggerAPI-1FBCE4.svg?style=flat" alt="APIDoc">
</a>
<a href="https://travis-ci.org/Kitura/LoggerAPI">
<img src="https://travis-ci.org/Kitura/LoggerAPI.svg?branch=master" alt="Build Status - Master">
</a>
<img src="https://img.shields.io/badge/os-macOS-green.svg?style=flat" alt="macOS">
<img src="https://img.shields.io/badge/os-linux-green.svg?style=flat" alt="Linux">
<img src="https://img.shields.io/badge/license-Apache2-blue.svg?style=flat" alt="Apache 2">
<a href="http://swift-at-ibm-slack.mybluemix.net/">
<img src="http://swift-at-ibm-slack.mybluemix.net/badge.svg" alt="Slack Status">
</a>
</p>
# LoggerAPI
A logger protocol that provides a common logging interface for different kinds of loggers. In addition, a class with a set of static functions for logging within your code is provided.
[Kitura](https://github.com/Kitura/Kitura) uses this API throughout its implementation when logging.
## Usage
#### Add dependencies
Add the `LoggerAPI` package to the dependencies within your application’s `Package.swift` file. Substitute `"x.x.x"` with the latest `LoggerAPI` [release](https://github.com/Kitura/LoggerAPI/releases):
```swift
.package(url: "https://github.com/Kitura/LoggerAPI.git", from: "x.x.x")
```
Add `LoggerAPI` to your target's dependencies:
```swift
.target(name: "example", dependencies: ["LoggerAPI"]),
```
#### Import package
```swift
import LoggerAPI
````
#### Log messages
Add log messages to your application:
```swift
Log.warning("This is a warning.")
Log.error("This is an error.")
```
#### Define a logger
You need to define a `logger` in order to output these messages. You may wish to write your own `Logger` implementation, or you can use `HeliumLogger` that writes to standard output:
```swift
import LoggerAPI
import HeliumLogger
let myLogger = HeliumLogger(.info)
Log.logger = myLogger
```
You can find out more about HeliumLogger [here](https://github.com/Kitura/HeliumLogger/blob/master/README.md).
#### Logging messages to swift-log
You can direct your log messages to be logged via [swift-log](https://github.com/apple/swift-log) by setting the `swiftLogger` property:
```swift
import LoggerAPI
import Logging
let myLogger = Logging.Logger(label: "myLogger")
myLogger.logLevel = .notice
Log.swiftLogger = myLogger
```
If both `logger` and `swiftLogger` are set, then log messages will be sent to both logging backends. The log level configured for a LoggerAPI Logger and a swift-log Logger are independent, so may be used to log at different levels.
Note that because the hierarchy of log levels defined by LoggerAPI and swift-log is slightly different, a mapping is defined between the levels. See the documentation for `Log.isLogging()` for details.
## API documentation
For more information visit our [API reference](http://ibm-swift.github.io/LoggerAPI/).
## Community
We love to talk server-side Swift, and Kitura. Join our [Slack](http://swift-at-ibm-slack.mybluemix.net/) to meet the team!
## License
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/Kitura/LoggerAPI/blob/master/LICENSE.txt).

347
Pods/LoggerAPI/Sources/LoggerAPI/Logger.swift generated Normal file
View File

@ -0,0 +1,347 @@
/**
* Copyright IBM Corporation 2016 - 2019
*
* 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.
**/
import Logging
import Foundation
/// Implement the `CustomStringConvertible` protocol for the `LoggerMessageType` enum
extension LoggerMessageType: CustomStringConvertible {
/// Convert a `LoggerMessageType` into a printable format.
public var description: String {
switch self {
case .entry:
return "ENTRY"
case .exit:
return "EXIT"
case .debug:
return "DEBUG"
case .verbose:
return "VERBOSE"
case .info:
return "INFO"
case .warning:
return "WARNING"
case .error:
return "ERROR"
}
}
}
/// A logger protocol implemented by Logger implementations. This API is used by Kitura
/// throughout its implementation when logging.
public protocol Logger {
/// Output a logged message.
///
/// - Parameter type: The type of the message (`LoggerMessageType`) being logged.
/// - Parameter msg: The message to be logged.
/// - Parameter functionName: The name of the function invoking the logger API.
/// - Parameter lineNum: The line in the source code of the function invoking the
/// logger API.
/// - Parameter fileName: The file containing the source code of the function invoking the
/// logger API.
func log(_ type: LoggerMessageType, msg: String,
functionName: String, lineNum: Int, fileName: String)
/// Indicates if a message with a specified type (`LoggerMessageType`) will be in the logger
/// output (i.e. will not be filtered out).
///
/// - Parameter type: The type of message (`LoggerMessageType`).
///
/// - Returns: A Boolean indicating whether a message of the specified type
/// (`LoggerMessageType`) will be in the logger output.
func isLogging(_ level: LoggerMessageType) -> Bool
}
extension NSLock {
func withLock<T>(_ body: () throws -> T) rethrows -> T {
self.lock()
defer {
self.unlock()
}
return try body()
}
}
/// A class of static members used by anyone who wants to log messages.
public class Log {
private static var _logger: Logger?
private static var _loggerLock: NSLock = NSLock()
/// An instance of the logger. It should usually be the one and only reference
/// of the `Logger` protocol implementation in the system.
/// This can be used in addition to `swiftLogger`, in which case log messages
/// will be sent to both loggers.
public static var logger: Logger? {
get {
return self._loggerLock.withLock { self._logger }
}
set {
self._loggerLock.withLock { self._logger = newValue }
}
}
private static var _swiftLogger: Logging.Logger?
private static var _swiftLoggerLock: NSLock = NSLock()
/// An instance of a swift-log Logger. If set, LoggerAPI will direct log messages
/// to swift-log. This can be used in addition to `logger`, in which case log
/// messages will be sent to both loggers.
public static var swiftLogger: Logging.Logger? {
get {
return self._swiftLoggerLock.withLock { self._swiftLogger }
}
set {
self._swiftLoggerLock.withLock { self._swiftLogger = newValue }
}
}
/// Log a message for use when in verbose logging mode.
///
/// - Parameter msg: The message to be logged.
/// - Parameter functionName: The name of the function invoking the logger API.
/// Defaults to the name of the function invoking
/// this function.
/// - Parameter lineNum: The line in the source code of the function invoking the
/// logger API. Defaults to the line of the
/// function invoking this function.
/// - Parameter fileName: The file containing the source code of the function invoking the
/// logger API. Defaults to the name of the file containing the function
/// which invokes this function.
public static func verbose(_ msg: @autoclosure () -> String, functionName: String = #function,
lineNum: Int = #line, fileName: String = #file ) {
if let logger = logger, logger.isLogging(.verbose) {
logger.log( .verbose, msg: msg(),
functionName: functionName, lineNum: lineNum, fileName: fileName)
}
swiftLogger?.info("\(msg())")
}
/// Log an informational message.
///
/// - Parameter msg: The message to be logged.
/// - Parameter functionName: The name of the function invoking the logger API.
/// Defaults to the name of the function invoking
/// this function.
/// - Parameter lineNum: The line in the source code of the function invoking the
/// logger API. Defaults to the line of the
/// function invoking this function.
/// - Parameter fileName: The file containing the source code of the function invoking the
/// logger API. Defaults to the name of the file containing the function
/// which invokes this function.
public class func info(_ msg: @autoclosure () -> String, functionName: String = #function,
lineNum: Int = #line, fileName: String = #file) {
if let logger = logger, logger.isLogging(.info) {
logger.log( .info, msg: msg(),
functionName: functionName, lineNum: lineNum, fileName: fileName)
}
swiftLogger?.notice("\(msg())")
}
/// Log a warning message.
///
/// - Parameter msg: The message to be logged.
/// - Parameter functionName: The name of the function invoking the logger API.
/// Defaults to the name of the function invoking
/// this function.
/// - Parameter lineNum: The line in the source code of the function invoking the
/// logger API. Defaults to the line of the
/// function invoking this function.
/// - Parameter fileName: The file containing the source code of the function invoking the
/// logger API. Defaults to the name of the file containing the function
/// which invokes this function.
public class func warning(_ msg: @autoclosure () -> String, functionName: String = #function,
lineNum: Int = #line, fileName: String = #file) {
if let logger = logger, logger.isLogging(.warning) {
logger.log( .warning, msg: msg(),
functionName: functionName, lineNum: lineNum, fileName: fileName)
}
swiftLogger?.warning("\(msg())")
}
/// Log an error message.
///
/// - Parameter msg: The message to be logged.
/// - Parameter functionName: The name of the function invoking the logger API.
/// Defaults to the name of the function invoking
/// this function.
/// - Parameter lineNum: The line in the source code of the function invoking the
/// logger API. Defaults to the line of the
/// function invoking this function.
/// - Parameter fileName: The file containing the source code of the function invoking the
/// logger API. Defaults to the name of the file containing the function
/// which invokes this function.
public class func error(_ msg: @autoclosure () -> String, functionName: String = #function,
lineNum: Int = #line, fileName: String = #file) {
if let logger = logger, logger.isLogging(.error) {
logger.log( .error, msg: msg(),
functionName: functionName, lineNum: lineNum, fileName: fileName)
}
swiftLogger?.error("\(msg())")
}
/// Log a debugging message.
///
/// - Parameter msg: The message to be logged.
/// - Parameter functionName: The name of the function invoking the logger API.
/// Defaults to the name of the function invoking
/// this function.
/// - Parameter lineNum: The line in the source code of the function invoking the
/// logger API. Defaults to the line of the
/// function invoking this function.
/// - Parameter fileName: The file containing the source code of the function invoking the
/// logger API. Defaults to the name of the file containing the function
/// which invokes this function.
public class func debug(_ msg: @autoclosure () -> String, functionName: String = #function,
lineNum: Int = #line, fileName: String = #file) {
if let logger = logger, logger.isLogging(.debug) {
logger.log( .debug, msg: msg(),
functionName: functionName, lineNum: lineNum, fileName: fileName)
}
swiftLogger?.debug("\(msg())")
}
/// Log a message when entering a function.
///
/// - Parameter msg: The message to be logged.
/// - Parameter functionName: The name of the function invoking the logger API.
/// Defaults to the name of the function invoking
/// this function.
/// - Parameter lineNum: The line in the source code of the function invoking the
/// logger API. Defaults to the line of the
/// function invoking this function.
/// - Parameter fileName: The file containing the source code of the function invoking the
/// logger API. Defaults to the name of the file containing the function
/// which invokes this function.
public class func entry(_ msg: @autoclosure () -> String, functionName: String = #function,
lineNum: Int = #line, fileName: String = #file) {
if let logger = logger, logger.isLogging(.entry) {
logger.log(.entry, msg: msg(),
functionName: functionName, lineNum: lineNum, fileName: fileName)
}
swiftLogger?.trace("\(msg())")
}
/// Log a message when exiting a function.
///
/// - Parameter msg: The message to be logged.
/// - Parameter functionName: The name of the function invoking the logger API.
/// Defaults to the name of the function invoking
/// this function.
/// - Parameter lineNum: The line in the source code of the function invoking the
/// logger API. Defaults to the line of the
/// function invoking this function.
/// - Parameter fileName: The file containing the source code of the function invoking the
/// logger API. Defaults to the name of the file containing the function
/// which invokes this function.
public class func exit(_ msg: @autoclosure () -> String, functionName: String = #function,
lineNum: Int = #line, fileName: String = #file) {
if let logger = logger, logger.isLogging(.exit) {
logger.log(.exit, msg: msg(),
functionName: functionName, lineNum: lineNum, fileName: fileName)
}
swiftLogger?.trace("\(msg())")
}
/// Indicates if a message with a specified type (`LoggerMessageType`) will be logged
/// by some configured logger (i.e. will not be filtered out). This could be a Logger
/// conforming to LoggerAPI, swift-log or both.
///
/// Note that due to differences in the log levels defined by LoggerAPI and swift-log,
/// their equivalence is mapped as follows:
/// ```
/// LoggerAPI: swift-log:
/// .error -> .error
/// .warning -> .warning
/// .info -> .notice
/// .verbose -> .info
/// .debug -> .debug
/// .entry -> .trace
/// .exit -> .trace
/// ```
///
/// For example, a swift-log Logger configured to log at the `.notice` level will log
/// messages from LoggerAPI at a level of `.info` or higher.
///
/// - Parameter level: The type of message (`LoggerMessageType`).
///
/// - Returns: A Boolean indicating whether a message of the specified type
/// (`LoggerMessageType`) will be logged.
public class func isLogging(_ level: LoggerMessageType) -> Bool {
return isLoggingToLoggerAPI(level) || isLoggingToSwiftLog(level)
}
/// Indicates whether a LoggerAPI Logger is configured to log at the specified level.
///
/// - Parameter level: The type of message (`LoggerMessageType`).
///
/// - Returns: A Boolean indicating whether a message of the specified type
/// will be logged via the registered `LoggerAPI.Logger`.
private class func isLoggingToLoggerAPI(_ level: LoggerMessageType) -> Bool {
guard let logger = logger else {
return false
}
return logger.isLogging(level)
}
/// Indicates whether a swift-log Logger is configured to log at the specified level.
///
/// - Parameter level: The type of message (`LoggerMessageType`).
///
/// - Returns: A Boolean indicating whether a message of the specified type
/// will be logged via the registered `Logging.Logger`.
private class func isLoggingToSwiftLog(_ level: LoggerMessageType) -> Bool {
guard let logger = swiftLogger else {
return false
}
switch level {
case .error:
return logger.logLevel <= .error
case .warning:
return logger.logLevel <= .warning
case .info:
return logger.logLevel <= .notice
case .verbose:
return logger.logLevel <= .info
case .debug:
return logger.logLevel <= .debug
case .entry, .exit:
return logger.logLevel <= .trace
}
}
}
/// The type of a particular log message. It is passed with the message to be logged to the
/// actual logger implementation. It is also used to enable filtering of the log based
/// on the minimal type to log.
public enum LoggerMessageType: Int {
/// Log message type for logging when entering into a function.
case entry = 1
/// Log message type for logging when exiting from a function.
case exit = 2
/// Log message type for logging a debugging message.
case debug = 3
/// Log message type for logging messages in verbose mode.
case verbose = 4
/// Log message type for logging an informational message.
case info = 5
/// Log message type for logging a warning message.
case warning = 6
/// Log message type for logging an error message.
case error = 7
}