blt_treegettoken(3) [debian man page]

Blt_TreeGetToken(3)					      BLT Library Procedures					       Blt_TreeGetToken(3)

__________________________________________________________________________________________________________________________________________________

NAME

       Blt_TreeGetToken - Grabs a token associated with existing tree data object.

SYNOPSIS

       #include <bltTree.h>

       int
       Blt_TreeGetToken(interp, name, tokenPtr)

ARGUMENTS

       Tcl_Interp   *interp   (in)	Interpreter to report results back to.

       const char   *name     (in)	Name of an existing tree data object.  Can be qualified by a namespace.

       Blt_Tree     *tokenPtr (out)	Points to location to store the client tree token.
_________________________________________________________________

DESCRIPTION

       This procedure obtains a token to a C-based tree data object.  The arguments are as follows:

       interp	 Interpreter to report results back to.  If an error occurs, then interp->result will contain an error message.

       name	 Name  of an existing tree data object.  It's an error if a tree name doesn't already exist.  Name can be qualified by a namespace
		 such as fred::myTree.	If no namespace qualifier is used, the tree the current namespace is searched, then the global namespace.

       tokenPtr  Points to the location where the returned token is stored. A tree token is used to work with the tree object.

       A token for the tree data object is returned.  Tree data objects can be shared.	For example,  the  tree  and  hiertable  commands  may	be
       accessing  the  same  tree  data  object.   Each  client grabs a token that is associated with the tree.  When all tokens are released (see
       Blt_TreeReleaseToken) the tree data object is automatically destroyed.

RETURNS

       A standard Tcl result is returned.  If TCL_ERROR is returned, then interp->result will contain an error message.  The following errors  may
       occur:

       o  No tree exists as name. You can use Tcl_TreeExists to determine if a tree exists beforehand.

       o  Memory can't be allocated for the token.

EXAMPLE

       The following example allocated a token for an existing tree.

	      Blt_Tree token;

	      if (Blt_TreeGetToken(interp, "myTree", &token) != TCL_OK) {
		  return TCL_ERROR;
	      }
	      printf("tree is %s
", Blt_TreeName(token));

SEE ALSO

       Tcl_TreeCreate, Tcl_TreeExists, Tcl_TreeReleaseToken

BLT
									2.4						       Blt_TreeGetToken(3)

grammar::me::util(n)					   Grammar operations and usage 				      grammar::me::util(n)

__________________________________________________________________________________________________________________________________________________

NAME

       grammar::me::util - AST utilities

SYNOPSIS

       package require Tcl  8.4

       package require grammar::me::util  ?0.1?

       ::grammar::me::util::ast2tree ast tree ?root?

       ::grammar::me::util::ast2etree ast mcmd tree ?root?

       mcmd lc location

       mcmd tok from ?to?

       ::grammar::me::util::tree2ast tree ?root?

_________________________________________________________________

DESCRIPTION

       This package provides a number of utility command for the conversion between the various representations of abstract syntax trees as speci-
       fied in the document grammar::me_ast.

       ::grammar::me::util::ast2tree ast tree ?root?
	      This command converts an ast from value to object representation. All nodes in the ast will be converted into nodes  of  this  tree,
	      with  the  root of the AST a child of the node root. If this node is not explicitly specified the root of the tree is used. Existing
	      content of tree is not touched, i.e.  neither removed nor changed, with the exception of the specified root node, which will gain  a
	      new child.

       ::grammar::me::util::ast2etree ast mcmd tree ?root?
	      This  command  is  like  ::grammar::me::util::ast2tree, except that the result is in the extended object representation of the input
	      AST.  The source of the extended information is the command prefix mcmd.	It has to understand two methods, lc, and  tok,  with  the
	      semantics specified below.

	      mcmd lc location
		     Takes  the location of a token given as offset in the input stream and return a 2-element list containing the associated line
		     number and column index, in this order.

	      mcmd tok from ?to?
		     Takes one or two locations from and to as offset in the input stream and returns a Tcl list containing the specified part	of
		     the input stream. Both location are inclusive. If to is not specified it will default to the value of from.

		     Each  element  of the returned list is a list containing the token, its associated lexeme, the line number, and column index,
		     in this order.

       Both the ensemble command ::grammar::me::tcl provided by the package grammar::me::tcl and  the  objects	command  created  by  the  package
       ::grammar::me::cpu fit the above specification.

       ::grammar::me::util::tree2ast tree ?root?
	      This  command  converts an ast in (extended) object representation into a value and returns it.  If a root node is specified the AST
	      is generated from that node downward. Otherwise the root of the tree object is used as the starting point.

BUGS, IDEAS, FEEDBACK
       This document, and the package it describes, will undoubtedly contain bugs and other problems.  Please report such in  the  category  gram-
       mar_me  of  the Tcllib SF Trackers [http://sourceforge.net/tracker/?group_id=12883].  Please also report any ideas for enhancements you may
       have for either package and/or documentation.

KEYWORDS

       abstract syntax tree, syntax tree, tree

CATEGORY

       Grammars and finite automata

COPYRIGHT

       Copyright (c) 2005 Andreas Kupries <andreas_kupries@users.sourceforge.net>

grammar_me								0.1						      grammar::me::util(n)