Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

namespacex(n) [osx man page]

namespacex(n)						    Namespace utility commands						     namespacex(n)

__________________________________________________________________________________________________________________________________________________

NAME

       namespacex - Namespace utility commands

SYNOPSIS

       package require Tcl  8.5

       package require namespacex  ?0.1?

       ::namespacex hook add ?namespace? cmdprefix

       ::namespacex hook proc ?namespace? arguments body

       ::namespacex hook on ?namespace? guardcmdprefix actioncmdprefix

       ::namespacex hook next arg...

       ::namespacex info allchildren namespace

       ::namespacex info allvars namespace

       ::namespacex info vars namespace ?pattern?

       ::namespacex state get namespace

       ::namespacex state set namespace dict

       ::namespacex state drop namespace

_________________________________________________________________

DESCRIPTION

       This package provides a number of utility commands for working with namespaces.

API

       ::namespacex hook add ?namespace? cmdprefix

       ::namespacex hook proc ?namespace? arguments body

       ::namespacex hook on ?namespace? guardcmdprefix actioncmdprefix

       ::namespacex hook next arg...

       ::namespacex info allchildren namespace
	      This  command returns a list containing the names of all child namespaces in the specified namespace and its children. The names are
	      all fully qualified.

       ::namespacex info allvars namespace
	      This command returns a list containing the names of all variables in the specified namespace and its children.  The  names  are  all
	      relative to namespace, and not fully qualified.

       ::namespacex info vars namespace ?pattern?
	      This command returns a list containing the names of all variables in the specified namespace.

       ::namespacex state get namespace
	      This command returns a dictionary holding the names and values of all variables in the specified namespace and its child namespaces.

	      Note that the names are all relative to namespace, and not fully qualified.

       ::namespacex state set namespace dict
	      This  command takes a dictionary holding the names and values for a set of variables and replaces the current state of the specified
	      namespace and its child namespaces with this state.  The result of the command is the empty string.

       ::namespacex state drop namespace
	      This command unsets all variables in the specified namespace and its child namespaces.  The result  of  the  command  is	the  empty
	      string.

KEYWORDS

       extended namespace, info, namespace unknown, namespace utilities, state (de)serialization, unknown hooking, utilities

COPYRIGHT

       Copyright (c) 200? Neil Madden (http://wiki.tcl.tk/12790)
       Copyright (c) 200? Various (http://wiki.tcl.tk/1489)
       Copyright (c) 2010 Documentation, Andreas Kupries

namespacex								0.1							     namespacex(n)

Check Out this Related Man Page

variable(n)						       Tcl Built-In Commands						       variable(n)

__________________________________________________________________________________________________________________________________________________

NAME

       variable - create and initialize a namespace variable

SYNOPSIS

       variable ?name value...? name ?value?
_________________________________________________________________

DESCRIPTION

       This  command  is  normally used within a namespace eval command to create one or more variables within a namespace.  Each variable name is
       initialized with value.	The value for the last variable is optional.

       If a variable name does not exist, it is created.  In this case, if value is specified, it is assigned to the newly created  variable.	If
       no  value  is  specified,  the new variable is left undefined.  If the variable already exists, it is set to value if value is specified or
       left unchanged if no value is given.  Normally, name is unqualified (does not include the names of  any	containing  namespaces),  and  the
       variable  is  created in the current namespace.	If name includes any namespace qualifiers, the variable is created in the specified names-
       pace.  If the variable is not defined, it will be visible to the namespace which command, but not to the info exists command.

       If the variable command is executed inside a Tcl procedure, it creates local variables linked to the corresponding namespace variables (and
       therefore  these  variables  are  listed by info vars.)	In this way the variable command resembles the global command, although the global
       command only links to variables in the global namespace.  If any values are given, they are used to modify the  values  of  the	associated
       namespace variables.  If a namespace variable does not exist, it is created and optionally initialized.

       A name argument cannot reference an element within an array.  Instead, name should reference the entire array, and the initialization value
       should be left off.  After the variable has been declared, elements within the array can be set using ordinary set or array commands.

EXAMPLES

       Create a variable in a namespace:
	      namespace eval foo {
		  variable bar 12345
	      }

       Create an array in a namespace:
	      namespace eval someNS {
		  variable someAry
		  array set someAry {
		      someName	someValue
		      otherName otherValue
		  }
	      }

       Access variables in namespaces from a procedure:
	      namespace eval foo {
		  proc spong {} {
		      # Variable in this namespace
		      variable bar
		      puts "bar is $bar"

		      # Variable in another namespace
		      variable ::someNS::someAry
		      parray someAry
		  }
	      }

SEE ALSO

       global(n), namespace(n), upvar(n)

KEYWORDS

       global, namespace, procedure, variable

Tcl									8.0							       variable(n)
Man Page