.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "EMBOSS::ACD 3pm"
.TH EMBOSS::ACD 3pm 2024-02-25 "perl v5.38.2" "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
EMBOSS::ACD \- parse EMBOSS ACD (AJAX Command Definition) files
.SH AUTHOR
.IX Header "AUTHOR"
Luke McCarthy <lukem@gene.pbi.nrc.ca>
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use EMBOSS::ACD;
\&  
\&  $acd = EMBOSS::ACD\->new($acdfile);
\&  
\&  $application = $acd\->name;
\&  
\&  $description = $acd\->documentation;
\&
\&  @groups = $acd\->groups;
\&  
\&  foreach $parameter ($acd\->param) {
\&        while (($attribute, $value) = each %$parameter) {
\&                ...
\&        }
\&  }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
EMBOSS::ACD parses EMBOSS Ajax Command Definition files and provides
object-oriented access to the data contained therein.
.PP
For a complete specification of the ACD format, see
http://emboss.sourceforge.net/developers/acd
.PP
Note that no checks are performed to ensure that the ACD file is semantically
valid.  Specifically, datatypes and attributes that aren't defined in the
specification can occur in the file and will be parsed as normal.  This is a
good thing, as the module remains useful even if new datatypes are added by
local developers or the EMBOSS crew.
.PP
Public methods are described below:
.IP new($acdfile) 4
.IX Item "new($acdfile)"
Parses the specified ACD file.  Returns a new EMBOSS::ACD object on success,
and dies on failure.
.Sp
\&\f(CW$acdfile\fR is the full path to a valid ACD file.
.IP \fBname()\fR 4
.IX Item "name()"
Returns the name of the application whose ACD file was parsed.
.IP \fBdocumentation()\fR 4
.IX Item "documentation()"
Returns a short description of the application whose ACD file was parsed.
.IP \fBgroups()\fR 4
.IX Item "groups()"
Returns a list of functional groups to which the application belongs.  For a
list of possible groups, see
http://emboss.sourceforge.net/developers/acd/syntax.html#sect2214
.IP param($param) 4
.IX Item "param($param)"
Returns a reference to a hash describing the specified parameter.  The hash
contains key-value pairs corresponding to the attributes specified in the ACD
file, plus the keys 'name' and 'datatype'.  The value of the 'datatype' key is
the canonical name of the data type, regardless of any abbreviation in the ACD
file.  For a list of possible data types, see
http://emboss.sourceforge.net/developers/acd/syntax.html#sect23
.Sp
If no parameter is specified, a list of all parameters is returned.  The
members of the list are hash references as described above.
.Sp
Note that, in accordance with the ACD specification, attribute names are not
expanded if they are abbreviated in the ACD file.
.Sp
\&\f(CW$param\fR is either undefined (see above) or the name of the desired parameter.
.IP canonical_datatype($datatype) 4
.IX Item "canonical_datatype($datatype)"
Returns the canonical name of the specified abbreviated datatype, or undefined
if the abbreviation is ambiguous or not recognized.
.SH BUGS
.IX Header "BUGS"
None that I know of...
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2004 Luke McCarthy.  All rights reserved.  This program is free
software.  You may copy or redistribute it under the same terms as Perl itself.