.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Tangence::Compiler::Parser 3pm"
.TH Tangence::Compiler::Parser 3pm "2021-04-30" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
"Tangence::Compiler::Parser" \- parse "Tangence" interface definition files
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This subclass of Parser::MGC parses a Tangence interface definition and
returns a metadata tree.
.SH "GRAMMAR"
.IX Header "GRAMMAR"
The top level of an interface definition file contains \f(CW\*(C`include\*(C'\fR directives
and \f(CW\*(C`class\*(C'\fR and \f(CW\*(C`struct\*(C'\fR definitions.
.SS "include"
.IX Subsection "include"
An \f(CW\*(C`include\*(C'\fR directive imports the definitions from another file, named
relative to the current file.
.PP
.Vb 1
\& include "filename.tan"
.Ve
.SS "class"
.IX Subsection "class"
A \f(CW\*(C`class\*(C'\fR definition defines the set of methods, events and properties
defined by a named class.
.PP
.Vb 3
\& class N {
\&    ...
\& }
.Ve
.PP
The contents of the class block will be a list of \f(CW\*(C`method\*(C'\fR, \f(CW\*(C`event\*(C'\fR, \f(CW\*(C`prop\*(C'\fR
and \f(CW\*(C`isa\*(C'\fR declarations.
.SS "struct"
.IX Subsection "struct"
A \f(CW\*(C`struct\*(C'\fR definition defines the list of fields contained within a named
structure type.
.PP
.Vb 3
\& struct N {
\&    ...
\& }
.Ve
.PP
The contents of the struct block will be a list of \f(CW\*(C`field\*(C'\fR declarations.
.SS "method"
.IX Subsection "method"
A \f(CW\*(C`method\*(C'\fR declaration defines one method in the class, giving its name (N)
and types of its arguments and and return (T).
.PP
.Vb 1
\& method N(T, T, ...) \-> T;
.Ve
.SS "event"
.IX Subsection "event"
An \f(CW\*(C`event\*(C'\fR declaration defines one event raised by the class, giving its name
(N) and types of its arguments (T).
.PP
.Vb 1
\& event N(T, T, ...);
.Ve
.SS "prop"
.IX Subsection "prop"
A \f(CW\*(C`prop\*(C'\fR declaration defines one property supported by the class, giving its
name (N), dimension (D) and type (T). It may be declared as a \f(CW\*(C`smashed\*(C'\fR
property.
.PP
.Vb 1
\& [smashed] prop N = D of T;
.Ve
.PP
Scalar properties may omit the \f(CW\*(C`scalar of\*(C'\fR, by supplying just the type
.PP
.Vb 1
\& [smashed] prop N = T;
.Ve
.SS "isa"
.IX Subsection "isa"
An \f(CW\*(C`isa\*(C'\fR declaration declares a superclass of the class, by its name (C)
.PP
.Vb 1
\& isa C;
.Ve
.SS "Types"
.IX Subsection "Types"
The following basic type names are recognised
.PP
.Vb 2
\& bool int str obj any
\& s8 s16 s32 s64 u8 u16 u32 u64
.Ve
.PP
Aggregate types may be formed of any type (T) by
.PP
.Vb 1
\& list(T) dict(T)
.Ve
.SH "SUBCLASS METHODS"
.IX Header "SUBCLASS METHODS"
If this class is subclassed, the following methods may be overridden to
customise the behaviour. They allow the subclass to return different objects
in the syntax tree.
.SS "make_class"
.IX Subsection "make_class"
.Vb 1
\&   $class = $parser\->make_class( name => $name )
.Ve
.PP
Return a new instance of Tangence::Meta::Class to go in a package. The
parser will call \f(CW\*(C`define\*(C'\fR on it.
.SS "make_struct"
.IX Subsection "make_struct"
.Vb 1
\&   $struct = $parser\->make_struct( name => $name )
.Ve
.PP
Return a new instance of Tangence::Meta::Struct to go in a package. The
parser will call \f(CW\*(C`define\*(C'\fR on it.
.SS "make_method"
.IX Subsection "make_method"
.Vb 1
\&   $method = $parser\->make_method( %args )
.Ve
.SS "make_event"
.IX Subsection "make_event"
.Vb 1
\&   $event = $parser\->make_event( %args )
.Ve
.SS "make_property"
.IX Subsection "make_property"
.Vb 1
\&   $property = $parser\->make_property( %args )
.Ve
.PP
Return a new instance of Tangence::Meta::Method, Tangence::Meta::Event
or Tangence::Meta::Property to go in a class.
.SS "make_argument"
.IX Subsection "make_argument"
.Vb 1
\&   $argument = $parser\->make_argument( %args )
.Ve
.PP
Return a new instance of Tangence::Meta::Argument to use for a method
or event argument.
.SS "make_field"
.IX Subsection "make_field"
.Vb 1
\&   $field = $parser\->make_field( %args )
.Ve
.PP
Return a new instance of Tangence::Meta::Field to use for a structure type.
.SS "make_type"
.IX Subsection "make_type"
.Vb 1
\&   $type = $parser\->make_type( $primitive_name )
\&
\&   $type = $parser\->make_type( $aggregate_name => $member_type )
.Ve
.PP
Return an instance of Tangence::Meta::Type representing the given
primitive or aggregate type name. An implementation is allowed to use
singleton objects and return identical objects for the same primitive name or
aggregate and member type.
.SH "AUTHOR"
.IX Header "AUTHOR"
Paul Evans <leonerd@leonerd.org.uk>