add check-copyright to CI

.forgejo/workflows/test.yml

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-later
+# See Notices.txt for copyright information
 on: [push, pull_request]
 
 jobs:
@@ -7,6 +9,8 @@ jobs:
       - uses: https://code.forgejo.org/actions/checkout@v3
         with:
           fetch-depth: 0
+      - run: |
+          scripts/check-copyright.sh
       - run: |
           curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain 1.80.1
           source "$HOME/.cargo/env"

.gitignore

@@ -1,2 +1,4 @@
+# SPDX-License-Identifier: LGPL-3.0-or-later
+# See Notices.txt for copyright information
 /target
-.vscode
+.vscode

README.md

@@ -1,3 +1,7 @@
+<!--
+SPDX-License-Identifier: LGPL-3.0-or-later
+See Notices.txt for copyright information
+-->
 # Fayalite
 
 Fayalite is a library for designing digital hardware -- a hardware description language (HDL) embedded in the Rust programming language. Fayalite's semantics are based on [FIRRTL] as interpreted by [LLVM CIRCT](https://circt.llvm.org/docs/Dialects/FIRRTL/FIRRTLAnnotations/).

crates/fayalite-proc-macros-impl/src/hdl_bundle.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 use crate::{
     hdl_type_common::{
         common_derives, get_target, ItemOptions, MakeHdlTypeExpr, MaybeParsed, ParsedField,

crates/fayalite-proc-macros-impl/src/hdl_enum.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 use crate::{
     hdl_type_common::{
         common_derives, get_target, ItemOptions, MakeHdlTypeExpr, MaybeParsed, ParsedGenerics,

crates/fayalite-proc-macros-impl/src/hdl_type_common.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 use crate::{fold::impl_fold, kw, Errors, HdlAttr, PairsIterExt};
 use proc_macro2::{Span, TokenStream};
 use quote::{format_ident, quote_spanned, ToTokens};

crates/fayalite/examples/blinky.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 use clap::Parser;
 use fayalite::{cli, prelude::*};
 

crates/fayalite/src/_docs.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 #![doc = include_str!("../README.md")]
 
 //!

crates/fayalite/src/_docs/modules.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 //! # Fayalite Modules
 //!
 //! The [`#[hdl_module]`][`crate::hdl_module`] attribute is applied to a Rust

crates/fayalite/src/_docs/modules/extern_module.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 //! These are for when you want to use modules written in
 //! some other language, such as Verilog.
 //!

crates/fayalite/src/_docs/modules/module_bodies.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 //! # Module Function Bodies
 //!
 //! The `#[hdl_module]` attribute lets you have statements/expressions with `#[hdl]` annotations

crates/fayalite/src/_docs/modules/module_bodies/hdl_array_expressions.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 //! # `#[hdl]` Array Expressions
 //!
 //! `#[hdl]` can be used on Array Expressions to construct an [`Array<[T; N]>`][type@Array] expression:

crates/fayalite/src/_docs/modules/module_bodies/hdl_if_statements.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 //! # `#[hdl] if` Statements
 //!
 //! `#[hdl] if` statements behave similarly to Rust `if` statements, except they end up as muxes

crates/fayalite/src/_docs/modules/module_bodies/hdl_let_statements.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 //! ## `#[hdl] let` statements
 
 pub mod inputs_outputs;

crates/fayalite/src/_docs/modules/module_bodies/hdl_let_statements/inputs_outputs.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 //! ### Inputs/Outputs
 //!
 //! Inputs/Outputs create a Rust variable with type [`Expr<T>`] where `T` is the type of the input/output.

crates/fayalite/src/_docs/modules/module_bodies/hdl_let_statements/instances.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 //! ### Module Instances
 //!
 //! module instances are kinda like the hardware equivalent of calling a function,

crates/fayalite/src/_docs/modules/module_bodies/hdl_let_statements/memories.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 //! # Memories
 //!
 //! Memories are optimized for storing large amounts of data.

crates/fayalite/src/_docs/modules/module_bodies/hdl_let_statements/registers.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 //! ### Registers
 //!
 //! Registers are memory devices that will change their state only on a clock

crates/fayalite/src/_docs/modules/module_bodies/hdl_let_statements/wires.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 //! ### Wires
 //!
 //! Wires are kinda like variables, but unlike registers,

crates/fayalite/src/_docs/modules/module_bodies/hdl_literals.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 //! # `_hdl`-suffixed literals
 //!
 //! You can have integer literals with an arbitrary number of bits like so:

crates/fayalite/src/_docs/modules/module_bodies/hdl_match_statements.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 //! # `#[hdl] match` Statements
 //!
 //! `#[hdl] match` statements behave similarly to Rust `match` statements, except they end up as muxes

crates/fayalite/src/_docs/modules/module_bodies/hdl_struct_variant_expressions.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 //! # `#[hdl]` Struct/Variant Expressions
 //!
 //! Note: Structs are also known as [Bundles] when used in Fayalite, the Bundle name comes from [FIRRTL].

crates/fayalite/src/_docs/modules/normal_module.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 //! # Normal Modules
 //!
 //! See also: [Extern Modules][`super::extern_module`]

crates/fayalite/src/_docs/semantics.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 //! # Fayalite Semantics
 //!
 //! Fayalite's semantics are based on [FIRRTL]. Due to their significance, some of the semantics are also documented here.

crates/fayalite/src/_docs/semantics/connection_semantics.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 //! # Connection Semantics
 //!
 //! Fayalite's connection semantics are unlike assignments in software, so be careful!

crates/fayalite/src/cli.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 use crate::{
     bundle::{Bundle, BundleType},
     firrtl,

crates/fayalite/src/expr/target.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 use crate::{
     array::Array,
     bundle::{Bundle, BundleField},

crates/fayalite/src/prelude.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 pub use crate::{
     annotations::Annotation,
     array::{Array, ArrayType},

crates/fayalite/src/util/ready_valid.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 use crate::prelude::*;
 
 #[hdl]

crates/fayalite/src/util/scoped_ref.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// See Notices.txt for copyright information
 mod safety_boundary {
     use std::{cell::Cell, ptr::NonNull};
 

crates/fayalite/visit_types.json

@@ -1,4 +1,8 @@
 {
+    "license_header": [
+        "SPDX-License-Identifier: LGPL-3.0-or-later",
+        "See Notices.txt for copyright information"
+    ],
     "types": {
         "Module": {
             "data": {

scripts/check-copyright.sh

@@ -0,0 +1,74 @@
+#!/bin/bash
+# SPDX-License-Identifier: LGPL-3.0-or-later
+# See Notices.txt for copyright information
+set -e
+
+function fail()
+{
+    local error="$1"
+    echo "error: $error" >&2
+    exit 1
+}
+
+function fail_file()
+{
+    local file="$1" line="$2" error="$3"
+    fail "$file:$((line + 1)): $error"
+}
+
+function check_file()
+{
+    local file="$1" regexes=("${@:2}")
+    local lines
+    mapfile -t lines < "$file"
+    local line
+    for line in "${!regexes[@]}"; do
+        eval '[[ "${lines[i]}" =~ '"${regexes[i]}"' ]]' ||
+            fail_file "$file" "$line" "doesn't match regex: ${regexes[i]}"
+    done
+}
+
+POUND_HEADER=('^"# SPDX-License-Identifier: LGPL-3.0-or-later"$' '^"# See Notices.txt for copyright information"$')
+SLASH_HEADER=('^"// SPDX-License-Identifier: LGPL-3.0-or-later"$' '^"// See Notices.txt for copyright information"$')
+MD_HEADER=('^"<!--"$' '^"SPDX-License-Identifier: LGPL-3.0-or-later"$' '^"See Notices.txt for copyright information"$')
+JSON_HEADER=('^"{"$' '^"    \"license_header\": ["$' '^"        \"SPDX-License-Identifier: LGPL-3.0-or-later\","$' '^"        \"See Notices.txt for copyright information\""')
+
+function main()
+{
+    local IFS=$'\n'
+    [[ -z "$(git status --porcelain)" ]] || fail "git repo is dirty"
+    local file
+    for file in $(git ls-tree --name-only --full-tree -r HEAD); do
+        case "/$file" in
+        /Cargo.lock)
+            # generated file
+            ;;
+        */LICENSE.md|*/Notices.txt)
+            # copyright file
+            ;;
+        /crates/fayalite/tests/ui/*.stderr)
+            # file that can't contain copyright header
+            ;;
+        /.forgejo/workflows/*.yml|*/.gitignore|*.toml)
+            check_file "$file" "${POUND_HEADER[@]}"
+            ;;
+        *.md)
+            check_file "$file" "${MD_HEADER[@]}"
+            ;;
+        *.sh)
+            check_file "$file" '^'\''#!'\' "${POUND_HEADER[@]}"
+            ;;
+        *.rs)
+            check_file "$file" "${SLASH_HEADER[@]}"
+            ;;
+        *.json)
+            check_file "$file" "${JSON_HEADER[@]}"
+            ;;
+        *)
+            fail_file "$file" 0 "unimplemented file kind -- you need to add it to $0"
+            ;;
+        esac
+    done
+}
+
+main