Commit 02893d80cf013b14708d2262e9ecf0037cf6b3f2 | zig

author	Wooster <r00ster91@proton.me> 2022-08-14 21:31:12+02:00
committer	Wooster <r00ster91@proton.me> 2022-08-14 21:34:59+02:00
log	02893d80cf013b14708d2262e9ecf0037cf6b3f2
tree	3743f76a8e77500c8220e67dae3e3b654056c885
parent	d178df773a6a11eff0b7f06f41fe26930c228b91

api: rename and deprecate a bunch of functions

`isAlNum` and `isAlpha`:
1. I think these names are a bit cryptic.
2. `isAlpha` is a bit ambiguous: is it alpha*numeric* or alpha*betic*?
   This is why I renamed `isAlpha` to `isAlphabetic`.
3. For consistency and because `isAlNum` looks weird, I renamed it to `isAlphanumeric`.

`isCntrl`:
1. It's cryptic and hard to find when you look for it.
2. We don't save a lot of space writing it this way.
3. It's closer to the name of the `control_code` struct.

`isSpace`:
1. The name is ambiguous and misleading.

`spaces`:
1. Ditto

`isXDigit`:
1. The name is extremely cryptic.
2. The function is very hard to find by its name.

1 files changed, 28 insertions(+), 13 deletions(-)

lib
- std
  - ascii.zig

lib/std/ascii.zig+28-13

 @@ -222,16 +222,31 @@ fn inTable(c: u8, t: tIndex) bool {
     return (combinedTable[c] & (@as(u8, 1) << @enumToInt(t))) != 0;
 }
-pub fn isAlNum(c: u8) bool {
+// remove all decls marked as DEPRECATED after 0.10.0
+/// DEPRECATED: use `isAlphanumeric`
+pub const isAlNum = isAlphanumeric;
+/// DEPRECATED: use `isAlpha`
+pub const isAlpha = isAlphabetic;
+/// DEPRECATED: use `isAlpha`
+pub const isCntrl = isControl;
+/// DEPRECATED: use `isWhitespace`.
+pub const isSpace = isWhitespace;
+/// DEPRECATED: use `whitespace`.
+pub const spaces = whitespace;
+/// DEPRECATED: use `isHex`.
+pub const isXDigit = isHex;
+pub fn isAlphanumeric(c: u8) bool {
     return (combinedTable[c] & ((@as(u8, 1) << @enumToInt(tIndex.Alpha)) |
         @as(u8, 1) << @enumToInt(tIndex.Digit))) != 0;
 }
-pub fn isAlpha(c: u8) bool {
+pub fn isAlphabetic(c: u8) bool {
     return inTable(c, tIndex.Alpha);
 }
-pub fn isCntrl(c: u8) bool {
+pub fn isControl(c: u8) bool {
     return c <= control_code.us or c == control_code.del;
 }
 @@ -256,21 +271,21 @@ pub fn isPunct(c: u8) bool {
     return inTable(c, tIndex.Punct);
 }
-pub fn isSpace(c: u8) bool {
+pub fn isWhitespace(c: u8) bool {
     return inTable(c, tIndex.Space);
 }
-/// All the values for which isSpace() returns true. This may be used with
+/// Whitespace for general use.
-/// e.g. std.mem.trim() to trim whiteSpace.
+/// This may be used with e.g. `std.mem.trim` to trim whitespace.
-pub const spaces = [_]u8{ ' ', '\t', '\n', '\r', control_code.VT, control_code.FF };
+/// See also: `isSpace`.
+pub const whitespace = [_]u8{ ' ', '\t', '\n', '\r', control_code.vt, control_code.ff };
-test "spaces" {
+test "whitespace" {
-    const testing = std.testing;
+    for (whitespace) |char| try std.testing.expect(isWhitespace(char));
-    for (spaces) |space| try testing.expect(isSpace(space));
     var i: u8 = 0;
     while (isASCII(i)) : (i += 1) {
-        if (isSpace(i)) try testing.expect(std.mem.indexOfScalar(u8, &spaces, i) != null);
+        if (isWhitespace(i)) try std.testing.expect(std.mem.indexOfScalar(u8, &whitespace, i) != null);
     }
 }
 @@ -278,7 +293,7 @@ pub fn isUpper(c: u8) bool {
     return inTable(c, tIndex.Upper);
 }
-pub fn isXDigit(c: u8) bool {
+pub fn isHex(c: u8) bool {
     return inTable(c, tIndex.Hex);
 }
 @@ -286,7 +301,7 @@ pub fn isASCII(c: u8) bool {
     return c < 128;
 }
-/// DEPRECATED: use `c == ' ' or c == '\x09'` or try `isWhitespace`
+/// DEPRECATED: use `c == ' ' or c == '\t'` or try `isWhitespace`
 pub fn isBlank(c: u8) bool {
     return (c == ' ') or (c == '\x09');
 }