Abstract for GDDM Base Application Programming Reference

• What this book is about
• Who this book is for
• What you need to know

Summary of changes

• Summary of changes for GDDM 3.1

More GDDM information

• GDDM publications
• Books from related libraries

GDDM programming interface

• The nonreentrant interface
• The reentrant interface
• The system programmer interface
• Application programming language considerations
• APL
• Assembler language
• BASIC (IBM)
• C
• Declaring variables
• COBOL
• FORTRAN
• PL/I
• REXX
• GDDM call syntax
• Methods of passing parameters
• Values that can be passed
• Types of parameters
• Strings
• Passing array parameters
• Parameters that are too short
• Parameters that are too long
• Omitting parameters
• Finding syntax from reference sources
• Interdependent parameters, array dimensions, string lengths
• Parameter syntax in ERXPROTO
• Parameter syntax in the reference manuals
• Dependency between parameters
• Restrictions
• Differences

A summary of the calls by function

• Types of functions
• Control functions
• Copy functions
• Device functions
• Graphics functions
• Graphics segment functions
• Interactive graphics functions
• High-performance alphanumeric functions
• Image functions
• Image management
• Image presentation
• Mapped alphanumeric functions
• Operator window functions
• Page functions
• Partition functions
• Procedural alphanumeric functions
• Symbol set functions
• Utility call functions

The GDDM calls

• Format of the GDDM call descriptions
• Syntax of GDDM calls
• Error messages in GDDM calls
• Alphabetic list of GDDM calls
• APDEF
• APDEL
• APMOD
• APQIDS
• APQNUM
• APQRY
• APQSIZ
• APQUID
• ASCCOL
• ASCGET
• ASCHLT
• ASCPUT
• ASCSS
• ASDFLD
• ASDFLT
• ASDFMT
• ASDTRN
• ASFBDY
• ASFCLR
• ASFCOL
• ASFCUR
• ASFEND
• ASFHLT
• ASFIN
• ASFINT
• ASFMOD
• ASFOUT
• ASFPSS
• ASFSEN
• ASFTRA
• ASFTRN
• ASFTYP
• ASGGET
• ASGPUT
• ASMODE
• ASQCOL
• ASQCUR
• ASQFLD
• ASQHLT
• ASQLEN
• ASQMAX
• ASQMOD
• ASQNMF
• ASQSS
• ASRATT
• ASREAD
• ASRFMT
• ASTYPE
• CDPU
• CGLOAD
• CGSAVE
• DSCLS
• DSCMF
• DSCOPY
• DSDROP
• DSFRCE
• DSOPEN
• DSQCMF
• DSQDEV
• DSQUID
• DSQUSE
• DSRNIT
• DSUSE
• ESACRT
• ESADEL
• ESAQRY
• ESASEL
• ESEUDS
• Encoded format of a nickname UDS
• ESLIB
• ESPCB
• ESQCPG
• ESQEUD
• ESQOBJ
• ESQUNL
• ESQUNS
• ESSCPG
• ESSUDS
• FSALRM
• FSCHEK
• FSCLS
• FSCOPY
• FSENAB
• FSEXIT
• FSFRCE
• FSGET
• FSGETE
• FSGETS
• FSINIT
• Other forms for CICS, IMS, and TSO
• FSLOG
• FSLOGC
• FSOPEN
• FSPCLR
• FSPCRT
• FSPDEL
• FSPQRY
• FSPSEL
• FSPWIN
• FSQCPG
• FSQDEV
• FSQERR
• FSQSYS
• FSQUPD
• FSQUPG
• FSQURY
• FSQWIN
• FSREST
• FSRNIT
• FSSAVE
• FSSHOR
• FSSHOW
• FSTERM
• FSTRAN
• FSTRCE
• FSUPDM
• GSAM
• GSARC
• GSARCC
• GSAREA
• GSBMIX
• GSBND
• GSCA
• GSCALL
• GSCB
• GSCBS
• GSCD
• GSCH
• GSCHAP
• GSCHAR
• GSCLP
• GSCLR
• GSCM
• GSCOL
• GSCOPY
• GSCORR
• GSCORS
• GSCP
• GSCPG
• GSCS
• GSDEFE
• GSDEFS
• GSDSS
• GSELPS
• GSENAB
• GSENDA
• GSFLD
• GSFLSH
• GSFLW
• GSGET
• GSGETE
• GSGETS
• GSIDVF
• GSIDVI
• GSILOC
• GSIMG
• GSIMGS
• GSIPIK
• GSISTK
• GSISTR
• GSLINE
• GSLOAD
• The elements of opt-array
• GSLSS
• GSLT
• GSLW
• GSMARK
• GSMB
• GSMIX
• GSMOVE
• GSMRKS
• GSMS
• GSMSC
• GSPAT
• GSPFLT
• GSPLNE
• GSPOP
• GSPS
• GSPUT
• GSQAGA
• GSQAM
• GSQATI
• GSQATS
• GSQBMX
• GSQBND
• GSQCA
• GSQCB
• GSQCBS
• GSQCD
• GSQCEL
• GSQCH
• GSQCHO
• Device variations
• GSQCLP
• GSQCM
• GSQCOL
• GSQCP
• GSQCPG
• GSQCS
• GSQCUR
• GSQFLD
• GSQFLW
• GSQLID
• GSQLOC
• GSQLT
• GSQLW
• GSQMAX
• GSQMB
• GSQMIX
• GSQMS
• GSQMSC
• GSQNSS
• GSQORG
• GSQPAT
• GSQPIK
• GSQPKS
• GSQPOS
• GSQPRI
• GSQPS
• GSQSEN
• GSQSIM
• GSQSS
• GSQSSD
• GSQSTK
• GSQSTR
• GSQSVL
• GSQTA
• GSQTAG
• GSQTB
• GSQTFM
• GSQVIE
• GSQWIN
• GSREAD
• GSRSS
• GSSAGA
• GSSATI
• GSSATS
• GSSAVE
• GSSCLS
• GSSCPY
• GSSCT
• GSSDEL
• GSSEG
• GSSEN
• GSSINC
• GSSORG
• GSSPOS
• GSSPRI
• GSSTFM
• GSSVL
• GSTA
• GSTAG
• GSUWIN
• GSVECM
• GSVIEW
• GSWIN
• IMACLR
• IMACRT
• IMADEL
• IMAGID
• IMAGT
• IMAGTE
• IMAGTS
• IMAPT
• IMAPTE
• IMAPTS
• IMAQRY
• IMARES
• IMARF
• IMARST
• IMASAV
• IMATRM
• IMPCRT
• IMPDEL
• IMPGID
• IMPRST
• IMPSAV
• IMRBRI
• IMRCON
• IMRCVB
• IMREX
• IMREXR
• IMRNEG
• IMRORN
• IMRPL
• IMRPLR
• IMRRAL
• IMRREF
• IMRSCL
• IMXFER
• ISCTL
• ISENAB
• ISESCA
• ISFLD
• ISIBOX
• Device variations
• ISILOC
• ISLDE
• ISQBOX
• ISQCOM
• ISQFLD
• ISQFOR
• ISQLOC
• ISQRES
• ISQSCA
• ISSE
• ISXCTL
• MSCPOS
• MSDFLD
• MSGET
• MSPCRT
• MSPQRY
• MSPUT
• MSQADS
• Description of sections
• MSQFIT
• MSQFLD
• MSQGRP
• MSQMAP
• MSQMOD
• MSQPOS
• MSREAD
• PSDSS
• PSLSS
• PSLSSC
• PSQSS
• PSRSS
• PSRSV
• PTNCRT
• PTNDEL
• PTNMOD
• PTNQRY
• PTNQUN
• PTNSEL
• PTSCRT
• PTSDEL
• PTSQPI
• PTSQPN
• PTSQPP
• PTSQRY
• PTSQUN
• PTSSEL
• PTSSPP
• SPINIT
• SPMXMP
• SSQF
• SSREAD
• SSWRT
• WSCRT
• WSDEL
• WSIO
• WSMOD
• WSQRY
• WSQUN
• WSQWI
• WSQWN
• WSQWP
• WSSEL
• WSSWP

Device variations

• Operator windows, partitions, primary, alternate, and dual screens
• Operator windows
• Partitions
• Primary and alternate screen sizes
• Dual screen devices
• Dual screen size
• Device-specific saved pictures
• GDF saved as 2-byte integers
• ADMSAVE files
• Screen redraw
• Graphics primitives outside segments
• Programmed symbol sets (PS) and graphics text
• Character mode 1 (hardware character sets)
• Character mode 2 (image symbol sets)
• PS stores and device cell-size dimensions
• FSCHEK call
• Alphanumerics
• Alphanumeric field attributes
• Double-byte character sets (DBCS)
• Cursor position within mixed fields
• 3278-52
• Alphanumeric colors
• Graphics colors
• Color mixing
• Foreground color mix mode
• "Mix" mode
• "Underpaint" mode
• "Exclusive-OR" mode
• "Transparent" mode
• "Mix" mode
• Combinations of foreground and background mix modes
• Graphics line types and widths
• Line types (GSLT)
• Line widths (GSFLW and GSLW)
• Graphics area shading
• Graphics image
• Graphics logical input devices
• Choice devices
• Locator devices (GSILOC)
• Echo types
• Trigger keys
• Pick devices (GSIPIK)
• Echo
• Trigger keys
• Stroke devices (GSISTK)
• String devices (GSISTR)
• Image

APL request codes module

• The address table
• The request code table
• GDDM Base APL codes, in numeric order

GDDM-REXX programming interface

• GDDM-REXX commands, subcommands, and utilities
• Summary
• Commands
• Subcommands
• Utility EXEC
• Syntax conventions
• GDDMREXX command
• GDDMREXX INIT
• Parameters
• GDDMREXX TERM
• Parameters
• GDDMREXX VERSION
• Parameters
• GXGET subcommand
• GXGET AAB
• Parameters
• GXGET CDT
• Parameters
• GXGET LASTMSG
• Parameters
• GXGET MSG
• Parameters
• GXGET NAMES
• Parameters
• GXGET TRACE
• Parameters
• GXSET subcommand
• GXSET AAB
• Parameters
• GXSET MSADS
• Parameters
• GXSET MSG
• Parameters
• GXSET MSVARS
• Parameters
• GXSET TRACE
• Parameters
• GDDM calls
• ERXMSVAR EXEC
• Parameters
• Description
• Field naming rules
• Sample output
• Possible pitfalls

Symbol sets

• How GDDM handles symbol sets
• Loading programmed symbol stores
• PS store numbers
• Symbol-set identification
• Using preloaded PS sets
• Selecting symbol sets by device type
• Using PS with graphics
• Loading graphics symbol sets
• Devices other than 3179-Gs, 3192-Gs, 3472-Gs, 4224s, ASCII graphics displays, GDDM-PCLK, and GDDM-OS/2 Link devices
• 3270-PC/Gs, 3270-PC/GXs, 3179-Gs, 3192-Gs, and 3472-Gs
• PS overflow caused by picture complexity
• Using symbol sets in printing
• Using DBCS symbol sets
• Naming conventions for sample image symbol sets
• Sample image symbol sets
• Sample vector symbol sets
• Illustrations of vector typefaces

Symbol set formats

• Image symbol set component format
• Vector symbol set component format

GDDM object file formats

• Record structure
• The record identification field
• The header record information field
• Data records

GDF order descriptions

• Compatibility
• Saving GDF orders
• Format of GDF objects
• Coordinates and aspect ratio
• GDF orders: summary
• General structure
• Order formats
• Normal format
• Short format
• Padding
• Coordinate data
• Primitives
• Current position
• Attributes
• GDF orders: full descriptions
• Format of tables
• Format of examples
• Arc
• Arc parameters
• Area
• Background color mix
• Call segment
• Character angle
• Character box
• Character box spacing
• Character direction
• Character precision
• Character set
• Character shear
• Character string
• Color
• Comment
• Current position
• End area
• Fillet
• Foreground color mix
• Fractional line width
• Full arc
• Image - begin
• Image - data
• Image - end
• Line
• Line type
• Line width
• Marker
• Marker box
• Marker scale
• Marker type
• Model transform
• Pattern
• Pick (tag) identifier
• Pop
• Process specific control
• Relative line
• Segment attribute
• Segment attribute modify
• Segment characteristics
• Segment end
• Segment end prolog
• Segment position
• Segment start
• Segment viewing window
• Text alignment
• Process specific control orders (PSC)
• Symbol-set process specific control orders
• Picture prolog process specific control orders
• Symbol-set PSC orders
• Begin symbol-set mapping
• Map symbol-set identifier
• End symbol-set mapping
• Picture prolog
• Begin picture prolog
• End picture prolog
• Set default arc parameters
• Set default background mix
• Set default character angle
• Set default character box
• Set default character-box spacing
• Set default character direction
• Set default character precision
• Set default character set
• Set default character shear
• Set default coordinate type
• Set default extended color
• Set default foreground mix
• Set default fractional line width
• Set default line type
• Set default marker box
• Set default marker type
• Set default pattern
• Set default pick identifier
• Set default picture scale
• Set default text alignment
• Set default viewing window
• Set picture boundary
• Set picture origin

Image file formats

• Formats and compression types
• 3193 data stream and page printer formats
• Unformatted data

Picture interchange format files

• Processing PIF files under TSO
• The conversion operation
• The GDF file-conversion utility
• The transfer operation
• The IND$FILE CLIST
• The IND$FILE file transfer command
• Commands to use under TSO
• To transfer a PIF file from the workstation to host
• To transfer a GDDM GDF picture from the host to the workstation
• To convert a PIF file into a GDDM ADMGDF object
• To convert a GDDM ADMGDF object into a PIF file
• The format of a PIF file
• Processing PIF files under VM/CMS
• The conversion operation
• The GDF file-conversion utility
• The transfer operation
• The IND$FILE EXEC
• The IND$FILE file transfer command
• Commands to use under VM/CMS
• To transfer a PIF file from the workstation to host
• To transfer a GDDM GDF picture from the host to the workstation
• To convert a PIF file into a GDDM ADMGDF object
• To convert a GDDM ADMGDF object into a PIF file
• The format of a PIF file
• Creating PIF data under GDDM
• Creating PIF data at a workstation
• How PIF data relates to GDF data
• Base PIF
• Restrictions and considerations
• Creating files
• The spool print function
• The GDDM sample program ADMUSP4
• ADMUPCV and ADMUPCT utilities
• LCLMODE processing option
• GGXA file conversion
• DisplayGraphics
• The structure of a PIF file

Computer Graphics Metafiles

• Application program calls
• CGLOAD
• CGSAVE
• Utility programs
• ADMUCG
• ADMUGC
• SEND and RECEIVE
• External defaults
• CGM file format
• National language code pages
• Conversion profiles
• Format of a conversion profile
• Picture mapping information
• Picture adjustment factors
• Conversion Profiles supplied with GDDM
• Creating conversion profiles for other applications
• GDF order processing (CGSAVE call)
• CGM order processing (CGLOAD call)

Graphics Interchange Format (GIF) files

• GIF file structure
• ADMUGIF
• Keyword parameters
• Invoking ADMUGIF under VM/CMS
• Example VM/CMS invocations
• Invoking ADMUGIF under MVS/TSO
• Example MVS/TSO invocations
• For both VM/CMS and MVS/TSO
• Return codes

Format of a Composite Document Presentation Data Stream

• Document structure
• Structured fields
• Summary of structured fields
• Structured field formats
• Begin active environment group (D3A8C9) BAG
• Begin bar code object (D3A8EB) BBC
• Bar code data (D3EEEB) BDA
• Bar-code-data descriptor (D3A6EB) BDD
• Begin document (D3A8A8) BDT
• Begin graphics object (D3A8BB) BGR
• Begin image object (D3A8FB) BIM
• Begin master environment group (D3A8C8) BMG
• Begin object environment group (D3A8C7) BOG
• Begin page (D3A8AF) BPG
• Begin presentation text (D3A89B) BPT
• End active environment group (D3A9C9) EAG
• End bar code object (D3A9EB) EBC
• End document (D3A9A8) EDT
• End graphics object (D3A9BB) EGR
• End image object (D3A9FB) EIM
• End master environment group (D3A9C8) EMG
• End object environment group (D3A9C7) EOG
• End page (D3A9AF) EPG
• End presentation text (D3A99B) EPT
• Graphics data (D3EEBB) GAD
• Graphics data descriptor (D3A6BB) GDD
• Image data descriptor (D3A6FB) IDD
• Invoke master environment group (D3AFC8) IMG
• Image picture data (D3EEFB) IPD
• Map bar code (D3ABEB) MBC
• Medium copy count (D3B188) MCC
• Map coded font (D3AB8A) MCF/2
• Medium descriptor (D3A688) MDD
• Medium modification control (D3A788) MMC
• Map medium overlay (D3ABDF) MMO
• No operation (D3EEEE) NOP
• Object area descriptor (D3A66B) OBD
• Object area position (D3AC6B) OBP
• Page descriptor (D3A6AF) PGD
• Page position (D3B1AF) PGP
• Presentation text descriptor (D3A69B) PTD
• Presentation text data (D3EE9B) PTX
• AFPDS structured fields supported by the CDPU
• Summary of AFPDS structured fields supported by the CDPU

Application data structure for mapping

• Adjunct fields
• COBOL example
• Assembler language example
• PL/I example
• Adjunct field names
• Adjunct values
• Selector adjunct
• Cursor adjunct
• Attribute adjuncts
• Base attribute adjunct
• Extended highlighting adjunct
• Color adjunct
• Programmed symbols adjunct
• Validation adjunct
• Field outlining
• Length adjunct
• Character attributes
• Setting character attributes from the terminal
• Designator characters for light-pen or cursor selection
• Map-defined input editing
• AID translation
• Folding
• Justification and padding
• Copying the application data structure into the program
• Overlaying application data areas
• Double-byte character string fields
• Mixed double-byte and single-byte character fields in maps
• GDDM-supplied mapping constants

GDDM high-performance alphanumerics

• HPA data structure
• The field list
• The field list header row
• The field definition row
• Example
• The data buffer
• Mixed double-byte and single-byte character fields
• Character attributes
• Example
• The bundle list
• Bundle list header row
• Bundle definition row
• Example
• How to use high-performance alphanumerics
• Move mode and locate mode
• Output
• Input
• Reshow
• Field list update rules
• Data buffer update rule
• Bundle list update rule
• Dynamic fields
• Interpreted languages
• Read-only storage
• Shared storage
• Validation

External defaults

• GDDM's default values
• Changing GDDM's default values
• External defaults: format
• Alphabetical list of GDDM external defaults

Processing options

• Processing options
• Processing options: format
• Processing options: full descriptions

Name-lists

• Reserved names "*" and blanks
• Family-1 name-list
• CICS name-list
• VSE/Batch name-list
• IMS name-list
• TSO name-list
• MVS/Batch name-list
• VM name-list

Device characteristics tokens

• Creating your own device tokens
• Device tokens for ASCII graphics displays
• GDDM-supplied device tokens

Special-purpose programming in GDDM

• SPIB format
• Using the system programmer interface
• Initialization
• The system programmer interface block
• Format of the system programmer interface block
• Specifying user exits
• Exit values
• GDDM user-exit conventions
• The task switch exit
• The call intercept exit
• The coordination exit
• Storage exit routines - interface specifications
• Call format descriptor module
• The address table
• The call descriptor table
• RCPPSTAB(j)
• The parameter descriptor table
• RCPPPDES(n)

Glossary

Index