Annotations

ESPL1000 currently supports a few simple Annotations which allow for additional Errors, Warnings and Notes to be issued without adding syntax bloat.

New Annotations can easily be added and existing ones can be disabled with minimal code changes in the transpiler.

Supported Annotations

• @halts - issues warning if subroutine could not be proven to terminate
• @deprecated - issues warning for calls to this subroutine
• @private
  • subroutines: issues warning if the subroutine is called directly outside it's own namespace
  • structs: issues warning if the struct is referenced directly outside it's own namespace
  • struct members: issues warning if the struct member is accessed outside it's own namespace
• @extern function is assumed to be a defined externally. Do not error if no definition is found.
  This annotation can be used to link against C code.

Example

@private
struct A {
	@private
	uint32 b;

	uint32 a;
}

fn main () ~> int {
	subr1();
	subr2();
	return 0;
}

@deprecated  //should cause warning (usage in main)
fn subr1() ~> bool {
	return true;
}

@halts  //should cause warning (infinite loop)
fn subr2() -> bool {
	while(true){ }
	return true;
}