Type File Syntax

This page documents the syntax of the C3 "type" files (.c3typ) in BNF. There is also a list of the keywords.

Note that these are only the syntax rules; additional semantic rules further restrict valid usage.

start

type　EOF
annotation +　type　EOF

start syntax diagram

type

type_modif *　type　ident_path　bind_vars ?　extends_ ?　mixes ?　type_suffix *　(　'{'　ann_field *　'}'　) ?
private ?　remix　type　ident_path　as　ident_path　extends_ ?　mixes ?　type_suffix *　(　'{'　ann_field *　'}'　) ?
private ?　native　( lang_only | lang_runtime )　remix　type　ident_path　mixes ?　(　'{'　ann_field *　'}'　) ?
( private | remix ) *　enum　type　ident_path　mixes ?　( '{'　ann_enum_field +　'}' ) ?
( private | remix ) *　union　type　ident_path　bind_vars ?　'='　union_anyof
abstract ?　duck　type　ident_path　bind_vars ?　extends_ ?　mixes　type_suffix *　(　'{'　ann_field *　'}'　) ?

type syntax diagram

union_anyof

simple_type　union_alts
'('　lambda_type　')'　union_alts

union_anyof syntax diagram

type_modif

abstract　|　private　|　inline　|　final　|　not mixable　|　not remixable　|　entity　|　extendable　|　not extendable　|　remix　|　native

type_modif syntax diagram

type_suffix

schema_name　|　type_key　|　default_rt

type_suffix syntax diagram

default_rt syntax diagram

ann_field

type_field
annotation +　type_field

ann_field syntax diagram

type_field

ident　':'　field_mod *　ann_value_type　fkey_ref_type ?　field_suffix *　( ';' ) ?

type_field syntax diagram

field_mod

private　|　const

field_mod syntax diagram

fkey_ref_type

'('　ident_path　( ','　ident_path ) ?　')'

fkey_ref_type syntax diagram

field_suffix

defaultv　enum_vals ?　|　calculated
schema_name　|　schema_suffix　|　not persistable　|　translate

field_suffix syntax diagram

schema_name

schema name　STRING

schema_name syntax diagram

schema_suffix

schema suffix　STRING

schema_suffix syntax diagram

type_key

type key　STRING

type_key syntax diagram

calculated

stored ?　calc　expr_top
periodic　stored ?　calc　expr_top　period　STRING
scheduled　stored ?　calc　expr_top　schedule　STRING

calculated syntax diagram

translate

translate by　ident

translate syntax diagram

ann_enum_field

enum_field
annotation +　enum_field

ann_enum_field syntax diagram

enum_field

ID　',' ?
ident　'='　primitive　',' ?
ident　':'　private ?　( func_type | inherit_type )　',' ?

enum_field syntax diagram

kw_type

kw_base
as
calc
const
duck
extendable
period
periodic
schedule
scheduled
stored
type
union

kw_type syntax diagram

ident

ID
kw_type

ident syntax diagram

value_type_start

ann_value_type　EOF

value_type_start syntax diagram

annotations_start

annotations　EOF

annotations_start syntax diagram

param_types_start

param_types　EOF

param_types_start syntax diagram

param_types

'('　')'　EOF
'('　param_type　( ','　param_type ) *　')'　EOF

param_types syntax diagram

param_type

ann_value_type　'...' ?

param_type syntax diagram

bind_vars

'<'　bind_var　( ','　bind_var ) *　'>'

bind_vars syntax diagram

bind_var

ident
bind_restr

bind_var syntax diagram

bind_restr

ident　':'　value_type

bind_restr syntax diagram

extends_

extends　ref_type

extends_ syntax diagram

mixes

mixes　ref_type　( ','　ref_type ) *

mixes syntax diagram

value_type

data_type
func_type
inherit_type
void_type

value_type syntax diagram

ann_value_type

value_type
annotation +　value_type

ann_value_type syntax diagram

data_type

lambda_type
'('　lambda_type　')'　union_alts
vt_mods　'('　( simple_type　|　( '('　lambda_type　')' ) )　( union_alts　')'

data_type syntax diagram

ann_data_type

data_type
annotation +　data_type

ann_data_type syntax diagram

simple_type

atom_type　|　tuple_type　|　vector_type

simple_type syntax diagram

atom_type

basic_type　|　any_type　|　native_type

atom_type syntax diagram

basic_type

prim_type　|　ref_type　|　coll_type　|　push_stream_type　|　event_stream_type

basic_type syntax diagram

any_type

vt_mods ?　any

any_type syntax diagram

prim_type

vt_mods ?　prim_types

prim_type syntax diagram

serialized

serialized　ser_rhs_type

serialized syntax diagram

ser_rhs_type

basic_type
annotation +　native_type

ser_rhs_type syntax diagram

prim_types

string　serialized ?
string　enum_vals
binary　serialized ?
binary　enum_vals
typed ?　json　serialized ?
json　enum_vals
int　enum_vals ?
utc ?　PRIM_TYPE_DATETIME　no tz ?　( with millis | with micros | with nanos ) ?　enum_vals ?
prim_other　enum_vals ?

prim_types syntax diagram

prim_other

byte　|　int16　|　int32　|　bigint
float　|　double　|　decimal
boolean　|　number

prim_other syntax diagram

ref_type

vt_mods ?　mixing ?　ref_path　( '.'　ref_path ) *
vt_mods ?　id_path　bind_meta

ref_type syntax diagram

ref_path

id_path　( '<'　ref_var　( ','　ref_var ) *　'>' ) ?

ref_path syntax diagram

bind_meta

'<'　'<'　ann_data_type　'>'　'>'

bind_meta syntax diagram

ref_var

ann_value_type　|　bind_restr

ref_var syntax diagram

coll_type

vt_mods ?　'['　ann_value_type　']'
vt_mods ?　'set<'　ann_value_type　'>'
vt_mods ?　'map<'　ann_value_type　','　ann_value_type　'>'
vt_mods ?　stream　'<'　ann_value_type　'>'
vt_mods ?　collection　'<'　ann_value_type　'>'

coll_type syntax diagram

push_stream_type

vt_mods ?　push stream　'<'　ann_value_type　'>'

push_stream_type syntax diagram

event_stream_type

vt_mods ?　event stream　'<'　ann_value_type　'>'

event_stream_type syntax diagram

tuple_type

vt_mods ?　'{'　tuple_field　( ','　tuple_field ) *　',' ?　'}'
'('　simple_type　','　( simple_type　( ','　simple_type ) *　',' ? ) ?　')'
vt_mods ?　tuple

tuple_type syntax diagram

tuple_field

( ident | STRING )　':'　ann_data_type

tuple_field syntax diagram

simple_ref

ref_path

simple_ref syntax diagram

vector_type

vt_mods ?　'['　INT　']'

vector_type syntax diagram

func_type

func_mods ?　function　bind_vars ?　'('　func_param ?　( ','　func_param ) *　')'　return_type ?　inherit_from ?　claim_suffix
func_mods ?　member function　bind_vars ?　'('　func_param ?　( ','　func_param ) *　')'　return_type ?　inherit_from ?　claim_suffix
func_mods ?　property　bind_vars ?　'('　')'　return_type　claim_suffix

func_type syntax diagram

lambda_type

vt_mods ?　lambda　'('　func_param ?　( ','　func_param ) *　')'　return_type ?

lambda_type syntax diagram

func_mod

abstract　|　optional　|　final　|　inline　|　cached　|　stateful

func_mod syntax diagram

func_mods

func_mod +　( private　func_mod * ) ?

func_param

annotation *　ident　':'　ann_data_type　( '...'　|　defaultv ) ?

func_param syntax diagram

inherit_from

from　ident_path

inherit_from syntax diagram

claim_suffix

lang_runtime　( '|'　( lang_only　|　lang_runtime ) ) *
lang_only　( '|'　( lang_only　|　lang_runtime ) ) *

claim_suffix syntax diagram

lang_runtime

lang_key　( '-'　ident ) +　runtime_ver ?

lang_runtime syntax diagram

lang_only

lang_key　runtime_ver ?

lang_only syntax diagram

lang_key

java　|　js　|　py　|　ts　|　tsx

lang_key syntax diagram

runtime_ver

VERSION

runtime_ver syntax diagram

inherit_type

func_mods ?　vt_mods ?　'~'　inherit_from ?　claim_suffix
func_mods ?　'~'　return_type　inherit_from ?　claim_suffix
func_mods ?　'~'　'('　inherit_param ?　( ','　inherit_param ) *　')'　inherit_from ?　claim_suffix
vt_mods ?　'~'　( serialized　|　enum_vals )

inherit_type syntax diagram

inherit_param

annotation *　ident　':'　inherit_pt　( '...'　|　defaultv ) ?

inherit_param syntax diagram

inherit_pt

data_type
annotation *　vt_mods ?　'~'

inherit_pt syntax diagram

return_type

':'　ann_data_type

return_type syntax diagram

native_type

vt_mods ?　native

native_type syntax diagram

void_type

void

void_type syntax diagram

vt_mods

'!'　|　'?'　|　'!?'

vt_mods syntax diagram

defaultv

'='　expr_top

defaultv syntax diagram

annotation

'@'　ident
'@'　ident　'@('　ann_values　')'
'@'　ident　'('　ann_values　')'
'@'　ident　'@('　ann_value_only　')'

annotation syntax diagram

annotations

annotation +

annotations syntax diagram

ann_values

ann_value　( ','　ann_value ) *

ann_values syntax diagram

ann_value

ann_val_lhs　'='　ann_val_rhs
ann_val_lhs　'+='　ann_val_rhs

ann_value syntax diagram

ann_value_only

ann_val_rhs

ann_value_only syntax diagram

ann_val_lhs

STRING　|　ident

ann_val_lhs syntax diagram

ann_val_rhs

literal　|　id_path

ann_val_rhs syntax diagram

literal

primitive　|　object_val　|　array_val　|　datefn

literal syntax diagram

primitive

( STRING　|　multi_string　|　INT　|　BOOL　|　DEC　|　FLOAT )

primitive syntax diagram

object_val

'{'　key_value　( ','　key_value ) *　',' ?　'}'
'{'　'}'

object_val syntax diagram

key_value

ident　':'　literal
STRING　':'　literal
INT　':'　literal
DEC　':'　literal
ident　':'　ID
STRING　':'　ID
INT　':'　ID
DEC　':'　ID

key_value syntax diagram

array_val

'['　literal　( ','　literal ) *　',' ?　']'
'['　']'

array_val syntax diagram

datefn

'Date('　STRING　')'

datefn syntax diagram

id_path

ID
ID_PATH
kw_safe

id_path syntax diagram

ident_path

ident
ID_PATH
id_path　'.'　ident

ident_path syntax diagram

enum_vals

enum　'('　literal　( ','　literal ) *　')'
enum　id_path

enum_vals syntax diagram

union_alts

union_alt +

union_alts syntax diagram

union_alt

'|'　union_elt
'^'　union_elt

union_alt syntax diagram

union_elt

simple_type
'('　ann_data_type　')'

union_elt syntax diagram

expr_start

expr_top　EOF

expr_start syntax diagram

expr_top

expr_ternary
expr_lambda

expr_top syntax diagram

expr_ternary

expr_or　( '?'　expr_top　':'　expr_top ) ?

expr_ternary syntax diagram

expr_or

expr_and　( '||'　expr_and ) *

expr_or syntax diagram

expr_and

expr_bitOr　( '&&'　expr_bitOr ) *

expr_and syntax diagram

expr_bitOr

expr_bitXOr　( '|'　expr_bitXOr ) *

expr_bitOr syntax diagram

expr_bitXOr

expr_bitAnd　( '^'　expr_bitAnd ) *

expr_bitXOr syntax diagram

expr_bitAnd

expr_equal　( '&'　expr_equal ) *

expr_bitAnd syntax diagram

expr_equal

expr_comp　(　'=='　expr_comp
'!='　expr_comp
( isA | instanceof )　id_path　) *
ident　in　expr_comp

expr_equal syntax diagram

expr_comp

expr_shift　(　'<'　expr_shift
'>'　expr_shift
( '<'　'=' )　expr_shift
( '>'　'=' )　expr_shift
( '<'　'='　'>' )　expr_shift　) *

expr_comp syntax diagram

expr_shift

expr_add　(　( '<'　'<' )　expr_add
( '>'　'>' )　expr_add
( '>'　'>'　'>' )　expr_add　) *

expr_shift syntax diagram

expr_add

expr_mul　(　'+'　expr_mul
'-'　expr_mul　) *

expr_add syntax diagram

expr_mul

expr_exp　(　'*'　expr_exp
'/'　expr_exp
'%'　expr_exp　) *

expr_mul syntax diagram

expr_exp

expr_unary　( ( '*'　'*' )　expr_unary ) *

expr_exp syntax diagram

expr_unary

expr_dotcall
'!'　expr_unary
'-'　expr_unary
'~'　expr_unary

expr_unary syntax diagram

expr_dotcall

( expr_value　|　kw_func )　( expr_callargs
'['　expr_top　']'
'.'　(　id_path
'('　expr_top　')'　)　) *

expr_dotcall syntax diagram

expr_callargs

'('　( expr_top　( ','　expr_top ) * ) ?　')'
'('　expr_namedarg　( ','　expr_namedarg ) *　')'

expr_callargs syntax diagram

expr_namedarg

ident　'='　expr_top

expr_namedarg syntax diagram

expr_lambda

'('　')'　'=>'　expr_top
'('　lambda_param　( ','　lambda_param ) *　')'　'=>'　expr_top
lambda_param　'=>'　expr_top

expr_lambda syntax diagram

lambda_param

ident

lambda_param syntax diagram

expr_value

primitive
datefn
expr_array
expr_object
id_path
'('　expr_top　')'

expr_value syntax diagram

expr_array

'['　expr_top　( ','　expr_top ) *　',' ?　']'
'['　']'

expr_array syntax diagram

expr_object

'{'　expr_objkv　( ','　expr_objkv ) *　',' ?　'}'
'{'　'}'

expr_object syntax diagram

expr_objkv

ident　':'　expr_top
STRING　':'　expr_top
INT　':'　expr_top
DEC　':'　expr_top

expr_objkv syntax diagram

kw_base

boolean
binary
byte
decimal
double
float
int
int16
int32
bigint
json
BOOL
abstract
any
cached
collection
entity
enum
extends
final
function
inline
lambda
mixes
mixing
native
optional
private
property
remix
stateful
stream
tuple
typed
utc
void
kw_func
kw_safe

kw_base syntax diagram

kw_func

string
PRIM_TYPE_DATETIME
number

kw_func syntax diagram

kw_safe

default
from
in
instanceof
isA
java
js
py
serialized
ts
tsx

kw_safe syntax diagram

multi_string

STRING　STRING +

multi_string syntax diagram

PRIM_TYPE_DATETIME

datetime　|　date

PRIM_TYPE_DATETIME syntax diagram

VERSION

'@'　DIGIT +　( '.'　DIGIT + ) *

VERSION syntax diagram

BOOL

true　|　false

BOOL syntax diagram

INT

'-' ?　DIGITS

INT syntax diagram

DEC

'-' ?　DIGITS ?　'.'　DIGITS

DEC syntax diagram

FLOAT

'-' ?　( DIGITS ?　'.'　DIGITS　EXP　|　DIGITS　EXP )

FLOAT syntax diagram

STRING

'"'　( STRING_ESC　|　~ ( '"'　|　'\\'　|　'\n'　|　'\r' ) ) *　'"'
'\''　( STRING_ESC　|　~ ( '\''　|　'\\'　|　'\n'　|　'\r' ) ) *　'\''

ID

'\'` ?　ID_FIRST　ID_REST *

ID syntax diagram

ID_PATH

'\' ?　[ID_FIRST](#id_first)　[ID_REST](#id_rest) \*　( '.'`　ID_FIRST　ID_REST * ) +

ID_PATH syntax diagram

WS_WS

( ' '　|　'\t'　|　'\u000C'　|　'\r' ) +

WS_WS syntax diagram

WS_NL

( WS_WS *　'\n' ) +　WS_WS *

WS_NL syntax diagram

WS_COMMENT

( '//'　~ ( '\n' | '\r' ) *　( '\r\n'　|　'\r'　|　'\n' )
'//'　~ ( '\n' | '\r' ) *
'/*'　( . ) *　'*/' )

WS_COMMENT syntax diagram

ID_FIRST

LETTER　|　'_'

ID_FIRST syntax diagram

ID_REST

ID_FIRST　|　DIGIT

ID_REST syntax diagram

STRING_ESC

'\\"'　|　'\\\''　|　'\\\\'　|　'\\r'　|　'\\n'　|　'\\t'　|　( '\\u'　HEX_DIGIT　HEX_DIGIT　HEX_DIGIT　HEX_DIGIT )

LETTER

UNICODE_CLASS_LL　|　UNICODE_CLASS_LU　|　UNICODE_CLASS_LM　|　UNICODE_CLASS_LO

LETTER syntax diagram

DIGIT

'0'..'9'

DIGIT syntax diagram

DIGITS

DIGIT +　( '_'　DIGIT + ) *

DIGITS syntax diagram

HEX_DIGIT

DIGIT　|　'a'..'f'　|　'A'..'F'

HEX_DIGIT syntax diagram

EXP

( e　|　E　)　'-' ?　DIGIT +

EXP syntax diagram

Copy link to this sectionstart

Copy link to this sectiontype

Copy link to this sectionunion_anyof

Copy link to this sectiontype_modif

Copy link to this sectiontype_suffix

Copy link to this sectiondefault_rt

Copy link to this sectionann_field

Copy link to this sectiontype_field

Copy link to this sectionfield_mod

Copy link to this sectionfkey_ref_type

Copy link to this sectionfield_suffix

Copy link to this sectionschema_name

Copy link to this sectionschema_suffix

Copy link to this sectiontype_key

Copy link to this sectioncalculated

Copy link to this sectiontranslate

Copy link to this sectionann_enum_field

Copy link to this sectionenum_field

Copy link to this sectionkw_type

Copy link to this sectionident

Copy link to this sectionvalue_type_start

Copy link to this sectionannotations_start

Copy link to this sectionparam_types_start

Copy link to this sectionparam_types

Copy link to this sectionparam_type

Copy link to this sectionbind_vars

Copy link to this sectionbind_var

Copy link to this sectionbind_restr

Copy link to this sectionextends_

Copy link to this sectionmixes

Copy link to this sectionvalue_type

Copy link to this sectionann_value_type

Copy link to this sectiondata_type

Copy link to this sectionann_data_type

Copy link to this sectionsimple_type

Copy link to this sectionatom_type

Copy link to this sectionbasic_type

Copy link to this sectionany_type

Copy link to this sectionprim_type

Copy link to this sectionserialized

Copy link to this sectionser_rhs_type

Copy link to this sectionprim_types

Copy link to this sectionprim_other

Copy link to this sectionref_type

Copy link to this sectionref_path

Copy link to this sectionbind_meta

Copy link to this sectionref_var

Copy link to this sectioncoll_type

Copy link to this sectionpush_stream_type

Copy link to this sectionevent_stream_type

Copy link to this sectiontuple_type

Copy link to this sectiontuple_field

Copy link to this sectionsimple_ref

Copy link to this sectionvector_type

Copy link to this sectionfunc_type

Copy link to this sectionlambda_type

Copy link to this sectionfunc_mod

Copy link to this sectionfunc_mods

Copy link to this sectionfunc_param

Copy link to this sectioninherit_from

Copy link to this sectionclaim_suffix

Copy link to this sectionlang_runtime

Copy link to this sectionlang_only

Copy link to this sectionlang_key

Copy link to this sectionruntime_ver

Copy link to this sectioninherit_type

Copy link to this sectioninherit_param

Copy link to this sectioninherit_pt

Copy link to this sectionreturn_type

Copy link to this sectionnative_type

Copy link to this sectionvoid_type

Copy link to this sectionvt_mods

Copy link to this sectiondefaultv

Copy link to this sectionannotation

Copy link to this sectionannotations

Copy link to this sectionann_values

Copy link to this sectionann_value

Copy link to this sectionann_value_only

Copy link to this sectionann_val_lhs

Copy link to this sectionann_val_rhs