Skip to content

Commit 5546e0e

Browse files
parkeraparkera
committed
Add a new Status file to show which parts of the framework are implemented
1 parent 521582d commit 5546e0e

File tree

3 files changed

+164
-1
lines changed

3 files changed

+164
-1
lines changed

‎Docs/ReleaseNotes.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Foundation Release Notes
2+
3+
* Welcome to Foundation!

‎Docs/Status.md

+156
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
# Implementation Status
2+
3+
This document lays out the structure of the Foundation project, and provides the current implementation status of each major feature.
4+
5+
Foundation is divided into groups of related functionality. These groups are currently laid out in the Xcode project, even though they are in a flat structure on disk.
6+
7+
As Foundation is a work in progress, not all methods and functionality are present. When implementations are completed, this list should be updated to reflect the current state of the library.
8+
9+
* **Runtime**: The basis for interoperability.
10+
11+
The classes and methods in this group provide an interface for interoperability between C code and Swift. They also provide common layers used throughout the framework such as the root class `NSObject`.
12+
13+
* `NSObject` is mostly implemented.
14+
* `NSEnumerator` is fully implemented.
15+
* `NSSwiftRuntime` _(internal use only)_ contains Swift runtime-specific functionality.
16+
* `NSObjCRuntime` is missing some key parts such as NSClassFromString. Much of the functionality here is specific to the Objective-C runtime and is not relevant when building for Swift.
17+
18+
19+
* **URL**: Networking primitives.
20+
21+
The classes in this group provide functionality for manipulating URLs and paths via a common model object. The group also has classes for creating and receiving network connections.
22+
23+
* `NSURL` is mostly implemented.
24+
* `NSURLSession` and related classes are not yet implemented.
25+
* _Note_: `NSURLConnection` is deprecated API and not present in this version of Foundation.
26+
27+
28+
* **Formatters**: Locale and language-correct formatted values.
29+
30+
This group contains the is the base `NSFormatter` class and its subclasses. These formatters can be used for dates, numbers, sizes, energy, and many other types.
31+
32+
* `NSFormatter` is fully implemented.
33+
* `NSDateFormatter` is mostly implemented.
34+
* The remaining formatters are not yet implemented.
35+
36+
37+
* **Predicates**: Base functionality for building queries.
38+
39+
This is the base class and subclasses for `NSPredicate` and `NSExpression`.
40+
41+
* These classes are not yet implemented.
42+
43+
44+
* **Serialization**: Serialization and deserialization functionality.
45+
46+
The classes in this group perform tasks like parsing and writing JSON, property lists and binary archives.
47+
48+
* `NSPropertyList` is mostly implemented.
49+
* `NSCoder` and `NSKeyedArchiver` are mostly not yet implemented (a few funnel methods are implemented).
50+
* `NSJSONSerialization` is not yet implemented.
51+
52+
53+
* **XML**: A group of classes for parsing and representing XML documents and elements.
54+
55+
The classes provided in this group are responsible for parsing and validating XML. They should be an interface for representing libxml2 in a more object-oriented manner.
56+
57+
* These classes are not yet implemented.
58+
59+
60+
* **Collections**: A group of classes to contain objects.
61+
62+
The classes provided in this group provide basic collections. The primary role for these classes is to provide an interface layer between the CoreFoundation implementations and the standard library implementations. Additionally, they have useful extras like serialization support. There are also additional collection types that the standard library does not support.
63+
64+
> _Note_: See [Known Issues](Issues.md) for more information about bridging between Foundation collection types and Swift standard library collection types.
65+
66+
* `NSOrderedSet` is not yet implemented.
67+
* `NSCFArray` _(internal use only)_ implements toll-free bridging between Swift and CoreFoundation array types.
68+
* `NSIndexSet` is fully implemented.
69+
* `NSIndexPath` is fully implemented.
70+
* `NSArray` is partially implemented.
71+
* `NSDictionary` is partially implemented.
72+
* `NSCFDictionary` _(internal use only)_ implements toll-free bridging between Swift and CoreFoundation dictionary types.
73+
* `NSSet` is partially implemented.
74+
* `NSCFSet` _(internal use only)_ implements toll-free bridging between Swift and CoreFoundation set types.
75+
* `NSCache` is fully implemented.
76+
* `NSSortDescriptor` is not yet implemented.
77+
78+
79+
* **RunLoop**: Timers, streams and run loops.
80+
81+
The classes in this group provide support for scheduling work and acting upon input from external sources.
82+
83+
* `NSPort` is not yet implemented.
84+
* `NSPortMessage` is not yet implemented.
85+
* `NSRunLoop` is not yet implemented. Its CoreFoundation equivalent `CFRunLoop` is available, but needs some work to remove a dependency on libdispatch.
86+
* `NSStream` is not yet implemented.
87+
* `NSTimer` is not yet implemented.
88+
89+
90+
* **String**: A set of classes for scanning, manipulating and storing string values.
91+
92+
The NSString implementation is present to provide an interface layer between CoreFoundation and Swift, but it also adds additional functionality on top of the Swift standard library String type. Other classes in this group provide mechanisms to scan, match regular expressions, store attributes in run arrays attached to strings, and represent sets of characters.
93+
94+
> _Note_: See [Known Issues](Issues.md) for more information about bridging between the Foundation NSString types and Swift standard library String type.
95+
96+
* `NSRegularExpression` is not yet implemented.
97+
* `NSScanner` is fully implemented. _Note_: This class contains some experimental API. See the source for more details.
98+
* `NSTextCheckingResult` is not yet implemented.
99+
* `NSAttributedString` is not yet implemented.
100+
* `NSCharacterSet` is fully implemented.
101+
* `NSString` is partially implemented.
102+
* `NSCFString` _(internal use only)_ implements toll-free bridging between Swift and CoreFoundation String types.
103+
104+
105+
* **Number**: A set of classes and methods for representing numeric values and structures.
106+
107+
* `NSRange` is fully implemented.
108+
* `NSDecimal` is not yet implemented.
109+
* `NSDecimalNumber` is not yet implemented.
110+
* `NSGeometry` is fully implemented.
111+
* `NSAffineTransform` is not yet implemented.
112+
* `NSNumber` is fully implemented.
113+
* `NSValue` is not yet implemented.
114+
115+
116+
* **UserDefaults**: A mechanism for storing values to persist as user settings and local.
117+
118+
* `NSUserDefaults` is not yet implemented.
119+
* `NSLocale` is fully implemented.
120+
121+
122+
* **OS**: Mechanisms for interacting with the operating system on a file system level as well as process and thread level
123+
124+
* `NSFileHandle` is mostly not yet implemented, excluding a few methods used for plutil.
125+
* `NSFileManager` is partially implemented.
126+
* `NSTask` is not yet implemented.
127+
* `NSBundle` is mostly not yet implemented. The CoreFoundation implementation of `CFBundle` is available to use.
128+
* `NSProcessInfo` is mostly implemented.
129+
* `NSThread` is fully implemented.
130+
* `NSOperation` is not yet implemented.
131+
* `NSLock` is fully implemented.
132+
* `NSPathUtilities` is mostly implemented.
133+
134+
135+
* **DateTime**: Classes for representing dates, timezones, and calendars.
136+
137+
* `NSCalendar` is fully implemented. _Note_: This class contains some experimental API. See the source for more details.
138+
* `NSDate` is fully implemented.
139+
* `NSTimeZone` is partially implemented.
140+
141+
142+
* **Notifications**: Classes for loosely coupling events from a set of many observers.
143+
144+
* `NSNotification` is not yet implemented.
145+
* `NSNotificationQueue` is not yet implemented.
146+
147+
148+
* **Model**: Representations for abstract model elements like null, data, and errors.
149+
150+
* `NSNull` is fully implemented.
151+
* `NSData` is mostly implemented.
152+
* `NSProgress` is not yet implemented.
153+
* `NSError` is fully implemented.
154+
* `NSUUID` is fully implemented.
155+
* `NSPersonNameComponents` is not yet implemented.
156+
* `FoundationErrors` is an interoperability layer between `NSError` and Swift error handling.

‎README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ Our primary goal is to achieve implementation parity with Foundation on Apple pl
2222

2323
In our first year, we are not looking to make major API changes to the library. We feel that this will hamper the primary goal. There are some areas where API changes are unavoidable, however. For more information on those APIs and the overall design of Foundation, please see [our design document](Docs/Design.md).
2424

25+
### Current Status
26+
27+
See our [status page](Docs/Status.md) for a detailed list of what features are currently implemented.
28+
2529
## Using Foundation
2630

2731
Here is a simple `main.swift` file which uses Foundation. This guide assumes you have already installed a version of the latest [Swift binary distribution](https://swift.org/downloads#latest).
@@ -73,4 +77,4 @@ The Objective-C runtime is not part of the Swift open source project. We can, ho
7377

7478
##### How do I contribute?
7579

76-
We welcome contributions to Foundation! Please see the [Known Issues](Docs/Issues.md) page if you are looking for an area where we need help. We are also standing by on the [Mailing Lists](https://swift.org/community/#communication) to answer questions about what is most important to do and what we will accept into the project.
80+
We welcome contributions to Foundation! Please see the [known issues](Docs/Issues.md) page if you are looking for an area where we need help. We are also standing by on the [mailing lists](https://swift.org/community/#communication) to answer questions about what is most important to do and what we will accept into the project.

0 commit comments

Comments
 (0)