---

zephyr-core.vtc File Reference

Primitive types for vt zephyr support. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Compounds
struct	Tzgram
	Data type for incoming zephyrgrams. More...
Functions
func	new_zgram ()[zgram]
	Creates a new Tzgram object. More...
func	zapply (f, z)
	Applies a function to all string members of a zephyrgram. More...
func	zephyr_init (world, rmt, login)
	Initialize zephyr for a particular remote. More...
func	zephyr_cleanup (world)
	Clean up after stopping zephyr in vt. More...
func	zephyr_change_window (world, old, new)
	Change the window zephyr is being shown in. More...
func	zephyr_netread (line)[n]
	Read an incoming message. More...
func	zephyr_save (w, fp)
	Save information about this world to a file. More...
func	zephyr_list (w)
	Print information about this world for the list_worlds command. More...
func	zephyr_print (w)
	Print general information about this world. More...
func	add_zephyr (name)
	User command to add a zephyr world. More...
Variables
	ZEPHYR = alloc(5, Twtype)
	Global variable to hold the vt world object for zephyrs. More...

---

Detailed Description

Primitive types for vt zephyr support.

Author:

David Maze <dmaze@mit.edu>

Version:

$Id$

This file provides a primitive zephyrgram type, via new_zgram(). It also provides the basis for an interface between vt and Zephyr. An external function, zephyr_output(), must be provided for this code to call to output the zephyrgram in cur_rmt->zephyr.

Typically, few of the functions in this file will be called directly. The user initialization code will call add_zephyr() to connect vt to zephyr, and possible new_zgram() to create Tzgram objects. The remainder of the functions are called internally by vt.

The user initialization code must also provide a function to process outbound messages. This function is typically called zephyr_outbound(), and takes a vt remote object and a single text line as parameters. The address of this function should be assigned to ZEPHYR->outbound.

Definition in file zephyr-core.vtc.

---

Function Documentation

func add_zephyr ( name )

User command to add a zephyr world. This command is typically called directly out of .local.vtc. Parameters: name   Name of the world to add Definition at line 272 of file zephyr-core.vtc.

func new_zgram ( )

Creates a new Tzgram object. All of the string fields are set to empty, the personal flag is set to false, and fields is allocated as an array of two empty strings. Returns: A new Tzgram object Definition at line 111 of file zephyr-core.vtc. Referenced by zephyr_init(), and zephyr_output().

func zapply ( f, z )

Applies a function to all string members of a zephyrgram. The function should take a string as a parameter, and return the new string. Parameters: f   Function to apply z   Zephyrgram to apply f to Definition at line 134 of file zephyr-core.vtc. Referenced by zephyr_output().

func zephyr_change_window ( world, old, new )

Change the window zephyr is being shown in. Parameters: world   Zephyr world object to move old   Original world new   New world Definition at line 184 of file zephyr-core.vtc.

func zephyr_cleanup ( world )

Clean up after stopping zephyr in vt. Parameters: world   Zephyr world object to break down Definition at line 170 of file zephyr-core.vtc.

func zephyr_init ( world, rmt, login )

Initialize zephyr for a particular remote. Parameters: world   Zephyr world object to initialize rmt   vt remote to initialize for login   Unused Definition at line 157 of file zephyr-core.vtc.

func zephyr_list ( w )

Print information about this world for the list_worlds command. Parameters: w   World to print information about Definition at line 248 of file zephyr-core.vtc.

func zephyr_netread ( line )

Read an incoming message. The input of this function is generally the output of zwgc using a specialized .zwgc.desc file. Parameters: line   Input line from zwgc to process Definition at line 198 of file zephyr-core.vtc.

func zephyr_print ( w )

Print general information about this world. Parameters: w   World to print information about Definition at line 258 of file zephyr-core.vtc.

func zephyr_save ( w, fp )

Save information about this world to a file. Parameters: w   World to save information about fp   File pointer to write to Definition at line 238 of file zephyr-core.vtc.

---

Variable Documentation

ZEPHYR = alloc(5, Twtype)

Global variable to hold the vt world object for zephyrs. Definition at line 147 of file zephyr-core.vtc.

---