Repository navigation
Contribuir
- Leia a Arquitetura — em particular o modelo de threads e o replay de edições (
Edit). - Compile e corra os testes: Instalação e compilação.
- Tenha presentes as duas prioridades do projeto: desempenho (a UI nunca engasga) e segurança (sem
unsafe, ficheiros = entrada hostil, sem rede).
| Regra | Onde está definida |
|---|---|
| Rust stable, edição 2024 |
rust-toolchain.toml, Cargo.toml
|
rustfmt com max_width = 120 e use_small_heuristics = "Max"
|
rustfmt.toml |
Clippy pedantic como aviso e -D warnings no make lint
|
Cargo.toml, Makefile
|
unwrap() / expect() só nos testes |
Cargo.toml (unwrap_used, expect_used), clippy.toml
|
#![forbid(unsafe_code)] em todos os crates
|
cada lib.rs / main.rs
|
#[allow(...)] com reason = "..." quando é mesmo preciso |
convenção do código existente |
Comentários e documentação do código em inglês; o README.md e esta wiki em português |
convenção do repositório |
Princípios que o código segue:
-
Modelo validado:
bw-coremantém as invariantes na construção, em cada edição e na desserialização. Uma edição nova deve ser umEditaplicado porCircuit::apply, que valida tudo antes de mudar algo e devolve o que tocou (Applied), e tem de ser determinística (a UI e o simulador aplicam-na às suas cópias). - Nada de trabalho O(n) por frame ou por edição quando é evitável: atualize slots, redes e adjacências tocadas, não o circuito inteiro.
- Entrada hostil: qualquer parser novo tem limites explícitos (tamanho, contagens, profundidade), não usa recursão sem limite, não reserva memória antes de verificar os bytes disponíveis e tem testes com dados malformados (e, idealmente, um alvo de fuzzing).
-
Nada da rede, nada executado. Dependências novas têm de passar a política do
deny.toml(licenças permissivas, só crates.io). - Compatibilidade de ficheiros: mudar o formato implica subir a versão, manter a leitura das anteriores e gravar fixtures da versão antiga com o código anterior antes da mudança (ver Formato de ficheiros).
- A biblioteca incluída e
examples/macros-demo.bitwerksão gerados: altere o gerador emcrates/bw-sim/tests/library.rse regenere comBITWERK_REGEN_LIBRARY=1 cargo test -p bw-sim --test library.
make fmt # formata
make lint # clippy pedantic, -D warnings
make test # todos os testes
make fuzz-check # se mexeu em bw-io ou nos alvos de fuzzing
make audit # se mexeu em dependências (requer cargo-deny)Ou tudo de uma vez: make check-all (fmt-check + lint + test + audit).
Se a alteração toca no renderizador, no simulador ou na cena, meça também:
make bench
make sweep # com o ecrã desbloqueado e a janela visívele compare com os números de Desempenho. Uma corrida INVALID RUN não conta.
O histórico usa mensagens curtas em inglês, no imperativo, a descrever a funcionalidade (por exemplo "Add macros, hierarchy navigation and the Parts Centre").
Não inclua caminhos absolutos da sua máquina, endereços de email ou outros dados pessoais em código, testes, fixtures ou documentação; use caminhos relativos ao repositório. Ficheiros de terceiros (como as fixtures do Digital Works) só entram sem alterações e com a licença num NOTICE.
bitwerk — simulador de circuitos lógicos digitais para macOS · Licença MIT OR Apache-2.0 (LICENSE-MIT e LICENSE-APACHE no repositório) · A fonte de verdade é o código e o README.md do repositório; esta wiki descreve a versão 0.1.0.
Começar
Utilização
- Componentes
- Fios e junções
- Simulação
- Memória
- Macros e hierarquia
- Parts Centre
- Importação do Digital Works
- Exportação para o Digital Works
Referência técnica
Projeto