Reference Manual of admst-2 Language

A Freescale.com !n!t!at!veSupported by www.sourceforge.net

Introduction

This document is the reference document of the admst language. admst is a subset of the xml language. Its DTD can be found at admst.dtd. admst is used by adms to transform verilog-ams source code into any kind of outputs (html documents, C code for spice simulators.) The primary application of admst is to create C code generators that generate from verilog-ams language ready-to-compile C code for some simulator-specific API. However its use can be extended to other applications like the automatic generation of html documentation. Most of the syntax used by admst has been borrowed from the xsl language.
The command below shows how adms interprets admst scripts (myadmst.xml is an admst script and myverilogams.va is a verilog-ams file):

admsXml interprets the admst intructions found in file myadmst.xml and apply the instructions to the contents of the verilog-ams file myverilogams.va. It will produce some output files according to the admst transforms specified into myadmst.xml.

Example of admst script

  
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE admst PUBLIC "-//adms//DTD admst 2.0//-" "http://mot-adms.sourceforge.net/xml-files/adms/admst.dtd">
  3. <admst version="1.48.0" xmlns:admst="http://mot-adms.sourceforge.net/adms/admst.xml">
  4.  <admst:getenv name="HOME"/>
  5.  <admst:text format="HOME is %s\n"/>
  6. </admst>
  

• Line 1. is required. It is not used by admsXml but it helps xml tools to identify the contents of the admst file.
• Line 2. is required. It defines a link to the DTD of the admst language. The admst DTD is similar to a yacc grammar. It specifies the syntax of the admst language. It is not used by adms. If program xmllint is installed on your system then the following command can check the validity of script myadmst.xml against DTD admst.dtd:

  xmllint admst.xml -noout -postvalid -noblanks

• Line 3. and Line 6. are required. They delimit the declaration of the admst transforms.
• Line 4. illustrates the use of admst transform admst:getenv. admst:getenv has one attribute called name. Transform admst:getenv will look for the value of shell environement variable HOME and pushes its value to a internal stack created by admsXml.
• Line 5. illustrates the use of admst transform admst:text. admst:text has one attribute called format. Transform admst:text will print the text specified into attribute format. Each occurence of %s will be replaced by the top value of the internal stack created by admsXml.

List of admst Transforms

The list below provides a brief description of all possible admst transforms. Each admst transform has a set of attributes that modify or refine its behavior. An attribute is made of a name and a value: attrName="attrValue". The container of value attrValue can either be a scalar or a list. The data type of value attrValue can either be a basic type (integer, real, string, enumeration) or a reference to an adms element (module, node, branch, ...). adms uses attribute properties (datatypefamily, datatypename, size) to check dynamically the validity of attrValue. A star ("*") means that attrValue can be any adms element or can be of any type.

Examples:

• attribute version of admst transform admst can only be a scalar string.
• attribute select of admst transform admst:for-each can only be a list of any adms elements.

This page has been automatically created by applying the xsl transform admststyle.xsl to the xml data file admst.xml.
The rendering of the page is specified by the css stylesheet adms.css. You can get the full contents of data file admst.xml by viewing the source of the document from your web browser. Please address any comments to r29173.