Z88DK - Z88 Library Functions

The z88 was the first machine target of z88dk, and as such has a large amount of library routines to support its operating system, OZ. Much of the API provided by OZ is available to z88 C programmers, to use as you wish. Z88dk is also capable of producing the full range of z88 applications and documentation is provided to help you create them. It is also possible to create z88 packages - the z88 equivalent of shared libraries. To obtain the functions listed in this file, you should link your program with the z88 library using the -lz88 flag.

#include <z88.h>

#define FILEMAIL "FILE"
#define DATEMAIL "DATE"

int readmail(char *type, char *info, int length);
int sendmail(char *type, char *info, int length);

These two functions read and write `application mail'. The only two supported types are FILEMAIL and DATEMAIL which on a standard z88 are produced by the Filer and Calendar applications. Both functions return 1 on success and 0 on failure.

int savescr();
int restsrc(int handle);
int freescr(int handle);

These functions cause OZ to save a copy of the application screen, restore the image and free the memory
associated with the image. savescr() returns a handle on success or 0 on failure. The handle returned should be retained and supplied to the subsequent functions. NB These function calls should be used sparsely if at all due to the limited memory available on an unexpanded z88.

void nameapp(char *name);

This function enables an application program to name an instance of an application. This name appears in the index of suspended applications.

int opendor(char *filename);
void readdor(int dor, char type, char len, void *buf);
void closedor(int dor);
void writedor(int dor, char type, char len, void *buf);
void deletedor(int dor);
int sondor(int dor, char *store);
int brotherdor(int dor, char *store);

Routines for DOR manipulation. See the Developers Notes for more information.

wild_t wcopen(far char *name, int mode);
int wcnext(wild_t handle, void *buf, size_t len, wildcard_t *dest);
int wcclose(wild_t handle);

These routines are for wildcard manipulation. For more information see the Developers Notes . wcopen() opens a wildcard handler, returning a handle on success or 0 on failure. mode should be a logical or WILD_SCANDIR and WILD_PARENTS. wcclose() will close the wildcard handler opened by wcopen(). wcnext() returns the next entry from the wildcard handler into the memory pointed to by buf up to maximum length len. Infomation about the entry is placed in dest which is a pointer to a structure of type wildcard_t. If this information is not required then NULL should be supplied.

typedef struct wildcard_st {
        void    *endptr;
        u8_t    segments;
        u8_t    length;
        u8_t    dortype;
} wildcard_t;

int exec_cli(char *cli_command);

Execute the cli command supplied.

char *stripdev(char *explicitname);
char *strippath(char *explicitname);

stripdev() returns a pointer in explicitname to after the device specifier. strippath returns a pointer in explicitname to the filename i.e. after the path and device.

void openpopup(int wid, int tlx, int tly, int width, int height, char *name);
void openwindow(int wid, int tlx, int tly, int width, int height);
void opentitled(int wid, int tllx, int tly, int width, int height, char *name);

These functions open various forms of windows on the z88 console.