Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

audit the standard library API and implementations #1629

Open
andrewrk opened this issue Oct 3, 2018 · 4 comments
Open

audit the standard library API and implementations #1629

andrewrk opened this issue Oct 3, 2018 · 4 comments
Labels
breaking Implementing this issue could cause existing code to no longer compile or have different behavior. standard library This issue involves writing Zig code for the standard library.
Milestone
1.0.0

Comments

@andrewrk
Copy link
Member

andrewrk commented Oct 3, 2018 •
edited
Loading

  • Code review for implementation robustness
  • API correctness, robustness, consistency, and future proofing
  • Review all fully qualified names
  • Remove unnecessary APIs. They can go into third party maintained projects/packages.
  • Compare with other language std libs, make sure we are not missing some critical component
  • convert TODO comments from source code into issues #363
@andrewrk andrewrk added the standard library This issue involves writing Zig code for the standard library. label Oct 3, 2018
@andrewrk andrewrk added this to the 1.0.0 milestone Oct 3, 2018
@andrewrk andrewrk mentioned this issue Oct 3, 2018
Merged
@andrewrk andrewrk mentioned this issue Nov 6, 2018
Closed
@andrewrk andrewrk mentioned this issue Nov 25, 2018
Closed
@andrewrk andrewrk mentioned this issue Apr 16, 2019
Closed
@andrewrk andrewrk mentioned this issue May 5, 2019
Merged
@andrewrk andrewrk mentioned this issue May 17, 2019
Closed
andrewrk added a commit that referenced this issue Jan 5, 2020
@andrewrk
std.os.getrusage: add C extern fn and reserved field
fee9318 
 * add reserved field to match musl struct definition so that
   it will work with musl libc.
 * add libc getrusage so that it will work with libc

what's not done in this branch is:
 * test coverage. See #1629, which should also aim to provide
   general test coverage for the std lib.
 * rusage struct bits for non-linux operating systems
@schmee schmee mentioned this issue Jan 14, 2020
Closed
@andrewrk andrewrk added the breaking Implementing this issue could cause existing code to no longer compile or have different behavior. label Mar 3, 2020
@andrewrk andrewrk mentioned this issue Mar 4, 2020
Closed
@Vexu Vexu mentioned this issue May 8, 2020
Merged
@Vexu Vexu mentioned this issue Jun 27, 2020
Closed
@jayschwa
Copy link
Contributor

Does naming consistency fall under this issue? It seems like there's a mix of long versus shortened names (e.g. eql or len).

@squeek502 squeek502 mentioned this issue Jan 15, 2021
Closed
@jayschwa jayschwa mentioned this issue Nov 20, 2021
Open
@iacore
Copy link
Contributor

iacore commented Nov 23, 2021 •
edited
Loading

tl;dr: use code generation for data structures then we only need to audit the code generation part

Maybe we should name standard library functions based on some established library standard like Progsbase. We don't need to write test cases ourselves since it's provided by the standard library standard.

Non-IO functions can be easily generated from existing code in another language. It's possible to use code generation to make entire Progsbase library available in Zig, so how big a standard library do we want Zig to have? We should have a discussion on this.

On code generation, aside from Progsbase, it's easy to generate code from any language with similar memory model (no RC or GC). We may also implement a new back-end for Haxe and generate standard library that way.

@iacore
Copy link
Contributor

iacore commented Dec 20, 2021

There are so many issues about the standard library. I want to create a project at https://github.com/ziglang/zig/projects?type=beta but I don't have permission. @andrewrk can you do it?

We probably also need a code review solution for (crowd-sourcing) reviewing standard library.

@iacore iacore mentioned this issue Dec 23, 2021
Open
@andrewrk andrewrk mentioned this issue May 17, 2022
Merged
@andrewrk andrewrk mentioned this issue May 26, 2022
Closed
@andrewrk andrewrk mentioned this issue Jul 2, 2023
Closed
@jayschwa jayschwa mentioned this issue Aug 27, 2023
Merged
andrewrk pushed a commit that referenced this issue Aug 28, 2023
@jayschwa @andrewrk
std: Rename TailQueue to DoublyLinkedList
ff61c42 
`TailQueue` was implemented as a doubly-linked list, but named after an
abstract data type. This was inconsistent with `SinglyLinkedList`, which
can be used to implement an abstract data type, but is still named after
the implementation. Renaming `TailQueue` to `DoublyLinkedList` improves
consistency between the two type names, and should help discoverability.

`TailQueue` is now a deprecated alias of `DoublyLinkedList`.

Related to issues #1629 and #8233.
@squeek502 squeek502 mentioned this issue Sep 22, 2023
Closed
@perillo
Copy link
Contributor

perillo commented Jan 23, 2024

Currently some namespaces like compress and crypto are hierarchical. Is there a plan to add more of these, like:

  • encoding (for json, base64, leb128?)
  • archive (for tar, zip?)
  • container (array_hash_map, array_list, hash_map, linked_list, multi_array_list, ...)
  • rt (for start, start_windows_tls) (the name rt is used both in C and Hare)

@andrewrk andrewrk mentioned this issue Oct 17, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
breaking Implementing this issue could cause existing code to no longer compile or have different behavior. standard library This issue involves writing Zig code for the standard library.
Projects
None yet
Milestone
1.0.0
Development

No branches or pull requests
4 participants
@andrewrk @jayschwa @perillo @iacore