onyx icon indicating copy to clipboard operation
onyx copied to clipboard

[Feature Request] Add per file flag for #+package and #+local

Open clsource opened this issue 1 year ago • 2 comments

  • #+package at the start of the file will mark any defined symbol as the package only scope. A file defined with #+package flag can use #local flag for scoping at the file level for individual symbols.

  • #+local at the start of the file will mark any defined symbol as the file only scope. A file defined with #+local flag can use #package flag for scoping at the package level for individual symbols.

A file with flags #+package or #+local cannot make its symbols public in any way. Another public file should be created.

Motivation

By using a file level fiag we can separate our APIs with public and private (package and file only) scopes, and avoid saturating our public files and symbols with scope attributes.

Example

By using this flag we can cleary separate scopes in our package.

- api.onyx // public apis
- api.pkg.onyx // package scope apis
- api.local.onyx // file (local) scope apis

Syntax

It was preferred the syntax #+ instead of //+ since it has less characters and promotes the meaning of a compiler directive instead of a comment.

clsource avatar Dec 03 '24 00:12 clsource

I think this is a great idea! I have designed many APIs like this where I have one "public" file, and many internal implementation files. I'm unsure if I like #+package, because every other directive so far is always # + a symbol. But I will have to think about what other wording it could be, as #package would be ambiguous.

brendanfh avatar Dec 03 '24 04:12 brendanfh

Maybe since #private was used before can be reintroduced as #private for package scope and #private file for local scope

Or current directives be extended

  • #package file or #package.file
  • #local file or #local.file

Or a new #scope directive that can have a value

  • #scope(package)
  • #scope(file)

clsource avatar Dec 03 '24 10:12 clsource