Digital PDFs

AA-PC02A-TE

December 1990

480 pages

Original

16MB

Document:	CDA Reference Manual: Volume 2
Order Number:	AA-PC02A-TE
Revision:
Pages:	480
Original Filename:	http://bitsavers.org/pdf/dec/vax/vms/layered_product/AA-PC02A-TE_CDA_Reference_Manual_Volume_2_199006.pdf

OCR Text

CDA Reference Manual:
Volume2
Order Number: Volume 2: M-PC02A-TE

June 1990
This manual provides reference material for using the CDA Toolkit to create compound
document applications, converters, and viewers.

Revision/Update Information:

This revised manual supersedes the CDA Reference
Manual Part I (Order No. AA-PABUA-TE) and Part Ii
(Order No. AA-PABVA-TE).

Software Version:

digital equipment corporation
maynard, massachusetts

VMS Version 5.4
ULTRIX Version 4.0

First Printing, December 1988
Revised, October 1989
Revised, June 1990

The information in this document is subject to change without notice and should not be
construed as a commitment by Digital Equipment Corporation. Digital Equipment Corporation
assumes no responsibility for any errors that may appear in this document.
The software described in this document is furnished under a license and may be used or
copied only in accordance with the terms of such license.
No responsibility is assumed for the use or reliability of software on equipment that is not
supplied by Digital Equipment Corporation or its affiliated companies.
Restricted Rights: Use, duplication, or disclosure by the U.S. Government is subject to
restrictions as set forth in subparagraph (c) (1) (ii) of the Rights in Technical Data and
Computer Software clause at DFARS 252.227-7013.

© Digital Equipment Corporation 1990.
All Rights Reserved.
Printed in U.S.A.
The postpaid Reader's Comments forms at the end of this document request your critical
evaluation to assist in preparing future documentation.
The following are trademarks of Digital Equipment Corporation:
CDA
DDIF
ODIS
DEC
DECnet
DEC US
DECwindows
DIGITAL
DTIF

Live Link
LN03
MASS BUS
PrintServer
Q-bus
ReGIS
ULTRIX
UNIBUS
VAX

VAXcluster
VAX RMS
VAXstation
VT
XUI

The following are third-party trademarks:
Postscript is a registered trademark of Adobe Systems, Inc.
Lotus 1-2-3 is a registered trademark of Lotus Development Corp.
ZK5428

This document was prepared using VAX DOCUMENT, Version 1.2

Contents
Preface . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 1

xvii

Introduction

1.1

CDA Item Data Types ........................................ .

1-1

1.2

CDA Default Values ......................................... .

1-4

1.3

DDIF Standard Aggregates .................................... .

1-5

1.4

DDIF Tags ................................................ .

1-7

1.5

DDIF Initial Values .......................................... .

1-9

1.6

DDIF Processing Options ..................................... .
1.6.1
Inherit Attributes Processing Option ....................... .
1.6.1.1
Type References and Definitions ................. .
1.6.1.2
Style Guides ............................... .
1.6.2
Retain Definitions Processing Option ....................... .
1.6.3
Evaluate Content Processing Option ....................... .
1.6.3.1
Content References and Definitions ............... .
1.6.3.2
Computed Segment Content and External References ... .
1.6.4
Discard Segments Processing Options . . . . . . . . . . . . . . . . . . . . . .

1-13
1-14
1-14
1-15
1-15
1-15
1-16
1-16
1-17

1.7

DTIF Document Aggregate Hierarchy ............................. .

1-17

1.8

CFE Aggregate Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1-18

1.9

ESF Aggregate Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1-19

Chapter 2
2.1

Bundled Converter Formats and Commands
Base System Front Ends (Input Formats) .......................... .
2.1.1
DDIF Front End ..................................... .
2.1.1.1
Data Mapping .............................. .
2.1.1.2
Conversion Restrictions . . . . . . . . . . . . . . . . . . . . . . . . .
2.1.1.3
External File References ....................... .
2.1.1.4
Document Syntax Errors . . . . . . . . . . . . . . . . . . . . . . . .
2.1.2
DTIF Front End ..................................... .
2.1.2.1
Data Mapping .............................. .
2.1.2.2
Conversion Restrictions ........................ .
2.1.2.3
External File References . . . . . . . . . . . . . . . . . . . . . . . .
2.1.2.4
DTIF Syntax Errors .......................... .

2-1
2-1
2-1
2-1
2-1
2-1
2-2
2-2
2-2
2-2
2-2

iii

Text Front End ..................................... .
2.1.3.1
Data Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.1.3.2
Conversion Restrictions ........................ .
2.1.3.3
External File References . . . . . . . . . . . . . . . . . . . . . . . .
2.1.3.4
Document Syntax Errors ....................... .

2-2
2-2
2-3
2-3
2-3

Base System Back Ends (Output Formats) . . . . . . . . . . . . . . . . . . . . . . . . . .

2-3
2-3
2-3
2-3
2-3
2-3
2-4
2-4
2-4
2-4
2-4
2-4
2-5
2-5
2-5
2-6
2-6
2-7
2-7
2-7
2-7
2-7
2-7
2-7
2-8
2-8
2-8
2-8
2-8
2-8
2-8
2-9
2-11
2-13
2-16
2-18
2-20

2.1.3

2.2

2.2.1

DDIF Back End ..................................... .
2.2.1.1
Data Mapping .............................. .
2.2.1.2
Conversion Restrictions . . . . . . . . . . . . . . . . . . . . . . . . .
2.2.2
DTIF Back End ..................................... .
2.2.2.1
Data Mapping .... , ......................... .
2.2.2.2
Conversion Restrictions . . . . . . . . . . . . . . . . . . . . . . . . .
2.2.2.3
External File References ....................... .
2.2.3
Text Back End ...................................... .
2.2.3.1
Data Mapping .............................. .
2.2.3.2
Conversion Restrictions ........................ .
2.2.3.3
Processing Options .......................... .
2.2.4
Postscript Back End . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.2.4.1
Data Mapping .............................. .
2.2.4.2
Conversion Restrictions . . . . . . . . . . . . . . . . . . . . . . . . .
2.2.4.3
Processing Options . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.2.4.4
Paper Size Processing Option ................... .
2.2.4.5
Paper Height Processing Option .................. .
2.2.4.6
Paper Width Processing Option . . . . . . . . . . . . . . . . . . .
2.2.4. 7
Top Margin Processing Option . . . . . . . . . . . . . . . . . . . .
2.2.4.8
Bottom Margin Processing Option ................. .
2.2.4.9
Left Margin Processing Option ................... .
2.2.4.10
Right Margin Processing Option .................. .
2.2.4.11
Paper Orientation Processing Option ............... .
2.2.4.12
Eight Bit Output Processing Option ................ .
2.2.4.13
Output Buffer Size Processing Option .............. .
2.2.4.14
Soft Directives Processing Option . . . . . . . . . . . . . . . . . .
2.2.4.15
Word Wrap Processing Option ................... .
2.2.4.16
Page Wrap Processing Option ................... .
2.2.4.17
Layout Processing Option . . . . . . . . . . . . . . . . . . . . . . .
2.2.5
Analysis Back End . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.2.6
Processing Options for Domain Conversion . . . . . . . . . . . . . . . . . . .
CONVERT/DOCUMENT ....................................... .
VIEW ........................................ ·············
CDOC ................................................... .
DXVDOC ................................................. .
VDOC ................................................... .

Chapter 3

Transferring CDA Documents

3.1

Sending CDA Documents on a VMS System . . . . . . . . . . . . . . . . . . . . . . . . .

3-1

3.2

Receiving CDA Documents on a VMS System . . . . . . . . . . . . . . . . . . . . . . .

3-2

3.3

Sending CDA Documents on an ULTRIX System . . . . . . . . . . . . . . . . . . . . . .

3-2

3.4

Receiving CDA Documents on an ULTRIX System . . . . . . . . . . . . . . . . . . . .

3-3

3.5

Copying CDA Documents on a VMS System . . . . . . . . . . . . . . . . . . . . . . . .

3-3

3.6

Copying CDA Documents on an ULTRIX System . . . . . . . . . . . . . . . . . . . . . .

3-3

Chapter 4

DDIF Structures

4.1

DDIF Document Structure Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4-1

4.2

Generic Aggregate Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4-1

DDIF$_ARC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_BEZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_CRF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_CTD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_CTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_DDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_DHD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_DSC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_ERF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_EXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_FAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_FTD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_GLA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_GLY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_GTX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_HRD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_HRV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_1DU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_1MG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_LG1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_LIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_LL 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_LS1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_LSD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_LW1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_0CC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_PGD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_PGL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_PGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_PHD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_PTD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_PTH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_PVT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_RCD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_RGB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_SEG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_SFT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_SFV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_SGA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GENERAL SEGMENT ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
COMPUTED CONTENT ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . . .
COPIED AND REMOTE COMPUTED CONTENT . . . . . . . . . . . . . . . . . . . .
VARIABLE COMPUTED CONTENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CROSS-REFERENCE COMPUTED CONTENT . . . . . . . . . . . . . . . . . . . . .
FUNCTION COMPUTED CONTENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STRUCTURE DESCRIPTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LANGUAGE ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LEGEND ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MEASUREMENT ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ALTERNATE PRESENTATION ATTRIBUTE . . . . . . . . . . . . . . . . . . . . . . . .
LAYOUT ATTRIBUTES......................................
GALLEY-BASED LAYOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4-2
4-5
4-7
4-8
4-10
4-12
4-13
4-16
4-18
4-21
4-23
4-25
4-26
4-28
4-32
4-34
4-36
4-38
4-41
4-42
4-43
4-45
4-50
4-52
4-54
4-57
4-59
4-61
4-64
4-66
4-67
4-70
4-74
4-76
4-77
4-78
4-81
4-83
4-85
4-90
4-92
4-93
4-94
4-95
4-96
4-97
4-98
4-99
4-100
4-101
4-102
4-104

PATH-BASED LAYOUT......................................
POSITION-RELATIVE LAYOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TEXT POSITION LAYOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FONT DEFINITIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PATTERN DEFINITIONS.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PATH DEFINITIONS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LINE-STYLE DEFINITIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONTENT DEFINITIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TYPE DEFINITIONS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TEXT ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TEXT MASK PATTERN......................................
TEXT FONT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TEXT RENDITION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TEXT SIZE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TEXT DIRECTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TEXT CHARACTER DECIMAL ALIGNMENT . . . . . . . . . . . . . . . . . . . . . . .
TEXT LEADER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TEXT KERNING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LINE ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MARKER ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GALLEY ATTRIBUTES......................................
IMAGE ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IMAGE COMPONENT SPACE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FRAME PARAMETERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FRAME FLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FRAME BOUNDING BOX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FRAME OUTLINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FRAME CLIPPING. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FRAME POSITION. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FIXED FRAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
INLINE FRAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GALLEY FRAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MARGIN FRAME..........................................
FRAME CONTENT TRANSFORMATION . . . . . . . . . . . . . . . . . . . . . . . . . .
ITEM CHANGE LIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_SGB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
COUNTER VARIABLE VALUES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
COMPUTED VARIABLE VALUES...............................
LIST VARIABLE VALUES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_TBS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_TRN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_TXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF$_TYD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 5

4-105
4-109
4-111
4-112
4-113
4-114
4-115
4-116
4-117
4-118
4-119
4-120
4-121
4-123
4-124
4-125
4-126
4-127
4-128
4-132
4-133
4-134
4-137
4-139
4-140
4-141
4-143
4-144
4-145
4-147
4-148
4-149
4-150
4-152
4-153
4-154
4-156
4-158
4-159
4-160
4-162
4-164
4-165

DTIF Structures

5.1

DTIF Document Structure Overview .............................. .

5-1

5.2

Generic Aggregate Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_ARD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_CAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_CCD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_CFT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_CLD ............................................... .
DTIF$_CLR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_COR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5-1
5-2
5-4
5-10
5-12
5-13
5-18
5-19

DTIF$_DAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_DSC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_DTF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_ERF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_EXT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_FMI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_HDR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_LPT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_NES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_NMR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_NVL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_RNG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_ROW................................................
DTIF$_RWR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_TBL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_TMD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTIF$_VTX.................................................
DTIF$_WND ................... ·. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 6
6.1

Chapter 7
7.1

5-20
5-22
5-24
5-25
5-27
5-29
5-43
5-46
5-51
5-52
5-53
5-55
5-57
5-59
5-60
5-62
5-65
5-66

CFE Structures
CFE Generic Aggregate Items .................................. .
CFE$_CCD ................................................. .
CFE$_CFT ................................................ .
CFE$_CLR ................................................ .
CFE$_COR ............................................... .
CFE$_DAT ................................................ .
CFE$_EXL ................................................ .
CFE$_EXP ................................................ .
CFE$_FRF ................................................ .
CFE$_NPM ............................................... .
CFE$_PEX ................................................ .
CFE$_PFE ................................................ .
CFE$_RWR ............................................... .
CFE$_SLL ................................................ .
CFE$_STF ................................................ .
CFE$_STP ................................................ .
CFE$_TXC ................................................ .
CFE$_VTX ................................................ .

6-1
6-2
6-4
6-5

6-6
6-7
6-9
6-53
6-55
6-56
6-57
6-58

6-60
6-61
6-62
6-63
6-64
6-65

ESF Structures
ESF Generic Aggregate Items .................................. .
ESF$_DAT ................................................ .
ESF$_EDS ................................................ .
ESF$_EXT ................................................ .
ESF$_NVL ................................................ .
ESF$_RPT ................................................ .
ESF$_TXS ................................................ .

7-1
7-2
7-4

7-20
7-22

7-24
7-27

vii

Chapter 8
8.1

CDA Toolkit Routines
Compile and Link Procedures for Applications ...................... .
8.1.1
VMS Link Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8.1.2
ULTRIX Link Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AGGREGATE TYPE TO OBJECT ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CLOSE FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CLOSE STREAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CLOSE TEXT FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONVERT . . . . . . . . . . . . . . . . . . . . . . ·. . . . . . . . . . . . . . . . . . . . . . . . . . .
CONVERT AGGREGATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONVERT DOCUMENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONVERT POSITION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
COPY AGGREGATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CREATE AGGREGATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CREATE FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CREATE ROOT AGGREGATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CREATE STREAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CREATE TEXT FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DELETE AGGREGATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DELETE ROOT AGGREGATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ENTER SCOPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ERASE ITEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FIND DEFINITION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FIND TRANSFORMATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FLUSH STREAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GET AGGREGATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GET ARRAY SIZE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GET DOCUMENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • . . . .
GET EXTERNAL ENCODING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GET STREAM POSITION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GET TEXT POSITION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
INSERT AGGREGATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LEAVE SCOPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LOCATE ITEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NEXT AGGREGATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
OBJECT ID TO AGGREGATE TYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
OPEN CONVERTER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
OPEN FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
OPEN STREAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
OPEN TEXT FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PRUNE AGGREGATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PRUNE POSITION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PUT AGGREGATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PUT DOCUMENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
READ TEXT FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
REMOVE AGGREGATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STORE ITEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WRITE TEXT FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

viii

8-1
8-2
8-2

8-3
8-6

8-9
8-11
8-13
8-24
8-28
8-31
8-33
8-36

8-39
8-45
8-50
8-54
8-58
8-60

8-62
8-76

8-79
8-83

8-86
8-88
8-94

8-97
8-100
8-103
8-106
8-108
8-112
8-115
8-120
8-123
8-126
8-130
8-138
8-141
8-145
8-148
8-150
8-153
8-156
8-158
8-160
8-168

Chapter 9

User-Defined Routines
ALLOCATE/DEALLOCATE ROUTINES ............................. .
FLUSH ROUTINE ........................................... .
GET ROUTINE ............................................. .
GET-POSITION ROUTINE ...................................... .
PUT ROUTINE ............................................. .

Chapter 10

CDA Toolkit Example Program

Chapter 11

CDA Converter Routines

11.1

Compile and Link Procedures for Converter Images . . . . . . . . . . . . . . . . . . .
11.1.1
VMS Compile and Link Procedure . . . . . . . . . . . . . . . . . . . . . . . . .
11.1.2
ULTRIX Compile and Link Procedure ...................... .
CLOSE ENTRY POINT ....................................... .
GET-AGGREGATE ENTRY POINT ................................ .
GET-POSITION ENTRY POINT .................................. .
DOMA/lv$READ_FORMAT ENTRY POINT ........................... .
DOMA/lv$WRITE_FORMAT ENTRY POINT .......................... .

Chapter 12

Text Front End Source File

Chapter 13

CDA Viewer Routines

9-2
9-4
9-6
9-8
9-10

11-1
11-2
11-2
11-3
11-5
11-8
11-10
11-15

13.1

CDA Viewer Support of Adobe Font Metrics. . . . . . . . . . . . . . . . . . . . . . . . .

13-1

13.2

Compile and Link Procedures for Viewer Images . . . . . . . . . . . . . . . . . . . . .
13.2.1
VMS Link Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13.2.2
ULTRIX Link Procedures .............. ; . . . . . . . . . . . . . . . . .
CC DELETE PAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CC END...................................................
CC GET PAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CC INITIALIZE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOTTOM DOCUMENT.........................................
CLOSE FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DOCUMENT INFO............................................
GOTO PAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NEXT PAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PREVIOUS PAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
REGISTER CLASS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TOP DOCUMENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VIEWER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VIEWER CREATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VIEWER FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

13-2
13-2
13-2
13-4
13-6
13-8
13-10
13-13
13-15
13-16
13-18
13-20
13-22
13-24
13-25
13-27
13-31
13-34

Appendix A

DDIF Fill Patterns

Appendix B

DDIF Syntax Diagrams

B.1

ODIS Built-In Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-1

B.2

Built-In Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-3

B.3

DDIS Defined TYpes ......................................... .

8-3

B.4

DDIF Syntax Diagrams ....................................... .

8-5

Appendix C

DTIF Syntax Diagrams

Appendix D

CFE Syntax Diagrams

Appendix E

ESF Syntax Diagrams

Appendix F

VMS Support for CDA in DECwindows
VMS Commands and Utilities .................................. .
F.1.1
Displaying RMS File Tags .............................. .
F.1.1.1
DIRECTORY/FULL ........................... .
F.1.1.2
ANALYZE/RMS_FILE ......................... .
F.1.2
Creating RMS File Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
F.1.3
Preserving RMS File Tags and DDIF Semantics ............... .
F.1.3.1
COPY Command ............................ .
F.1.3.2
VMS Mail Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
F.1.4
APPEND Command .................................. .

F-1
F-2
F-2
F-2
F-3
F-4
F-4
F-4

DDIF Support in a Heterogeneous Environment ..................... .
F.2.1
EXCHANGE/NETWORK Command ........................ .
F.2.2
Using the COPY Command in a Heterogeneous Environment . . . . . . .
F.2.3
VMS Mail Utility in a Heterogeneous Environment . . . . . . . . . . . . . . .

F-5
F-5

VMS RMS Interface Changes ................................... .
F.3.1
Programming Interface for File Tagging . . . . . . . . . . . . . . . . . . . . . .
F.3.2
Accessing a Tagged File . . . . . . . . . . . . . . . . . . . . . . . . . . . .....
F.3.2.1
File Aecesses That Do Not Sense Tags . . . . . . . . . . . . . .
F.3.2.2
File Accesses That Sense Tags .................. .
F.3.3
Preserving Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

F-10
F-11
F-11
F-13

F.4

Distributed File System Support for DDIF Tagged Files . . . . . . . . . . . . . . . . .

F-14

F.5

VMS RMS Errors ........................................... .

F-14

F.1

F.2

F.3

F-5

F~
F~

Appendix G

CDA$ Facility Messages

Glossary of Terms

Index

Examples
1-1

Analysis Output of DDIF Initial Segment Attributes . . . . . . . . . . . . . . . . . . . . . .

1-10

10-1

Sample CDA Toolkit Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

10-1

10-2

Analysis Output of DDIF File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

10-33

F-1

Tagging a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

F-9

F-2

Accessing a Tagged File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

F-12

1-1

Figures
DDIF Document Aggregate Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1-7

1-2

DTIF Document Aggregate Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1-18

1-3

CFE Aggregate Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1-19

1-4

ESF Aggregate Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1-20

4-1

Character Orientation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4-108

8-1

Example Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-92

A-1

CDA Fill Patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

A-6

8-1

Object Descriptor Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-4
8-4

8-2

Latin1 String Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-3

Text String Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-6

DDIF Document Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-5
8-5
8-5
8-5

8-7

Document Descriptor Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-6

8-8

Document Header Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-6

8-9

Document Root Segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-6

8-10

Segment Primitive Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-11

Begin-Segment Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-12

Text Primitive Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-7
8-7
8-7

8-13

Text Attributes Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-8

8-4

Character String Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-5

Application Private Data Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-14

Rendition Code Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-8

8-15
8-16

Leader Style Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-9

Text Layout Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-9

8-17

Text String Layout Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-10

B-18

Formatting Primitive Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-10

8-19

Value Directive Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-10

8-20

Directive Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-11

8-21

Escapement Directive Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-11

8-22

Variable Reset Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-11

8-23

Graphics Primitive Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-11

8-24

Polyline Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-12
xi

xii

B-25

Cubic Bezier Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-12

B-26

Arc Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-12

8-27

Fill Area Set Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-13

B-28

Line Attributes Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-14

8-29

Line Style Number Syntax Diagram. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-14

8-30

Line End Number Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-14

8-31

Line Join Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-14

8-32
B-33

Marker Attributes Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Marker Number Syntax Diagram. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • . .

8-15
8-15

8-34

Image Primitive Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-15

8-35

Image Coding Attributes Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-16

B-36

Image Attributes Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-16

8-37

Image Lookup Table Data Syntax Diagram. . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-17

8-38

Image Component Space Attributes Syntax Diagram . . . . . . . . . . . . . . . . . . . . .

8-17

8-39

Restricted Content Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-18

8-40

Content Reference Primitive Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . .

8-18

B-41

Content Reference Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-18

B-42

Bounding Box Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-19

8-43

Color Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-19

8-44

Red/Green/Blue Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-19

8-45

Compute Definition Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-20

8-46

Cross-Reference Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-20

8-47

Escapement Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-20

8-48

External Reference Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-20

B-49

Font Definition Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-21

8-50
B-51

Format Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-21

Frame Parameters Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-21

8-52

lnline Frame Parameters Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-22

B-53

Galley Frame Parameters Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-22

8-54

Galley Vertical Position Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-22

8-55

Margin Frame Parameters Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-23

8-56

Margin Horizontal Position Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-23

8-57

Function Link Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-23

8-58

External Reference Index Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-24

8-59

Language Index Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-24

8-60

Content Definition Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-24

B-61

Label Types Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-24

B-62

Label Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-25

B-63

ASCII String Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-25

B-64

Variable Label Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-25

8-65

Legend Units Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-25

8-66

Angle Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-25

B-67

AngleRef Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-26

8-68

Measurement Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-26

B-69

Position Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-26

8-70

Ratio Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-26

8-71

Right Angle Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-27

8-72

Size Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-27

8-73

X-Coordinate Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-28

B-74

Y-Coordinate Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-28

B-75
B-76

Measurement Units Syntax Diagram ............................... .

B-28

Named Value Syntax Diagram ................................... .
Value Data Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Named Value List Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-28
B-29
B-29

B-79

Font Number Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-29

B-80

Marker Number Syntax Diagram .................................. .

B-29

B-81
B-82

Path Number Syntax Diagram ................................... .
Pattern Number Syntax Diagram ................................. .

B-30
B-30

B-83
B-84

Path Definition Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Composite Path Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-30
B-30

B-85
B-86

Arc Path Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cubic Bezier Path Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-31
B-31

B-87

Line Definition Syntax Diagram .................................. .

B-31

B-88

Polyline Path Syntax Diagram ................................... .

B-32

B-77
B-78

B-89

Pattern Definition Syntax Diagram ................................ .

B-32

B-90

Standard Pattern Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-32

B-91

Reference Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-33

B-92

Segment Attributes Syntax Diagram ............................... .

B-93
B-94

Segment Type Definition Syntax Diagram ............................ .

B-33
8-34

8-95
B-96

Structure Definition Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Occurrence Definition Syntax Diagram .............................. .
Structure Element Syntax Diagram ................................ .

8-34
B-34
B-35

B-97

Tag Syntax Diagram .......................................... .

B-35

B-98

Category Tag Syntax Diagram ................................... .

B-35

B-99

Conformance Tag Syntax Diagram

B-35

B-100

Named Value Tag Syntax Diagram ................................ .

B-35

B-101

Segment Tag Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-36

B-102

Storage System Tag Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-36

B-103

Stream Tag Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-36

B-104

Transformation Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-36

B-105

Variable Binding Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-37

B-106

Counter Definition Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-37

B-107

Layout Object Type Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-37

B-108

Expression Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-38

B-109

Counter Style Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-38

B-11 O String Expression Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-38

B-111

Record List Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-39

B-112

Record Definition Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-39

B-113
B-114

Generic Layout Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Page Description Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-39
8-39

B-115

Page Set Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-40

B-116

Page Layout Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-40

B-117
8-118

Layout Primitive Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Layout Galley Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-40
8-41

8-119

Galley Attributes Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-41

8-120

Specific Layout Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-41

8-121

Wrap Attributes Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-42

8-122

Layout Attributes Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-42
xiii

xiv

B-123

Break Criteria Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-42

B-124

General Measure Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-43

B-125

General Size Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-43

B-126

Tab Stop List Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-43

B-127

Tab Stop Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-43

B-128

Generalized Time Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B-44

C-1

DTIF Document Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-1

C-2

Document Descriptor Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-1

C-3

Document Header Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-2

C-4

External Reference Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-2

C-5

Storage System Tag Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-3

C-6

External References Index Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-3

C-7

Language Preference Table Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . .

C-3

C-8

Named Edit String Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-4

C-9

Table Definition Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-4

C-10

Table Metadata Syntax Diagram. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-5

C-11

Table Window Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-5

C-12

Table Rows Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-6

C-13

Cell Data Syntax Diagram . . . . . . . . . . . . . . . . .- . . . . . . . . . . . . . . . . . . . . . .

C-6

C-14

Cell Value Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-7

C-15

Varying Text Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-7

C-16

Array Definition Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-8

C-17

Complex Float Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-8

C-18

Column Attributes Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-9

C-19

Data Type Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-10

C-20

Format Info List Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-10

C-21

Language Preference Index Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . .

C-11

C-22

Format Type Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-11

C-23

Edit String Index Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-12

C-24

Numeric Format Type Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-12

C-25

Numeric Format Precision Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-13

C-26
C-27

Predefined Text Types Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Predefined Date Types Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-13
C-13

C-28

Format Flags Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-14

C-29

Date Time Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-14

C-30

Application Private Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-14

C-31

Named Value List Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-15

C-32

Value Data Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-15

C-33

ASCII String Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-15

C-34

Column Number Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-16

C-35

Row Number Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-16

C-36

Cell Coordinates Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-16

C-37

Range Definition Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-17

C-38

Range Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-17

C-39

Cell Range Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-18

C-40

Row Range Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-18

C-41

Column Range Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-18

C-42

Named Range Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-18

D-1

Private Function Expression Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . .

D-1

D-2

Storage System Tag Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

D-2

D-3

Named Parameter Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

D-2

D-4

Expression Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

D-2

D-5

Expression List Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

D-3

D-6

Text Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

D-8

D-7

Varying Text Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

D-8

Selector List Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

D-8

D-9

Decimal String Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

D-9

D-10

Edit String Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

D-9

D-11

Parenthesized Expressions Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . .

D-9

D-12

Field Reference Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

D-9

E-1

Edit String Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

E-1

E-2

Edit String Buffer Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

E-1

E-3

Single Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

E-2

E-4

Repeat Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

E-3

E-5

Application Private Edit String Syntax Diagram . . . . . . . . . . . . . . . . . . . . . . . . .

E-3

1-1

CDA Item Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1-1

1-2

DDIF Standard Aggregates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1-5

1-3

DDIF Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1-8

Tables

4-1

Generic Aggregate Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4-1

4-2

Character Set Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4-32

4-3

Normal Horizontal Alignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4-107

4-4
4-5
4-6

Normal Vertical Alignment . . . . . . . . . . . . . . . . . . • . . . . . . . . . . . . . . . . . . . .

4-108

Line Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4-115

Line Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4-128

5-1

DTIF Generic Aggregate Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5-1

6-1

CFE Generic Aggregate Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6-1

6-2

Valid Arithmetic Expression Values for CFE$_EXL_EXPR_C . . . . . . . . . . . . . . . .

6-10

6-3

Valid Binary Expression Values for CFE$_EXL_EXPR_C . . . . . . . . . . . . . . . . . .

6-11

6-4
6-5

Valid Boolean and Relational Expression Values for CFE$_EXL_EXPR_C ...... .

6-12

Valid Cell-Related Expression Values for CFE$_EXL_EXPR_C ............. .

6-14

6-6

Valid Choose and Lookup Expression Values for CFE$_EXL_EXPR_C ........ .

6-17

6-7

Valid Conversion Expression Values for CFE$_EXL_EXPR_C .............. .

6-19

6-8

Valid Date and Time Expression Values for CFE$_EXL_EXPR_C ........... .

6-21

6-9

Valid Financial Expression Values for CFE$_EXL_EXPR_C . . . . . . . . . . . . . . . . .

6-27

6-10

Valid Identification Expression Values for CFE$_EXL_EXPR_C ............. .

6-39

6-11

Valid Literal Values for CFE$_EXL_EXPR_C . . . . . . . . . . . . . . . . . . . . . . . . . .

6-12

Valid Miscellaneous Expression Values for CFE$_EXL_EXPR_C ............ .

6-41
6-42
6-43
6-44
6-46
6-49

6-13

Valid Series Expression Values for CFE$_EXL_EXPR_C . . . . . . . . . . . . . . . . . .

6-14

Valid Statistical Expression Values for CFE$_EXL_EXPR_C . . . . . . . . . . . . . . . .

6-15

Valid String Expression Values for CFE$_EXL_EXPR_C . . . . . . . . . . . . . . . . . . .

6-16

Valid Transcendental Expression Values for CFE$_EXL_EXPR_C ........... .

6-17

Valid Trigonometric Expression Values for CFE$_EXL_EXPR_C ............ .

6-50

6-18

Valid Variable Values for CFE$_EXL_EXPR_C . . . . . . . . . . . . . . . . . . . . . . . . .

6-51

7-1

ESF Generic Aggregate Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

7-2

Valid Values for ESF$_EDS_EDIT_STRING_C . . . . . . . . . . . . . . . . . . . . . . . . .

7-1
7-5

7--3
11-1
A-1
8-1
8-2
8--3
8-4
F-1

xvi

Valid Values for ESF$_RPT_SEQ_C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Top-Level Aggregate Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF Fill Patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ODIS Built-In Primitives. . . . . . . . . . . . . . . . . . . . . . . . . • . . . . . . . . . . . . . . .
ODIS Built-In Constructors . . . . . . . . . • . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ODIS Built-In Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ODIS Defined Types............................. . . . . . . . . . . . . . .
Tag Support Item Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

7-24
11-7
A-1
8-1
8-2
B-3
8-4
F-7

Preface

This manual provides reference material for using the CDA (Compound Document
Architecture) Toolkit to create compound document applications, converters, and
viewer widgets. Information in this manual includes reference material for using
the DDIF (DIGITAL Document Interchange Format) and DTIF (DIGITAL Table
Interchange Format) aggregates that are processed by the CDA Toolkit routines.
The CDA Toolkit is a collection of data structures and routines that support the
creation of CDA applications. The CDA Converter architecture is used to convert
files of a specified input format to a specified output format. The CDA Viewer
is used to display CDA-encoded files on a workstation display or character cell
terminal.
CDA is supported in both the VMS and the ULTRIX environments. The information contained in this manual is appropriate for both systems. Any differences
between the two implementations are called out in the text of this manual.
All of the following products support CDA-encoded files. If you intend to manipulate only DDIF files and do not have an interest in the particulars of the file
format, you can use any one of these products to manipulate a CDA-encoded file.
DECpaint

PrintScreen

CardFiler

DEC GKS
CDA Viewer

DEC GKS-3D
DECwindows MAIL

PHIGS
DECimage Applications
Services

Converters

MAIL

DECchart

DECdecision

DECwrite
DEC Test Manager

Intended Audience
This manual is intended for system and application programmers who already
have been introduced to CDA and who are ready to use the CDA Toolkit to write
compound document applications, converters, or viewers. Some knowledge of the
tasks and terminology associated with document typesetting is helpful.

Document Structure
This manual consists of 13 chapters, several appendixes, and a glossary, as
follows:
•

Chapter 1, Introduction provides an introduction to the reference material
describing the aggregates and routines contained in the CDA Toolkit.

xvii

xviii

•

Chapter 2, Bundled Converter Formats and Commands describes the VMS
and ULTRIX converter formats and commands used to convert and to view
CDA documents.

•

Chapter 3, Transferring CDA Documents describes how to mail and to copy
CDA documents on VMS and ULTRIX systems.

•

Chapter 4, DDIF Structures describes each of the DDIF aggregate structures.

•

Chapter 5, DTIF Structures describes each of the DTIF aggregate structures.

•

Chapter 6, CFE Structures describes each of the CFE aggregate structures.

•

Chapter 7, ESF Structures describes each of the ESF aggregate structures.

•

Chapter 8, CDA Toolkit Routines describes each of the routines contained
in the CDA Toolkit. The routines are documented in alphabetical order.
Each routine description specifies the calling format, the encoding of the
parameters, a detailed description of the function of the routine, and what
condition values the routine can return.

•

Chapter 9, User-Defined Routines describes the user-defined routines used to
write CDA-conforming applications and front and back ends.

•

Chapter 10, CDA Toolkit Example Program contains an example program
that uses the CDA Toolkit to create a DDIF file, and an illustration of the file
created by the example program.

•

Chapter 11, CDA Converter Routines describes each of the converter routines
that must be created in order to write a CDA-conforming front or back end.

•

Chapter 12, Text Front End Source File contains the source code for the Text
front end to be used as an example for those wanting to develop their own
front or back ends.

•

Chapter 13, CDA Viewer Routines describes each of the viewer routines used
to create a character-cell or DECwindows viewer application.

•

Appendix A, DDIF Fill Patterns illustrates the CDA-defined fill patterns.

•

Appendix B, DDIF Syntax Diagrams contains a brief overview of DDIS
(DIGITAL Data Interchange Syntax) followed by the syntax diagrams for the
various constructs supported by the DDIF architecture.

•

Appendix C, DTIF Syntax Diagrams contains the syntax diagrams for the
various constructs supported by DTIF.

•

Appendix D, CFE Syntax Diagrams contains the syntax diagrams for the
various constructs supported by CFE.

•

Appendix E, ESF Syntax Diagrams contains the syntax diagrams for the
various constructs supported by ESF.

•

Appendix F, VMS Support for CDA in DECwindows discusses the support
provided by VMS for the CDA Toolkit and the tagging of DDIF-encoded files.

•

Appendix G, CDA$ Facility Messages lists and describes the CDA$_ facility
messages generated by the CDA Toolkit.

•

Glossary, Glossary of Terms defines the terminology associated with the CDA
Toolkit and CDA Converter Architecture.

Associated Documents
CDA is supported by a variety of DIGITAL products. Descriptions of the support
provided by each product are contained in that product's documentation. For
example, GKS support for CDA is described in the GKS documentation set, and
so on.
The complete CDA documentation set includes two tutorials and a reference
manual:

•

Introduction to the CDA Services

•

Guide to Creating Compound Documents with the CDA Toolkit

•

CDA Reference Manual

The CDA documentation set is a separately orderable subkit available for purchase with the VMS and ULTRIX operating system documentation. Each manual
in the CDA documentation set is also available for separate purchase.
The CDA Converter Library end-user documentation set describes additional
document, graphics, image, and table data file formats that are supported by the
CDA Converter architecture, but that are not bundled with the VMS or ULTRIX
operating system. The following two manuals describe the additional interchange
formats:

•

Guide to the CDA Converter Library

•

Getting Started with the CDA Converter Library

Conventions
The following conventions are used in this manual:
Ctrl/x

A sequence such as Ctrl/x indicates that you must hold
down the key labeled Ctrl while you press another key
or a pointing device button.

PFl x

A sequence such as PFl x indicates that you must first
press and release the key labeled PFl, then press and
release another key or a pointing device button.
A key name is shown enclosed to indicate that you
press a key on the keyboard.
In examples, a horizontal ellipsis indicates one of the
following possibilities:
•
•
•

Additional optional arguments in a statement
have been omitted.
The preceding item or items can be repeated one
or more times.
Additional parameters, values, or other information can be entered.

A vertical ellipsis indicates the omission of items from
a code example or command format; the items are
omitted because they are not important to the topic
being discussed.

xix

()

In format descriptions, parentheses indicate that, if
you choose more than one option, you must enclose the
choices in parentheses.

[]

In format descriptions, brackets indicate that whatever
is enclosed is optional; you can select none, one, or all
of the choices.

{}

In format descriptions, braces surround a required
choice of options; you must choose one of the options
listed.
Red ink indicates information that you must enter
from the keyboard or a screen object that you must
choose or click on. For online manuals, user input is
specified in bold.
Italic text represents the introduction of a new term or
the name of an argument, an attribute, or a reason.

red ink

italic text
italic text

Italic text represents user-written routines (for example, get-aggregate).

boldface text

Boldface text represents information that can vary
in system messages (for example, Internal error
number).

UPPERCASE TEXT

Uppercase letters indicate that you must enter a
command (for example, enter OPEN/READ).

UPPERCASE TEXT

Uppercase letters indicate the name of a CDA Toolkit
routine, the name of a file, the name of a file protection
code, or the abbreviation for a system privilege.

lowercase text

Lowercase letters indicate the names of the CDA
Toolkit VAX format routines and values that are
portable to ULTRIX systems. Value names that appear
in lowercase must be coded as such in order to be
portable to ULTRIX systems.
Hyphens in coding examples indicate that additional
arguments to the request are provided on the line that
follows.

numbers

Unless otherwise noted, all numbers in the text are
assumed to be decimal. Nondecimal radixes-binary,
octal, or hexadecimal-are explicitly indicated in the
coding examples.

Chapter 8

CDA Toolkit Routines
This section describes the CDA Toolkit routines and VMS and ULTRIX compile
and link procedures used to create CDA-conforming applications. Each routine
description includes the following information:
•

A common language (VAX) style binding that is supported on both VMS and
ULTRIX systems

•

An ULTRIX C style binding that is supported on both VMS and ULTRIX
systems

•

A description of the value returned by the routine

•

Descriptions of each routine argument

•

A description of the routine itself

•

A list of possible values returned by the routine
NOTE

Given the bindings available at this time, there are two ways to create
CDA Toolkit applications that are portable across VMS and ULTRIX
systems:
1. Code using C style bindings by matching mix-cased spelling.

2. Code your source in lowercase if using the VAX formats (as the
bindings are lowercase in the current ULTRIX CDA Toolkit).
If you are programming in Ada, please refer to the Guide to Applications
Programming for information on Ada programming with DECwindows.

8.1

Compile and Link Procedures for Applications
To create a VMS or ULTRIX application using the CDA Toolkit routines, include
the following public files in your source code:
VMS and ULTRIX

File Names

Description

SYS$LIBRARY:cda$def.h
/usr/include/cda_def.h

CDA Toolkit keyword definitions

SYS$LIBRARY:ddif$def.h
/usr/include/ddif_def.h

DDIF aggregate definitions

CDA Toolkit Routines 8-1

VMS and ULTRIX

File Names

Description

SYS$LIBRARY:dtif$def.h
/usr/include/dtif_def.h

DTIF aggregate definitions

SYS$LIBRARY:cda$msg.h
/usr/include/cda_msg.h

CDA error messages

NOTE

If you are programming in Ada, please refer to the Guide to
Applications Programming for information on Ada programming
with DECwindows.

Section 8.1.1 describes the VMS compile and link procedure for CDA applications.
Section 8.1.2 describes the ULTRIX compile and link procedure for CDA
applications.

8.1.1

VMS Link Procedure
You can compile and link a CDA application on VMS using the following build
procedure that also incorporates debugging:
$ CC /DEBUG MY APPLICATION
$ LINK /DEBUG MY APPLICATION,SYS$INPUT:/OPTION
SYS$LIBRARY:CDA$ACCESS/SHARE

8.1.2

ULTRIX Link Procedure
You can compile and link an application on ULTRIX using the following build
procedure:
% cc -o my_application rny_application.c -lddif -lm

The -Im parameter specifies the math library that is required by the CDA Toolkit
routines (-lddif).

8-2 CDA Toolkit Routines

AGGREGATE TYPE TO OBJECT ID

AGGREGATE TYPE TO OBJECT ID
Translates a root aggregate type to an object identifier.

VAX FORMAT
status

=cda$aggregate_type_to_object_id
(aggregate-type ,but-fen ,buf-adr ,nam-len ,nam-buf
,act-nam-len ,act-fen)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

aggregate-type

buf-len

buf-adr

nam-len

Access:

write only

Mechanism:

by value

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

array

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference, array. reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

CDA Toolkit Routines 8-3

AGGREGATE TYPE TO OBJECT ID

Argument

Argument Information

nam-buf

VMS usage:

array

Data type:

character string

act-nam-len

act-len

Access:

write only

Mechanism:

by reference, array reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

C FORMAT
status

=CdaAggregateTypeToObjectld
(aggregate_type, buf_len, buf_adr, nam_len,
nam_buf, act_nam_Ien, act_Ien)

Argument Information
unsigned long CdaAggregateTypeToObjectid(aggregate_type,
buf_len, buf_adr, nam_len,
nam_buf, act_nam_len, act_len)
unsigned long
aggregate_type;
unsigned long
buf_len;
unsigned long
buf_adr[];
unsigned long
nam_len;
unsigned char
nam_buf[];
unsigned long
*act_nam_len;
unsigned long
*act_len;

RETURNS
status
A condition value indicating the return status of the routine call.

8-4 CDA Toolkit Routines

AGGREGATE TYPE TO OBJECT ID

Arguments
aggregate-type
Type of the aggregate being translated. The root aggregate type must be either
DDIF$_DDF or DTIF$_DTF.
but-Jen
Length (in bytes) of the object identifier buffer. Length must be at least 28 bytes
(space for 7 longwords).
buf-adr
An array of longwords to receive the object identifier.
nam-len
Length (in bytes) of the domain name buffer.
nam-buf
Address of the domain name buffer to receive a string of characters.
act-nam-len
Receives the actual length (in bytes) of the domain name in the nam-buf buffer.
act-fen
Receives the actual length (in bytes) of the object identifier.

Description
The AGGREGATE TYPE TO OBJECT ID routine translates a root aggregate type
to an object identifier.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA$_INVAGGTYP

Invalid aggregate type

CDA$_INVBUFLEN

Invalid buffer length

CDA Toolkit Routines 8-5

CLOSE FILE

CLOSE FILE
Closes the specified compound document file and stream. If the file being closed
was receiving output, the CLOSE FILE routine writes any buffered data before
closing the file and stream.

VAX FORMAT
status= cda$close_file

(stream-handle , tile-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

stream-handle

file-handle

Access:

write only

Mechanism:

by value

VMS usage:
Data type:

identifier
longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:
Data type:

identifier
longword (unsigned)

Access:

read only

Mechanism:

by reference

C FORMAT
status = CdaCloseFile

(stream_handle, file_handle)

8-6

CDA Toolkit Routines

CLOSE FILE

Argument Information
unsigned long CdaCloseFile(stream_handle,
file_handle)
unsigned long
stream_handle;
unsigned long
file_handle;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
stream-handle
Handle of the stream to be closed. This handle is returned by a call to either the
OPEN FILE routine or the CREATE FILE routine.
file-handle
Handle of the file to be closed._ This handle is returned by a call to either the
OPEN FILE routine or the CREATE FILE routine.

Description
The CLOSE FILE routine closes the specified stream and compound document
file. If the file being closed was receiving output, this routine writes out any
buffered data before closing the stream. Note that the stream-handle and
file-handle values are invalid after a call to this routine.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion'

Any error returned by the memory deallocation routines.
Any error returned by the file routines.

CDA Toolkit Routines 8-7

CLOSE FILE

Example
This example illustrates a typical call to the CLOSE FILE routine. The entire
document is written to the output file prior to a call to the CLOSE FILE routine.
After the file has been closed, the document root aggregate is deleted.

/* output to a DDIF file */
printf ("Writing document ... \n");
status= cda$put_document(&root_aggregate_handle,
&stream_handle);
if (FAILURE(status)) return(status);
status= cda$close_file(&stream_handle, &file_handle);
if (FAILURE(status)) return(status);
status= cda$delete_root_aggregate(&root_aggregate_handle);
if (FAILURE(status)) return(status);

8-8

CDA Toolkit Routines

CLOSE STREAM

CLOSE STREAM
Closes an open compound document stream.

VAX FORMAT
status

=cda$close_stream
(stream-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

stream-handle

Data type:

identifier
longword (unsigned)

Access:

read only

Mechanism:

by reference

C FORMAT
status

=CdaCloseStream
(stream_handle)

Argument Information
unsigned long CdaCloseStream(stream_handle)
unsigned long
stream_handle;

CDA Toolkit Routines 8-9

CLOSE STREAM

RETURNS
status

A condition value indicating the return status of the routine. call.

Argument
stream-handle

Handle of the stream to be closed. This handle is returned by a call to either the
OPEN STREAM routine or the CREATE STREAM routine.

Description
The CLOSE STREAM routine closes an open compound document stream. If the
stream being closed was receiving output, the CLOSE STREAM routine writes
out any buffered data before closing the stream. Note that the stream-handle
argument is invalid after a call to this routine.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

Any error returned by the memory deallocation routines.

8-10

CDA Toolkit Routines

CLOSE TEXT FILE

CLOSE TEXT FILE
Closes a text file.

VAX FORMAT
status= cda$close_text_file

(text-file-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

text-file-handle

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

C FORMAT
status = CdaCloseTextFile

(text_ file_ handle)

Argument Information
unsigned long CdaCloseTextFile(text_file_handle)
unsigned long
text_file_handle;

CDA Toolkit Routines

8-11

CLOSE TEXT FILE

RETURNS
status
A condition value indicating the return status of the routine call

Argument
text-file-handle
Identifier of the text file to be closed. This handle is returned by a call to either
the CREATE TEXT FILE routine or the OPEN TEXT FILE routine.

Description
The CLOSE TEXT FILE routine closes a text file. The text-file-handle is invalid
after a call to this routine.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

Any error returned by the memory deallocation routines.
Any error returned by the file routines.

8-12 CDA Toolkit Routines

CONVERT

CONVERT
Lets the user perform document conversion from within an application. This
includes beginning, continuing, or discontinuing the conversion of a document.

VAX FORMAT
status

=cda$convert
(function-code ,standard-item-list ,private-item-list
,converter-context)

Argument Information

Argument
status

function-code

standard-item-list

private-item-list

converter-context

Argument Information
VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

rea~ only

Mechanism:

by reference

VMS usage:

item_list_2

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference, array reference

VMS usage:

unspecified

Data type:

unspecified

Access:

read only

Mechanism:

by reference

VMS usage:

context

Data type:

longword (unsigned)

Access:

read only or write only

Mechanism:

by reference

CDA Toolkit Routines 8-13

CONVERT

C FORMAT

status = CdaConvert
((unction_code, standard_item_list,
private_item_list, convertec_context)

Argument Information
unsigned long CdaConvert(function_code, standard_item_list,
private item list, converter context)
unsigned long function code;
unsigned long
*standard item list;
unsigned char
*private_Item_list;
unsigned long
*converter_context;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
function-code
Symbolic constant that identifies the function to be performed. These symbolic
constant values are defined in the file cda$def.h on VMS systems and in the file
cda_def.h on ULTRIX systems. Valid values are as follows:
CDA$_START
Start conversion. This function code must be specified to begin a document
conversion.
CDA$_CONTINUE
Continue a conversion that was suspended. This function code may only
be specified if a previous call to the CONVERT routine returned the value
CDA$_SUSPEND. If CDA$_SUSPEND is returned by a call to the CONVERT
routine, either CDA$_CONTINUE or CDA$_STOP must be specified so that
resources locked by the conversion are released.
CDA$_STOP
Discontinue a conversion that was suspended. This function code may only
be specified if the previous call to the CONVERT routine returned the value
CDA$_SUSPEND. If CDA$_SUSPEND is returned by a call to the CONVERT
routine, either CDA$_STOP or CDA$_CONTINUE must be specified so that
resources locked by the conversion are released.

8-14

CDA Toolkit Routines

CONVERT
standard-item-list

An item list that identifies the document source and destination, and can also
contain options to control processing.

Each entry in the item list is a 2-longword structure with the following format:

item code

buffer length
buffer address

0
4

To terminate the item list, you must specify the final entry or longword as 0.
The standard-item-list argument is only valid when function-code is set to
CDA$_START; otherwise, standard-item-list is ignored. Valid code values for
the items in the standard-item-list are as follows:
CDA$_/NPUT_FORMAT

The parameter is the address and length of a string that specifies the input
document format.
CDA$_/NPUT_FRONT_END_PROCEDURE

The parameter is the address of the main entry point for the front end.
The item-list length field for this item must be set to 0. This item enables a
caller to provide a front end that is a routine within the calling application
rather than a separate image. If this item code is used, the CDA$_INPUT_
FILE item can be used to pass any information (not necessarily a file
specification) to the front end.
CDA$_/NPUT_FRONT_END_DOMAIN

The parameter is the address and length of a string that specifies the input
document domain (either DDIF or DTIF). This item is used with the CDA$_
INPUT_PROCEDURE item to denote the input domain.
CDA$_/NPUT_FILE

The parameter is the address and length of the file specification of the input
document.
CDA$_/NPUT_DEFAULT

The parameter is the address and length of a string that specifies the default
input file type. To simplify the porting of applications to other operating
systems, the string should consist only of a file type in lowercase characters.
If this parameter is omitted, the front end will supply an appropriate backup
default file specification.
CDA$_/NPUT_PROCEDURE

The parameter is the address of a procedure to provide input to the front end.
The item-list length field must be set to 0. The input procedure must conform
to the requirements for a user get routine. The calling sequence for a user get
routine is defined in Chapter 9.

CDA Toolkit Routines 8-15

CONVERT

CDA$_/NPUT_PROCEDURE_PARM

The parameter is the address of a longword parameter to the input procedure.
The item-list length field must be set to 4. This item is valid only if the
CDA$_INPUT_PROCEDURE value is specified
CDA$_/NPUT_POSITION_PROCEDURE

The parameter is the address of a procedure that provides position information. The item-list length field must be set to 0. The position procedure must
conform to the requirements for a user get-position routine. The get-position
procedure is specified in the description of the OPEN CONVERTER routine.
CDA$_/NPUT_ROOT_AGGREGATE

The parameter is the address of a longword root aggregate handle that
specifies an in-memory input document. The item-list length field must be set
to 4. The entire in-memory structure, including the root aggregate itself, is
erased by this operation. Note that the root aggregate must specify standard
memory allocation.
CDA$_ OUTPUT_FORMAT

The parameter is the address and length of a string that specifies the output
document format.
CDA$_ OUTPUT_BACK_END_PROCEDURE

The parameter is the address of the main entry point of the back end.
The item-list length field must be set to 0. This item enables a caller to
provide a back end that is part of the calling application rather than a
separate image. If this item code is used, the CDA$_0UTPUT_FILE item can
be used to pass any information (not necessarily a file specification) to the
back end.
CDA$_0UTPUT_BACK_END_DOMAIN

The parameter is the address and length of a string that specifies the output
document domain (either DDIF or DTIF). This item is used with the CDA$_
OUTPUT_PROCEDURE item to denote the output domain.
CDA$_0UTPUT_FILE

The parameter is the address and length of the file specification of the output
document.
CDA$_0UTPUT_DEFAULT

The parameter is the address and length of a string that specifies the default
output file type. To simplify the porting of applications to other operating
systems, the string should consist only of a file type in lowercase characters.
If this parameter is omitted, the back end will supply an appropriate backup
default file specification.
CDA$_ OUTPUT_PROCEDURE

The parameter is the address of a procedure to receive output. The item-list
length field must be set to 0. The output procedure must conform to the
requirements for a user put routine. The calling sequence for a user put
routine is defined in Chapter 9.

8-16

CDA Toolkit Routines

CONVERT
CDA$_0UTPUT_PROCEDURE_PARM

The parameter is the address of a longword parameter to the output procedure. The item-list length field must be set to 4. This item is valid only if the
CDA$_0UTPUT_PROCEDURE item is specified.
CDA$_0UTPUT_PROCEDURE_BUFFER

The parameter is the address and length of the initial output buffer for
the output procedure. This item is valid only if the CDA$_0UTPUT_
PROCEDURE item is specified.
CDA$_ OUTPUT_ROOT_AGGREGATE

The parameter is the address of a longword root aggregate handle that
receives an in-memory output document. The item-list length field must
be set to 4. The root aggregate must be empty, and must specify standard
memory allocation. This root aggregate contains an entire in-memory
document at the end of the conversion.
CDA$_ OPTIONS_FILE

The parameter is the address and length of the file specification of an options
file that contains options to control processing. The default file type is
CDA$0PTIONS on VMS systems and cda_options on ULTRIX systems. Each
line of the file specifies a format name that can contain upper- and lowercase
alphabetic characters, digits, dollar signs, and underscores, optionally
preceded by spaces and tabs, and terminated by any character other than
those listed. Alphabetic case is not significant. The syntax and interpretation
of the text that follows the format name are specified by the supplier of the
front and back ends for the specified format. Multiple lines that specify the
same format are permitted.
CDA$_0PTIONS_LINE

The parameter is the address and length of a string that contains options to
control processing. The format of each string is defined in the description of
the CDA$_0PTIONS_FILE item code.
private-item-list
A private item list that is passed directly to the output converter module that is
invoked. The specification of this item list is the responsibility of the particular
back end. Its purpose is to provide for direct two-way communication between
the caller of the CONVERT routine and the back end. On ULTRIX systems, the
CDA$_0UTPUT_BACK_END_PROCEDURE item must be specified when this
parameter is used.
converter-context
If function-code is set to CDA$_START, this argument receives a value that
must be specified as the converter-context parameter when the CONVERT
routine is called with CDA$_CONTINUE or CDA$_STOP as the function code.
This value is invalidated when the CONVERT routine returns a status other than
CDA$_SUSPEND. This parameter is used by the back end to store its processing
context.

CDA Toolkit Routines

8-17

CONVERT

Description
The CONVERT routine lets you perform document conversion from within an
application. This includes beginning, continuing, or discontinuing the conversion
of a document.
To specify the input and output information, and any processing options files,
you should construct an item list with the appropriate fields as specified in the
description of the standard-item-list argument. Note that the standard-itemlist argument is only valid when function-code is set to CDA$_START. The
following restrictions apply when you are constructing the standard-item-list:

8-18

•

Either the CDA$_INPUT_FORMAT item or the CDA$_INPUT_FRONT_
END_PROCEDURE item, but not both, can be specified once in the item list.
If neither is specified, the default input format is DDIF.

•

Either the CDA$_INPUT_FILE item, the CDA$_INPUT_PROCEDURE item,
or the CDA$_INPUT_ROOT_AGGREGATE item must be specified once in the
item list. If the CDA$_INPUT_PROCEDURE item is specified, the CDA$_
INPUT_PROCEDURE_PARM item can also be specified once.

•

Either the CDA$_0UTPUT_FORMAT item or the CDA$_0UTPUT_BACK_
END_PROCEDURE item, but not both, can be specified once in the item list.
If neither is specified, the default output format is DDIF.

•

Either the CDA$_0UTPUT_FILE item, the CDA$_0UTPUT_PROCEDURE
item, or the CDA$_0UTPUT_ROOT_AGGREGATE item must be specified
once in the item list. If the CDA$_0UTPUT_PROCEDURE item is specified,
the CDA$_0UTPUT_PROCEDURE_PARM item and the CDA$_0UTPUT_
PROCEDURE_BUFFER item can each be specified once.

•

The CDA$_0PTIONS_FILE item can only be specified once in the item list.

•

The CDA$_0PTIONS_LINE item can be specified multiple times in the item
list.

CDA Toolkit Routines

CONVERT

RETURN VALUES

Return Value

Description

CDA$_DCVNOTFND

Domain converter not found.

CDA$_ICVNOTFND

Input converter not found.

CDA$_INVFUNCOD

Invalid function code.

CDA$_INVINPDMN

Invalid input domain.

CDA$_INVITMLST

Invalid item list.

CDA$_INVOUTDMN

Invalid output domain.

CDA$_NORMAL

Normal successful completion.

CDA$_0CVNOTFND

Output converter not found.

CDA$_SUSPEND

Converter is suspended.

CDA$_UNSUPCNV

Unsupported conversion.

CDA$_UNSUPFMT

Unsupported document format.

Any error conditions returned by the specific front end.
Any error conditions returned by the specific back end.

Example
This example illustrates the use of the CONVERT routine to invoke the DDIF
and Text converters.
/* Example text to ddif conversion using callable converter interface

* with a user-supplied get-rtn for text input.
*/
#ifdef vms
#include <cda$def .h>
#include <cda$msg.h>
#include <fab.h>
#include <rab.h>
#include <rmsdef .h>
#else
#include <cda def .h>
#include <cda msg.h>
#include <sys/file.h>
#include <stdio.h>
#endif
#define FAILURE(x)

( ( (x)

& 1)

#define text ubf size 2048

CDA Toolkit Routines

8-19

CONVERT
/* User-supplied get-prm

*I
#ifdef vms
struct FAB
text_fab;
struct RAB
text_rab;
#else
struct urab
int fd;
FILE *fs;
unsigned char *fil_buffer;
unsigned long fil_buflen;
unsigned long fil_size;

/*
/*
/*
/*
/*

file descriptor
*/
file ptr, used for text files */
address of input buffer */
length of input buffer */
size of file */

};

struct urab
text_rab;
extern char *fgets();
#endif
unsigned char
text _ubf[text ubf size];
static unsigned char ddif format [] = "DDIF";
static unsigned long ddif _format_length = sizeof (ddif- format)

- 1;

static unsigned char text format[] = "TEXT";
static unsigned long text format_length = sizeof(text- format) - 1;
static unsigned char text - file [] = "text";
static unsigned long text file length = sizeof (text - file)

static unsigned char text default [] = .txt";
static unsigned long text_default_length = sizeof (text - default) - 1;
II

static unsigned char ddif- file[] = "output";
static unsigned long ddif file _length = sizeof(ddif- file) - 1;
static unsigned char ddif default [] = II• ddif";
static unsigned long ddif default _length
sizeof (ddif default) - 1;

/* User-supplied get-rtn
*/
unsigned long input_text_procedure(get_prm, num_bytes, buf_adr)
#ifdef vms
struct RAB
*get_prm;
#else
struct urab
*get_prm;
#endif
unsigned long
*num_bytes;
unsigned char
**buf_adr;
{

#ifdef vms
unsigned long

status;

status= sys$get(get_prm);
if (FAILURE(status))
{

if (status == RMS$ EOF)
status = CDA$_ENDOFDOC;
return status;
*num_bytes = get_prm->rab$w_rsz;
*buf adr = get_prm->rab$l_rbf;
return status;
#else
char *status;
unsigned long buffer_length;

8-20

CDA Toolkit Routines

CONVERT
status= fgets(get_prm->fil_buffer, get_prm->fil_buflen,
get_prm->fs);
if (status == NULL)
{

*num_bytes = 0;
return CDA$_ENDOFDOC;
}

buffer_length = strlen(get_prm->fil_buffer);
if ((get_prm->fil_buffer) [buffer_length-1]
*num_bytes
buffer_length - 1;
else
*num_bytes
buffer_length;
*buf adr = get_prm->fil_buffer;
return CDA$_NORMAL;

'\n')

#endif
}

main()
{

unsigned long status;
unsigned long text_parameter;
struct item list standard item list[15];
unsigned long integer_value;
unsigned long index;
unsigned char text filename[8];
printf ("Starting TEXT to DDIF procedure conversion\n");
#ifdef vms
/* Open input text file */
text_fab = cc$rms_fab;
text_rab = cc$rms_rab;
text_fab.fab$l_fna
text file;
text_fab.fab$b_fns
text_file_length;
text_fab.fab$l_fop
FAB$M_SQO;
text_fab.fab$b_rfm
FAB$C_VAR;
text_fab.fab$l_dna
text_default;
text_fab.fab$b_dns
text_default_length;
text_rab.rab$l_fab
&text fab;
text_rab.rab$l_rop
RAB$M=LOC I RAB$M_RAH;
text_rab. rab$l_ubf
text_ubf;
text_rab.rab$w_usz
text_ubf_size;
status= sys$open(&text_fab);
if (FAILURE(status)) return status;
status= sys$connect(&text_rab);
if (FAILURE(status))
{

sys$close(&text_fab);
return status;
#else
strcpy(text_filename, text_file);
strcat(text_filename, text_default);
text_filename[text_file_length + text_default length]
text_rab.fil_buffer
text_ubf;
text_rab.fil_buffer = text_ubf;
text_rab.fil_buflen = text_ubf_size;
text_rab.fs = fopen(text_filename, "r");
if (text_rab.fs
NULL) return CDA$_0PENFAIL;

#endif
/* Setup for conversion */
text_parameter = (unsigned long) &text_rab;
integer_value

CDA$_START;
CDA Toolkit Routines

8-21

CONVERT
/* Input conversion parameters */
index = O;
standard_item_list[index] .cda$w_item_length
text_format_length;
standard_item_list[index] .cda$w_item_code =
CDA$_INPUT_FORMAT;
standard_item_list[index] .cda$a_item_address
(char *) text_format;
index += 1;
standard item list[index] .cda$w item length
standard-item-list[index] .cda$w-item-code =
CDA$ INPUT-PROCEDURE;
standard_item=list[index] .cda$a_item_address
input_text_procedure;
index += 1;
standard item list[index] .cda$w item length
standard-item-list[index] .cda$w-item-code =
CDA$_INPUT=PROCEDURE_PARM; standard_item_list[index] .cda$a_item_address
&text_parameter;
index += 1;

(char*)

/* Output conversion parameters */
standard_item_list[index] .cda$w_item_length
ddif format length;
standard_item_list[index] .cda$w_item_code =
CDA$_0UTPUT_FORMAT;
standard_item_list[index] .cda$a_item_address
(char *) ddif format;
index += 1;
standard_item_list[index] .cda$w_item_length
ddif file length;
standard item list[index] .cda$w item code=
CDA$ OUTPUT FILE;
standard_item_list[index] .cda$a_item_address
(char *) ddif_file;
index += 1;
standard item list[index] .cda$w item length
ddif _default_length;
standard item list[index] .cda$w item code=
CDA$_0UTPUT_DEFAULT;
standard_item_list[index] .cda$a_item_address
(char *) ddif_default;
index += 1;
standard item list[index] .cda$w item length= 0;
standard=item=list[index] .cda$w=item=code = O;

/* Perform the conversion */
status= cda$convert(&integer_value, standard_item_list, 0,
&integer_value);
if (FAILURE(status))
return (status);
#ifdef vms
/* Close the input file */
status= sys$close(&text_fab);
if (FAILURE(status)) return status;
#else
fclose(text_rab.fs);
#endif
printf ("Completed TEXT to DDIF procedure conversion\n");

8-22

CDA Toolkit Routines

CONVERT
To compile and run this program on VMS systems, you can use the following DCL
commands:
$ cc
$ /OPTIMIZE=NODISJOINT -$ /NOLIST =$ TEXT CONVERTER.C
$ LINK /EXE=TEXT CONVERTER _$ /NOMAP $ TEXT CONVERTER,SYS$INPUT:/OPTION
SYS$LIBRARY:CDA$ACCESS/SHARE
SYS$SHARE:VAXCRTL/SHARE
$ RUN TEXT_CONVERTER

To compile and run this program on ULTRIX systems, you can use the following
commands:
% cc -o text converter text converter.c -lddif -lm
% text converter

CDA Toolkit Routines 8-23

CONVERT AGGREGATE

CONVERT AGGREGATE
the aggregate type
Reads the next aggregate from a specified front end.

VAX FORMAT
status

=cda$convert_aggregate
(root-aggregate-handle , front-end-handle
, aggregate-handle , aggregate-type)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

root-aggregate-handle

front-end-handle

aggregate-handle

aggregate-type

8-24

CDA Toolkit Routines

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

CONVERT AGGREGATE

C FORMAT

status = CdaConvertAggregate
(root_aggregate_handle, front_end_handle,
aggregate_handle, aggregate_type)

Argument Information
unsigned long CdaConvertAggregate(root_aggregate_handle,
front_end_handle, aggregate_handle,
aggregate_type)
unsigned long
root_aggregate_handle;
unsigned long
front_end_handle;
unsigned long
*aggregate_handle;
unsigned long
*aggregate type;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle
Identifier of the root aggregate associated with the aggregate to be read. This
handle is returned by a call to the CREATE ROOT AGGREGATE routine.

When reading aggregates using this routine, you must use the same value for
root-aggregate-handle consistently to read all the aggregates in the compound
document. Once you have read all the aggregates, you cannot specify the same
root-aggregate-handle again when calling this routine.
front-end-handle
Identifier of the front end that reads the aggregate. This handle is either returned by a call to the OPEN CONVERTER routine, or is passed as a parameter
to the ddif$write_format or dtif$write_format entry point in the back end.
aggregate-handle
Receives the handle of the aggregate just read. This handle must be used in all
subsequent operations on that aggregate.
aggregate-type
Receives the aggregate type. If the aggregate type is DDIF$_EOS (end of
segment), then the value of aggregate-handle is 0.

CDA Toolkit Routines 8-25

CONVERT AGGREGATE
The aggregate type returned can be any one of the primary DDIF or DTIF
aggregates:
Aggregate Type

Meaning

DDIF$_DSC
DDIF$_DHD

Document descriptor
Document header
Document segment

DDIF$_SEG
DDIF$_TXT
DDIF$_GTX

DDIF$_HRV
DDIF$_SFV

Text content
General text content
Hard directive
Soft directive
Hard value directive
Soft value directive

DDIF$_BEZ
DDIF$_LIN

Bezier curve content
Polyline content

DDIF$_ARC
DDIF$_FAS
DDIF$_IMG

Arc content
Fill area set content
Image content

DDIF$_CRF

Content reference

DDIF$_EXT
DDIF$_PVT

External content

DDIF$_HRD
DDIF$_SFT

DDIF$_GLY
DDIF$_EOS
DTIF$_:bsc
DTIF$_HDR
DTIF$_TBL
DTIF$_ROW
DTIF$_CLD

Private content
Layout galley
End of segment
Document descriptor
Document header
Table definition
Row definition
Cell data

Note that the returned aggregate is not part of a sequence.

Description
The CONVERT AGGREGATE routine lets your application read the next
aggregate from the specified front end. This routine can only be invoked by a
back end.

8-26 CDA Toolkit Routines

CONVERT AGGREGATE

RETURN VALUES

Return Value

Description

CDA$_ENDOFDOC

End of document

CDA$_INVAGGTYP

Invalid aggregate type

CDA$_INVDOC

Invalid document content

CDA$_NORMAL

Normal successful completion

CDA$_UNSUPCNV

Unsupported conversion

Any error returned by the memory allocation routines.
Any error returned by the file routines.

CDA Tooikit Routines

8-27

CONVERT DOCUMENT

CONVERT DOCUMENT
Reads an entire document from a specified front end.

VAX FORMAT
status= cda$convert_document
(root-aggregate-handle , front-end-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

root-aggregate-handle

front-end-handle

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

C FORMAT
status = CdaConvertDocument
(rooLaggregate_..:handle, fronLend_handle)

8-28

CDA Toolkit Routines

CONVERT DOCUMENT

Argument Information
unsigned long CdaConvertDocument(root_aggregate_handle,
front_end_handle)
unsigned long
root_aggregate_handle;
unsigned long
front_end_handle;

RETURNS
status

A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle

Identifier of the root aggregate associated with the document being read. This
root aggregate handle is returned by a call to the CREATE ROOT AGGREGATE
routine.
Once you read an entire document, you cannot call the CONVERT DOCUMENT
routine specifying the same root aggregate handle again. That is, you can only
read a document associated with a particular root aggregate once.
front-end-handle

Identifier of the front end that reads the document. This handle is passed to
the back end as a parameter to the ddif$write_format or dtif$write_format
entry point in the back end. In addition, when a front end calls the OPEN
CONVERTER routine, the new front end handle is returned.

Description
The CONVERT DOCUMENT routine lets your application read an entire
document from the specified front end. This routine can only be invoked by a
back end. On return from this routine, the entire document is present in memory
in aggregates linked from the document root aggregate.

CDA Toolkit Routines

8-29

CONVERT DOCUMENT

RETURN VALUES

Return Value

Description

CDA$_NORMAL
CDA$_INVAGGTYP
CDA$_INVDOC

Normal successful completion
Invalid aggregate type
Invalid document content

Any error returned by the memory allocation routines.
Any error returned by the file routines.

8-30 CDA Toolkit Routines

CONVERT POSITION

CONVERT POSITION
Returns the current position in the input stream being processed, as well as the
total size of the input stream.

VAX FORMAT
status = cda$convert_position

(front-end-handle ,stream-position ,stream-size)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

front-end-handle

stream-position

stream-size

Access:

write only

Mechanism:

by reference

C FORMAT
status

=CdaConvertPosition
(front_end_handle, stream_position, stream_size)

CDA Toolkit Routines 8-31

CONVERT POSITION

Argument Information
unsigned long CdaConvertPosition(front_end_handle,
stream_position, stream_size)
front_end_handle;
unsigned long
*stream_position;
unsigned long
*stream_size;
unsigned long

RETURNS
status

A condition value indicating the return status of the routine call.

Arguments
front-end-handle

Identifier of the front end that is processing the input stream. The front end
handle is either returned by a call to the OPEN CONVERTER routine or is
passed as a parameter to ddif$write_format or dtif$write_format.
stream-position

Receives the current position (in bytes or aggregates) as measured from the start
of the input stream being processed.
stream-size

Receives the total size (in bytes or aggregates) of the input stream being processed.

Description
The CONVERT POSITION routine returns the current position in the input
stream being processed, as well as the total size of a document being processed by
the CONVERT AGGREGATE routine. The numbers are either in units of bytes
or aggregates.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

Any condition value returned by the front end get-position procedure.

8-32 CDA Toolkit Routines

COPY AGGREGATE

COPY AGGREGATE
Creates a copy of an aggregate and its entire substructure. If the specified
aggregate is part of a sequence, only the aggregate specified and its substructure,
rather than the entire sequence, is copied.

VAX FORMAT
status

=cda$copy_aggregate
(root-aggregate-handle ,input-aggregate-handle
, output-aggregate-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

root-aggregate-handle

input-aggregate-handle

output-aggregate-handle

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by. reference

CDA Toolkit Routines 8-33

COPY AGGREGATE

C FORMAT
status = CdaCopyAggregate
(root_aggregate_handle, input_aggregate_handle,
output_ aggregate_ handle)

Argument Information
unsigned long CdaCopyAggregate(root_aggregate_handle,
input_aggregate_handle,
output_aggregate_handle)
unsigned long
root_aggregate_handle;
unsigned long
input_aggregate_handle;
unsigned long
*output_aggregate_handle;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle
Identifier of the root aggregate with which the copied aggregate is associated.
The new copy of the aggregate becomes part of the document identified by this
root aggregate handle. This root aggregate handle is returned by a call to either
the OPEN FILE routine or the CREATE ROOT AGGREGATE routine.
input-aggregate-handle
Identifier of the aggregate to be copied.
output-aggregate-handle
Receives the handle of the new copy of the specified aggregate. This new
aggregate handle must be used in all subsequent operations on that aggregate.

Description
The COPY AGGREGATE routine makes a copy of the specified aggregate and its
entire substructure. This copy becomes part of the document identified by the
specified root aggregate handle argument, and it is assigned a unique aggregate
identifier, specified by the output aggregate handle argument.

8-34

CDA Toolkit Routines

COPY AGGREGATE

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA$_INVAGGTYP

Invalid aggregate type

CDA Toolkit Routines 8-35

CREATE AGGREGATE

CREATE AGGREGATE
Creates a new aggregate that contains empty items. Once this aggregate is
created, it can be populated using the STORE ITEM routine.

VAX FORMAT
status

=cda$create_aggregate
(root-aggregate-handle ,aggregate-type
,aggregate-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

root-aggregate-handle

aggregate-type

aggregate-handle

8-36

CDA Toolkit Routines

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

CREATE AGGREGATE

C FORMAT
status = CdaCreateAggregate

(root_aggregate_handle, aggregate_type,
aggregate_handle)

Argument Information
unsigned long CdaCreateAggregate(root_aggregate_handle,
aggregate_type, aggregate_handle)
unsigned long
root_aggregate_handle;
unsigned long
aggregate_type;
unsigned long
*aggregate_handle;

RETURNS
status

A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle

Identifier of the root aggregate with which the newly created aggregate is
associated. This handle is returned by a call to either the OPEN FILE routine or
the CREATE ROOT AGGREGATE routine.
aggregate-type

The type of aggregate to be created, expressed as a symbolic constant. The
aggregate type symbolic constants are defined in the files ddif$def.h and dtif$def.h
on VMS systems and in the files ddif_def.h and dtif_def.h on ULTRIX systems.
aggregate-handle

Receives the identifier of the newly created aggregate. This handle must be used
in all subsequent operations on that aggregate.

Description
The CREATE AGGREGATE routine creates a new aggregate of the specified type
that contains empty items. Once this aggregate is created, it can be populated
using the STORE ITEM routine. The created aggregate is part of the document
specified by the root aggregate handle.

CDA Toolkit Routines

8-37

CREATE AGGREGATE

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA$_INVAGGTYP

Invalid aggregate type

Any error returned by the memory allocation routines.

8-38 CDA Toolkit Routines

CREATE FILE

CREATE FILE
Creates a new compound document file for output. An output stream is also
created.

VAX FORMAT
status

=cda$create_file
(file-spec-Jen ,file-spec ,default-file-spec-Jen
,default-file-spec ,alloc-rtn ,dealloc-rtn
,alloc-dealloc-prm ,root-aggregate-handle
,result-file-spec-fen ,result-file-spec
,result-file-ret-len ,stream-handle ,file-handle)

Argument Information

Argument
status

file-spec-len

file-spec

default-file-spec-len

Argument Information
VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:
Data type:

longword_unsigned
longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

char_string

Data type:

character string

Access:

read only

Mechanism:

by reference

VMS usage:
Data type:

longword_unsigned
longword (unsigned)

Access:
Mechanism:

read only
by reference

CDA Toolkit Routines

8-39

CREATE FILE

Argument

Argument Information

default-file-spec

VMS usage:

char_string

Data type:

character string

Access:

read only

Mechanism:

by reference

VMS usage:

procedure

alloc-rtn

dealloc-rtn

alloc-dealloc-prm

root-aggregate-handle

result-file-spec-Ien

result-file-spec

result-file-ret-len

8-40 CDA Toolkit Routines

Data type:

procedure entry mask

Access:

call after stack unwind

Mechanism:

by reference, procedure reference

VMS usage:

procedure

Data type:

procedure entry mask

Access:

call after stack unwind

Mechanism:

by reference, procedure reference

VMS usage:

context

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

char_string

Data type:

character string

Access:

write only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

CREATE FILE

Argument

Argument Information

stream-handle

VMS usage:

identifier

file-handle

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

C FORMAT
status= CdaCreateFile

(file_spec_len, file_spec, defau/t_file_spec_len,
defau/t_file_spec, alloc_rtn, dealloc_rtn,
alloc_ dealloc_prm, root_aggregate_handle,
result_fi/e_spec_len, resu/t_fi/e_spec,
resu/t_fi/e_ret_/en, stream_handle, file_handle)

Argument Information
unsigned long CdaCreateFile(file spec len, file spec,
default_file=spec=len, defa~lt_file_spec,
alloc_rtn, dealloc_rtn, alloc_dealloc_prm,
root_aggregate_handle, result_file_spec_len,
result_file_spec, result_file_ret_len,
stream handle, file handle)
unsigned long
file spec len;
unsigned char
*file spec;
unsigned long
default file spec len;
unsigned char
*default file spec;
unsigned long
(*alloc rtn) (};
unsigned long
(*dealloc rtn) ();
unsigned long
alloc_dealloc_prm;
unsigned long
root_aggregate_handle;
unsigned long
result_file_spec_len;
unsigned char
*result_file_spec;
unsigned long
*result_file_ret_len;
unsigned long
*stream handle;
unsigned long
*file_handle;

CDA Toolkit Routines

8-41

CREATE FILE

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
file-spec-Jen
The length (in bytes) of the string specified by the file-spec parameter.
file-spec
The file specification.
default-file-spec-Jen
The length (in bytes) of the buffer specified by default-file-spec. If you specify a
value of 0 for both the default-file-spec-len and default-file-spec arguments, a
default file specification of ".ddif' is used.
default-file-spec
The default file specification. In order to simplify the porting of applications, the
character string should consist of only a file type in lowercase characters. If you
specify an address of 0 for both the default-file-spec-len and default-file-spec
arguments, a default file specification of ".ddif' is used. On ULTRIX systems, the
string is appended to the file specification, if the file specification does not already
contain a period.
alloc-rtn
Address of a memory allocation routine. The calling sequence for an allocation
routine is defined in the Description section of this routine. If you specify 0 for
this argument, a default memory allocation routine is used. For a description, see
Chapter 9.
dealloc-rtn
Address of a memory deallocation routine. The calling sequence for a deallocation
routine is defined in the Description section of this routine. If you specify 0 for
this argument, a default memory deallocation routine is used. For a description,
see Chapter 9.
alloc-dealloc-prm
User context to be passed to the memory allocation and deallocation routines.
If the system default memory allocation or deallocation routine is used, this
parameter is ignored. For a description, see Chapter 9.
root-aggregate-handle
Identifier of the root aggregate associated with the newly created compound
document. This handle must be used in all subsequent operations on that root
aggregate. This handle is returned by a call to the CREATE ROOT AGGREGATE
routine.

The root-aggregate-handle argument is used to specify the file type of the
newly created document using the aggregate type DDIF$_DDF for a DDIF file or
DTIF$_DTF for a DTIF file.
8-42 CDA Toolkit Routines

CREATE FILE

result-file-spec-Jen

Length (in bytes) of the buffer specified by result-file-spec. If you specify 0 for
this parameter, the length of the resultant file specification is not returned.
result-file-spec

Receives the resultant file specification. If you specify 0 for this parameter, the
resultant file specification is not returned. This file specification is the result of a
VMS RMS $CREATE operation. On ULTRIX systems, the file-spec argument is
copied to this buffer.
result-file-ret-len

Receives the actual length (in bytes) of the resultant file specification. If you
specify 0 for this parameter, the actual length of the resultant file specification is
not returned.
stream-handle

Receives the handle of the newly created compound document stream. This
handle must be used in all subsequent operations on that stream.
file-handle

Receives the handle of the newly created compound document file. This handle
must be used in all subsequent operations on that file.

Description
The CREATE FILE routine creates a new compound document file for output and
also creates an output stream. Note that you must have created a document root
aggregate (by a call to the CREATE ROOT AGGREGATE routine) prior to calling
this routine. The handle of this document root aggregate must be passed to the
CREATE FILE routine, and must also be used in all subsequent operations on
that root aggregate.

RETURN VALUES

Return Value

Description

CDA$_NORMAL
CDA$_INVAGGTYP

Normal successful completion
Invalid aggregate type

Any error returned by the memory allocation routines.
Any error returned by the file routines.

CDA Toolkit Routines 8-43

CREATE FILE

Example
This example illustrates a typical call to the CREATE FILE routine. The length
of the file specification is specified by the spec_length parameter, and the file
specification is example.ddif. This call does not specify a default file specification
length or a default file specification; this combination defaults to a default file
specification of .ddif. The system memory allocation and deallocation routines are
passed as a zero value, meaning that the default system memory routines are
used. The root aggregate handle specifies the root aggregate of the document.
This root aggregate must exist prior to a call to this routine.
The result_length, result_buffer, and result_length arguments contain
information about the actual resultant file specification of the created file. The
stream_hand.le and file_handle arguments receive the identifiers of the newly
created stream and file.

/* set up file for DDIF file */
spec_length = 12;
result length= sizeof(result buffer);
status-= cda$create_file(&spec_length, "example.ddif", 0, 0,
0, 0, 0 f
&root_aggregate_handle,
&result_length,
&result buffer[O], &result length,
&stream=handle, &file_handle);
if (FAILURE(status)) return(status);

8-44 CDA Toolkit Routines

CREATE ROOT AGGREGATE

CREATE ROOT AGGREGATE
Creates a document root aggregate.

VAX FORMAT
status= cda$create_root_aggregate

(alloc-rtn ,dealloc-rtn , alloc-dealloc-prm
,processing-options ,aggregate-type
,root-aggregate-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

procedure

Data type:

procedure entry mask

alloc-rtn

dealloc-rtn

alloc-dealloc-prm

Access:

call after stack unwind

Mechanism:

by reference, procedure reference

VMS usage:

procedure

Data type:

procedure entry mask

Access:

call after stack unwind

Mechanism:

by reference, procedure reference

VMS usage:

context

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by value

CDA Toolkit Routines

8-45

CREATE ROOT AGGREGATE
Argument
processing-options

aggregate-type

root-aggregate-handle

Argument Information
VMS usage:
item_list_2
Data type:

record

Access:

read only

Mechanism:
VMS usage:

by reference, array· reference
longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

C FORMAT
status= CdaCreateRootAggregate

(alloc_rtn, dealloc_rtn, alloc_dealloc_prm,
processing_options, aggregate_type,
root_aggregate_handle)

Argument Information
unsigned long CdaCreateRootAggregate(alloc rtn, dealloc rtn,
alloc_dealloc_prm, processing_options,
aggregate_type, root_aggregate_handle)
unsigned long
(*alloc_rtn) ();
unsigned long
(*dealloc_rtn) ();
unsigned long
*processing_options;
unsigned long
alloc_dealloc_prm;
unsigned long
aggregate_type;
unsigned long
*root_aggregate_handle;

RETURNS

status
A condition value indicating the return status of the routine call.

8-46 CDA Toolkit Routines

CREATE ROOT AGGREGATE

Arguments
alloc-rtn

Address of a memory allocation routine. The calling sequence for an allocation
routine is defined in the Description section of this routine. If you specify 0 for
this argument, a default memory allocation routine is used. For a description, see
Chapter 9.
dealloc-rtn

Address of a memory deallocation routine. The calling sequence for a deallocation
routine is defined in the Description section of this routine. If you specify 0 for
this argument, a default memory deallocation routine is used. For a description,
see Chapter 9.
alloc-dealloc-prm

User context to be passed to the memory allocation and deallocation routines.
If the system default memory allocation or deallocation routine is used, this
parameter is ignored. For a description, see Chapter 9.
processing-options

An item list containing options to control input processing. Each entry in the
item list is a 2-longword structure. To terminate the item list you must specify
the final entry or longword as 0. Valid item codes are as follows:
DDIF$_INHERIT_ATTRIBUTES

Attribute inheritance is applied to all document segments. First, if a segment has a type
reference that corresponds to a type definition,
the attributes of the type are applied to the
segment.
If a segment is the root segment, and a style

guide is referenced in the document's header,
the definitions and layout from the style guide
are applied to the root segment. For the root
segment only, standard defined initial values
are applied to the attributes of the segment
that do not yet have values ..
If the segment is not the root segment, at-

tribute values of its parent segment are
applied to the attributes of the segment that
do not yet have values. For more information
on the inherit attributes processing option, see
Section 1.6.1.
DDIF$_RETAIN_DEFINITIONS

Segment definitions that enable the operation
of CDA$FIND_DEFINITION are retained.
This item code is required only if neither
DDIF$_INHERIT_ATTRIBUTES nor DDIF$_
EVALUATE_CONTENT is specified. For
more information on the retain definitions
processing option, see Section 1.6.2.

CDA Toolkit Routines 8-47

CREATE ROOT AGGREGATE

DDIF$_EVALUATE_CONTENT

Content reference (DDIF$_CRF) aggregates
are replaced with the value of the definition
(DDIF$_CTD) they reference. The value of
this content definition may be in the current
document or in an external document.
Content for segments with the DDIF$_SGA_
COMPUTE_C item present in the segment's
attributes (DDIF$_SGA) may be imported
from an external reference. If the value
of the DDIF$_SGA_COMPUTE_C item is
DDIF$K_REMOTE_COMPUTE, the external
content is imported and replaces the segment's
original content. If the value of the DDIF$_
SGA_COMPUTE_C item is DDIF$_K_COPY_
COMPUTE, the external content is imported
only if the segment has no content. For more
information on the evaluate content processing
option, see Section 1.6.3.

DDIF$_DISCARD_I_SEGMENTS

Segments of the image ($I ) content category,
and any nested segments, are discarded.
For more information on the discard image
segments processing option, see Section 1.6.4.

DDIF$_DISCARD_2D_SEGMENTS

Segments of the graphics ( $2D) content category, and any nested segments, are discarded.
For more information on the discard graphics
segments processing option, see Section 1. 6.4.

DDIF$_DISCARD_T_SEGMENTS

Segments of the text ( $T) ·content category,
and any nested segments, are discarded. For
more information on the discard text segments
processing option, see Section 1.6.4.

DDIF$_DISCARD_TBL_SEGMENTS

Segments of the table ( $TBL) content category, and any nested segments, are discarded.
For more information on the discard table
segments processing option, see Section 1.6.4.

DDIF$_DISCARD_PDL_SEGMENTS

Segments of the page description language
( $PDL) content category, and any nested segments, are discarded. For more information
on the discard page descriptions language
segments processing option, see Section 1.6.4.

This item list contains options only to control input processing. If you are
creating a root aggregate for output processing, you must specify both an item
length and an item buffer address of 0.
aggregate-type

The type of aggregate to be created, expressed as a symbolic constant. The only
valid root aggregate types are DDIF$_DDF and DTIF$_DTF.
root-aggregate-handle

Receives a value that identifies the newly created root aggregate. This handle
must be used in all subsequent operations on that root aggregate.

8-48

CDA Toolkit Routines

CREATE ROOT AGGREGATE

Description
The CREATE ROOT AGGREGATE routine creates a document root aggregate.

RETURN VALUES

Return Value

Description

CDA$_NORMAL
CDA$_INVAGGTYP
CDA$_INVITMLST

Normal successful completion
Invalid aggregate type
Invalid item list

Any error returned by the memory allocation routines.

Example
This code segment illustrates a typical call to the CREATE ROOT AGGREGATE
routine. The first four parameters are passed as zero values, indicating that the
default system memory allocation and deallocation routines are used and that no
processing options are specified. The aggregate type passed is DDIF$_DDF, which
is the document root aggregate, and the root aggregate handle that is returned is
used to identify that document throughout the program.

aggregate_type = DDIF$_DDF;
status = cda$create_root_aggregate(O, 0, 0, 0, &aggregate_type,
&root_aggregate_handle);
if (FAILURE(status)) return(status);

CDA Toolkit Routines

8-49

CREATE STREAM

CREATE STREAM
Opens a compound document stream for output.

VAX FORMAT
status = cda$create_stream
(alloc-rtn ,dealloc-rtn ,alloc-dealloc-prm ,put-rtn
,put-prm ,but-Jen ,buf-adr ,stream-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

alloc-rtn

dealloc-rtn

alloc-dealloc-prm

8-50

CDA Toolkit Routines

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

procedure

Data type:

procedure entry mask

Access:

call after stack unwind

Mechanism:

by reference, procedure reference

VMS usage:

procedure

Data type:

procedure entry mask

Access:

call after stack unwind

Mechanism:

by reference, procedure reference

VMS usage:

context

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by value

CREATE STREAM

Argument

Argument Information

put-rtn

VMS usage:

procedure

Data type:

procedure entry mask

Access:

read only

Mechanism:
VMS usage:

by reference, procedure reference
user_arg

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by value

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

put-prm

buf-len

buf-adr

stream-handle

Access:

read only

Mechanism:

by reference

VMS usage:

vector_byte_unsigned

Data type:

byte (unsigned)

Access:

read only

Mechanism:

by reference, array reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

C FORMAT

status

=CdaCreateStream
(alloc_rtn, dealloc_rtn, alloc_deal/oc_prm, put_rtn,
put_prm, but_ fen, but_adr, stream_handle)

CDA Toolkit Routines 8-51

CREATE STREAM

Argument Information
unsigned long CdaCreateStream(alloc_rtn, dealloc_rtn,
alloc_dealloc_prm, put_rtn, put_prm,
buf_len, buf_adr, stream_handle)
unsigned long
(*alloc_rtn) ();
unsigned long
(*dealloc_rtn) ();
unsigned long
alloc_dealloc_prm;
unsigned long
(*put_rtn) ();
unsigned long
put_prm;
unsigned long
buf_len;
unsigned char
*buf_adr;
unsigned long
*stream_handle;

RETURNS
status

A condition value indicating the return status of the routine call.

Arguments
alloc-rtn

Address of a stream put routine. The calling sequence for a put routine is defined
in Chapter 9. If you specify 0 for this argument on VMS systems, a system
default routine is used. On ULTRIX systems, you must provide both a put-rtn
and put-prm; there is no default. If you specify a value other than the default for
this argument, you must also specify a value for the put-prm argument.

8-52 CDA Toolkit Routines

CREATE STREAM
put-prm
User context to be passed to the stream put routine. If the VMS system default
put routine is used, the value must be a pointer to a RAB. On ULTRIX systems, you must provide both a put-rtn and put-prm; there is no default. For a
description, see Chapter 9.
but-Jen
Length of the buffer specified by the buf-adr parameter.
buf-adr
Address of a buffer that receives the output data.
stream-handle
Receives the handle of the newly created stream. This handle must be used in all
subsequent operations on that stream.

Description
The CREATE STREAM routine opens a compound document stream for output.
The number of streams that you can open simultaneously is limited only by the
amount of memory available.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

Any error returned by the memory allocation routines.

CDA Toolkit Routines

8-53

CREATE TEXT FILE

CREATE TEXT FILE
Creates a standard text file for output.

VAX FORMAT
status= cda$create_text_file

(file-spec-fen ,file-spec ,default-file-spec-fen
,default-file-spec ,resuIt-file-spec-Jen
,result-file-spec ,result-file-ret-len ,text-file-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by. reference

VMS usage:

char_string

file-spec-len

file-spec

default-file-spec-len

default-file-spec

8-54

CDA Toolkit Routines

Data type:

character string

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:
VMS usage:

by reference
char_string

Data type:

character string

Access:

read only

Mechanism:

by reference

CREATE TEXT FILE

Argument

Argument Information

result-file-spec-len

VMS usage:

longword_unsigned

result-file-spec

result-file-ret-Ien

text-file-handle

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

char_string

Data type:

character string

Access:

write only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

C FORMAT
status= CdaCreateTextFile
(file_spec_len, file_spec, defau/t_file_spec_len,
defau/t_file_spec, result_file_spec_len,
resu/t_fi/e_spec, resu/t_fi/e_ret_len,
text_ file_handle)

CDA Toolkit Routines 8-55

CREATE TEXT FILE

Argument Information
unsigned long CdaCreateTextFile(file spec len, file spec,
default file spec len, default-file spec,
result file spec len, result file spec,
result=file=ret_len, text_file_handle)
unsigned long
file spec len;
unsigned char
*file_spec;
unsigned long
default file spec len;
unsigned char
*default_file_spec;
unsigned long
result_file_spec_len;
unsigned char
*result file spec;
unsigned long
*result=file=ret_len;
unsigned long
*text_file_handle;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
file-spec-Jen
Length (in bytes) of the string specified by the file-spec argument.
file-spec
File specification of the text file to be created for output.
default-file-spec-len
Length (in bytes) of the string specified by default-file-spec. If you specify 0 for
this parameter, no default file specification is used.
default-file-spec
Default file specification. If you specify 0 for this parameter, no default file
specification is used. The string should consist only of a file type in lowercase
characters. On ULTRIX systems, the string is appended to the file specification if
the file specification does not already contain a period.
result-file-spec-len
Length (in bytes) of the buffer specified by result-file-spec. If you specify 0 for
this parameter, the length of the resultant file specification is not returned.
result-file-spec
Receives the resultant file specification. This file specification is the result of a
VMS RMS $CREATE operation. On ULTRIX systems, the file-spec is copied to
this buffer. If you specify 0 for this parameter, a resultant file specification is not
returned.

8-56 CDA Toolkit Routines

CREATE TEXT FILE

result-file-ret-len

Receives the actual length (in bytes) of the resultant file specification. If you
specify 0 for this parameter, the actual length of the resultant file specification is
not returned.
text-file-handle

Receives the handle of the text file. This handle must be used in all subsequent
operations on that text file.

Description
The CREATE TEXT FILE routine creates a standard text file for output.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

Any error returned by the memory allocation routines.
Any error returned by the file routines.

CDA Toolkit Routines 8-57

DELETE AGGREGATE

DELETE AGGREGATE
Destroys an aggregate and all of its substructure. If the specified aggregate is
part of a sequence, the aggregate is cut from the sequence before being destroyed.

VAX FORMAT
status = cda$delete_aggregate

(root-aggregate-handle ,aggregate-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

root-aggregate-handle

aggregate-handle

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:
Access:

longword (unsigned)

Mechanism:

by reference

VMS usage:

identifier
longword (unsigned)

Data type:

read only

Access:

read only

Mechanism:

by reference

C FORMAT
status

=CdaDeleteAggregate
(root_aggregate_handle, aggregate_handle)

~58

CDA Toolkit Routines

DELETE AGGREGATE

Argument Information
unsigned long CdaDeleteAggregate(root_aggregate_handle,
aggregate_handle)
unsigned long
root_aggregate_handle;
unsigned long
aggregate_handle;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle
Identifier of the root aggregate associated with the aggregate to be deleted. This
handle is returned by a call to either the OPEN FILE routine or the CREATE
ROOT AGGREGATE routine.
aggregate-handle
Identifier of the aggregate to be destroyed.

Description
The DELETE AGGREGATE routine destroys an aggregate and all of its substructure. If the specified aggregate is part of a sequence, the aggregate is cut from
the sequence before being destroyed. Note that the specified aggregate handle
and the handles of any subaggregates linked to the specified aggregate either
directly or indirectly to children of the root aggregate are invalid after a call to
this routine.

RETURN VALUES

Return Value

Description

CDA$_NORMAL
CDA$_1NVAGGTYP

Normal successful completion
Invalid aggregate type

Any error returned by the memory deallocation routines.

CDA Toolkit Routines

8-59

DELETE ROOT AGGREGATE

DELETE ROOT AGGREGATE
Destroys a document root aggregate and all of its substructure.

VAX FORMAT
status = cda$delete_root_aggregate
(root-aggregate-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

root-aggregate-handle

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

C FORMAT
status= CdaDeleteRootAggregate
(root_aggregate_handle)

Argument Information
unsigned long CdaDeleteRootAggregate(root_aggregate_handle)
unsigned long
root_aggregate_handle;

8-60

CDA Toolkit Routines

DELETE ROOT AGGREGATE

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle
Identifier of the root aggregate to be deleted. This handle is returned by a call to
either the OPEN FILE routine or the CREATE ROOT AGGREGATE routine.

Description
The DELETE ROOT AGGREGATE routine destroys a document root aggregate
and all of its associated substructure. The root aggregate and its substructure
form a tree structure, so that when the root aggregate is deleted, any aggregates
attached to that root aggregate are also deleted. The root-aggregate-handle as
well as the handles of any aggregates that are linked to the root aggregate either
directly or indirectly are invalid after a call to this routine.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

Any error returned by the memory deallocation routines.

GOA Toolkit Routines

8-61

ENTER SCOPE

ENTER SCOPE
Opens a document scope for incremental writing.

VAX FORMAT
status

=cda$enter_scope
(root-aggregate-handle ,stream-handle ,scope-code
[,aggregate-handle])

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier
longword (unsigned)

root-aggregate-handle

Data type:

stream-handle

scope-code

aggregate-handle

8-62 CDA Toolkit Routines

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:
Mechanism:

read only
by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

ENTER SCOPE

C FORMAT
status

=CdaEnterScope
(root_aggregate_handle, stream_handle,
scope_code,aggregate_handle)

Argument Information
unsigned long CdaEnterScope(root_aggregate_handle,
stream_handle, scope_code
aggregate_handle)
unsigned long
root aggregate handle;
unsigned long
stream_handle;unsigned long
scope_code;
unsigned long
aggregate_handle;

RETURNS
status

A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle
Identifier of the root aggregate associated with the document content to be
incrementally written. This handle is returned by a call to either the OPEN FILE
routine or the CREATE ROOT AGGREGATE routine.
stream-handle
Identifier of the stream associated with the document to be written. This handle
is returned by a call to either the CREATE FILE routine or the CREATE
STREAM routine.
scope-code
Symbolic constant identifying the scope to be opened. Valid values for the DDIF
root aggregate are as follows:
Code

Meaning

DDIF$K_DOCUMENT_SCOPE

Document scope

DDIF$K_CONTENT_SCOPE

Content scope

DDIF$K_SEGMENT_SCOPE

Segment scope

Valid values for the DTIF root aggregate are as follows:

CDA Toolkit Routines 8-63

ENTER SCOPE

Code

Meaning

DTIF$K_DOCUMENT_SCOPE

Document scope

DTIF$K_TABLE_SCOPE

Table scope

DTIF$K_ROW_SCOPE

Row scope

DTIF$K_CELLS_SCOPE

Cell scope (for all cells in a row)

aggregate-handle
Identifier of an aggregate of the appropriate type, if required by the scope code
specified.

The aggregate must be completely populated, except that its content sequence
must be empty. The DDIF scoped sections that require that the aggregatehandle be specified are as follows:
Scope

Value of Aggregate-Handle

DDIF$K_SEGMENT_SCOPE

Aggregate-handle is the handle of an aggregate
of type DDIF$_SEG.

The DTIF scoped sections that require that the aggregate-handle be specified
are as follows:
Scope

Value of Aggregate-Handle

DTIF$K_TABLE_SCOPE

Aggregate-handle is the handle of the table
aggregate, which contains everything to be specified
except the rows.
Aggregate-handle is the handle of the row aggregate, which contains everything to be specified
except the cells.

DTIF$K_ROW_SCOPE

Description
The ENTER SCOPE routine lets you open a particular document scope for
incremental writing. The types of scopes that you can open for a DDIF-encoded
document are the following:
•

DDIF$K_DOCUMENT_SCOPE

•

DDIF$K_CONTENT_SCOPE

•

DDIF$K_SEGMENT_SCOPE

For a DTIF-encoded document, the types of scopes that you can open are as
follows:

8-64

•

DTIF$K_DOCUMENT_SCOPE

•

DTIF$K_TABLE_SCOPE

•

DTIF$K_ROW_SCOPE

•

DTIF$K_CELLS_SCOPE

CDA Toolkit Routines

ENTER SCOPE

Using Scope to Write DDIF Documents Incrementally

When performing incremental writing on a DDIF-encoded document, you should
perform the following steps:
1.

Call the ENTER SCOPE routine, specifying scope-code as DDIF$K_
DOCUMENT_SCOPE.

2. Write an aggregate of type DDIF$_DSC.
3. Write an aggregate of type DDIF$_DHD.
4. Call the ENTER SCOPE routine, specifying scope-code as DDIF$K_
CONTENT_SCOPE.
5. Write a root segment of type DDIF$_SEG. The root segment is a top-level
segment that contains the document content. This document content can
consist of content aggregates as well as nested segments. If the document
contains only one segment, that segment is the root segment and it contains
all of the document content. If the document contains multiple segments,
they must be nested within a root segment.
You can use either of the following methods to create the root segment.
Because the first method requires that the entire segment be completed
before calling the PUT AGGREGATE routine, once you select that method
you must continue to use that method while writing all of the document
content. If you select the second method, you can use either method to write
any nested segments. Again, if while writing nested segments, you select the
first method, you must continue to use that method, and so on.
a.

Call the PUT AGGREGATE routine with a· completed aggregate of type
DDIF$_SEG, whose DDIF$_SEG_CONTENT item references a sequence
of aggregates that make up the entire content for that segment, including
any nested segments. Using this method, you need only call the PUT
AGGREGATE routine once, because the DDIF$_SEG aggregate written in
the call to PUT AGGREGATE is already completely populated.

Call the ENTER SCOPE routine, specifying scope-code as DDIF$K_
SEGMENT_SCOPE, with a completed aggregate of type DDIF$_SEG
whose DDIF$_SEG_CONTENT item is empty. You can then call the PUT
AGGREGATE routine for each aggregate that makes up the segment
content, in order. Once that segment and all its nested segments have
been output, call the LEAVE SCOPE routine, specifying scope-code as
DDIF$K_SEGMENT_SCOPE to complete that segment.

6. Call the LEAVE SCOPE routine, specifying scope-code as DDIF$K_
CONTENT_SCOPE.
7. Call the LEAVE SCOPE routine, specifying scope-code as DDIF$K_
DOCUMENT_SCOPE.
When you call the ENTER SCOPE routine with scope-code specified as
DDIF$K_SEGMENT_SCOPE, you can write aggregates of the following types
within the segment, provided that the appropriate restrictions on content types
within content categories are observed:

CDA Toolkit Routines 8-65

ENTER SCOPE

Aggregate Type

Meaning

DDIF$_SEG

Document segment

DDIF$_TXT

Text content

DDIF$_HRD
DDIF$_SFT

Hard directive
Soft directive

DDIF$_LIN
DDIF$_ARC

Polyline content
Arc content

DDIF$_BEZ
DDIF$_IMG
DDIF$_CRF
DDIF$_EXT

Bezier curve content
Image content
Content reference
External content

DDIF$_PVT

Private content

Using Scope to Write DTIF Documents Incrementally

When performing incremental writing of a DTIF-encoded document, you should
perform the following steps:
1.

Call the ENTER SCOPE routine, specifying scope-code as DTIF$K_
DOCUMENT_SCOPE.

2. Create a header (type DTIF$_HDR) aggregate and write it using the PUT
AGGREGATE routine.
3. Create a table (DTIF$_TBL) aggregate, specifying everything to be written
except the table rows.
4. Call the ENTER SCOPE routine, specifying scope-code as DTIF$K_TABLE_
SCOPE and aggregate-handle as the handle of the table aggregate to be
written.
5. Create a row (DTIF$_ROW) aggregate, specifying everything to be written
except the row cells.
6. Call the ENTER SCOPE routine, specifying scope-code as DTIF$K_ROW_
SCOPE and aggregate-handle as the handle of the row aggregate to be
written.
7. Call the ENTER SCOPE routine, specifying scope-code as DTIF$K_CELLS_
SCOPE (do not specify the aggregate-handle argument).
8. Create and populate a cell (DTIF$_CLD) aggregate, and invoke the PUT
AGGREGATE routine to write the completed aggregate.
9. Repeat until all of the cells in the row have been written.
10. Call the LEAVE SCOPE routine, specifying scope-code as DTIF$K_CELLS_
SCOPE.
11. Call the LEAVE SCOPE routine, specifying scope-code as DTIF$K_ROW_
SCOPE.
12. Repeat steps 6 through 11 for each row in the table.
13. Once all the rows in the table have been completed, call the LEAVE SCOPE
routine, specifying scope-code as DTIF$K_TABLE_SCOPE.
8-66

CDA Toolkit Routines

ENTER SCOPE

14. If there are additional tables to be created, repeat steps 4 through 13 to create
the additional tables.
15. Once all the tables in the document have been created, call the LEAVE
SCOPE routine, specifying scope-code as DTIF$K_DOCUMENT_SCOPE.
NOTE

After calling the ENTER SCOPE routine, if your application no longer
requires the aggregates written, you should issue a subsequent call to
the DELETE AGGREGATE routine to destroy these aggregates.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA$_INVSCOCOD

Invalid scope code

Any errors returned by the file routines.

Examples
The following example shows how to incrementally read a DDIF document and
write it to another DDIF file using the PUT AGGREGATE, ENTER SCOPE, and
LEAVE SCOPE routines.

/* Get the document from the front end using the aggregate method */
while (SUCCESS(status = cda$convert_aggregate (&root_aggregate_handle,
fre_handle,
&aggregate_handle,
&aggregate_type)))
switch (aggregate_type)

/* If the aggregate type is DDIF$_DSC, the document
descriptor aggregate, then enter document scope
and write the aggregate to the stream */
case DDIF$ DSC:
I* The first aggregate is incrementally read--enter
the document scope here before putting out the
aggregate */
scope = DDIF$K DOCUMENT SCOPE;
status = cda$e~ter_scope (&root_aggregate_handle,
&stream_handle,
&scope);
if (!SUCCESS(status))
CLEANUP (status);

CDA Toolkit Routines 8-67

ENTER SCOPE
status

cda$put_aggregate (&root_aggregate_handle,
&stream_handle,
&aggregate_handle);
if (!SUCCESS(status))
CLEANUP (status);
break;

Examples
/* If the aggregate type is DDIF$_DHD, the document
header aggregate, then simply write the aggregate
to the stream, since we're already in the document
scope */
case DDIF$_DHD:
status = cda$put_aggregate (&root_aggregate_handle,
&stream_handle,
&aggregate_handle);
if (!SUCCESS(status))
CLEANUP (status);
scope = DDIF$K CONTENT SCOPE;
/* DDIF$ DHD immediately precedes content--enter
content scope here */
status = cda$enter_scope (&root_aggregate_handle,
&stream_handle,
&scope);
if (!SUCCESS(status))
CLEANUP (status);
break;

/* If the aggregate type is DDIF$_SEG, the segment
aggregate, then enter the segment scope and write
the aggregate to the stream */
case DDIF$_SEG:
scope = DDIF$K_SEGMENT_SCOPE;
/* Enter segment scope passing segment handle-this call outputs the segment aggregate--enter
scope does put aggregate for segments */
status = cda$enter_scope (&root_aggregate_handle,
&stream_handle,
&scope,
&aggregate_handle);
if (!SUCCESS(status))
CLEANUP (status);
break;

/* If the aggregate type is DDIF$_EOS, end of
segment aggregate, then leave the segment scope */
case DDIF$_EOS:
scope = DDIF$K_SEGMENT_SCOPE;
status = cda$leave_scope (&root_aggregate_handle,
&stream_handle,
&scope);
if (!SUCCESS(status))
CLEANUP (status);
break;

8-68

CDA Toolkit Routines

ENTER SCOPE
/* For any other aggregate type, simply write the
aggregate to the stream */
default:
status = cda$put_aggregate (&root_aggregate_handle,
&stream_handle,
&aggregate_handle);
if (!SUCCESS(status))
CLEANUP (status);
break;

/*Delete the aggregate(s) just processed*/
status = cda$delete_aggregate (&root_aggregate_handle,
&aggregate_handle);
if (!SUCCESS(status))
CLEANUP (status);

/* Once all aggregates are processed, leave the content scope
and the document scope */

The following example shows the incremental method of creating a document,
using both methods outlined for writing nested segments.
I*
This is an example of using the incremental method to create a
document with nested segments being output using different options.

*/
#ifdef vms
#include <cda$def .h>
#include <ddif$def.h>
#else
#include <cda def.h>
#include <ddif def .h>
#end i f
#define FAILURE(x)

( ( (x)

main()
{

unsigned long
unsigned long
unsigned long
unsigned long
unsigned long
unsigned long
unsigned long
unsigned long
unsigned long

status;
aggregate_type;
aggregate_handle;
prev_aggregate_handle;
aggregate_itern;
aggregate_index;
add_info;
spec_length;
result_length;

CDA Toolkit Routines 8-69

ENTER SCOPE
unsigned char
unsigned long
unsigned long
unsigned long
unsigned long
unsigned long
unsigned char
unsigned long
unsigned long

result_buffer[255];
stream_handle;
file_handle;
root_aggregate_handle;
segment_handle;
integer_value;
byte_value;
buffer_length;
scope_code;

/* Create the root aggregate */
aggregate_type = DDIF$_DDF;
status= cda$create_root_aggregate(O, 0, 0, 0, &aggregate_type,
&root aggregate handle);
if (FAILURE(status)) return(status);
/* Create the file */
spec_length = 9;
result length= sizeof(result buffer);
status-= cda$create_file(&spec_length, "test.ddif", 0, 0,
0, O, 0,
&root_aggregate_handle, &result length,
&result_buffer[O], &result_length,
&stream_handle, &file_handle);
if (FAILURE(status)) return(status);

/* Enter Document Scope */
scope_code = DDIF$K_DOCUMENT_SCOPE;
status = cda$enter_scope(&root_aggregate_handle, &stream_handle,
&scope_code);
if (FAILURE(status)) return(status);
/* Create, populate, put, and delete the descriptor aggregate */
aggregate_type = DDIF$_DSC;
status= cda$create aggregate(&root aggregate handle,
&aggregate_type~ &aggregate_handle);
if (FAILURE(status)) return(status);

aggregate item = DDIF$ DSC MAJOR VERSION;
buffer length= sizeof(integer value);
integer value = 1;
status ~ cda$store item(&root aggregate handle, &aggregate handle,
&aggregate_item, &buffe;_length, &integer_;alue);
if (FAILURE(status)) return(status);

aggregate item = DDIF$ DSC MINOR VERSION;
buffer length= sizeof(integer value);
integer value = O;
status ~ cda$store item(&root aggregate handle, &aggregate handle,
-&aggregate=item, &buffer_length, &integer_value);
if (FAILURE(status)) return(status);
aggregate_item = DDIF$_DSC_PRODUCT_IDENTIFIER;
buffer length = 4;
status-= cda$store item(&root aggregate handle, &aggregate handle,
&aggregate_item~ &buffer_length, "Test");
if (FAILURE(status)) return(status);

8-70

CDA Toolkit Routines

ENTER SCOPE
aggregate item = DDIF$ DSC PRODUCT NAME;
buffer_length = 19;
add_info = CDA$K_ISO_LATIN1;
aggregate index = 0;
status = cda$store item(&root aggregate handle, &aggregate handle,
&aggregate item, &buffer length,
"Example Application", &aggregate index,
&add_info);
if (FAILURE(status)) return(status);
status = cda$put_aggregate(&root_aggregate_handle,
&stream handle, &aggregate handle);
if (FAILURE(status)) return(status);
status= cda$delete_aggregate(&root_aggregate_handle,
&aggregate handle);
if (FAILURE(status)) return(status);
-

/* Create, populate, put, and delete the header aggregate. */
aggregate type = DDIF$ DHD;
status= cda$create_aggregate(&root_aggregate_handle,
&aggregate type, &aggregate handle);
if (FAILURE(status)) return(status);
prev_aggregate_handle = aggregate_handle;

I* Store header items here */
status = cda$put_aggregate(&root_aggregate handle, &stream_handle,
&aggregate handle);
if (FAILURE(status)) return(status); status = cda$delete_aggregate(&root_aggregate_handle,
&aggregate handle);
if (FAILURE(status)) return(status);
-

/* Enter Content Scope */
scope code = DDIF$K CONTENT SCOPE;
status= cda$enter_scope(&root_aggregate_handle, &stream_handle,
&scope code);
if (FAILURE(status)) return(status);

/* Create the "root segment" aggregate, and fill it in except for
the content. This will be output using cda$enter scope, and
its contents will be output incrementally.
*/

aggregate_type = DDIF$_SEG;
status = cda$create_aggregate(&root_aggregate_handle,
&aggregate type, &aggregate handle);
if (FAILURE(status)) return(status);
segment_handle = aggregate_handle;
/* Fill in any items needed at the top level. */
aggregate type = DDIF$ SGA;
status = cda$create_aggregate(&root_aggregate_handle,
&aggregate type, &aggregate_handle);
if (FAILURE(status)) return(status);
-

CDA Toolkit Routines

8-71

ENTER SCOPE

aggregate item = DDIF$ SEG SPECIFIC ATTRIBUTES;
buffer length= sizeof(aggregate handle);
status-= cda$store_item(&root_aggregate_handle, &segment handle,
&aggregate_item, &buffer_length,
&aggregate_handle);
if (FAILURE(status)) return(status);
aggregate item = DDIF$ SGA CONTENT CATEGORY;
add info ~ DDIF$K T CATEGORY;
status = cda$store_Item(&root_aggregate_handle, &aggregate_handle,
&aggregate item, 0, O, 0, &add_info);
if (FAILURE(status)) return(status);

/* Enter Segment Scope.

This requires the segment aggregate handle,
and causes the segment aggregate to be output.
*/
scope code = DDIF$K SEGMENT SCOPE;
status= cda$enter_scope(&root_aggregate_handle, &stream_handle,
&scope code, &segment handle);
if (FAILURE(status)) return(status);
/* Delete the segment aggregate */
status= cda$delete_aggregate(&root_aggregate_handle,
&segment_handle);
if (FAILURE(status)) return(status);

/* Incrementally, create the content aggregates and put them out. */
aggregate_type = DDIF$_TXT;
status= cda$create_aggregate(&root_aggregate_handle,
&aggregate_type, &aggregate_handle);
if (FAILURE(status)) return(status);
aggregate_item = DDIF$_TXT_CONTENT;
buffer_length = 5;
status = cda$store_item(&root_aggregate_handle, &aggregate_handle,
&aggregate item, &buffer length, "Hello");
if (FAILURE(status)) return(status);
status= cda$put_aggregate(&root_aggregate_handle, &stream_handle,
&aggregate_handle);
if (FAILURE(status)) return(status);

/* Delete the text aggregate */
status= cda$delete_aggregate(&root_aggregate_handle,
&aggregate_handle);
if (FAILURE(status)) return(status);

/* The next content element is a segment

* Create a sement aggregate, link all its content to it,
* and output the aggregate.

(This segment does not use

cda$enter scope.)

aggregate type = DDIF$ SEG;
status= cda$create_aggregate(&root_aggregate_handle,
&aggregate type, &aggregate handle);
if (FAILURE(status)) return(status);
segment_handle = aggregate_handle;

8-72

CDA Toolkit Routines

ENTER SCOPE
aggregate type = DDIF$ SGA;
status = cda$create_aggregate(&root_aggregate_handle,
&aggregate type, &aggregate handle);
if (FAILURE(status)) return(status);
aggregate_item = DDIF$_SEG_SPECIFIC_ATTRIBUTES;
buffer length= sizeof(aggregate handle);
status-= cda$store_item(&root_aggregate_handle, &segment handle,
&aggregate_item, &buffer_length,
&aggregate_handle);
if (FAILURE(status)) return(status);
aggregate_item = DDIF$_SGA_CONTENT_CATEGORY;
add_info = DDIF$K_T_CATEGORY;
status = cda$store_item(&root_aggregate_handle, &aggregate handle,
&aggregate item, 0, 0, 0, &add_info);
if (FAILURE(status)) return(status);

/* Create content aggregates, and link them to
* the segment aggregate.

*I
aggregate_type = DDIF$_TXT;
status = cda$create_aggregate(&root_aggregate handle,
&aggregate type, &aggregate_handle);
if (FAILURE(status)) return(status);
prev_aggregate_handle = aggregate_handle;
aggregate_item = DDIF$_SEG_CONTENT;
buffer_length = sizeof(aggregate_handle);
status = cda$store_item(&root_aggregate_handle, &segment handle,
&aggregate_item, &buffer_length,
&aggregate_handle);
if (FAILURE(status)) return(status);
aggregate_item = DDIF$_TXT_CONTENT;
buffer_length = 5;
status = cda$store_item(&root_aggregate_handle, &aggregate_handle,
&aggregate_item, &buffer_length,
"There");
if (FAILURE(status)) return(status);
aggregate type = DDIF$ HRD;
status = cda$create_aggregate(&root_aggregate_handle,
&aggregate type, &aggregate handle);
if (FAILURE(status)) return(status);
-

cda$insert_aggregate(&aggregate_handle, &prev_aggregate_handle);
aggregate_item = DDIF$_HRD_DIRECTIVE;
buffer length= sizeof(integer value);
intege~_value = DDIF$K_DIR_NEW=PAGE;
status = cda$store_item(&root_aggregate_handle, &aggregate handle,
&aggregate_item, &buffer_length,
&integer_value);
if (FAILURE(status)) return(status);

CDA Toolkit Routines

8-73

ENTER SCOPE
/* Output the segment aggregate (Since the content is attached,

* it is output also.)
*I
status= cda$put_aggregate(&root_aggregate_handle, &stream_handle,
&segment handle);
if (FAILURE(status)) return(status);

I* Delete the segment aggregate and all aggregates

* attached to it.
*/

status

= cda$delete_aggregate(&root_aggregate_handle,

&segment_handle);
if (FAILURE(status)) return(status);
/* Output more content aggregates within the root segment */

I* Leave Segment Scope.

This is for the segment that was output
using cda$enter scope.
*/
scope code = DDIF$K SEGMENT SCOPE;
status= cda$leave_scope(&root_aggregate_handle, &stream_handle,
&scope code);
if (FAILURE(status)) return(status);

/* Leave Content Scope */
scope code = DDIF$K CONTENT SCOPE;
status= cda$leave_scope(&root_aggregate_handle, &stream_handle,
&scope code);
if (FAILURE(status)) return(status);
/* Leave Document Scope */
scope code = DDIF$K DOCUMENT SCOPE;
status= cda$leave_scope(&root_aggregate_handle, &stream_handle,
&scope code);
if (FAILURE(status)) return(status);

/* Close the file */
status= cda$close file(&stream handle,
if (FAILURE(status)) return(status);

&file~handle);

/* Delete the root aggregate */
status= cda$delete root aggregate(&root aggregate handle);
if (FAILURE(status)) ret~rn(status);
return 1;
}

This example illustrates the use of both methods of incremental writing: using
the PUT AGGREGATE routine with a completed segment or using ENTER
SCOPE and incrementally writing the segment's content. This program creates a
DDIF file whose analysis would appear as follows:

8-74

CDA Toolkit Routines

ENTER SCOPE
DDIF DOCUMENT
{

DDF DESCRIPTOR
{

DSC MAJOR VERSION 1
DSC- MINOR- VERSION 0
DSC PRODUCT IDENTIFIER
DSC- PRODUCT- NAME

Longword Integer
Longword Integer
"%H54657374"
! Byte string

"Test"

(

ISO LATINl

"Example Application"

)
}

DDF HEADER
{

}

DDF CONTENT
{

SEG- SPECIFIC- ATTRIBUTES
{

SGA_CONTENT_CATEGORY

T CATEGORY

"$T"

}

SEG CONTENT
{

TXT CONTENT

"%H48656C6C6F"

Byte string

"Hello"

}
{

SEG- SPECIFIC- ATTRIBUTES
SGA CONTENT CATEGORY

T CATEGORY

"$T"

}

SEG CONTENT
{

TXT CONTENT

"%H5468657265"

HRD DIRECTIVE

DIR NEW PAGE

Byte string

"There"

}

{

Integer

}

}
}

}

CDA Toolkit Routines

8-75

ERASE ITEM

ERASE ITEM
Erases (sets to empty) the contents of an item within an aggregate. If you erase
an item that is indexed, the index of each subsequent item (each item with a
higher index) decreases by 1.

VAX FORMAT
status = cda$erase_item

(root-aggregate-handle ,aggregate-handle
,aggregate-item [,aggregate-index])

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

root-aggregate-handle

aggregate-handle

aggregate-item

8-76

CDA Toolkit Routines

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

ERASE ITEM

Argument

Argument Information

aggregate-index

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

C FORMAT

status= CdaEraseltem
(root_aggregate_handle, aggregate_handle,
aggregate_item, aggregate_index)

Argument Information
unsigned long CdaEraseitem(root_aggregate_handle,
aggregate_handle, aggregate_item,
aggregate_index)
unsigned long
root aggregate handle;
unsigned long
aggregate_handle;
unsigned long
aggregate_item;
unsigned long
aggregate_index;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle
Identifier of the root aggregate of which the aggregate containing the item is a
part. This handle is returned by a call to either the OPEN FILE routine or the
CREATE ROOT AGGREGATE routine.
aggregate-handle
Identifier of the aggregate containing the item to be erased.
aggregate-item
Identifying code of the item to be erased, expressed as a symbolic constant. The
DDIF aggregate item symbolic constants are defined in the file ddif$def.h on
VMS systems and in the file ddif_def.h on ULTRIX systems and are discussed
in Chapter 4. The DTIF aggregate item symbolic codes are defined in the file

CDA Toolkit Routines

8-77

ERASE ITEM

dtif$def.h on VMS systems and in the file dtif_def.h on ULTRIX systems and are
described in Chapter 5.
aggregate-index

Index of the item to be erased (relative to 0). This argument is required whenever
the notation "Array of' appears in the data type of the specified item handle.
Otherwise, this argument is ignored and may be omitted. If an address of 0 is
specified, all array elements in the item are erased.

Description
The ERASE ITEM routine erases (sets to empty) the contents of an item within
an aggregate. If you erase an item that is indexed, the index of each subsequent
item (each item with a higher index) decreases by 1. If you specify 0, all array
elements in the item are erased.
Note that if you erase an item that contains the handle of a subaggregate, the
subaggregate is deleted.

RETURN VALUES

Return Value

Description

CDA$_NORMAL
CDA$_INVAGGTYP
CDA$_INVITMCOD
CDA$_EMPTY

Normal successful completion.

CDA$_INDEX
CDA$_VAREMPTY

Index exceeds array bounds.

CDA$_VARINDEX
CDA$_VARVALUE

8-78 CDA Toolkit Routines

Invalid aggregate type.
Invalid item code.
Item is empty.
Variant item is empty.
Variant index exceeds bounds.
Variant value is undefined.

FIND DEFINITION

FIND DEFINITION
Looks up the specified definition in a list of definitions.

VAX FORMAT
status

=cda$find_definition
(root-aggregate-handle ,aggregate-type ,but-Jen
,buf-adr ,aggregate-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

root-aggregate-handle

aggregate-type

buf-len

buf-adr

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

vector_byte_unsigned

Data type:

byte (unsigned)

Access:

read only

Mechanism:

by reference, array reference

CDA Toolkit Routines 8-79

FIND DEFINITION

Argument

Argument Information

aggregate-handle

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

C FORMAT
status = CdaFindDefinition
(root_aggregate_handle, aggregate_type, buf_len,
buf_adr, aggregate_handle)

Argument Information
unsigned long CdaFindDefinition(root_aggregate_handle,
aggregate_type, buf_len, buf_adr,
aggregate handle)
unsigned long
root_aggregate_handle;
unsigned long
aggregate type;
unsigned long
buf len; unsigned char
*buf_adr;
unsigned long
*aggregate_handle;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle
Identifier of the root aggregate with which the definition aggregate being searched
for is associated. This handle is returned by a call to either the OPEN FILE
routine or the CREATE ROOT AGGREGATE routine.
aggregate-type
The type of definition aggregate being searched for, expressed as a symbolic
constant. The DDIF aggregate type symbolic constants are defined in the file
ddif$def.h on VMS systems and in the file ddif_def.h on ULTRIX systems and are
discussed in Chapter 4. The DTIF aggregate type symbolic codes are defined in
the file dtif$def.h on VMS systems and in the file dtif_def.h on ULTRIX systems
and are described in Chapter 5.

8-80 CDA Toolkit Routines

FIND DEFINITION
but-Jen
Length of the buffer (in bytes) specified by buf-ad.r.
buf-adr
The buffer that contains the selector value used to indicate the desired definition from the list of definitions. The definition aggregate types DDIF$_FTD,
DDIF$_LSD, DDIF$_PHD, DDIF$_ERF, and DDIF$_PTD are identified in a
series of definitions by a unique number. Therefore, for these aggregate types,
the buf-ad.r value must be a longword. For aggregate types DDIF$_CTD,
DDIF$_TYD, and DDIF$_SGB, which are assigned string labels, the value must
be a string.
aggregate-handle
Receives a value that identifies the newly located definition aggregate. This
handle must be used in all subsequent operations on that aggregate.

Description
The FIND DEFINITION routine looks up the specified definition in a series of definition aggregates. For example, if you have several font definition
(DDIF$_FTD) aggregates and you want to retrieve the definition of the font identified by the index 3, you would invoke this routine, specifying the aggregatetype as DDIF$_FTD and the selector value (buf-adr) as 3. The aggregate types
that can be specified for this routine are as follows:
DDIF$_CTD

Content definition aggregate

DDIF$_ERF

External reference aggregate

DDIF$_FTD

Font definition aggregate

DDIF$_LSD

Line style definition aggregate

DDIF$_PHD

Path definition aggregate

DDIF$_PTD

Pattern definition aggregate

DDIF$_SGB

Segment bindings aggregate

DDIF$_TYD

Type definition aggregate

In order for this routine to return the correct information, you must have specified
one or more of the following processing options in the call to the CREATE ROOT
AGGREGATE routine:
•

DDIF$_INHERIT_ATTRIBUTES

•

DDIF$_EVALUATE_CONTENT

•

DDIF$_RETAIN_DEFINITIONS

This routine is only valid when you are using the aggregate (incremental) method
of document conversion, because the definition being determined is dependent
upon the current location in the document. If you call this routine when you are
performing document method conversion, the current position is the top of the
document, so that no definition is available.

CDA Toolkit Routines 8-81

FIND DEFINITION

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA$_INVAGGTYP

Invalid aggregate type

CDA$_INVBUFLEN

Invalid buffer length

CDA$_DEFNOTFOU

Definition not found

8-82 CDA Toolkit Routines

FIND TRANSFORMATION

FIND TRANSFORMATION
Returns the current transformation matrix values.

VAX FORMAT
status= cda$find_transformation

(root-aggregate-handle , transformation)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

root-aggregate-handle

transformation

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

address

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

C FORMAT
status = CdaFindTransformation

(root_aggregate_handle, transformation)

CDA Toolkit Routines 8-83

FIND TRANSFORMATION

Argument Information
unsigned long CdaFindTransformation(root_aggregate_handle,
transformation)
unsigned long
root aggregate handle;
float
**transformation;

RETURNS
status

A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle

Identifier of the root aggregate. This handle is returned by a call to either the
OPEN FILE routine or the CREATE ROOT AGGREGATE routine.
transformation

Receives the address of a vector of nine single-precision floating-point elements.
The elements of this vector specify the current content transformation in column
order. For example, the elements of the following array would be returned in the
order A, B, C, D, E, F, G, H, I.
A
B

D
E
F

G
H
I

Description
The FIND TRANSFORMATION routine returns the current values of the
transformation matrix specified by the DDIF$_TRN aggregate. In order for this
routine to return the correct information, you must have specified one or more of
the following processing options in the call to the CREATE ROOT AGGREGATE
routine:
•

DDIF$_INHERIT_ATTRIBUTES

•

DDIF$_EVALUATE_CONTENT

•

DDIF$_RETAIN_DEFINITIONS

8-84 CDA Toolkit Routines

FIND TRANSFORMATION

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA$_DEFNOTFOU

Definition not found

CDA Toolkit Routines 8-85

FLUSH STREAM

FLUSH STREAM
Flushes the contents of the stream and ensures that the data has been physically
transferred to the receiving medium.

VAX FORMAT
status= cda$flush_stream
(stream-handle , flush-rtn , flush-prm)

Argument Information

Argument

Argument Information

status

VMS usage:

stream-handle

flush-rtn

flush-prm

Data type:

cond_value
longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:
Access:

longword (unsigned)

Mechanism:

by reference

VMS usage:

procedure

read only

Data type:

procedure entry mask

Access:

call after stack unwind

Mechanism:

by reference, procedure reference

VMS usage:

context

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by value

C FORMAT
status = CdaFlushStream
(stream_handle, flush_rtn, flush_prm)

8-86 CDA Toolkit Routines

FLUSH STREAM

Argument Information
unsigned long CdaFlushStream(stream_handle,
flush_rtn, flush_prm)
unsigned long
stream_handle;
unsigned long
(*flush_rtn) ();
unsigned long
flush_prm;

RETURNS
status

A condition value indicating the return status of the routine call.

Arguments
stream-handle

Identifier of the output stream to be flushed. This handle is returned by a call to
the CREATE STREAM routine.
flush-rtn

Address of a stream flush routine. If you specify 0 for this argument, a default
flush-rtn is used. If you specify a value other than the default for this argument,
you must also specify a value for the fiush-prm argument. For more information,
see Chapter 9.
flush-prm

User context to be passed to the stream flush routine. ·This argument should
contain the value of the put-prm argument passed in a call to the CREATE
STREAM routine. For more information, see Chapter 9.

Description
The FLUSH STREAM routine writes any buffered data to an output stream and
ensures that the data has been physically transferred to the receiving medium.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

Any error returned by the file routines.

CDA Toolkit Routines 8-87

GET AGGREGATE

GET AGGREGATE
Reads the next aggregate from the specified stream.

VAX FORMAT
status = cda$get_aggregate

(root-aggregate-handle ,stream-handle
,aggregate-handle ,aggregate-type)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

root-aggregate-handle

stream_handle

aggregate-handle

aggregate-type

8-88

CDA Toolkit Routines

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

GET AGGREGATE

C FORMAT

status = CdaGetAggregate
(root_aggregate_handle, stream_handle,
aggregate_handle, aggregate_type)

Argument Information
unsigned long CdaGetAggregate(root_aggregate_handle,
stream_handle, aggregate_handle,
aggregate_type)
unsigned long
root_aggregate_handle;
unsigned long
stream_handle;
unsigned long
*aggregate_handle;
unsigned long
*aggregate_type;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle
Identifier of the root aggregate associated with the aggregate to be read. This
handle is returned by a call to either the OPEN FILE routine or the CREATE
ROOT AGGREGATE routine.

When reading aggregates using this routine, you must use the same value for
root-aggregate-handle consistently to read all the aggregates in the compound
document. Once you have read all the aggregates, you cannot specify the same
root-aggregate-handle again when calling this routine.
stream-handle
Identifier of the stream from which the aggregate is to be read. This handle
is returned by a call to either the OPEN FILE routine or the OPEN STREAM
routine.
aggregate-handle
Receives the handle of the retrieved aggregate. This aggregate handle is used to
identify the retrieved aggregate to any other aggregate transfer procedure.
aggregate-type
Receives the aggregate type. The DDIF aggregate type symbolic codes are defined
in the file ddif$def.h on VMS systems and in the file ddif_def.h on ULTRIX
systems and are described in Chapter 4. The DTIF aggregate type symbolic codes
CDA Toolkit Routines 8-89

GET AGGREGATE

are defined in the file dtif$def.h on VMS systems and in the file dtif_def.h on
ULTRIX systems and are described in Chapter 5.
Valid aggregate types are any one of the primary DDIF or DTIF aggregates:
Aggregate Type

Meaning

DDIF$_DSC

Document descriptor

DDIF$_DHD

Document header

DDIF$_SEG
DDIF$_TXT

Document segment
Text content

DDIF$_GTX

General text content

DDIF$_HRD

Hard directive

DDIF$_SFT

Soft directive

DDIF$_HRV

Hard value directive

DDIF$_SFV

Soft value directive

DDIF$_BEZ

Bezier curve content

DDIF$_LIN

Polyline content

DDIF$_ARC

Arc content

DDIF$_FAS

Fill area set content

DDIF$_IMG

Image content

DDIF$_CRF

Content reference

DDIF$_PVT

Private content

DDIF$_GLY

Layout galley

DDIF$_EOS
DDIF$_EXT

External content

DTIF$_DSC

Document descriptor

DTIF$_HDR

Document header

End of segment

DTIF$_TBL

Table definition

DTIF$_ROW

Row definition

DTIF$_CLD

Cell data

These aggregates are the only aggregates that can be returned by the GET
AGGREGATE routine. All other aggregates are somehow connected to these
aggregates and can be located by traversing the structure using other routines
(such as LOCATE ITEM and NEXT AGGREGATE). If the aggregate type is
DDIF$_EOS (end of segment), the aggregate-handle is 0 to indicate that the
nested segment has been completed.

Description
The GET AGGREGATE routine reads the next primary aggregate from a
specified stream. (The primary aggregates are listed in the description of the
aggregate-type argument.)

8-90

CDA Toolkit Routines

GET AGGREGATE

The GET AGGREGATE routine has three restrictions on the information returned:
•

The GET AGGREGATE routine returns only primary aggregates (as listed
in the description of the aggregate-type argument). Other aggregates are
returned attached to the primary aggregates.

•

When you call the GET AGGREGATE routine for a segment aggregate, it returns all the items in the segment aggregate (and all its substructure) except
for the content item (DDIF$_SEG_CONTENT) and its substructure.

•

When you call the GET AGGREGATE routine and it returns a DDIF$_EXT
aggregate, the encoding items (DDIF$_EXT_ENCODING_C, DDIF$_EXT_
ENCODING, and DDIF$_EXT_ENCODING_L will be empty. A call to the
GET EXTERNAL ENCODING routine must be made before the next call to
get AGGREGATE.

•

Content aggregates are returned one at a time, following the segment
aggregate.

•

When you are processing a document, you must observe the occurrence
of DDIF$_EOS aggregates, which denote the end of a segment's content.
It is also important to note that the DDIF$_EOS aggregate is a dummy
aggregate; it is not an actual aggregate and therefore does not have a valid
aggregate handle. Instead, it is simply an aggregate type that is returned to
indicate the end of a segment. The next aggregate returned is a sibling to
that segment.

The GET AGGREGATE routine reads the primary aggregates in a document
in a hierarchical fashion. That is, whenever GET AGGREGATE encounters a
segment, your next call to GET AGGREGATE descends to the next level of the
hierarchy and reads the contents of that segment before reading the remaining
content of the parent segment. The GET AGGREGATE routine only returns to
the parent segment's level of hierarchy when it encounters a DDIF$_EOS (end of
segment) aggregate to indicate that the nested segment is completed.
For example, consider a document that contains a document root aggregate
(DDIF$_DDF), a document descriptor (DDIF$_DSC), a document header (DDIF$_
DHD), and a root segment (DDIF$_SEG) with text content (DDIF$_TXT), a
nested segment (DDIF$_SEG), and Bezier content (DDIF$_BEZ), where the
segment nested under the root segment contains arc content (DDIF$_ARC). This
document is illustrated in Figure 8-1.

CDA Toolkit Routines 8-91

GET AGGREGATE
Figure 8-1:

Example Document

DDF

TXT

SEG i---• BEZ i---• EOS

ARC

EOS
ZK-1270A-GE

Following these generalized rules, the aggregates returned by consecutive calls to
GET AGGREGATE would be as follows:
1. DDIF$_DSC
2. DDIF$_DHD
3. DDIF$_SEG (root segment)
4. DDIF$_TXT
5. DDIF$_SEG (segment with nested arc content)
6. DDIF$_ARC (nested arc content aggregate)
7. DDIF$_EOS (dummy aggregate indicating end of segment with nested arc
content)
8. DDIF$_BEZ (Bezier content)
9. DDIF$_EOS (dummy aggregate indicating end of root segment)

8-92 CDA Toolkit Routines

GET AGGREGATE

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA$_ENDOFDOC

End of document

CDA$_INVDOC

Invalid document content

Any error returned by the memory allocation routines.
Any error returned by the file routines.

CDA Toolkit Routines 8-93

GET ARRAY SIZE

GET ARRAY SIZE
Determines the number of elements present in an array-valued aggregate item.

VAX FORMAT
status= cda$get_array_size
(aggregate-handle , aggregate-item , array-size)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

aggregate-handle

aggregate-item

array-size

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:
Data type:

longword_unsigned
longword (unsigned)

Access:

write only

Mechanism:

by reference

C FORMAT
status= CdaGetArraySize
(aggregate_handle, aggregate_item, array_size)

8-94

CDA Toolkit Routines

GET ARRAY SIZE

Argument Information
unsigned long CdaGetArraySize(aggregate_handle,
aggregate item, array size)
unsigned long aggregate_handle;
unsigned long
aggregate_item;
unsigned long
*array_size;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
aggregate-handle
Identifier of the aggregate containing the array-valued item.
aggregate-item
Identifying code of the array-valued aggregate item, expressed as a symbolic
constant. The DDIF aggregate item symbolic constants are defined in the module
ddif$def.h on VMS systems and in the module ddif_def.h on ULTRIX systems and
are defined in Chapter 4. The DTIF aggregate type symbolic codes are defined in
the file dtif$def.h on VMS systems and in the file dtif_def.h on ULTRIX systems
and are described in Chapter 5.
array-size
Receives the number of elements present in the array-valued item. Because the
index is zero based, this number is equal to 1 more than the value of the highest
valid aggregate index.

Description
The GET ARRAY SIZE routine determines the number of elements present in an
array-valued aggregate item.

CDA Toolkit Routines

8-95

GET ARRAY SIZE

RETURN VALUES

8-96

Return Value

Description

CDA$_NORMAL

Normal successful completion.

CDA$_INVAGGTYP

Invalid aggregate type.

CDA$_INVITMCOD

Invalid item code.

CDA$_EMPTY

Item is empty.

CDA Toolkit Routines

GET DOCUMENT

GET DOCUMENT
Reads an entire compound document from the specified stream.

VAX FORMAT
status

=cda$get_document
(root-aggregate-handle ,stream-handle)

Argument Information

Argument

Argument Information

status

root-aggregate-handle

stream-handle

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:
Data type:

identifier
longword (unsigned)

Access:

read only

Mechanism:

by reference

C FORMAT
status

=CdaGetDocument
(rooLaggregate_handle, stream_handle)

CDA Toolkit Routines 8-97

GET DOCUMENT

Argument Information
unsigned long CdaGetDocument(root_aggregate_handle,
stream handle)
unsigned long
root aggregate handle;
unsigned long
stream_handle;-

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle
Identifier of the root aggregate associated with the document to be read. This
handle is returned by a call to either the OPEN FILE routine or the CREATE
ROOT AGGREGATE routine.

Once you read an entire document, you cannot call the GET DOCUMENT routine
specifying the same root aggregate handle again. That is, you can only read a
document associated with a particular root aggregate once.
stream-handle
Identifier of the stream from which the document is to be read. This handle
is returned by a call to either the OPEN FILE routine or the OPEN STREAM
routine.

Description
The GET DOCUMENT routine reads an entire document from the specified
stream. This routine is used by a front end module to read an entire compound
document file into memory.
Upon completion of the call to this routine, the entire document is present in
memory in aggregates that are linked from the document root aggregate.

8-98 CDA Toolkit Routines

GET DOCUMENT

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA$_INVAGGTYP

Invalid aggregate type

CDA$_INVDOC

Invalid document content

Any error returned by the memory allocation routines.
Any error returned by the file routines.

CDA Toolkit Routines

8-99

GET EXTERNAL ENCODING

GET EXTERNAL ENCODING
Reads the value of an external encoding from the specified stream and stores it as
the value of the agg$_EXT_ENCODING item in the appropriate aggregate, which
can be DDIF$_EXT, DTIF$_EXT, or ESF$_EXT.

VAX FORMAT

status= cda$get_external_encoding
(root-aggregate-handle ,stream-handle
,aggregate-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:
Mechanism:

read only
by reference

VMS usage:

identifier

Data type:

longword (unsigned)

root-aggregate-handle

stream-handle

aggregate-handle

8-100 CDA Toolkit Routines

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

modify

Mechanism:

by reference

GET EXTERNAL ENCODING

C FORMAT

status

=CdaGetExternalEncoding
(rooLaggregate_handle, stream_handle,
aggregate_handle)

Argument Information
unsigned long CdaGetExternalEncoding(root_aggregate_handle,
stream_handle, aggregate_handle)
unsigned long
root_aggregate_handle;
unsigned long
stream_handle;
unsigned long
*aggregate_handle;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle
Identifier of the root aggregate. This handle is returned by a call to either the
OPEN FILE routine or the CREATE ROOT AGGREGATE routine.
stream-handle
Identifier of the stream containing the external encoding. This handle is returned
by a call to either the OPEN FILE routine or the OPEN STREAM routine.
aggregate-handle
Identifier of an aggregate of type DDIF$_EXT, DTIF$_EXT, or ESF$_EXT. The
external encoding value that is read from the stream is written to the agg$_EXT_
ENCODING item in the appropriate aggregate, where agg refers to the specific
aggregate type. That aggregate becomes the root aggregate for the external
document.

Description
The GET EXTERNAL ENCODING routine reads the value of an external encoding and stores the value in the agg$_EXT_ENCODING item of the aggregate
specified by aggregate-handle, which can be an aggregate of type DDIF$_EXT,
DTIF$_EXT, or ESF$_EXT. If the external encoding is DDIF or DTIF, the value
stored is the handle of a DDIF or DTIF root aggregate, which contains the entire
document in the external encoding.
CDA Toolkit Routines 8-101

GET EXTERNAL ENCODING
If used, the GET EXTERNAL ENCODING routine must be invoked immediately
after the specified aggregate has been returned by the GET AGGREGATE
routine. Alternatively, the caller can read the DDIS encoding of an inner
document by calling the CDA Toolkit input routines on an inner document root
aggregate.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA$_INVDOC

Invalid document

CDA$_INVAGGTYP

Invalid aggregate type

8-102 CDA Toolkit Routines

GET STREAM POSITION

GET STREAM POSITION
Returns the current position in and size of a CDA data stream.

VAX FORMAT
status= cda$get_stream_position
(stream-handle ,position-rtn ,position-prm
, stream-position , stream-size)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

stream-handle

position-rtn

position-prm

stream-position

Access:

read only

Mechanism:

by reference

VMS usage:

procedure

Data type:

procedure entry mask

Access:

call after stack unwind

Mechanism:

by reference

VMS usage:

context

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by value

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

CDA Toolkit Routines 8-103

GET STREAM POSITION

Argument

Argument Information

stream-size

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

C FORMAT

status = CdaGetStream Position
(stream_handle, position_rtn, position_prm,
stream_position, stream_size)

Argument Information
unsigned long CdaGetStreamPosition(stream_handle,
position_rtn, position_prm,
stream position, stream size)
unsigned long
stream handle;
unsigned long
(*position rtn) ();
unsigned long
position prm;
unsigned long
*stream_position;
unsigned long
*stream_size;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
stream-handle
Identifier of the stream. The handle is returned by a call to either the OPEN
STREAM routine or the OPEN FILE routine.
position-rtn
Address of a get-position routine. The calling sequence for a get-position routine
is defined in Chapter 11. If you specify 0 for this argument, the CDA Toolkit
provides a default get-position routine. If you specify a value other than the
default for this parameter, you must also specify a value for the position-prm
argument.

8-104

GOA Toolkit Routines

GET STREAM POSITION
position-prm
User context to be passed to the get-position routine. This argument should
contain the value of the get-prm argument passed in a call to the OPEN
STREAM or CREATE STREAM routine, or the value of the file handle in a call
to the OPEN FILE or CREATE FILE routine. If you specify a value for the
position-rtn argument, you must also specify a value for this argument.
stream-position
Receives the current position (in bytes) as measured from the start of the input
stream being processed.
stream-size
Receives the total size (in bytes) of the input stream being processed.

Description
The GET STREAM POSITION routine returns the current position and total size
of the CDA data stream being processed.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA Toolkit Routines

8-105

GET TEXT POSITION

GET TEXT POSITION
Returns the current position in and size of a text file.

VAX FORMAT
status= cda$get_text_position
(file-handle , file-position , file-size)

Argument Information

Argument

Argument Information.

status

VMS usage:
Data type:

file-handle

file-position

file-size

cond_value
longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:
Mechanism:

read only
by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

VMS usage:
Data type:

longword_unsigned
longword (unsigned)

Access:

write only

Mechanism:

by reference

C FORMAT
status = CdaGetTextPosition
(file_handle, file_position, file_size)

8-106 CDA Toolkit Routines

GET TEXT POSITION

Argument Information
unsigned long CdaGetTextPosition(file handle,
file position, file size)
unsigned long
file handle;
unsigned long
*file_position;
unsigned long
*file_size;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
file-handle
Identifier of the text file being processed. This handle is returned by a call to the
OPEN TEXT FILE routine.
file-position
Receives the current position (in bytes) as measured from the start of the input
text file being processed.
file-size
Receives the total size (in bytes) of the text file being processed.

Description
The GET TEXT POSITION routine returns the current position in and total size
of an input text file being processed.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA Toolkit Routines 8-107

INSERT AGGREGATE

INSERT AGGREGATE
Inserts an aggregate into a sequence. The location at which the aggregate is to
be inserted is determined by specifying the preceding aggregate in the sequence.

VAX FORMAT

status= cda$insert_aggregate

(aggregate-handle ,prev-aggregate-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

aggregate-handle

prev-aggregate-handle

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:
Data type:

identifier
longword (unsigned)

Access:

read only

Mechanism:

by reference

C FORMAT

status= CdalnsertAggregate

(aggregate_handle, prev_aggregate_handle)

8-108 CDA Toolkit Routines

INSERT AGGREGATE

Argument Information
unsigned long CdainsertAggregate(aggregate_handle,
prev_aggregate_handle)
unsigned long
aggregate_handle;
unsigned long
prev_aggregate_handle;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
aggregate-handle
Identifier of the aggregate to be inserted into the sequence.
prev-aggregate-handle
Identifier of the aggregate after which the aggregate identified by aggregatehandle is to be inserted in the sequence.

Description
The INSERT AGGREGATE routine inserts an aggregate into a sequence. The
location at which the aggregate is to be inserted is indicated by specifying the
preceding aggregate in the sequence.
If the aggregate indicated by aggregate-handle is the first aggregate in its
own sequence, this entire sequence is inserted into the sequence containing the
aggregate specified by prev-aggregate-handle. If the aggregate specified as
aggregate-handle is part of a sequence but is not the first aggregate in that
sequence, or if it is the value of an item, an error is returned.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA$_INVINSERT

Aggregate already in a sequence

CDA Toolkit Routines

8-109

INSERT AGGREGATE

Example
This example illustrates the use of the INSERT AGGREGATE routine to insert
an aggregate into a sequence.

aggregate_type = DDIF$_PTH;
status = cda$create_aggregate(&root_aggregate_handle,
&aggregate type,
&inner_aggregate_handle);
if (FAILURE(status)) return(status);
aggregate item = DDIF$ SGA FRM OUTLINE;
item_length = 4;
status = cda$store_item(&root_aggregate_handle, &aggregate_handle,
&aggregate item,&item length,
&inner_aggregate_handle);
if (FAILURE(status)) return(status);
aggregate_item = DDIF$_PTH_C;
local_length = sizeof(integer_value);
integer value = DDIF$K PATH REFERENCE;
status ~ cda$store item(&root aggregate handle,
&inner_aggregate_handle,
&aggregate_item,
&local_length, &integer_value);
if (FAILURE(status)) return(status);
aggregate_item = DDIF$_PTH_REFERENCE;
local length= sizeof(integer value);
integer value = 1;
status ~ cda$store_item(&root_aggregate_handle,
&inner_aggregate_handle,
&aggregate_item,
&local_length, &integer_value);
if (FAILURE(status)) return(status);
aggregate_type = DDIF$_PTH;
status = cda$create_aggregate(&root_aggregate_handle,
&aggregate type,
&inner_aggregate_handle_2);
if (FAILURE(status)) return(status);
status = cda$insert_aggregate(&inner_aggregate_handle_2,
&inner aggregate handle);
if (FAILURE(status)) return(status);aggregate item = DDIF$ PTH C;
local_length = sizeof(integer_value);
integer value = DDIF$K PATH BEZIER;
status ~ cda$store_itern(&root_aggregate_handle,
&inner_aggregate_handle_2,
&aggregate_item,
&local_length, &integer_value);
if (FAILURE(status)) return(status);

8-110

CDA Toolkit Routines

INSERT AGGREGATE
aggregate item = DDIF$ PTH BEZ PATH C;
local length= sizeof (integer value);
integer value = DDIF$K VALUE CONSTANT;
aggregate_index = O; status = cda$store_item(&root_aggregate_handle,
&inner aggregate handle 2,
&aggregate_item,-&local=length,
&integer_value, &aggregate_index);
if (FAILURE(status)) return(status);
aggregate_item = DDIF$_PTH_BEZ_PATH;
local length= sizeof(integer value);
integer_value = 20;
aggregate_index = O;
status = cda$store_item(&root_aggregate_handle,
&inner aggregate handle 2,
&aggregate_item,&local_length, &integer_value,
&aggregate_index);
if (FAILURE(status)) return(status);

CDA Toolkit Routines

8-111

LEAVE SCOPE

LEAVE SCOPE
Completes a document that was incrementally written.

VAX FORMAT
status

=cda$1eave_scope
(root-aggregate-handle , stream-handle
, scope-code)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

root-aggregate-handle

stream-handle

scope-code

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

C FORMAT
status

=CdaleaveScope
(root_ aggregate_handle, stream_handle,
scope_code)

8-112 CDA Toolkit Routines

LEAVE SCOPE

Argument Information
unsigned long CdaLeaveScope(root_aggregate_handle,
stream_handle, scope_code)
unsigned long
root_aggregate_handle;
unsigned long
stream_handle;
unsigned long
scope_code;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle
Identifier of the root aggregate associated with the document being incrementally
written. This handle is returned by a call to either the OPEN FILE routine or
the CREATE ROOT AGGREGATE routine.
stream-handle
Identifier of the stream associated with the document being incrementally
written. This handle is returned by a call to either the CREATE FILE routine or
the CREATE STREAM routine.
scope-code
Symbolic constant identifying the scope to be completed. Valid values are as
follows:
Code

Meaning

DDIF$K_DOCUMENT_SCOPE

Document scope

DDIF$K_CONTENT_SCOPE

Content scope

DDIF$K_SEGMENT_SCOPE

Segment scope

DTIF$K_DOCUMENT_SCOPE

Document scope

DTIF$K_TABLE_SCOPE

Table scope

DTIF$K_ROW_SCOPE

Row scope

DTIF$K_CELLS_SCOPE

Cell scope (for all cells in a row)

Description
The LEAVE SCOPE routine completes a compound document that was incrementally written. For more information on incremental writing of documents, see the
description for the ENTER SCOPE routine.

CDA Toolkit Routines 8-113

LEAVE SCOPE

RETURN VALUES

Return Value

Description

CDA$_NORMAL
CDA$_INVSCOCOD

Normal successful completion
Invalid scope code

Any errors returned by the file routines.

8-114 CDA Toolkit Routines

LOCATE ITEM

LOCATE ITEM
Locates an item within an aggregate by returning its address.

VAX FORMAT
status = cda$1ocate_item
(root-aggregate-handle ,aggregate-handle
,aggregate-item ,item-address ,item-length
[,aggregate-index] [,add-info])

Argument Information

Argument
status

root-aggregate-handle

aggregate-handle

aggregate-item

item-address

Argument Information
VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

address

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

CDA Toolkit Routines 8-115

LOCATE ITEM

Argument

Argument Information

item-length

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:
Mechanism:

write only

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read or write

Mechanism:

by reference

aggregate-index

add-info

by reference

C FORMAT
status

=Cdalocateltem
(root_aggregate_handle, aggregate_handle,
aggregate_item, item_address, item_length,
aggregate_index, add_info)

Argument Information
unsigned long CdaLocateitem(root aggregate handle,
aggregate_handle, aggregate_item,
item address, item length,
aggregate_index, add_info)
unsigned long
root aggregate handle;
unsigned long
aggregate_handle;
unsigned long
aggregate_item;
unsigned char
*item_address;
unsigned long
*item_length;
unsigned long
aggregate index;
unsigned long
*add_info;

RETURNS
status
A condition value indicating the return status of the routine call.

8-116 CDA Toolkit Routines

LOCATE ITEM

Arguments
root-aggregate-handle

Identifier of the root aggregate with which the aggregate containing the item to
be located is associated. This identifier is returned by a call to either the OPEN
FILE routine or the CREATE ROOT AGGREGATE routine.
You must use identical memory management procedures when storing and
locating an item within an aggregate, to ensure consistent treatment of memory
allocation and deallocation.
aggregate-handle

Identifier of the aggregate containing the item to be located.
aggregate-item

Identifying code of the item, expressed as a symbolic constant. The DDIF
aggregate item symbolic constants are defined in the file ddif$def.h on VMS
systems and in the file ddif_def.h on ULTRIX systems and are described in
Chapter 4. The DTIF aggregate type symbolic codes are defined in the file
dtif$def.h on VMS systems and in the file dtif_def.h on ULTRIX systems and are
described in Chapter 5.
A user context item named DDIF$_USER_CONTEXT for DDIF aggregates
and DTIF$_USER_CONTEXT for DTIF aggregates is available within every
aggregate. This item is a longword that can be used by the application for any
purpose.
For use by applications, a DDIF$_AGGREGATE_TYPE item and a DTIF$_
AGGREGATE_TYPE item are defined for every DDIF and DTIF aggregate type,
respectively. It is a read-only item and, consequently, may be located using
only this routine. If you specify this aggregate item, it returns the type of the
aggregate.
item-address

Receives the address of the item's value. This storage area can only be read by
the calling program; that is, it is read-only. The returned item-address is valid
until either the STORE ITEM or the ERASE ITEM routine is called for any item
in the aggregate, or until the aggregate is deleted.
If the item being located contains an aggregate handle, a call to this routine
returns the address of the aggregate handle. In order to use this aggregate

handle, you must "dereference" it. For example, in C you would do the following:
cda$locate item(&root agg handle, &agg handle, &agg item,
&sub_agg,-&item_length~ &agg_index,-&add_info);

The sub_agg parameter receives the address of the aggregate handle of the
subaggregate. To use this handle, you would do the following:
agg handle = *sub agg;
cda$locate item(&root agg handle, &agg handle, &agg item,
&buf_addr~ &buf_length~ &agg_index,-&add_info);

If there are subsequent aggregates in a sequence, you should use the NEXT

AGGREGATE routine to retrieve the subsequent aggregates.

CDA Toolkit Routines

8-117

LOCATE ITEM

item-length

Receives the length (in bytes) of the item's value.
aggregate-index

Index of the item (relative to 0). This argument is required whenever the notation
"Array of' appears in the data type of the specified item handle. Otherwise, this
argument is only required if the add-info argument is also required.
add-info

Receives a data type-specific modifier for the data types character string and
string with add-info. Selects the floating-point format to be returned for items
with the data type general floating-point. Receives an integer scaling factor for
the data type scaled integer. For data types other than character string, string
with add-info, general floating-point, and scaled integer, this argument is not
written and may be omitted.
For the data type character string, the add-info parameter receives the character
set designator. For the data type string with add-info, if the string value is
equal to one of the standard tag values, the add-info parameter receives a value
that identifies the tag. For the data type scaled integer, the add-info parameter
receives an integer scaling factor. For the data type general floating-point, the
add-info parameter contains a value that selects the format for the floating-point
value to be returned. For add-info values for the general floating-point type, see
Table 1-1. Otherwise, add-info receives a value that indicates that the tag is
private.

Description
The LOCATE ITEM routine determines the address of an item within an
aggregate.
If the located item is encoded as the handle of an aggregate, you receive the
address of the aggregate handle. To use this handle in subsequent routine calls,
you must first "dereference" it. (For more information, see the description of the
item-address argument.)
If the located item is encoded as an "Array of', the user must call the GET ARRAY
SIZE routine to determine the array size, and then use the LOCATE ITEM
routine to read each item in the array by incrementing the aggregate-index
argument.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion.

CDA$_1NVAGGTYP

Invalid aggregate type.

8-118 CDA Toolkit Routines

LOCATE ITEM

Return Value

Description

CDA$_INVITMCOD
CDA$_EMPTY

Invalid item code.

CDA$_INDEX
CDA$_VAREMPTY
CDA$_VARINDEX
CDA$_VARVALUE
CDA$_DEFAULT

Index exceeds array bounds.
Variant item is empty.

Item is empty.

Variant index exceeds bounds.
Variant value is undefined.
Value returned is either a default value that is not in the data
stream or is an inherited value if inheritance is enabled for the
root aggregate.

CDA Toolkit Routines 8-119

NEXT AGGREGATE

NEXT AGGREGATE
Locates the next aggregate in an aggregate sequence.

VAX FORMAT
status= cda$next_aggregate
(aggregate-handle ,next-aggregate-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

aggregate-handle

next-aggregate-handle

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:
Data type:

identifier
longword (unsigned)

Access:

write only

Mechanism:

by reference

C FORMAT
status= CdaNextAggregate
(aggregate_handle, nexLaggregate_handle)

8-120 CDA Toolkit Routines

NEXT AGGREGATE

Argument Information
unsigned long CdaNextAggregate(aggregate_handle,
next_aggregate_handle)
unsigned long
aggregate_handle;
unsigned long
*next_aggregate_handle;

RETURNS
status

A condition value indicating the return status of the routine call.

Arguments
aggregate-handle

Identifier of the aggregate to be used in locating the next aggregate.
next-aggregate-handle

Receives the handle of the aggregate that follows the aggregate specified by
aggregate-handle. If the aggregate specified by aggregate-handle is the last
aggregate in the sequence, next-aggregate-handle receives a value of 0.

Description
The NEXT AGGREGATE routine locates the next aggregate in a sequence
of aggregates. This aggregate is located using the preceding aggregate as a
reference. (The preceding aggregate is specified by the aggregate-handle
argument.)
To read the aggregates in a sequence, you must retrieve the aggregate handle
of the first aggregate using the LOCATE ITEM routine. (The handle of the
first aggregate in the sequence is stored as an item in the current aggregate.)
Once you have located the first item in the sequence using the LOCATE ITEM
routine, you can use the NEXT AGGREGATE routine to retrieve each additional
aggregate in the sequence. All aggregates in the sequence have been retrieved
when the status CDA$_ENDOFSEQ is returned.
For example, the DDIF$_CRF_TRANSFORM item in the DDIF$_CRF aggregate
is encoded as a sequence of DDIF$_TRN aggregates. To access the sequence
of DDIF$_TRN aggregates, you would first use the LOCATE ITEM routine to
read the handle of the first DDIF$_TRN aggregate that is stored in the DDIF$_
CRF_TRANSFORM item. You would then use the NEXT AGGREGATE routine
to return each additional aggregate in this encoded sequence, until the status
CDA$_ENDOFSEQ is returned.

CDA Toolkit Routines

8-121

NEXT AGGREGATE

If you are interested in retrieving aggregates from a particular input stream that
are not encoded as a sequence, refer to·the description of the GET AGGREGATE
routine.
NOTE

If several different aggregate types may be linked in sequence, locate
the aggregate type for the aggregate to determine its type (DDIF$_
AGGREGATE_TYPE item code).

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA$_ENDOFSEQ

No successor aggregate found

8-122 CDA Toolkit Routines

OBJECT ID TO AGGREGATE TYPE

OBJECT ID TO AGGREGATE TYPE
Translates an object identifier to a root aggregate type.

VAX FORMAT
status

=cda$object_id_to_aggregate_type
(buf-len ,buf-adr ,nam-len ,nam-adr ,act-nam-len
,aggregate-type}

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

buf-len

buf-adr

nam-len

nam-adr

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

array

Data tyPe:

longword (unsigned)

Access:

read only

Mechanism:

by reference, array reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:
Mechanism:

read only
by reference

VMS usage:
Data type:

array
longword (unsigned)

Access:

write only

Mechanism:

by reference, array reference

CDA Toolkit Routines 8-123

OBJECT ID TO AGGREGATE TYPE

Argument

Argument Information

act-nam-len

VMS usage:

aggregate-type

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

C FORMAT
status= CdaObjectldToAggregateType
(buf_len, buf_adr, nam_len, nam_adr, act_nam_len,

aggregate_type)

Argument Information
unsigned long CdaObjectidToAggregateType(buf_len,
buf_adr, nam_len, nam_adr,
act_nam_len, aggregate_type)
unsigned long
buf_len;
unsigned long
buf_adr[];
unsigned long
nam_len;
unsigned char
*nam_adr;
unsigned long
*act_nam_len;
unsigned long
*aggregate_type;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
but-fen
Length (in bytes) of the object identifier buffer.
buf-adr
Address of the object identifier.

8-124 CDA Toolkit Routines

OBJECT ID TO AGGREGATE TYPE
nam-len
Length (in bytes) of the domain name buffer.
nam-adr
Receives the address of the domain name buffer.
act-nam-len
Receives the actual length (in bytes) of the domain name in the nam-adr buffer.
aggregate-type
Receives the translated aggregate type.

Description
The OBJECT ID TO AGGREGATE TYPE routine translates an object identifier
to a root aggregate type.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA$_INVAGGTYP

Invalid aggregate type

CDA Toolkit Routines 8-125

OPEN ·coNVERTER

OPEN CONVERTER
Activates a front end to process nested content, which can be in the same format
as the current document or in a different format.

VAX FORMAT
status = cda$open_converter

(standard-item-list , converter-context
, front-end-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

standard-item-list

converter-context

front-end-handle

C FORMAT
status

8-126

=CdaOpenConverter

CDA Toolkit Routines

Data type:

cond_value
longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

item_list_2

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference, array reference

VMS usage:

context

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

OPEN CONVERTER
(standard_item_list, converter_context,
fronLend_handle)

Argument Information
unsigned long CdaOpenConverter(standard_item_list,
converter context, front end handle)
unsigned long
*standard_Item=list;
unsigned long
converter_context;
unsigned long
*front_end_handle;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
standard-item-list
An item list that identifies the document source and destination, and can also
contain options to control processing.

Each entry in the item list is a 2-longword structure with the following format:

item code

buffer length
buffer address

To terminate the item list, you must specify the final entry or longword as 0.
Valid code values for the items in the standard-item-list are as follows:
CDA$_/NPUT_FORMAT

The parameter is the address and length of a string that specifies the input
document format.
CDA$_1NPUT_FRONT_END_PROCEDURE

The parameter is the address of the main entry point in the front end,
either ddif$read_format or dtif$read_format. The item list length field
must be 0. This item enables a caller to provide a front end that is part of
the calling application rather than a separate image. If this item code is
used, the CDA$_INPUT_FILE item can be used to pass any information (not
necessarily a file specification) to the front end.

CDA Toolkit Routines

8-127

OPEN CONVERTER
CDA$_1NPUT_FRONT_END_DOMAIN
The parameter is the address and length of a string that specifies the input
document domain (either DDIF or DTIF).
CDA$_/NPUT_FILE
The parameter is the address and length of the file specification of the input
document.
CDA$_/NPUT_DEFAULT
The parameter is the address and length of the default file specification of the
input document. If this parameter is omitted, the front end must supply an
appropriate backup default file specification.
CDA$_/NPUT_PROCEDURE
The parameter is the address of a procedure to provide input. The item list
length field must be 0. The input procedure must conform to the requirements
for a get routine. The calling sequence for a user get routine is defined in
Chapter 9.
CDA$_/NPUT_PROCEDURE_PARM
The parameter i.s the address of a longword parameter to the input procedure.
The item list length field must be 4.
CDA$_1NPUT_POSITION_PROCEDURE
The parameter is the address of a procedure that provides position information. The item list length field must be set to 0. For more information on the
calling sequence for a user get routine, see Chapter 9.
CDA$_1NPUT_ROOT_AGGREGATE
The parameter is the address of a longword handle to a root aggregate that
specifies an in-memory input document. The item list length field must be
4. The in-memory structure, except for the root aggregate itself, is erased by
this operation. The root aggregate must specify standard memory allocation.
converter-context
Context value passed as a parameter to the ddif$read_format or dtif$read_
format entry point in the front end.
front-end-handle
Receives the handle of the front end that will process the nested content. This
handle must be used in all subsequent operations relating to that front end.

Description
The OPEN CONVERTER routine activates an additional front end to process
nested content that is an entire document. The nested content may be in the
same format as that of the main document or in a different format.
Processing options that were specified at the main conversion call (either from
the command line or by the CONVERT routine) for this document format are
automatically retrieved and appended to the standard item list to create a front
end item list that is then passed to the front end's main entry point.

8-128 CDA Toolkit Routines

OPEN CONVERTER

RETURN VALUES

Return Value

Description

CDA$_NORMAL
CDA$_UNSUPFMT

Normal successful completion
Unsupported document format

Any error returned by the specific front end.

CDA Toolkit Routines 8-129

OPEN FILE

OPEN FILE
Opens the specified file for input and validates that its initial contents are valid
compound document data. An input stream and a root aggregate are also created.

VAX FORMAT

status= cda$open_file
(file-spec-fen , file-spec , default-file-spec-Jen
,default-file-spec ,alloc-rtn ,dealloc-rtn
, al/oc-dealloc-prm , aggregate-type
,processing-options ,result-fife-spec-fen
,result-file-spec ,result-file-ret-len ,stream-handle
, file-handle , root-aggregate-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

file-spec-len

file-spec

default-file-spec-len

8-130

CDA Toolkit Routines

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

char_string

Data type:

character string

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

OPEN FILE

Argument

Argument Information

default-file-spec

VMS usage:

char_string

Data type:

character string

alloc-rtn

dealloc-rtn

alloc-dealloc-prm

aggregate-type

processing-options

result-file-spec-len

result-file-spec

Access:

read only

Mechanism:

by reference

VMS usage:

procedure

Data type:

procedure entry mask

Access:

call after stack unwind

Mechanism:

by reference

VMS usage:

procedure

Data type:

procedure entry mask

Access:

call after stack unwind

Mechanism:

by reference

VMS usage:

context

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by value

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

item_list_2

Data type:

record

Access:

read only

Mechanism:

by reference, array reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

char_string

Data type:

character string

Access:

write only

Mechanism:

by reference

CDA Toolkit Routines 8-131

OPEN FILE

Argument

Argument Information

result-file-ret-len

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:
Mechanism:

write only
by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

VMS usage:
Data type:

identifier
longword (unsigned)

Access:

write only

Mechanism:

by reference

VMS usage:

identifier

stream-handle

file-handle

root-aggregate-handle

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

C FORMAT
status

=CdaOpenFile
(file_spec_len, file_spec, defau/t_file_spec_len,
default_fi/e_spec, alloc_rtn, dealloc_rtn,
alloc_dealloc_prm, aggregate_type,
processing_options, result_ file_spec_len,
resu/t_file_spec, resu/t_file_ret_/en, stream_handle,
file_handle, root_aggregate_handle)

Argument Information

8-132 CDA Toolkit Routines

OPEN FILE
unsigned long CdaOpenFile(file spec len, file spec,
default_file_spec_len, default_file_spec,
alloc rtn, dealloc rtn, alloc dealloc prm,
aggregate_type, processing_options, result_file_spec_len, result_file_spec,
result file ret len, stream handle,
file handle~ root aggregate-handle)
unsigned long
file_spec_len;
unsigned char
*f ile_spec;
unsigned long
default_file_spec_len;
unsigned char
*default_file_spec;
unsigned long
(*alloc rtn) ();
unsigned long
(*dealloc_rtn) ();
unsigned long
alloc_dealloc_prm;
unsigned long
aggregate type;
unsigned long
*processi~g options;
unsigned long
result_file=spec_len;
unsigned char
*result file spec;
unsigned long
*result-file-ret len;
unsigned long
*stream=handle; unsigned long
*file_handle;
unsigned long
*root_aggregate_handle;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
file-spec-Jen
The length of the string specified by the file-spec parameter.
file-spec
The file specification.
default-file-spec-Jen
The length (in bytes) of the buffer specified by default-file-spec. If you specify an
address of 0 for both the default-file-spec-len and default-file-spec arguments,
a default file specification of ".ddif' is used.
default-file-spec
The default file specification. In order to simplify the porting of applications, the
character string should consist of only a file type in lowercase characters. If you
specify an address of 0 for both the default-file-spec-len and default-file-spec
arguments, a default file specification of ".ddif' is used. On ULTRIX systems, the
string is appended to the file specification, if the file specification does not already
contain a period.
alloc-rtn
Address of a memory allocation routine. The calling sequence for an allocation
routine is defined in the Description section of this routine. If you specify 0 for
this argument, a default memory allocation routine is used. For a description, see
Chapter 9.
CDA Toolkit Routines

8-133

OPEN FILE
dealloc-rtn
Address of a memory deallocation routine. The calling sequence for a deallocation
routine is defined in the Description section of this routine. If you specify 0 for
this argument, a default memory deallocation routine is used. For a description,
see Chapter 9.
alloc-dealloc-prm
User context to be passed to the memory allocation and deallocation routines. If
the system default memory allocation or deallocation procedure is used, this value
is ignored. For a description, see Chapter 9.
aggregate-type
The type of aggregate, expressed as a symbolic constant. The only valid root
aggregate types are DDIF$_DDF and DTIF$_DTF.
processing-options
An item list containing options to control processing. Each entry in the item list
is a 2-longword structure; to terminate the item list you must specify a final entry
or longword of zero. Valid item codes are as follows:
DDIF$_INHERIT_ATTRIBUTES

Inheritance is applied to all document segments. First, if a segment has a type reference that corresponds to a type definition,
the attributes of the type are applied to the
segment.
If a segment is the root segment, and a style

DDIF$_EVALUATE_CONTENT

Content reference (DDIF$_CRF) aggregates
are replaced with the value of the definition
(DDIF$_CTD) they reference. The value of
this content definition may be in the document
or in an external reference.

8-134 CDA Toolkit Routines

OPEN FILE

Content for segments with the DDIF$_SGA_
COMPUTE_C item present in the segment's
attributes (DDIF$_SGA) may be imported
from an external reference. If the value
of the DDIF$_SGA_COMPUTE_C item is
DDIF$K_REMOTE_COMPUTE, the external
content is imported and replaces the segment's
original content. If the value of the DDIF$_
SGA_COMPUTE_C item is DDIF$_K_COPY_
COMPUTE, the external content is imported
only if the segment has no content. For more
information on the evaluate content processing
option, see Section 1.6.3.
DDIF$_DISCARD_l_SEGMENTS

Segments of the image ( $1 ) content category,
and any nested segments, are discarded.
For more information on the discard image
segments processing option, see Section 1.6.4.

DDIF$_DISCARD_2D_SEGMENTS

Segments of the graphics ( $2D ) content category, and any nested segments, are discarded.
For more information on the discard graphics
segments processing option, see Section 1.6.4.

DDIF$_DISCARD_T_SEGMENTS

Segments of the text ( $T) content category,
and any nested segments, are discarded. For
more information on the discard text segments
processing option, see Section 1.6.4.

DDIF$_DISCARD_TBL_SEGMENTS

Segments of the table ( $TBL) content category, and any nested segments, are discarded.
For more information on the discard table
segments processing option, see Section 1.6.4.

DDIF$_DISCARD_PDL_SEGMENTS

result-file-spec-Jen
Length of the buffer (in bytes) specified by result-file-spec. If you specify 0 for
this parameter, the resultant file specification length is not returned.
result-file-spec
Receives the resultant file specification. If you specify 0 for this parameter, the
resultant file specification is not returned. This file specification is the result of
a VMS RMS $OPEN operation. On ULTRIX systems, the file-spec argument is
copied to this buffer.
result-file-ret-len
Receives the actual length (in bytes) of the resultant file specification.
stream-handle
Receives a value that identifies the newly created stream. This handle must be
used in all subsequent operations on that stream.
file-handle
Receives a value that identifies the newly opened file. This handle must be used
in all subsequent operations on that file.
CDA Toolkit Routines

8-135

OPEN FILE
root-aggregate-handle

Receives a value that identifies the newly created root aggregate. This handle
must be used in all subsequent operations on that root aggregate.

Description
The OPEN FILE routine opens a file for input and validates that the initial
contents of the file are compound document data. At the same time, this routine
also creates an input stream and a root aggregate.

RETURN VALUES

.Return Value

Description

CDA$_NORMAL
CDA$_INVAGGTYP

Normal successful completion

CDA$_INVITMLST

Invalid item list

Invalid aggregate type

Any error returned by the memory allocation routines.
Any error returned by the file routines.

Example
This example illustrates a typical call to the OPEN FILE routine. Following
a call to this routine, the file is read using the GET DOCUMENT routine and
subsequently closed.

/* Open the file for input */
aggregate type = DDIF$ DDF;
status = cda$open_file(&filename_length,
&testl_filename[O],
0,
0,

if (FAILURE(status))

8-136

CDA Toolkit Routines

0,
0,
&aggregate_type,
0,
&result file spec len,
&result=file=spec[OJ,
&result_file_ret_len,
&stream_handle,
&file_handle,
&root_aggregate_handle );
return(status);

OPEN FILE
/* Read the entire document in, then close the file */
print f ("Reading document ... \n") ;
status= cda$get document(&root aggregate handle,
&stream handle);
if (FAILURE(status)) return(status);
status= cda$close_file(&stream_handle, &file_handle);
if (FAILURE(status)) return(status);

CDA Toolkit Routines

8-137

OPEN STREAM

OPEN STREAM
Opens a compound document stream for input.

VAX FORMAT
status

=cda$open_stream
(alloc-rtn ,dealloc-rtn ,alloc-dealloc-prm ,get-rtn
,get-prm ,stream-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:
Data type:

procedure
procedure entry mask

alloc-rtn

dealloc-rtn

alloc-dealloc-prm

get-rtn

8-138 CDA Toolkit Routines

Access:

call after stack unwind

Mechanism:

by reference

VMS usage:

procedure

Data type:

procedure entry mask

Access:
Mechanism:

call after stack unwind
by reference

VMS usage:

context

Data type:

longword (unsigned)

Access:
Mechanism:

read only
by value

VMS usage:

procedure

Data type:

procedure entry mask

Access:

call after stack unwind

Mechanism:

by reference

OPEN STREAM

Argument

Argument Information

get-prm

VMS usage:

context

stream-handle

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

C FORMAT
status

=CdaOpenStream
(alloc_rln, dealloc_rtn, alloc_dealloc_prm, get_rtn,
get_prm, stream_handle)

Argument Information
unsigned long CdaOpenStream(alloc_rtn, dealloc_rtn,
alloc_dealloc_prm, get_rtn,
get prm, stream_handle)
unsigned long
(*alloc_rtn) ();
unsigned long
(*dealloc_rtn) ();
unsigned long
alloc_dealloc_prm;
unsigned long
(*get_rtn) ();
unsigned long
get_prm;
unsigned long
*stream_handle;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
alloc-rtn
Addre$s of a memory allocation routine. The calling sequence for an allocation
routine is defined in the Description section of this routine. If you specify 0 for
this argument, a default memory allocation routine is used. For a description, see
Chapter 9.

CDA Toolkit Routines 8-139

OPEN STREAM
dealloc-rtn
Address of a memory deallocation routine. The calling sequence for a deallocation
routine is defined in the Description section of this routine. If you specify 0 for
this argument, a default memory deallocation routine is used. For a description,
see Chapter 9.
alloc-dealloc-prm
User context to be passed to the memory allocation and deallocation routines.
If the system default memory allocation or deallocation routine is used, this
parameter is ignored. For a description, see Chapter 9.
get-rtn
Address of a stream get routine. The calling sequence for a get routine is defined
in Chapter 9. If you specify 0 for this argument on VMS systems, a default
get-rtn is used. On ULTRIX systems, you must supply both get-rtn and
get-prm; there is no default. If you specify a value other than the default for this
argument, you must also specify a value for the get-prm argument.
get-prm
U set context to be passed to the stream get routine. If the VMS system default
get routine is used, the value must be a pointer to a RAB. On ULTRIX systems, if
you specify a value for the get-rtn, you must supply a value other than 0 for the
get-prm argument. For a description, see Chapter 9.
stream-handle
Receives a value that identifies the newly created stream. This handle must be
used in all subsequent operations on that stream.

Description
The OPEN STREAM routine opens a compound document stream for input.
The number of streams that you can open simultaneously is limited only by the
amount of memory available.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

Any error returned by the memory allocation routines.

8-140 CDA Toolkit Routines

OPEN TEXT FILE

OPEN TEXT FILE
Opens a standard text file for input.

VAX FORMAT
status= cda$open_text_file

(file-spec-fen ,file-spec ,default-file-spec-Jen
, default-file-spec , result-file-spec-len
,result-file-spec ,result-file-ret-len , text-file-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

longword_unsigned

file-spec-len

file-spec

default-file-spec-len

default-file-spec

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

char_string

Data type:

character string

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

char_string

Data type:

character string

Access:

read only

Mechanism:

by reference

CDA Toolkit Routines 8-141

OPEN TEXT FILE

Argument

Argument Information

result-:file-spec-len

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

char_string

result-file-spec

result-file-ret-len

text-file-handle

Data type:

character string

Access:

write only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

C FORMAT
status

=CdaOpenTextFile
(file_spec_len, file_spec, defau/Lfile_spec_len,
defau/Lfile_spec, resu/Lfile_spec_len,
resu!Lfile_spec, resulLfile_reLlen,
texLfile_handle)

Argument Information
unsigned long CdaOpenTextFile(file spec len, file spec,
default_file_spec_len, default_file_spec,
result_file_spec_len, result_file_spec,
result file ret len, text file handle)
unsigned longfile spec len; unsigned char
*file_spec;
unsigned long
default_file_spec_len;
unsigned char
*default_file_spec;
unsigned long
result file spec len;
unsigned char
*result file spec;
unsigned long
*result-file-ret len;
unsigned long
*text_file_handle;

8-142 CDA Toolkit Routines

OPEN TEXT FILE

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
file-spec-Jen
Length (in bytes) of the string specified by·the file-spec argument.
file-spec
File specification of the text file to be opened for input.
default-file-spec-Jen
Length (in bytes) of the string specified by default-file-spec. If you specify 0 for
this parameter, no default file specification is used.
default-file-spec
Default file specification. If you specify a 0 for this parameter, no default file
specification is used. The string should consist only of a file type in lowercase
characters. On ULTRIX systems, the string is appended to the file specification if
the file specification does not already contain a period.
result-file-spec-Jen
Length (in bytes) of the buffer specified by result-file-spec. If you specify 0 for
this parameter, the length of the resultant file specification is not returned.
result-file-spec
Receives the resultant file specification. This file specification is the result of a
VMS RMS $OPEN operation. On ULTRIX systems, the file specification is copied
to this buffer. If you specify 0 for this parameter, a resultant file specification is
not returned.
result-file-ret-len
Receives the actual length (in bytes) of the resultant file specification.
text-file-handle
Receives the handle of the text file. This handle must be used in all subsequent
operations on that text file.

Description
The OPEN TEXT FILE routine opens a standard text file for input.

CDA Toolkit Routines 8-143

OPEN TEXT FILE

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

Any error returned by the memory allocation routines.
Any error returned by the file routines.

8-144

CDA Toolkit Routines

PRUNE AGGREGATE

PRUNE AGGREGATE
Removes the next sequential document content aggregate from an existing
in-memory compound document, and returns its handle and type.

VAX FORMAT

status

=cda$prune_aggregate
(root-aggregate-handle ,aggregate-handle
,aggregate-type)

Argument Information

Argument

Argument Information

status

VMS usage:

root-aggregate-handle

aggregate-handle

aggregate-type

Data type:

cond_value
longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

CDA Toolkit Routines

8-145

PRUNE AGGREGATE

C FORMAT
status

=CdaPruneAggregate
(root_aggregate_handle, aggregate_handle,
aggregate_type)

Argument Information
unsigned long CdaPruneAggregate(root_aggregate_handle,
aggregate handle, aggregate type)
unsigned long
root aggregate-handle;
unsigned long
*aggregate handle;
unsigned long
*aggregate=type;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle
Identifier of the root aggregate associated with the aggregate to be removed. This
aggregate handle is returned by a call to either the OPEN FILE routine or the
CREATE ROOT AGGREGATE routine.

When removing aggregates using the PRUNE AGGREGATE routine, you must
use the same value for the root aggregate handle argument consistently to remove
all the aggregates in the compound document. Once you have removed all the
aggregates, you cannot specify the same root aggregate handle again when calling
the PRUNE AGGREGATE routine.
aggregate-handle
Receives the handle of the removed aggregate. This handle must be used in all
subsequent operations on that aggregate.
aggregate-type
Receives the aggregate type. If the aggregate type returned is DDIF$_EOS (end
of segment), the value of the aggregate handle argument is 0.

8-146

CDA TOolkit Routines

PRUNE AGGREGATE

Description
The PRUNE AGGREGATE routine removes the next sequential primary aggregate from an existing in-memory compound document and returns the aggregate
identifier and type. Primary aggregates, also known as "top-level" aggregates,
include all the document content aggregates and the DDIF$_DHD, DDIF$_DSC,
and DDIF$_EOS aggregates. A front end should invoke this routine from the
get-aggregate entry point module in cases where the front end builds an entire
compound document in memory before returning its content.

RETURN VALUES

Return Value

Descriptfon

CDA$_NORMAL

Normal successful completion

CDA$_ENDOFDOC

End of document

CDA Toolkit Routines 8-147

PRUNE POSITION

PRUNE POSITION
Returns the position in and size of an in-memory document.

VAX FORMAT
status= cda$prune_position
(root-aggregate-handle ,file-position ,file-size)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

root-aggregate-handle

file-position

file-size

Access:

write only

Mechanism:

by value

VMS usage:
Data type:

identifier
longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

VMS usage:

longword_unsigned
longword (unsigned)

Data type:
Access:

write only

Mechanism:

by reference

C FORMAT
status= CdaPrunePosition
(root_aggregate_handle, file_position, file_size)

8-148 CDA Toolkit Routines

PRUNE POSITION

Argument Information
unsigned long CdaPrunePosition(root_aggregate_handle,
file_position, file_size)
unsigned long
root aggregate handle;
unsigned long
*f il; position;
unsigned long
*file=size;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle
Identifier of the root aggregate associated with the in-memory document. The
handle is returned by a call to either the OPEN FILE routine or the CREATE
ROOT AGGREGATE routine.
file-position
Receives the current position (in bytes) as measured from the start of the
document being processed.
file-size
Receives the total size (in bytes) of the in-memory document being processed.

Description
The PRUNE POSITION routine returns the current position in and total size
of the in-memory document being processed. This routine must be used by the
get-position routine when a front end builds an entire document in memory before
returning its content.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA Toolkit Routines

8-149

PUT AGGREGATE

PUT AGGREGATE
Writes one or more aggregates to a specified stream.

VAX FORMAT

status= cda$put_aggregate
(root-aggregate-handle ,stream-handle
,aggregate-handle)

Argument Information

Argument

Argument Information

status

root-aggregate-handle

stream-handle

aggregate-handle

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:
Data type:

identifier
longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

C FORMAT

status = CdaPutAggregate
(root_aggregate_handle, stream_handle,
aggregate_handle)
8-150

CDA Toolkit Routines

PUT AGGREGATE

Argument Information
unsigned long CdaPutAggregate(root_aggregate_handle,
stream handle, aggregate_handle)
unsigned long
root_aggregate_handle;
unsigned long
stream_handle;
unsigned long
aggregate_handle;

RETURNS
status

A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle

Identifier of the root aggregate associated with the aggregate to be written. This
handle is returned by a call to either the OPEN FILE routine or the CREATE
ROOT AGGREGATE routine.
When writing aggregates using the PUT AGGREGATE routine, you must use the
same value for root-aggregate-handle consistently to write all the aggregates
in the compound document. Once you have written all of the aggregates, you
cannot specify the same root-aggregate-handle again when calling this routine.
stream-handle

Identifier of the stream to which the aggregate is to be written. This handle is
returned by a call to either the CREATE FILE routine or the CREATE STREAM
routine.
aggregate-handle

Identifier of the aggregate to be written.

Description
The PUT AGGREGATE routine writes one or more aggregates to a specified
stream. Note that the aggregates remain unchanged after a call to this routine.
If you do not require these aggregates after you call this routine, your application
should include a subsequent call to the DELETE AGGREGATE routine to destroy
these aggregates.
If the aggregate is part of a sequence, a call to the PUT AGGREGATE routine

causes the entire sequence to be written. The aggregate type of the .written
aggregate must be one of the following primary DDIF or DTIF aggregates:

CDA Toolkit Routines 8-151

PUT AGGREGATE

Aggregate Type

Meaning

DDIF$_DSC

Document descriptor

DDIF$_DHD

Document header

DDIF$_SEG
DDIF$_TXT

Text content

DDIF$_GTX

General text content

DDIF$_HRD

Hard directive

DDIF$_SFT
DDIF$_HRV

Soft directive
Hard value directive

DDIF$_SFV

Soft value directive

DDIF$_BEZ

Bezier curve content

DDIF$_LIN

Polyline content

DDIF$_ARC

Arc content

Document segment

DDIF$_FAS

Fill area set content

DDIF$_IMG

Image content

DDIF$_CRF

Content reference

DDIF$_EXT

External content

DDIF$_PVT

Private content

DDIF$_GLY

Layout galley

DDIF$_EOS

End of segment

DTIF$_HDR

Document header

DTIF$_CLD

Cell data

DTIF$_DSC

Document descriptor

DTIF$_TBL

Table definition

DTIF$_ROW

Row definition

If the aggregate is of type DDIF$_SEG, the segment content must be specified
by the value of the DDIF$_SEG_CONTENT item. If the segment does not
contain content, you must use the ENTER SCOPE routine to write the segment
aggregate. Note that any lower-level content must be attached to the segment
aggregate before it is written.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA$_INVAGGTYP

Invalid aggregate type

CDA$_INVDOC

Invalid document content

Any error returned by the file routines.

8-152 CDA Toolkit Routines

PUT DOCUMENT

PUT DOCUMENT
Writes an entire document to the specified stream. The document is not changed
by this operation.

VAX FORMAT
status = cda$put_document

(root-aggregate-handle ,stream-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

identifier
longword (unsigned)

root-aggregate-handle

stream-handle

Data type:
Access:

read only

Mechanism:

by reference

C FORMAT
status = CdaPutDocument

(root_aggregate_handle, stream_handle)

CDA Toolkit Routines 8-153

PUT DOCUMENT

Argument Information
unsigned long CdaPutDocument(root_aggregate_handle,
stream handle)
unsigned long root aggregate handle;
unsigned long
stream_handle;-

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle
Identifier of the root aggregate associated with the document to be written. This
handle is returned by a call to either the OPEN FILE routine or the CREATE
ROOT AGGREGATE routine.

Once you write an entire document, you cannot call the PUT DOCUMENT
routine specifying the sanie root aggregate handle again. That is, you can only
write a document associated with a particular root aggregate once.
stream-handle
Identifier of the stream to which the document is to be written. This handle is
returned by a call to either the CREATE FILE routine or the CREATE STREAM
routine.

Description
The PUT DOCUMENT routine writes an entire document to a specified stream.
Note that the document remains unchanged after a call to this routine. If you do
not require the in.;memory structure after you call this routi:p.e, your application
should include a subsequent call to the DELETE ROOT AGGREGATE routine to
destroy this structure.

8-154 CDA Toolkit Routines

PUT DOCUMENT

RETURN VALUES

Rettµ"n Value

Description

CDA$_NORMAL
CDA$_INVDOC

Normal successful completion
Invalid document content

Any error returned by the file routines.

CDA Toolkit Routines 8-155

READ
TEXT FILE
I

READ TEXT FILE
Reads a line from a standard text file.

VAX FORMAT

status =cda$read_text_file
(text-file-handle ,buffer-length ,buffer-address)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

Data type:

longword (unsigned)

text-.file-handle

buffer-length

buffer-address

Access:

write only

Mechanism:

by va,lue

VMS usage:
Data type:

identifier
longword (unsigned)

Access:

read only

Mechanism:

by :reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

·by reference

VMS usage:

address

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

C FORMAT
status

=CdaReadTextFile
(text_file_handle, buffer_length, buffer_address)

8-156 CDA Toolkit Routines

READ TEXT FILE

Argument Information
unsigned long CdaReadTextFile(text_file_handle,
buffer length, buffer address)
unsigned longtext file handle;
unsigned long
*buffer_length;
unsigned char
*buffer_address;

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
text-file-handle
Identifier of the text file from which the line is to be read. This handle is returned
by a call to the OPEN TEXT FILE routine.
buffer-length
Receives the length (in bytes) of the line that is read.
buffer-address
Receives the address of the line that is read. No trailing record delimiter is
present. On ULTRIX, buffer-address receives the address of the line up to, but
not including, the new-line indicator.

Description
The READ TEXT FILE routine reads a line from a standard text file. On VMS
systems, the line is the next RMS record in the file. On ULTRIX systems, the line
is delimited by a new-line character.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA$_ENDOFDOC

End of document

Any error returned by the file routines.

CDA Toolkit Routines

8-157

REMOVE AGGREGATE

REMOVE AGGREGATE
Removes an aggregate from a sequence. The aggregate is not deleted. If the
specified aggregate is not part of a sequence and has no parent aggregate, no
operation is performed.

VAX FORMAT
status= cda$remove_aggregate
(aggregate-handle)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

aggregate-handle

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:
Data type:

identifier
longword (unsigned)

Access:

read only

Mechanism:

by reference

C FORMAT
status = CdaRemoveAggregate
(aggregate_handle)

Argument Information
unsigned long CdaRemoveAggregate(aggregate_handle)
unsigned long
aggregate_handle;

8-158 CDA Toolkit Routines

REMOVE AGGREGATE

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
aggregate-handle
Identifier· of the aggregate to be removed from the sequence.

Description
The REMOVE AGGREGATE routine removes an aggregate that is part of a
sequence from that sequence. The aggregate is not deleted. If the aggregate is
not part of a sequence and has no parent aggregate, no action is performed.
NOTE

Do not attempt to use the REMOVE AGGREGATE routine to remove
the only aggregate from a single-aggregate sequence, or to remove an
aggregate from its parent when the corresponding aggregate-valued
item of the parent is not defined to be a sequence of aggregates.
Although current implementation of the REMOVE AGGREGATE
routine allows removing the only aggregate from a single-aggregate
sequence, and even allows removing an aggregate from its parent when
the corresponding aggregate-valued item of the parent is not defined
to be a sequence of aggregates, the use of the REMOVE AGGREGATE
routine in this manner is not supported and may leave the aggregate
data structures in an inconsistent state. This use of the REMOVE
AGGREGATE routine may be prevented (causing an error status to be
returned) in a future release of the CDA toolkit.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA Toolkit Routines 8-159

STORE ITEM

STORE ITEM
Writes the contents of an item within an aggregate. If the item is indexed, the
index must not exceed one more than the number of existing items.

VAX FORMAT
status =cda$store_item
(root-aggregate-handle ,aggregate-handle
,aggregate-item ,but-Jen ,buf-adr [,aggregate-index]
[,add-info])

Argument Information

Argument

Argument Information

status

VMS usage:
Data type:

cond_value
longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

root-aggregate-handle

aggregate-handle

aggregate-item

8-160 CDA Toolkit Routines

Access:

read only

Mechanism:

by reference

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

STORE ITEM

Argument

Argument Information

buf-len

VMS usage:

buf-adr

aggregate-index

add-info

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:
VMS usage:

by reference
vector_byte_unsigned

Data type:

byte (unsigned)

Access:

read only

Mechanism:

by reference, array reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

C FORMAT
status

=CdaStoreltem
(root_aggregate_handle, aggregate_handle,
aggregate_item, buf_len, buf_adr, aggregate_index,
add_info)

Argument Information
unsigned long CdaStoreitem(root_aggregate_handle,
aggregate_handle, aggregate_item,
buf_len, buf_adr, aggregate_index,
add_info)
unsigned long
root_aggregate_handle;
unsigned long
aggregate_handle;
unsigned long
aggregate_item;
unsigned long
buf_len;
unsigned char
*buf_adr;
unsigned long
aggregate index;
unsigned long
add_info;-

CDA Toolkit Routines 8-161

STORE ITEM

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
root-aggregate-handle
Identifier of the root aggregate with which the aggregate containing the item is
associated. This handle is returned by a call to either the OPEN FILE routine or
the CREATE ROOT AGGREGATE routine.

You must use identical memory management procedures when storing and
locating an item within an aggregate to ensure consistent treatment of memory
allocation and deallocation.
aggregate-handle
Identifier of the aggregate into which the item is written.
aggregate-item
Identifying code of the item, expressed as a symbolic constant. The DDIF
aggregate item symbolic constants are defined in the file ddif$def.h on VMS
systems and in the file ddif_def.h on ULTRIX systems and are described in
Chapter 4. The DTIF aggregate type symbolic codes are defined in the file
dtif$def.h on VMS systems and in the file dtif_def.h on ULTRIX systems and are
described in Chapter 5.

A user context item named DDIF$_USER_CONTEXT for DDIF aggregates
and DTIF$_USER_CONTEXT for DTIF aggregates is available within every
aggregate. This item is a longword that can be used by the application for any
purpose.
but-Jen
Length (in bytes) of the buffer specified by the buf-adr argument.
buf-adr
Buffer containing the item's value.
aggregate-index
Index of the item (relative to 0). This argument is required whenever the notation
"Array of' appears in the data type of the specified item handle. Otherwise, this
argument is only required if the add-info argument is also required.
add-info
Data type-specific modifier for the data types character string, string with
add-info, general floating-point, and scaled integer. For data types other than
character string, string with add-info, general floating-point, and scaled integer,
this argument is ignored and may be omitted.

8-162 CDA Toolkit Routines

STORE ITEM
For the data type character string, the add-info parameter contains the character set designator. For the data type scaled integer, the add-info parameter
receives an integer scaling factor. For the data type string with add-info, if the
string value is equal to one of the standard tag values, the add-info parameter
contains a value that identifies the tag. For the data type general floatingpoint, the add-info parameter contains a value that identifies the format of the
floating-point value supplied in buf-adr. For add-info values for the general
floating-point type, see Table 1-1. Otherwise, add-info contains a value that
indicates that the tag is private.

Description
The STORE ITEM routine lets you store the value of each item within an
aggregate. After creating an aggregate, you must use this routine to fill in the
appropriate items in the aggregate. The items that exist for each aggregate are
defined in the files ddif$def.h and dtif$def.h on VM:S systems and in the files
ddif_def.h and dtif_def.h on ULTRIX systems, and are described in Chapter 4 and
in Chapters 5 through 7. Note that there are optional and required aggregate
items. If the text does not specify that the item is optional, then it must be
specified in order to create a valid aggregate of that type.
If an aggregate item is indexed, the index specified must not exceed one more
than the maximum index of the previously stored indexed items. If the item is of
data type variable, the value of the item that determines the data type must have
been previously established.

The STORE ITEM routine erases the previous item value, unless the item is
"aggregate valued" and not empty. (An "aggregate-valued" item is one in which
the value of the aggregate is actually the handle of another aggregate.) In the
case of an item that is aggregate valued and not empty, the specified aggregate
is inserted in sequence before the existing aggregate. If the specified aggregate
is the beginning of a sequence, the entire sequence is inserted before the existing
aggregate. If the specified aggregate is part of a sequence but is not the first
aggregate in the sequence, or if the specified aggregate is the value of an item, an
error is returned.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion.

CDA$_INVAGGTYP
CDA$_INVITMCOD

Invalid aggregate type.
Invalid item code.

CDA$_INDEX

Index exceeds array bounds.

CDA$_VAREMPTY

Variant item is empty.

CDA$_VARINDEX

Variant index exceeds bounds.

CDA Toolkit Routines

8-163

STORE ITEM

Return Value

Description

CDA$_VARVALUE
CDA$_INVINSERT
CDA$_INVBUFLEN

Variant value is undefined.
Aggregate already in a sequence.
Invalid buffer length.

Examples
This example illustrates the creation of a document descriptor aggregate (type
DDIF$_DSC), and the use of the STORE ITEM routine to fill in the items in the
aggregate.

static unsigned char
product_name []
{ 11 Sample P reduct 11 } ;

aggregate_type = DDIF$_DSC;
status = cda$create_aggregate(&root_aggregate_handle,
&aggregate~type,

&aggregate_handle);
if (FAILURE(status)) return(status);
aggregate_item = DDIF$_DDF_DESCRIPTOR;
local_length = sizeof(aggregate_handle);
status = cda$store_item(&root_aggregate_handle,
&root_aggregate_handle,
&aggregate_item,
&local_length, &aggregate_handle);
if (FAILURE(status)) return(status);
aggregate item = DDIF$ DSC MAJOR VERSION;
local_length = sizeof(integer_value);
integer_value = 1;
status = cda$store_item(&root_aggregate_handle,
&aggregate_handle,
&aggregate_item, &local_length,
&integer_value);
if (FAILURE(status)) return(status);
aggregate item = DDIF$ DSC MINOR VERSION;
local length= sizeof(integer value);
integer value = O;
status ~ cda$store_item(&root_aggregate_handle,
&aggregate_handle,
&aggregate_item, &local_length,
&integer_value);
if (FAILURE(status)) return(status);

8-164

CDA Toolkit Routines

STORE ITEM
aggregate_item = DDIF$_DSC_PRODUCT_IDENTIFIER;
local length = 7;
status = cda$store_item(&root_aggregate_handle,
&aggregate_handle,
&aggregate_item, &local_length,
"Example");
if (FAILURE(status)) return(status);
aggregate item = DDIF$ DSC PRODUCT NAME;
local len-= sizeof(product-name); aggregate index = 0;
add info ~ CDA$K ISO LATINl;
status = cda$store_item(&root_aggregate_handle, &aggregate handle
&aggregate_item, &local_length,
product name, &aggregate index,
&add_info);
if (FAILURE(status)) return(status);

This example illustrates the use of the STORE ITEM routine to specify two
transformation aggregates (type DDIF$_TRN). The type of transformation
specified by the DDIF$_TRN aggregate is indicated by the value of the DDIF$_
TRN_PARAMETER_C item. The first transformation aggregate specifies an
x-scale transformation. The second transformation aggregate specifies a 2 x 3
matrix transformation of the following format:
ADOBEOCF1

Each matrix coefficient is stored in the DDIF$_TRN aggregate in each call to the
STORE ITEM routine. The first call to STORE ITEM for this matrix writes the A
matrix coefficient into array item O; the second call writes B to array item 1, and
so on until coefficients A through F are written to the array. You are responsible
for updating the aggregate index of the array each time a coefficient is written.
One matrix coefficient is stored in each call to the STORE ITEM routine. The
aggregate index is used to specify which matrix coefficient is being written.

aggregate type = DDIF$ TRN;
status = cda$create_aggregate(&root_aggregate_handle,
&aggregate type,
&inner aggregate handle);
if (FAILURE(status)) return(status);
aggregate item = DDIF$ SGA FRM TRANSFORM;
item length = 4;
status = cda$store_item(&root_aggregate_handle,
&aggregate_handle, &aggregate_item,
&item length,
&inner_aggregate_handle);
if (FAILURE(status)) return(status);

CDA Toolkit Routines

8-165

STORE ITEM
aggregate_item = DDIF$_TRN_PARAMETER_C;
local length= sizeof(integer value);
integer value = DDIF$K x SCALE;
status ~ cda$store item(&root aggregate handle,
&inner_aggregate_handle,
&aggregate_item,
&local_length, &integer_value);
if (FAILURE(status)) return(status);
aggregate item = DDIF$ TRN PARAMETER;
local_length = sizeof(float_value);
float value = 3.5;
status = cda$store_item(&root_aggregate_handle,
&inner_aggregate_handle,
&aggregate_item,
&local_length, &float_value);
if (FAILURE(status)) return(status);
aggregate type = DDIF$ TRN;
status = cda$create_aggregate(&root_aggregate_handle,
&aggregate_type,
&inner_aggregate_handle_2);
if (FAILURE(status)) return(status);
status = cda$insert aggregate(&inner aggregate handle 2,
&inner-aggregate-handle);
if (FAILURE(status)) return(status);aggregate item = DDIF$ TRN PARAMETER C;
local length = sizeof (integer value);
integer value = DDIF$K MATRIX-2 BY 3;
status ~ cda$store item(&root-aggregate handle,
&inner_aggregate_handle_2,
&aggregate item,
&local_length, &integer_value);
if (FAILURE(status)) return(status);
aggregate_item = DDIF$_TRN_PARAMETER;
local_length = sizeof(float_value);
float value= 4.75;
aggregate index = O;
status = cda$store_item(&root_aggregate_handle,
&inner_aggregate_handle_2,
&aggregate_item,
&local_length, &float_value,
&aggregate_index);
if (FAILURE(status)) return(status);
aggregate_item = DDIF$_TRN_PARAMETER;
local_length = sizeof(float_value);
float value = 6.11;
aggregate index = 1;
status = cda$store_item(&root_aggregate_handle,
&inner_aggregate_handle_2,
&aggregate_item,
&local_length, &float_value,
&aggregate_index);
if (FAILURE(status)) return(status);

8-166

CDA Toolkit Routines

STORE ITEM
aggregate_item = DDIF$_TRN_PARAMETER;
local_length = sizeof(float_value);
float_value = 2.22;
aggregate_index = 2;
status = cda$store item(&root aggregate handle,
&inner_aggregate_handle_2,
&aggregate_item,
&local_length, &float_value,
&aggregate_index);
if (FAILURE(status)) return(status);
aggregate_item = DDIF$_TRN_PARAMETER;
local_length = sizeof(float_value);
float_value = 3.0;
aggregate_index = 3;
status = cda$store item(&root aggregate handle,
&inner_aggregate_handle_2,
&aggregate_item,
&local_length, &float_value,
&aggregate_index);
if (FAILURE(status)) return(status);
aggregate_item = DDIF$_TRN_PARAMETER;
local_length = sizeof(float_value);
float_value = 1.25;
aggregate index = 4;
status = cda$store item(&root aggregate handle,
&inner_aggregate_handle_2,
&aggregate_item,
&local_length, &float_value,
&aggregate_index);
if (FAILURE(status)) return(status);
aggregate_item = DDIF$_TRN_PARAMETER;
local_length = sizeof(float_value);
float_value = 2.15;
aggregate_index = 5;
status = cpa$store item(&root aggregate handle,
&inner_aggregate_handle_2,
&aggregate_item,
&local length, &float value,
&aggregate_index);
if (FAILURE(status)) return(status);

CDA Toolkit Routines

8-167

WRITE TEXT FILE

WRITE TEXT FILE
Writes a line of text to a standard text file.

VAX FORMAT
status= cda$write_text_file
(text-file-handle ,buffer-length ,buffer-address)

Argument Information

Argument

Argument Information

status

VMS usage:

cond_value

text-file-handle

buffer-length

buffer-address

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

VMS usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

VMS usage:

char_string

Data type:

character string

Access:

read only

Mechanism:

by reference

C FORMAT
status= CdaWriteTextFile
(text_fi/e_handle, buffer_length, buffer_address)

8-168

CDA Toolkit Routines

WRITE TEXT FILE

Argument Information
unsigned long CdaWriteTextFile(text_file_handle,
buffer length, buffer address)
unsigned long text file-handle;
unsigned long
buffer_length;
unsigned char
*buffer_address;

RETURNS
status

A condition value indicating the return status of the routine call.

Arguments
text-file-handle

Identifier of the text file to which the line is written. This handle is returned by
a call to the CREATE TEXT FILE routine.
buffer-length

Length (in bytes) of the buffer specified by the buffer-address argument.
buffer-address

The line to be written to the text file.

Description
The WRITE TEXT FILE routine writes a line of text to a standard text file. On
VMS systems, the written line becomes an RMS record. On ULTRIX systems, the
written line is followed by a new-line character.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

Any error returned by the file routines.

CDA Toolkit Routines

8-169

Chapter 9

User-Defined Routines
The chapter describes the user-defined routines used to write both CDAconforming applications and front and back ends. You can supply these routines
to modify the operation of the CDA Toolkit routines. For example, the GET
AGGREGATE routine, by default, calls a CDA Toolkit get routine. However, you
may provide your own get routine using the format described in this chapter.
Each routine description includes the following information:
•

A routine definition that each application must name according to its
operating system-specific format

•

Descriptions of each routine argument

•

A description of the routine itself

•

A list of possible values returned by each routine argument
NOTE

The entry points and conventions defined throughout this reference
section must be followed on both VMS and ULTRIX systems in order
for all front and back ends to work properly with the CDA Converter
Kernel.
If you are programming in Ada, please refer to the Guide to Applications
Programming for information on Ada programming with DECwindows.

User-Defined Routines

9-1

Allocate/Deallocate Routines

Allocate/Deallocate Routines
Are the specification of the calling standard for two optional user-supplied routines used to perform memory allocation and deallocation. The address of these
routines can be passed to the CREATE FILE, CREATE ROOT AGGREGATE,
CREATE STREAM, OPEN STREAM, or OPEN FILE routine. If specified, these
allocation and deallocation routines will be used throughout the CDA Toolkit to
allocate and deallocate memory.

FORMAT
status

=user-rtn (num-bytes ,base-adr ,alloc-dealloc-prm)

Argument Information

Argument
status

num-bytes

base-adr

alloc-dealloc-prm

Argument Information
Data type:

Usage:

cond_value
longword (unsigned)

Access:

write only

Mechanism:

by value

Usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

Usage:

address

Data type:

longword (unsigned)

Access:

read only or write only

Mechanism:

by reference

Usage:
Data type:

user_arg
longword (unsigned)

Access:

read only

Mechanism:

by value

RETURNS
status
A condition value indicating the return status of the routine call.
9-2 User-Defined Routines

Allocate/Deallocate Routines

Arguments
num-bytes

The number of bytes to allocate or deallocate. The value of num-bytes must be
greater than zero.
base-adr

Virtual address of the first byte of memory to be allocated or deallocated. (This
argument is write-only for an allocate routine, and read-only for a deallocate
routine.)
alloc-dealloc-prm

User context argument.

Description
The allocate I deallocate routines are the specification of the calling standard
for two optional user-supplied routines used to perform memory allocation and
deallocation. The address of these routines can be passed to the CREATE FILE,
CREATE ROOT AGGREGATE, CREATE STREAM, OPEN STREAM, or OPEN
FILE routine. If specified, these allocation and deallocation routines will be used
throughout the CDA Toolkit to allocate and deallocate memory.
The alloc-dealloc-prm argument is passed through these CDA routines to
the user-supplied routine. For example, the alloc-dealloc-prm argument
must be supplied to the CREATE FILE routine, which will then pass it to the
user-supplied allocate routine.

RETURN VALUES
Each of these user routines must return a completion status. The VMS convention for completion codes is followed. If the low bit of the return value is clear, an
error has occurred and the caller returns control to its caller; if the low bit of the
return value is set, the caller continues execution.

User-Defined Routines

9-3

Flush Routine

Flush Routine
Is a specification of the calling standard for an optional user-supplied routine.
The address of a routine that meets this specification can be passed to the
FLUSH STREAM routine, which will use the routine to force the writing of the
user's buffer.

FORMAT

status= flush-rtn

(flush-prm)

Argument Information

Argument

Argument Information

status

Usage:

cond_value

ftush-prm

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

Usage:

user_arg

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by value

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
flush-prm
User context argument.

9-4

User-Defined Routines

Flush Routine

Description
The flush routine is a specification of the calling standard for an optional usersupplied routine. The address of a routine that meets this specification can be
passed to the FLUSH STREAM routine, which will use the routine to force the
writing of the user's buffer.
The user-supplied flush routine is only neccessary when a user-supplied put
routine (using buffered output) has been specified in the call to the CREATE
STREAM routine.

RETURN VALUES
The user-defined flush routine must return a value that is one of the error status
codes named by the CDA Toolkit (such as CDA$_INVDOC), by VMS RMS, or that
is application-defined.
If the first bit of the longword returned by this routine is set to 1, the return
status is successful. However, if the first bit of the longword returned by this
routine is set to 0, the return status is unsuccessful.

This routine must return a completion status. The VMS convention for completion codes is followed. If the low bit of the return value is clear, an error has
occurred and the caller returns control to its caller; if the low bit of the return
value is set, the caller continues execution.

User-Defined Routines

9-5

Get Routine

Get Routine
Is a specification of the calling standard for an optional user-supplied routine.
The address of a routine that meets this specification can be passed to the
CONVERT routine or to the OPEN STREAM routine.

FORMAT
status

=get-rtn (get-prm ,num-bytes ,buf-adr)

Argument Information

Argument
status

get-prm

num-bytes

buf-adr

Argument Information
Usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

Usage:

user_arg

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by value

Usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

Usage:

address

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

RETURNS
status
A condition value indicating the return status of the routine call.

9-6

User-Defined Routines

Get Routine

Arguments
get-prm
User context argument.
num-bytes
Receives the number of bytes contained in the buffer. The num-bytes argument
is the address of an unsigned longword that receives this number. The number of
bytes is zero only if the stream does not contain any more data.
buf-adr
Receives the address of an unsigned longword that receives the buffer address.

Description
The get routine is a specification of the calling standard for an optional usersupplied routine. The address of a routine that meets this specification can be
passed to the CONVERT routine or to the OPEN STREAM routine.
For the CONVERT routine, this address will be passed to a front end converter,
which may then use the specified routine to read input data. Refer to the example
for the CONVERT routine in Chapter 8.
For the OPEN STREAM routine, this address will be stored for use by the GET
AGGREGATE routine when reading input data.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA$_ENDOFDOC

End of document

User-Defined Routines

9-7

Get-Position Routine

Get-Position Routine
Is a specification of the calling standard for an optional user-supplied routine.
The address of a routine that meets this specification can be passed to the
CONVERT routine. This user-supplied routine must provide position information
to allow the application reader or converter to determine the total size of the
current input stream as well as to determine the current position within the
stream. (This routine is useful for viewer back ends that provide a scroll bar
indicating the current position in the document being viewed.)

FORMAT
status= get-pos-rtn

(stream-prm ,stream-size)

Argument Information

Argument

Argument Information

status

Usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

stream-prm

stream-size

Usage:

user_arg

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by value

Usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by· reference

RETURNS
status

A condition value indicating the return status of the routine call.

9-8

User-Defined Routines

Get-Position Routine

Arguments
stream-prm
User context argument.
stream-size
Receives the number of bytes contained in the buffer. The stream-size argument
is the address of an unsigned longword that receives this number. The number of
bytes is zero only if the stream does not contain any more data.

Description
The get-position routine is a specification of the calling standard for an optional
user-supplied routine. The address of a routine that meets this specification can
be passed to the CONVERT routine. This user-supplied routine must provide
position information to allow the application reader or converter to determine the
total size of the current input stream as well as to determine the current position
within the stream. (This routine is useful for viewer back ends that provide a
scroll bar indicating the current position in the document being viewed.)

RETURN VALUES
The user-defined get-position routine can return a value that is one of the error
status codes named by the CDA Toolkit (such as CDA$_INVDOC), by VMS RMS,
or one that is application-defined.
If the first bit (bit 0) of the longword returned by this routine is set to 1, the
return status is successful. However, if the first bit of the longword returned by
this routine is set to 0, the return status is unsuccessful.

User-Defined Routines

9-9

Put Routine

Put Routine
Is a specification of the calling standard for an optional user-supplied routine.
The address of a routine that meets this specification can be passed to the
CONVERT routine or to the CREATE STREAM routine.

FORMAT
status= put-rtn

(put-prm ,num-bytes ,buf-adr ,next-but-fen
,next-buf-adr)

Argument Information

Argument

Argument Information

status

Usage:

put-prm

num-bytes

buf-adr

next-buf-len

9-10 User-Defined Routines

Data type:

cond_value
longword (unsigned)

Access:

write only

Mechanism:

by value

Usage:
Data type:

user_arg
longword (unsigned)

Access:

read only

Mechanism:

by value

Usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

Usage:

vector_byte_unsigned

Data type:

byte (unsigned)

Access:
Mechanism:

read only
by reference, array reference

Usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

Put Routine

Argument

Argument Information

nex:t-buf-adr

Usage:

address

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
put-prm
User context argument.
num-bytes
Number of bytes contained in the buffer. The num-bytes argument is the
address of an unsigned longword that contains this value.
buf-adr
Address of the buffer. The buf-adr argument is the address of an array of
unsigned bytes.
next-but-Jen
Length of the buffer specified by next-buf-adr. The next-buf-len argument is
the address of an unsigned longword that receives this length.
next-buf-adr
Address of a buffer that will receive further output data. The next-buf-adr
argument is the address of an unsigned longword that receives this address.
Next-buf-adr may simply be the current buffer, or a different buffer.

Description
The put routine is a specification of the calling standard for an optional usersupplied routine. The address of a routine that meets this specification can be
passed to the CONVERT routine or to the CREATE STREAM routine.
For the CONVERT routine, this address will be passed to a back end converter,
which may then use the specified routine to write output data. Refer to the
example for the CONVERT routine in Chapter 8.
For the CREATE STREAM routine, this address will be stored for use by the
PUT AGGREGATE routine when writing output data.

User-Defined Routines 9-11

Put Routine

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

The user-defined put routine always returns a status CDA$_NORMAL in an
unsigned longword integer.
The user-defined put routine can also return a value that is one of the error
status codes named by the CDA Toolkit (such as CDA$_INVDOC) or that is
application-defined.
If the first bit of the longword returned by this routine is set to 1, the return
status is successful. However, if the first bit of the longword returned by this
routine is set to 0, the return status is unsuccessful.

9-12

User-Defined Routines

Chapter 10

CDA Toolkit Example Program

This chapter illustrates a sample program, written in VAX C, that uses the
CDA Toolkit to create a DDIF document. Example 10-1 contains comments
where necessary, and Example 10-2 illustrates the analysis output of the DDIF
document created by the program. The callouts in this example correspond to
the callouts in Example 10-2. For example, if a callout corresponds to a call
to the CREATE ROOT AGGREGATE routine in Example 10-1, the callout in
Example 10-2 identifies the beginning of the document root aggregate created by
that call.
Example 10-1:

Sample CDA Toolkit Program

#ifdef vms
#include <ddif$def .h>
#include <cda$def .h>
#else
#include <ddif def .h>
#include <cda def .h>
#endif
#define FAILURE(x)
#define MAX POINTS 4

I* Include DDIF keyword definitions.
*I
I* Include CDA Toolkit keyword definitions. */
/* Include DDIF keyword definitions.
*/
/* Include CDA Toolkit keyword definitions. */
(((x) & 1)

== 0)

/*
** Subroutines to generate frequently-used aggregates.
*/
extern unsigned long create hrd dir( );
extern unsigned long create-gtx( );
unsigned long
poly_points[MAX_POINTS] [2]
{

{ 500, 500 },
{ 2500, 2000 } ,
{ 3500, 2000 } ,
{ 5500, 500 }
}i

unsigned long
unsigned long
unsigned long
uh signed long
unsigned long
unsigned long
unsigned long
unsigned long
unsigned long
unsigned long

aggregate_type;
aggregate_item;
aggregate index;
add_info;file handle;
integer_value;
integer_length
sizeof( integer_value );
local_length;
status;
stream_handle;

(continued on next page)
CDA Toolkit Example Program

10-1

Example 10-1 (Cont.): Sample CDA Toolkit Program
unsigned
unsigned
unsigned
unsigned
unsigned
unsigned

long
long
long
long
long
long

aggregate_handle;
aggregate_handle_length = sizeof( aggregate_handle );
root_aggregate_handle;
previous_aggregate_handle;
aggregate_handle_stack[ 100 ];
ahs_index = 0;

/* Data and structures for the frame definition. */
struct frm_flags
unsigned long
unsigned long

sga_frame_flags;
frame_ur_x_value
6000;
frame_ur_y_value = 2400;

I* Data for the polyline and Bezier curve. */
unsigned long

/* Data for the arc. */
struct arc_flags set_arc_flags;
arc_start = 4.Sel;
arc_extent = 9.0el;

float
float

unsigned long
unsigned long

arc line width = 60;

unsigned long

erf_data_type []
{1,3,12,1011,1,3,1};
erf_data_type_length = sizeof(erf_data_type);

unsigned char
unsigned long
unsigned char
unsigned long
unsigned long

filename[] = "DDIF_EXAMPLE.DDIF";
filename_length = sizeof ( filename ) - l;
result file spec[255];
result=file=spec_len = sizeof( result_file_spec );
result_file_ret_len;

unsigned long
unsigned long

dsc major version = l;
dsc=major=version_length

unsigned long
unsigned long

dsc minor version = 0;
dsc=minor=version_length = sizeof( dsc_minor version);

unsigned char
unsigned long

dsc product identifier[] = "DDIF$";
dsc~roduct=identifier_length =
sizeof ( dsc_product_identifier ) - l;

unsigned
unsigned
unsigned
unsigned

dsc_product_name[] = "Test Vl.0";
dsc_product_name_length = sizeof ( dsc_product_name ) - l;
erf descriptor name[] = "Style Guide";
erf=descriptor=name_length = sizeof( erf_descriptor_name ) - l;

char
long
char
long

sizeof( dsc_major_version );

unsigned char
unsigned long

erf label name[] = "defstyle";
erf=label=name_length = sizeof ( erf_label_name

unsigned char
unsigned long

erf label type[) = "$STYLE";
erf=label=type_length = sizeof ( erf_label_type ) - l;

- l;

unsigned char
unsigned long

dhd_languages_l[] = "E/USA/";
dhd_languages_length_l = sizeof ( dhd_languages_l

unsigned char
unsigned long

dhd_languages_2[] = "Mandarin";
dhd_languages_length_2 = sizeof ( dhd_languages_2 ) - l;

- l;

(continued on next page)

10-2

CDA Toolkit Example Program

Example 10-1 (Cont.):

Sample CDA Toolkit Program

unsigned char
unsigned long

sga_content_category[] = "$2D";
sga_content_category_length_2 =
sizeof( sga_content_category ) - 1;

unsigned char
unsigned long

txt_content[] = "This is the first line of the example text.";
txt_content_length = sizeof( txt_content ) - 1;

unsigned char
gtx_content_l[] = "This is the second line of the example text, \
and should be separated from the first line by a single space.";
unsigned char
gtx_content_2[] = "The third line of the example text will \
begin on a new line.";
unsigned char
gtx_content_3[]
"The fourth line of the example text will be \
separated from the previous lines by a blank line, and will be the \
last text on the first page.";
unsigned char
unsigned long

para_seg_type []
"PARA";
para_seg_type_ length = sizeof ( para_seg_type )

unsigned char
unsigned long

tyd_label [] = "FRAME";
tyd_label length =
sizeof ( tyd_ label ) - 1;

unsigned char
unsigned long

pline_label [] = "pline";
pline_label_length =
sizeof ( pline- label

)

- 1;

unsigned char
unsigned long

bline- label [] = "bline";
bline label length =
- sizeof ( bline label ) - 1;
-

unsigned char
unsigned long

filled arc- label [] = "filled arc";
filled arc label _length =
sizeof ( filled arc label

main()

- 1;

{

printf("Creating in-memory DDIF structure ... \n" );

(continued on next page)

CDA Toolkit Example Program

10-3

Example 10-1 (Cont.): Sample CDA Toolkit Program
/*

*****************************************************************************
**

The overall structure (excluding hard directives) is as follows:

DDF
(Root Aggregate)

DSC
(Descriptor)

\
DHD
(Header)

SEG
(Segment)

**
**

SEG

**
TXT - GTX - SEG - GTX - SEG - GTX - SEG - GTX

**
**

LIN

SEG

BEZ

I
ARC

**
*****************************************************************************
*/

I*
** Create the DDIF Root Aggregate.

*I
aggregate_type = DDIF$_DDF;
status = cda$create_root_aggregate( O, 0, O, O,
tt
&aggregate_type,
&root_aggregate_handle );
if ( FAILURE( status ) )
return (status);

/*
*****************************************************************************
**
**
**

DESCRIPTOR:

1) create the Descriptor ·aggregate
2) attach it to the Root aggregate
3) fill in the items in the Descriptor aggregate.

**
**

**
*****************************************************************************

*I
/*
** Create the Descriptor aggregate and attach it to the Root aggregate

** by storing its handle in the Descriptor item of the Root aggregate.
*/
aggregate_type = DDIF$_DSC;
status = cda$create_aggregate( &root_aggregate_handle, fl
&aggregate type,
&aggregate=handle_stack[ahs_index] );
if ( FAILURE( status ) )
return ( status );

(continued on next page)

10-4

CDA Toolkit Example Program

Example 10-1 (Cont.):

Sample CDA Toolkit Program

aggregate_item = DDIF$_DDF_DESCRIPTOR;
status = cda$store_item( &root_aggregate_handle,
t)
&root_aggregate_handle,
&aggregate_item,
&aggregate_handle_length,
&aggregate_handle_stack[ahs_index] );
if ( FAILURE( status ) )
return (status);

I*
** Fill in the Major Version item of the Descriptor aggregate.
*/
aggregate_item = DDIF$_DSC_MAJOR_VERSION;
status = cda$store_item( &root_aggregate_handle, . .
&aggregate_handle_stack[ahs_index],
&aggregate item,
&dsc major-version length,
&dsc=major=version-);
if( FAILURE( status ) )
return (status);

/*
** Fill in the Minor Version item of the Descriptor aggregate.
*/
aggregate item = DDIF$ DSC MINOR VERSION;
status = cda$store_item( &root_aggregate_handle,
&aggregate_handle_stack[ahs_index],
&aggregate item,
&dsc minor-version length,
&dsc=minor=version-);
if( FAILURE( status ) )
return (status);

I*
** Fill in the Product Identifier item of the Descriptor aggregate.
*/
aggregate item = DDIF$ DSC PRODUCT IDENTIFIER;
status = cda$store_item( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate item,
&dsc product identifier length,
dsc=product=identifier-);
if( FAILURE( status ) )
return (status);

** Fill in the Product Name item of the Descriptor aggregate.
*/

(continued on next page)

CDA Toolkit Example Program

10-5

Example 10-1 (Cont.):

Sample CDA Toolkit Program

aggregate_index = 0;
aggregate_item = DDIF$_DSC_PRODUCT NAME;
add_info = CDA$K_ISO_LATIN1;
status = cda$store_item( &root_aggregate_handle, CB
&aggregate handle stack[ahs index],
&aggregate=item, &dsc_product_name_length,
dsc_product_name,
&aggregate_index,
&add_info );
if ( FAILURE( status ) )
return (status);

*****************************************************************************
**
** HEADER:
**
1) create the Header aggregate
**
**

2) attach it to the Root aggregate
3) fill in the items in the Header aggregate

**
**

*****************************************************************************
*I
/*

** Create the Header aggregate and attach it to the Root aggregate
** by storing its handle in the Header item of the Root aggregate.
*/
aggregate_type = DDIF$_DHD;
status = cda$create_aggregate( &root_aggregate_handle, 6)
&aggregate_type,
&aggregate_handle_stack[ahs_index] );
if ( FAILURE( status ) )
return (status);
aggregate_item = DDIF$_DDF_HEADER;
status = cda$store_item( &root_aggregate_handle,
f)
&root_aggregate_handle,
&aggregate_item,
&aggregate handle length,
&aggregate=handle=stack[ahs_index] );
if ( FAILURE( status ) )
return (status);

I*
** Add the style guide reference.
*/
ahs_index++;
aggregate_type = DDIF$_ERF;
status = cda$create_aggregate( &root_aggregate_handle, C)
&aggregate type,
&aggregate=handle_stack[ahs_index] );
if ( FAILURE( status ) )
return (status);

(continued on next page)

1~ CDA Toolkit Example Program

Example 10-1 (Cont.):

Sample CDA Toolkit Program

aggregate_item = DDIF$_DHD_EXTERNAL_REFERENCES;
status = cda$store_item( &root aggregate handle,
CD
&aggregate_handle_stack[ahs_index-1],
&aggregate_item,
&aggregate_handle_length,
&aggregate_handle_stack[ahs_index] );
if ( FAILURE( status ) )
return (status);
aggregate_item = DDIF$_ERF_DATA TYPE;
status = cda$store_item( &root aggregate handle, I)
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&erf_data_type_length,
erf_data_type ) ;
if( FAILURE( status ) )
return (status);
aggregate_item = DDIF$_ERF_DESCRIPTOR;
aggregate_index = 0;
add_info = CDA$K_ISO_LATIN1;
status = cda$store_itern( &root aggregate handle, 49
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&erf descriptor name length,
erf=descriptor=narne~
&aggregate_index,
&add_info );
if ( FAILURE( status ) )
return (status);
aggregate_index = O;
add info = CDA$K ISO LATINl;
aggregate item =-DDIF$ ERF LABEL;
status = ~da$store ite;( &~oot aggregate handle, f>
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&erf_label_name_length,
erf_label_name,
&aggregate_index,
&add_info );
if ( FAILURE( status ) )
return (status);
aggregate item = DDIF$ ERF LABEL TYPE;
add info ~ DDIF$K STYLE LABEL TYPE;
status = cda$store_itern( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&erf_label_type_length,
erf_ label_type,
0,
&add_info);
if ( FAILURE( status ) )
return (status);

(continued on next page)

CDA Toolkit Example Program

10-7

Example 10--1 (Cont.):

Sample CDA Toolkit Program

aggregate item = DDIF$ ERF CONTROL;
integer_value = DDIF$K=NO_COPY_REFERENCE;
status = cda$store item( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&integer_length,
&integer_value);
if ( FAILURE( status ) )
return (status);
ahs_index--;

** Fill in the Languages item in Header aggregate. First, the enumeration
** value must be stored, then the data value. An index must be used since
** these are arrays.
*/
aggregate item = DDIF$ DHD LANGUAGES C;
integer value = DDIF$K-IS0-639 LANGUAGE;
aggregate_index = O; status = cda$store_item( &root aggregate handle,
I)
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&integer_length,
&integer_value,
&aggregate_index );
if( FAILURE( status } )
return ( status);
aggregate item = DDIF$ DHD LANGUAGES;
aggregate=index = O; status = cda$store_item( &root aggregate handle, 41
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&dhd_languages_length_l,
dhd languages 1,
&aggregate_index );
if ( FAILURE( status ) )
return (status);
aggregate item = DDIF$ DHD LANGUAGES C;
aggregate=index = 1; status = cda$store_item( &root aggregate handle,
~
&aggregate_handle_stack[ahs_index],
&aggregate item,
&integer_length,
&integer value,
&aggregate_index );
if ( FAILURE( status ) }
return (status);

(continued on next page)

10-8

CDA Toolkit Example Program

Example 10-1 (Cont.):

Sample CDA Toolkit Program

aggregate item = DDIF$ DHD LANGUAGES;
integer value = DDIF$K-OTHER LANGUAGE;
aggregate_index = l; add info = CDA$K_ISO_LATIN1;
status = cda$store_item( &root_aggregate_handle, ~
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&dhd_languages_length_2,
dhd languages 2,
&aggregate_index,
&add_info );
if ( FAILURE( status ) )
return (status);

/*
** Add the DHD STYLE GUIDE item, defining it to point to the
** first external reference, which was defined above as the
** style-guide file.

*/
aggregate item = DDIF$ DHD STYLE GUIDE;
integer_value = l;
status = cda$store_item( &root aggregate handle,
&aggregate handle stack[ahs index],
&aggregate=item, &integer_length,
&integer_value);
if ( FAILURE( status ) )
return (status);

*****************************************************************************
**

**
**

CONTENT:

1) create the Segment aggregate
2) attach it to the Root aggregate
3) fill in the items in the Segment aggregate

**
**
**

*****************************************************************************
*/

** Create the Segment aggregate and attach it to the Root aggregate
** by storing its handle in the Content item of the Root aggregate.
*/
aggregate_type = DDIF$_SEG;
status = cda$create_aggregate( &root_aggregate_handle, «fl
&aggregate type,
&aggregate=handle_stack[ahs_index] );
if ( FAILURE( status ) )
return (status);

(continued on next page)

CDA Toolkit Example Program

10-9

Example 10-1 (Cont.):

Sample CDA Toolkit Program

aggregate_item = DDIF$_DDF_CONTENT;
status = cda$store_item( &root_aggregate_handle,
&root_aggregate_handle,
&aggregate_item,
&aggregate handle length,
&aggregate=handle=stack[ahs_index] );
if ( FAILURE( status ) )
return (status);

«I

ahs_index++;
aggregate_type = DDIF$_SEG;
status = cda$create_aggregate( &root_aggregate_handle, ~
&aggregate type,
&aggregate=handle_stack[ahs_index] );
if ( FAILURE( status ) )
return (status);

I* Store into this segment. */
aggregate_item = DDIF$_SEG_CONTENT;
status = cda$store_item( &root aggregate handle, ~
&aggregate handle stack[ahs index-1],
&aggregate=item, &aggregate handle length,
&aggregate=handle=stack[ahs_index] );
if( FAILURE( status ) )
return ( status ) ;

/*
** Store the segment type ("PARA"). PARA is defined in the default
** style guide.
*I
aggregate_item = DDIF$_SEG_SEGMENT_TYPE;
status = cda$store_item( &root aggregate handle, ~
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&para_seg_type_length,
para_seg_type );
if ( FAILURE( status ) )
return ( status );

I*
** Now fill in the items in the Segment aggregate.
*/
ahs_index++;
aggregate_type = DDIF$_SGA;
status = cda$create_aggregate( &root_aggregate_handle,
~
&aggregate_type,
&aggregate_handle_stack[ahs_index] );
if ( FAILURE( status ) )
return (status);

(continued on next page)

10-10 CDA Toolkit Example Program

Example 10-1 (Cont.):

Sample CDA Toolkit Program

aggregate_item = DDIF$_SEG_SPECIFIC_ATTRIBUTES;
status = cda$store_item( &root_aggregate_handle, ~
&aggregate_handle_stack[ahs_index-1],
&aggregate_item,
&aggregate_handle_length,
&aggregate_handle_stack[ahs_index] );
if ( FAILURE( status ) )
return (status);

/*
** Create a type-definition aggregate and attach to the segment
** attribute aggregate.
*I
ahs_index++;
aggregate_type = DDIF$_TYD;
status = cda$create_aggregate( &root_aggregate_handle, ~
&aggregate type,
&aggregate=handle_stack[ahs_index] );
if( FAILURE( status ) )
return (status);
aggregate_item = DDIF$_SGA_TYPE_DEFNS;
status = cda$store_item( &root aggregate handle,
~
&aggregate handle stack[ahs index-1],
&aggregate=item, &aggregate handle length,
&aggregate=handle=stack[ahs_index] );
if ( FAILURE( status ) )
return (status);

/* Now store the type-definition label. */
aggregate_item = DDIF$_TYD_LABEL;
status = cda$store_item( &root aggregate handle, ~
&aggregate handle stack[ahs index],
&aggregate=item, &tyd_label_length,
tyd_label ) ;
if( FAILURE( status ) )
return (status );

I*
** Create an attribute aggregate, and attach to the
** type-def aggregate.
*I
ahs_index++;
aggregate_type = DDIF$_SGA;
status = cda$create_aggregate( &root_aggregate_handle,
&aggregate_type,
&aggregate_handle_stack[ahs_index] );
if( FAILURE( status ) )
return (status);

(continued on next page)

CDA Toolkit Example Program

10-11

Example 10-1 (Cont.):

Sample CDA Toolkit Program

aggregate_item = DDIF$_TYD_ATTRIBUTES;
status = cda$store_item( &root aggregate handle, ~
&aggregate handle stack[ahs index-1],
&aggregate=item, &aggregate handle length,
&aggregate=handle=stack[ahs_index] );
if ( FAILURE( status ) )
return (status);

/*
** Now that the type-def attributes aggregate is in place, store
** each desired attribute there.
*I
aggregate item = DDIF$ SGA CONTENT CATEGORY;
aggregate-index = 0; add_info ~ DDIF$K_2D_CATEGORY;
status = cda$store_item( &root aggregate handle, ~
&aggregate handle stack[ahs index],
&aggregate=item, &sga_content_category_length_2,
sga content category,
&aggregate index,
&add_info );
if ( FAILURE( status ) )
return (status);

/* Store the flags, indicating border on frame. */
aggregate item = DDIF$ SGA FRM FLAGS;
sga frame-flags.ddif$v-flo; around= 0;
sga-frame-flags.ddif$v-frame border = 1;
sga-frame-flags.ddif$v-frame-background fill
O;
sga-frame-flags.ddif$v-frm fill = 0;
integer_length = sizeof( sga_frame_flags );
status = cda$store_item( &root aggregate handle, C&
&aggregate handle stack[ahs index],
&aggregate=item, &integer_length,
&sga_frame_flags );
if ( FAILURE( status ) )
return ( status );
/* Store the bounding coordinates of the frame.

(Note indexing.) */

aggregate item = DDIF$ SGA FRM BOX LL X C;
integer value = DDIF$K-VALUE CONSTANT; aggregate_index = O; status = cda$store_item( &root aggregate handle, t)
&aggregate handle stack[ahs index],
&aggregate=item, &integer_ length,
&integer value,
&aggregate_index );
if( FAILURE( status ) )
return ( status );

(continued on next page)

10-12

CDA Toolkit Example Program

Example 10-1 (Cont.):

Sample CDA Toolkit Program

aggregate_item = DDIF$_SGA_FRM_BOX_LL_X;
aggregate index = O;
integer_value = O;
status = cda$store_item( &root_aggregate_handle, ~
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&integer length,
&integer:=value,
&aggregate_index );
if ( FAILURE( status ) )
return (status);
aggregate item = DDIF$ SGA FRM BOX LL Y C;
integer value = DDIF$K-VALUE CONSTANT; aggregate_index = 1; status = cda$store_item( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&integer length,
&integer-value,
&aggregate_index );
if ( FAILURE( status ) )
return ( status );
aggregate_item = DDIF$_SGA_FRM_BOX_LL_Y;
aggregate index = 1;
integer_value = O;
status = cda$store_item( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate item,
&integer_length,
&integer value,
&aggregate_index );
if( FAILURE( status ) )
return ( status );
/*And now the upper-right coordinates ... */
aggregate item = DDIF$ SGA FRM BOX UR X C;
integer value = DDIF$K-VALUE CONSTANT; aggregate index = O; status = cda$store_item( &root aggregate handle,
&aggregate handle stack[ahs index],
&aggregate=item, &integer length,
&integer-value,
&aggregate_index );
if( FAILURE( status ) )
return ( status );

(continued on next page)

CDA Toolkit Example Program

10-13

Example 10-1 (Cont.):

Sample CDA Toolkit Program

aggregate_item = DDIF$ SGA FRM BOX UR X;
aggregate index = 0;
integer value = frame ur x value;
status ~ cda$store_item(-&root_aggregate_handle,
&aggregate handle stack[ahs index],
&aggregate-item, &integer_length,
&integer_value,
&aggregate_index );
if ( FAILURE( status ) )
return (status);
aggregate item = DDIF$ SGA FRM BOX UR Y C;
integer value = DDIF$K-VALUE CONSTANT; aggregate_index = 1; status = cda$store_item( &root aggregate_handle,
&aggregate_handle_stack[ahs_index],
&aggregate item,
&integer_length,
&integer value,
&aggregate_index );
if( FAILURE( status ) )
return (status);
aggregate_item = DDIF$_SGA_FRM_BOX_UR_Y;
aggregate index = 1;
integer value = frame ur y value;
status ~ cda$store_item(-&root_aggregate_handle,
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&integer_length,
&integer_value,
&aggregate_index );
if ( FAILURE( status ) )
return (status);

/* Now store the form-position item. */
aggregate item = DDIF$ SGA FRM POSITION_C;
integer value = DDIF$K-FRAME GALLEY;
status ~ cda$store_item( &root_aggregate_handle,
&aggregate handle stack[ahs index],
&aggregate-item, &integer length,
&integer=value );
i f ( FAILURE ( status ) )
return ( status ) ;
ahs - index--; I* End of type attributes. *I
ahs - index--; /* End of type-definition */
ahs - index--; /* End of segment attributes aggregate. */

/*
** Create Text Content aggregate and store its handle in the SEG CONTENT
** item in DDF CONTENT.
(This is the first aggregate in a Sequence Of,
** so it is attached with a store. The rest will be inserted.)

(continued on next page)

10-14

CDA Toolkit Example Program

Example 10-1 (Cont.):

Sample CDA Toolkit Program

ahs_index++;
aggregate_type = DDIF$_TXT;
status = cda$create_aggregate( &root_aggregate_handle,
~
&aggregate_type,
&aggregate_handle_stack[ahs_index] );
if ( FAILURE( status ) )
return (status);
aggregate_item = DDIF$_SEG_CONTENT;
status = cda$store_item( &root aggregate handle, . ,
&aggr~gate_handle_stack[ahs_index-1],
&aggregate_item,
&aggregate handle length,
&aggregate=handle=stack[ahs_index] );
if( FAILURE( status ) )
return (status);

/*
** Add a text line.
*/

aggregate_item = DDIF$_TXT_CONTENT;
status = cda$store_item( &root_aggregate_handle,
.,
&aggregate handle stack[ahs index],
&aggregate=item, &txt_content_length,
txt_content ) ;
if ( FAILURE( status ) )
return (status);
/* Save the handle of the segment_content aggregate. */
previous_aggregate_handle = aggregate_handle_stack[ahs_index];
/* Insert a space (hard) directive. */
status = create hrd dir

&root_aggregate_handle,
~
&previous aggregate handle,
&aggregate handle stack[ahs index],
DDIF$K_DIR_SPACE-);
-

if ( FAILURE( status ) )
return (status);
/* Create a General Text Content aggregate. */
previous aggregate handle= aggregate handle stack[ahs index];
status =- create_gt; ( &root_aggregate=handle~
G &previous aggregate handle,
&aggregate_handle_stack[ahs_index],
gtx_content_l ) ;
if ( FAILURE( status
)
return (status);

I* Insert a new-line (hard) directive to force a new line. */

(continued on next page)

CDA Toolkit Example Program

10-15

Example 10-1 (Cont.): Sample CDA Toolkit Program
previous_aggregate_handle =aggregate handle stack[ahs index];
status = create_hrd_dir ( &root_aggregate_ha~dle,
.,&previous aggregate handle,
&aggregate handle stack[ahs index],
DDIF$K_DIR_NEW_LINE );
if ( FAILURE( status ) )
return (status);

I* Create another General Text Content aggregate. */
previous_aggregate_handle = aggregate_handle_stack[ahs_index];
status = create gtx ( &root aggregate handle,
&previous aggregate handle,
&aggregate_handle_stack[ahs_index],
gtx_content_2 ) ;
if ( FAILURE( status
)
return (status);
/* Insert two new-line directives to cause a skipped line. */
previous_aggregate_handle = aggregate_handle_stack[ahs_index];
status = create_hrd_dir ( &root_aggregate_handle,
&previous aggregate handle,
&aggregate_handle_stack[ahs_index],
DDIF$K_DIR_NEW_LINE );
if( FAILURE( status ) )
return (status);
previous aggregate handle = aggregate_handle_stack[ahs_index];
status =-create_hrd_dir ( &root aggregate handle,
&previous aggregate handle,
&aggregate_handle_stack[ahs_index],
DDIF$K_DIR_NEW_LINE );
if ( FAILURE( status ) )
return (status);

/* Create another General Text Content aggregate. */
previous_aggregate_handle = aggregate_handle_stack[ahs_index];
status = create_gtx
&root aggregate handle,
&previous aggregate handle,
&aggregate_handle_stack[ahs_index],
gtx_content_3 ) ;
if ( FAILURE( status
)
return (status);

/* Insert a new-page (hard) directive. */
previous_aggregate_handle
aggregate_handle_stack[ahs_index];
status = create_hrd_dir ( &root aggregate handle,
&previous aggregate handle,
&aggregate_handle_stack[ahs_index],
DDIF$K_DIR_NEW_PAGE );
if (FAILURE( status ) )
return ( status);

(continued on next page)

10-16

CDA Toolkit Example Program

Example 10-1 (Cont.):

Sample CDA Toolkit Program

/* Insert next general-text line. */
previous_aggregate_handle = aggregate_hahdle_stack[ahs_index];
status = create gtx ( &root aggregate handle,
&previous aggregate handle,
&aggregate_handle_stack[ahs_index),
"The following is a Bezier curve, using \
the same path as the polyline, within a frame:");
if ( FAILURE( status ) )
return ( status );

/*
** Create a new segment aggregate in which to define the polyline, and
** insert after the previous aggregate.
*/
previous_aggregate_handle = aggregate_handle_stack[ahs_index);
aggregate_type = DDIF$_SEG;
status = cda$create_aggregate( &root_aggregate_handle,
~
&aggregate type,
&aggregate=handle_stack[ahs_index) );
if ( FAILURE( status ) )
return ( status );

/*
** Insert after previous aggregate.
** is a sequence of aggregates.)

(Insert rather than store, as this

*I
status= cda$insert_aggregate( &aggregate handle stack[ahs index),
&previous_aggregate_handle );
if( FAILURE( status ) )
return ( status );

/* Store the segment ID. */
aggregate_item = DDIF$_SEG_ID;
status = cda$store_item( &root aggregate handle,
(&
&aggregate handle stack[ahs index),
&aggregate-item, &pline label length,
pline=label-);
if( FAILURE( status ) )
return (status);

/* Store the segment type ("FRAME"). */
aggregate item = DDIF$ SEG SEGMENT TYPE;
status = cda$store item( &root aggregate handle,
&aggregate_handle_stack[ahs_index),
&aggregate_item,
&tyd_label_length,
tyd_label );
if ( FAILURE( status ) )
return (status);
/* Create a Polyline aggregate. */

(continued on next page)

CDA Toolkit Example Program

10-17

Example 10-1 (Cont.):

Sample CDA Toolkit Program

ahs_index++;
aggregate_type = DDIF$_LIN;
status= cda$create_aggregate( &root_aggregate_handle,
&aggregate type,
&aggregate=handle_stack[ahs_index] );
if ( FAILURE( status ) )
return (status);

I* Store the Polyline aggregate. */
aggregate_item = DDIF$_SEG_CONTENT;
status = cda$store_item( &root aggregate handle,
~
&aggregate_handle_stack[ahs_index-1],
&aggregate_item,
&aggregate_handle_length,
&aggregate_handle_stack[ahs_index] );
if ( FAILURE( status ) )
return (status);

/* Store Polyline Flags into the Polyline aggregate. */
aggregate item = DDIF$ LIN FLAGS;
integer_value = Oxl; status = cda$store_item( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&integer_length,
&integer_value );
if ( FAILURE( status ) )
return ( status );

/* Store the Line Pattern bit string into the Polyline aggregate. */
aggregate item = DDIF$ LIN DRAW PATTERN;
integer_value = OxF; status = cda$store_item( &root aggregate handle,
&aggregate handle stack[ahs index],
&aggregate=item, &integer_length,
&integer_value );
if ( FAILURE( status ) )
return ( status);

** For the points to be used, store "VALUE CONSTANT" as the data type
** choice, followed by the value of the point.

*I
for (i = O; i < MAX_POINTS; i++ )
{

aggregate item = DDIF$ LIN PATH C;
integer value = DDIF$K-VALUE CONSTANT;
aggregate_index = i * 2;
status = cda$store_item( &root aggregate handle, I)
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&integer_length,
&integer value,
&aggregate_index );
if( FAILURE( status ) )
return (status);

(continued on next page)
10-18 CDA Toolkit Example Program

Example 10-1 (Cont.):

Sample CDA Toolkit Program

/* Store the x-coordinate integer value in the polyline path array. */
aggregate_item = DDIF$_LIN_PATH;
integer_value = poly__points[i] [0];
aggregate_index = i * 2;
status = cda$store_item( &root aggregate handle, G>
&aggregate_handle_stack[ahs_index],
&aggregate item,
&integer_length,
&integer_value,
&aggregate_index );
if ( FAILURE( status ) )
return (status);

I*
** Now store the y-coordinate for each point.

*I
aggregate item = DDIF$ LIN PATH C;
integer_v~lue = DDIF$K=VALUE_CONSTANT;
aggregate_index = ((2 * i) + 1 );
status = cda$store_item( &root aggregate handle,
&aggregate handle stack[ahs index],
&aggregate=item, &integer_length,
&integer_value,
&aggregate_index );
if ( FAILURE( status ) )
return (status);

aggregate_item = DDIF$_LIN_PATH;
integer value= poly points[i] [1];
aggregate_index = ((2 * i) + 1 );
status = cda$store_item( &root aggregate handle,
~
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&integer_length,
&integer value,
&aggregate_index );
if( FAILURE( status ) )
return (status);
}; /* End of "for" loop */
ahs_index--; /* End of pline. */

I* Insert two new-line directives to cause a skipped line. */
previous_aggregate_handle =aggregate handle stack[ahs index];
status = create_hrd_dir ( &root_aggre~ate_ha~dle, ·~ &previous aggregate handle,
&aggregate handle stack[ahs index],
DDIF$K_DIR_NEW_LINE );
if( FAILURE( status ) )
return (status);

(continued on next page)

CDA Toolkit Example Program

10-19

Example 10-1 (Cont.}:

Sample CDA Toolkit Program

previous aggregate handle = aggregate_handle_stack[ahs_index];
status =-create_hrd_dir ( &root aggregate handle,
&previous aggregate handle,
&aggregate_handle_stack[ahs_index],
DDIF$K_DIR_NEW_LINE );
if ( FAILURE( status ) )
return (status);
/* Insert next general-text line. */
previous_aggregate_handle =aggregate handle stack[ahs index];
status = create_gtx ( &root_aggregate=handle~ ~
&previous aggregate handle,
&aggregate handle stack[ahs index],
"The foll;wing i ; a polylir;e within a frame:" );
if ( FAILURE( status
return (status);

I* Insert two new-line directives to cause a skipped line. */
previous_aggregate_handle =aggregate handle stack[ahs index];
status = create_hrd_dir ( &root aggre~ate ha~dle, ~ &previous aggregate handle,
&aggregate_handle_stack[ahs_index],
DDIF$K_DIR_NEW_LINE );
if ( FAILURE( status ) )
return (status);
previous aggregate handle= aggregate_handle_stack[ahs_index];
status =-create_hrd_dir ( &root_aggregate_handle,
&previous aggregate handle,
&aggregate handle stack[ahs index],
DDIF$K_DIR_NEW_LINE );
if ( FAILURE( status ) )
return (status);

I* Insert two new-line directives to cause a skipped line.

previous aggregate handle = aggregate_handle_stack[ahs_index];
status =-create_hrd_dir ( &root aggregate handle,
&previous aggregate handle,
&aggregate handle stack[ahs index],
DDIF$K_DIR_NEW_LINE );
if ( FAILURE( status ) )
return (status);
previous aggregate handle = aggregate_handle_stack[ahs_index];
status =-create_hrd_dir ( &root aggregate handle,
&previous aggregate handle,
&aggregate handle stack[ahs index],
DDIF$K_DIR_NEW_LINE );
if ( FAILURE( status ) )
return (status);

I*
** Create new segment to define Bezier curve.
*/

(continued on next page)

10-20 CDA Toolkit Example Program

Example 10-1 (Cont.):

Sample CDA Toolkit Program

previous aggregate handle= aggregate handle stack[ahs index];
aggregate_type = DDIF$_SEG;
status = cda$create_aggregate( &root_aggregate_handle, G>
&aggregate_type,
&aggregate_handle_stack[ahs_index] );
if( FAILURE( status ) )
return (status);

** Insert after previous aggregate. (Insert rather than store,
** this is a sequence of aggregates.)

*I
status= cda$insert_aggregate( &aggregate handle stack[ahs index],
&previous_aggregate_handle
if ( FAILURE( status ) )
return (status);

/* Store the segment ID. */

aggregate_item = DDIF$_SEG_ID;
status = cda$store_item( &root aggregate handle, @B
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&bline label length,
bline-label-);
if ( FAILURE( status ) )
return (status);
/* Store the segment type ("FRAME"). */

aggregate item = DDIF$ SEG SEGMENT TYPE;
status = cda$store item( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&tyd_label_length,
tyd_label );
if ( FAILURE( status ) )
return (status);

I* Create a Bezier Curve aggregate. */
aggregate type = DDIF$ BEZ;
previous aggregate handle= aggregate handle stack[ahs index];
ahs_index++;
status = cda$create_aggregate( &root_aggregate_handle, i)
&aggregate_type,
&aggregate_handle_stack[ahs_index] );
if ( FAILURE( status ) )
return ( status );
/* Store the Bezier Curve aggregate */

aggregate_item = DDIF$_SEG_CONTENT;
status = cda$store_item( &root_aggregate_handle,
~
&aggregate_handle_stack[ahs_index-1],
&aggregate_item,
&aggregate_handle_length,
&aggregate_handle_stack[ahs_index] );
if ( FAILURE( status ) )
return (status);

(continued on next page)
CDA Toolkit Example Program

10-21

Example 10-1 (Cont.):

Sample CDA Toolkit Program

/* Store the Flags item into the Bezier Curve aggregate. */
aggregate item = DDIF$ BEZ FLAGS;
integer value = Oxl; status ~ cda$store_item( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&integer_length,
&integer_value );
if ( FAILURE( status ) )
return ( status );

/*
** For the points to be used, store "VALUE CONSTANT" as the data type
** choice, followed by the value of the point.

*/
for

(i = 0; i < MAX_POINTS; i++ )
{

aggregate item = DDIF$ BEZ PATH C;
integer value = DDIF$K-VALUE CONSTANT;
aggregate_index = i * 2;
status = cda$store_item( &root aggregate handle,
~
&aggregate handle stack[ahs index],
&aggregate=item, &integer_length,
&integer value,
&aggregate_index );
if ( FAILURE( status ) )
return (status);
/* Store the x-coordinate integer value in the polyline path array. */
aggregate item = DDIF$ BEZ PATH;
integer_value = poly_points[i] [OJ;
aggregate_index = i * 2;
status = cda$store_item( &root aggregate handle, ~
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&integer_length,
&integer value,
&aggregate_index );
if ( FAILURE( status ) )
return (status);

I*
** Now store the y-coordinate for each point.
*/
aggregate item = DDIF$ BEZ PATH C;
integer value = DDIF$K-VALUE CONSTANT;
aggregate_index = ((2
i) +-1 );
status = cda$store_item( &root aggregate handle,
~
&aggregate handle stack[ahs index],
&aggregate=item, &integer_length,
&integer value,
&aggregate_index );
if( FAILURE( status ) )
return (status);

(continued on next page)

10-22

CDA Toolkit Example Program

Example 10-1 (Cont.):

Sample CDA Toolkit Program

aggregate_item = DDIF$_BEZ_PATH;
integer value= poly points[i] [l];
aggregate_index = ( (2 * i) + 1 ) ;
status = cda$store_item( &root aggregate handle,
I)
&aggregate_handle_stack[ahs_index],
&aggregate item,
&integer length,
&integer-value,
&aggregate_index );
if ( FAILURE( status ) )
return (status);
}; /* End of "for" loop */
ahs_index--; /* End of Bezier segment */

/* Insert two new-line directives to cause a skipped line. */
previous_aggregate_handle =aggregate handle stack[ahs index];
fJstatus = create_hrd_dir ( &root aggregate ha~dle,
&previous aggregate handle,
&aggregate handle stack[ahs index],
DDIF$K_DIR_NEW_LINE );
if ( FAILURE( status ) )
return (status);
previous_aggregate_handle = aggregate_handle_stack[ahs_index];
status = create_hrd dir ( &root aggregate handle,
&previous aggregate handle,
&aggregate handle stack[ahs index],
DDIF$K_DIR_NEW_LINE );
if ( FAILURE( status ) )
return (status);

/* Insert next general-text line. */
previous_aggregate_handle =aggregate handle stack[ahs index];
status = create_gtx ( &root aggregate-handle~
Cl
&previous_aggregate_handle,
&aggregate handle stack[ahs index],
"The following is a basket;;eave-f illed arc \
within a frame:" );
if ( FAILURE( status
return (status);

/* Insert two new-line directives to cause a skipped line. */
previous_aggregate_handle =aggregate handle stack[ahs index];
status = create hrd dir ( &root aggregate ha~dle, '8 &previous aggregate handle,
&aggregat; handle stack[ahs index],
DDIF$K_DIR_NEW_LINE );
if( FAILURE( status ) )
return (status);
previous_aggregate_handle = aggregate_handle_stack[ahs_index];
status = create_hrd_dir ( &root_aggregate_handle,
&previous_aggregate_handle,
&aggregate_handle_stack[ahs_index],
DDIF$K_DIR_NEW_LINE );
if ( FAILURE( status ) )
return ( status );

(continued on next page)
CDA Toolkit Example Program

10-23

Example 10-1 (Cont.):

Sample CDA Toolkit Program

/*
** Create new segment to define special segment attributes for
** the arc.
*/
previous aggregate handle= aggregate handle stack[ahs index];
aggregate_type = DDIF$_SEG;
status= cda$create_aggregate( &root_aggregate_handle, <I
&aggregate type,
&aggregate=handle_stack[ahs_index] );
if ( FAILURE( status ) )
return (status);

/* Insert after previous aggregate. */
status= cda$insert_aggregate( &aggregate_handle_stack[ahs_index],
&previous_aggregate_handle );
if ( FAILURE( status ) )
return ( status );

/* Store the segment ID. */
aggregate_item = DDIF$_SEG_ID;
status = cda$store_item( &root aggregate handle, ~
&aggregate handle stack[ahs index],
&aggregate-item, &filled arc label length,
filled=arc=label-);
if ( FAILURE( status ) )
return (status);
/* Store the segment type ("FRAME"). */
aggregate item = DDIF$ SEG SEGMENT TYPE;
status = cda$store item( &root aggregate handle,
&aggregate handle stack[ahs index],
&aggregate=item, &tyd_label_length,
tyd_label );
if ( FAILURE( status ) )
return (status);

/*
** Create a segment aggregate and store in the seg-content item.
*/
ahs_index++;
aggregate_type = DDIF$_SEG;
status = cda$create_aggregate( &root_aggregate_handle, ~
&aggregate type,
&aggregate=handle_stack[ahs_index] );
if ( FAILURE( status ) )
return (status);

(continued on next page)

10-24

CDA Toolkit Example Program

Example 10-1 {Cont.):

Sample CDA Toolkit Program

aggregate_item = DDIF$_SEG_CONTENT;
status = cda$store_item( &root_aggregate_handle,
CD
&aggregate_handle_stack[ahs_index-1],
&aggregate_item,
&aggregate_handle_length,
&aggregate_handle_stack[ahs_index] );
if ( FAILURE( status ) )
return (status);

/*
**Create new segment attributes aggregate to define the arc's
** attributes, and store it in the segment aggregate just created.
*/
ahs_index++;
aggregate_type = DDIF$_SGA;
status = cda$create_aggregate( &root_aggregate_handle, ~
&aggregate_type,
&aggregate_handle_stack[ahs_index] );
if ( FAILURE( status ) )
return (status);
aggregate_item = DDIF$_SEG SPECIFIC ATTRIBUTES;
~
status = cda$store_item( &root aggregate handle,
&aggregate_handle_stack[ahs_index-1],
&aggregate_item,
&aggregate handle length,
&aggregate=handle=stack[ahs_index] );
if ( FAILURE( status ) )
return ( status};

I*
** Now store the specific attributes for the arc.
*/
aggregate item = DDIF$ SGA LIN WIDTH C;
integer value = DDIF$K-VALUE CONSTANT;
status ~ cda$store_item( &root_aggregate_handle,
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&integer length,
&integer=value );
if ( FAILURE( status } )
return (status};
aggregate_item = DDIF$_SGA_LIN_WIDTH;
integer value = arc line width;
status ~ cda$store Item(-&root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate item,
&integer length,
&integer=value );
if( FAILURE( status ) )
return (status};

(continued on next page)

CDA Toolkit Example Program 10-25

Example 10-1 (Cont.):

Sample CDA Toolkit Program

aggregate item = DDIF$ SGA LIN STYLE;
integer value = DDIF$K-SOLID LINE STYLE;
status ~ cda$store item( &root aggregate handle,
&aggregate handle stack[ahs index],
&aggregate-item, &integer length,
&integer=value );
if ( FAILURE( status ) )
return (status);
aggregate item = DDIF$ SGA LIN END START;
integer value = DDIF$K-ROUND LINE END;
status ~ cda$store item( &root aggregate handle,
&aggregate handle stack[ahs index],
&aggregate-item, &integer length,
&integer=value );
if ( FAILURE( status ) )
return ( status );
aggregate item = DDIF$ SGA LIN END FINISH;
integer value = DDIF$K-ROUND LINE END;
status ~ cda$store item( &root aggregate handle,
&aggregate handle stack[ahs index],
&aggregate-item, &integer length,
&integer=value );
if ( FAILURE( status ) )
return (status);
aggregate item = DDIF$ SGA LIN JOIN;
integer value = DDIF$K-MITERED-LINE JOIN;
status~ cda$store item( &root-aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate item,
&integer length,
&integer=value );
if ( FAILURE( status ) )
return (status);
aggregate item = DDIF$ SGA LIN INTERIOR PATTERN;
integer value = DDIF$K-PATT BASKET WEAVE;
status ~ cda$store item( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&integer_length,
&integer_value );
if ( FAILURE( status ) )
return (status);
ahs_index--; /* End of line attributes */

(continued on next page)

10-26 CDA Toolkit Example Program

Example 10-1 (Cont.):

Sample CDA Toolkit Program

/* Create an Arc Content aggregate. */
aggregate_type = DDIF$_ARC;
previous aggregate handle= aggregate handle stack[ahs index];
ahs_index++;
status = cda$create_aggregate( &root_aggregate_handle, I>
&aggregate_type,
&aggregate_handle_stack[ahs_index] );
if( FAILURE( status ) )
return ( status );

/*
** Store the arc-content aggregate as the seg_content of the previous

** aggregate.
*I
aggregate_item = DDIF$_SEG_CONTENT;
status = cda$store_item( &root_aggregate_handle, fi
&aggregate_handle_stack[ahs_index-1],
&aggregate_item,
&aggregate_handle_length,
&aggregate_handle_stack[ahs_index] );
if ( FAILURE( status ) )
return (status);

I* Store the Flags item into the arc aggregate. */
set arc flags.ddif$v arc draw arc = 1;
set-arc-flags.ddif$v-arc-fill-arc = 1;
set=arc=flags.ddif$v=arc=2ie_arc = 1;
set arc flags.ddif$v arc close arc = 0;
set=arc=flags.ddif$v=arc=flags=fill = O;
aggregate item = DDIF$ ARC FLAGS;
status = cda$store_item( &root_aggregate_handle,
&aggregate_handle_stack[ahs_index],
&aggregate item,
&integer_length,
&set_arc_flags );
if ( FAILURE( status ) )
return ( status );

/* Store "VALUE CONSTANT" as the data type choice for the arc
center x-coordinate. */
aggregate item = DDIF$ ARC CENTER X C;
integer value = DDIF$K-VALUE CONSTANT;
status ~ cda$store_item( &root_aggregate_handle,
&aggregate handle stack[ahs index],
&aggregate-item, &integer length,
&integer=value );
if ( FAILURE( status ) )
return (status);

(continued on next page)

CDA Toolkit Example Program

10-27

Example 10-1 (Cont.):

Sample CDA Toolkit Program

/* Store an integer value for the arc center x-coordinate. */
aggregate item = DDIF$ ARC CENTER X;
integer value = 3000; status ~ cda$store_item( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate item,
&integer length,
&integer=value );
if ( FAILURE( status ) )
return (status);

/* Store "VALUE CONSTANT" as the data type choice for the arc
center y-coordinate. */
aggregate_item = DDIF$_ARC_CENTER_Y_C;
integer value = DDIF$K VALUE CONSTANT;
status ~ cda$store ite~( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&integer_length,
&integer_value );
if ( FAILURE( status ) )
return (status);
/* Store an integer value for the arc center y-coordinate. */
aggregate item = DDIF$ ARC CENTER Y;
integer value = 150; status ~ cda$store_item( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&integer length,
&integer=value );
if ( FAILURE( status ) )
return (status);

/* Store "VALUE CONSTANT" as the data type choice for the arc
radius x value. */
aggregate item = DDIF$ ARC RADIUS X C;
integer_value = DDIF$K=VALUE_CONSTANT;
status = cda$store item( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&integer length,
&integer=value );
if ( FAILURE( status ) )
return (status);
/* Store an integer value for the arc radius x value. */
aggregate item = DDIF$ ARC RADIUS X;
integer value = 2000; status ~ cda$store_item( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&integer length,
&integer=value );
if ( FAILURE( status ) )
return (status);

(continued on next page)
1~28

CDA Toolkit Example Program

Example 10-1 (Cont.):

Sample CDA Toolkit Program

I* Store "ANGLE CONSTANT" as the data type choice for the arc
start value. */
aggregate item = DDIF$ ARC START C;
integer value = DDIF$K-ANGLE CONSTANT;
status ~ cda$store item( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate item,
&integer length,
&integer=value );
if ( FAILURE( status ) )
return (status);

/* Store an integer value for the arc start value. */
aggregate_item = DDIF$_ARC_START;
local_length = sizeof( arc_start );
status = cda$store item( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&local_length,
&arc_start );
if ( FAILURE( status ) )
return (status);

/* Store "ANGLE CONSTANT" as the data type choice for the arc
EXTENT value. */
aggregate_item = DDIF$_ARC_EXTENT_C;
integer_value = DDIF$K_ANGLE_CONSTANT;
status = cda$store item( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&integer_length,
&integer_value );
if ( FAILURE( status ) )
return (status);

/* Store an integer value for the arc EXTENT value. */
aggregate_item = DDIF$_ARC_EXTENT;
local_length = sizeof( arc_extent );
status = cda$store item( &root aggregate handle,
&aggregate_handle_stack[ahs_index],
&aggregate_item,
&local_length,
&arc_extent );
i f ( FAILURE( status ) )
return ( status ) ;
ahs - index--; /* End of arc. */
ahs - index--; I* End of arc-attribute segment */

/* Insert two new-line directives to cause a skipped line. */
previous_aggregate_handle =aggregate handle stack[ahs index];
status = create hrd dir ( &root_aggre~ate_ha~dle,
&previous_aggregate_handle,
&aggregate handle stack[ahs index],
DDIF$K_DIR_NEW_LINE );
if ( FAILURE( status ) )
return (status);

€1

(continued on next page)
CDA Toolkit Example Program

10-29

Example 10-1 (Cont.):

Sample CDA Toolkit Program

previous aggregate handle= aggregate_handle_stack[ahs_index];
status =-create_hrd_dir ( &root_aggregate_handle,
&previous aggregate handle,
&aggregate_handle_stack[ahs_index],
DDIF$K_DIR_NEW_LINE );
if ( FAILURE( status ) )
return (status);

/* Insert next general-text line. */
previous_aggregate_handle =aggregate handle stack[ahs index];
status = create gtx ( &root aggregate -handle~
fl &previous aggregate handle,
&aggregate_handle_stack[ahs_index],
"This ends the examples." );
if( FAILURE ( status
return ( status ) ;
ahs index--; /* End of image segment */
ahs index--; I* End of document content. *I
/* Create an output file to receive the DDIF stream. */
status= cda$create_file( &filename_length,
filename,
O, 0, 0, 0, O,
&root_aggregate_handle,
&result file spec len,
result-file-spec~

&result=file=spec_len,
&stream_handle,
&file_handle,
&root_aggregate_handle );
if ( FAILURE( status ) )
return ( status );
result file spec[result file spec len] = 0;
printf("Created file: %s\n",result_file_spec );
/* Write the DDIF stream to the output file */
printf("Writing document ... \n" ) ;
status= cda$put_document( &root_aggregate_handle,
&stream_handle );
if ( FAILURE( status ) )
return (status);

I* Close the output file. */
status = cda$close_file( &stream_handle,
&file_handle );
if ( FAILURE( status ) )
return (status);
/* Delete the Root aggregate structure. */
status= cda$delete_root_aggregate( &root_aggregate_handle );
if ( FAILURE( status ) )
return (status);
return;

(continued on next page)
10-30

CDA Toolkit Example Program

Example 10-1 (Cont.):

Sample CDA Toolkit Program

/*
** This routine creates a hard-directive aggregate for the specified
** directive type, and inserts it after the specified previous
** aggregate. It returns the handle of the newly-created aggregate.

*I
unsigned long create hrd dir (root_handle,
previous_handle,
return_handle,
dir_type )
unsigned long *root_handle;
unsigned long *previous_handle;
unsigned long *return handle;
unsigned long dir_type;
unsigned long
unsigned long
unsigned long
unsigned long
unsigned long
unsigned long
unsigned long

/*
/*
/*
/*

Root aggregate handle. */
previous handle */
Handle to be returned. */
Directive item code. */

aggregate_handle;
aggregate_handle_length
sizeof( aggregate_handle );
aggregate_type;
aggregate_item;
integer_value;
integer_length
sizeof( integer_value );
status;

/* Create a Hard Directive aggregate. */
aggregate type = DDIF$ HRD;
status= cda$create_aggregate(root_handle,
&aggregate_type,
&aggregate_handle );
if ( FAILURE( status ) )
return (status);
/* Insert the Hard Directive aggregate in the sequence of aggregates. */
status = cda$insert_aggregate( &aggregate_handle,
previous_handle );
if ( FAILURE( status ) )
return (status);
/* Store the designated directive as an item in the
Hard Directive aggregate. */
aggregate item = DDIF$ HRD DIRECTIVE;
integer value = dir type; status ~ cda$store_Item(root_handle,
&aggregate_handle,
&aggregate item,
&integer_length,
&integer_value );
if ( FAILURE( status ) )
return (status);
*return handle = aggregate_handle;
return(l );

(continued on next page)

CDA Toolkit Example Program

10-31

Example 10-1 (Cont.):

Sample CDA Toolkit Program

/*
** This routine creates a general-text aggregate for the specified
** text, and inserts it after the specified previous aggregate. It
** returns the handle of the newly-created aggregate.

*I
unsigned long create_gtx (root handle,
prevfous_handle,
return handle,
gtx_string )
unsigned long *root handle;
unsigned long *previous_handle;
unsigned long *return_handle;
char
*gtx_string;

unsigned long
unsigned long
unsigned long
unsigned long
unsigned long
unsigned long
unsigned long
unsigned long

aggregate_handle;
aggregate_handle_length
aggregate_type;
aggregate_item;
add_info;
integer_value;
local_length;
status;

/* Root aggregate handle. */
/* previous handle */
/* Handle to be returned. */
/* Ptr to text string. */

sizeof( aggregate_handle );

/* Create another General Text Content aggregate. */
aggregate type = DDIF$ GTX;
status= cda$create_aggregate(root_handle,
&aggregate_type,
&aggregate_handle );
if ( FAILURE( status ) )
return (status);
/* Insert the Text aggregate in the sequence of aggregates. */
status = cda$insert_aggregate( &aggregate handle,
previous_handle );
if ( FAILURE( status ) )
return (status);
/* Store more text into the General Text aggregate. */
aggregate item = DDIF$ GTX CONTENT;
add_info ~ CDA$K_ISO_LATINl;
local length= strlen( gtx string);
status = cda$store item(root handle,
&aggregate_handle,
&aggregate_item,
&local length,
gtx_string,
0,
&add info);
if ( FAILURE( status ) )
return (status);
*return handle = aggregate_handle;

(continued on next page)

10-32 CDA Toolkit Example Program

Example 10-1 (Cont.):

Sample CDA Toolkit Program

return(l );

Example 10-2 illustrates the Analysis output of the DDIF document created
by Example 10-1. The callouts in Example 10-1 correspond to the callouts in
Example 10-2.
In the Analysis output of a DDIF file, the following symbols are used.
•

A left brace indicates the beginning of an aggregate.

•

A right brace indicates the end of an aggregate.

•

A left parenthesis indicates the beginning of an array.

•

A right parenthesis indicates the end of an array.

Additionally, in this example all hexadecimal values produced by the Analysis
back end have been restored to their ASCII representations.
Note that default values are indicated by the comment "[Default value.]". These
values are not specified in Example 10-1; instead, the default values specified by
the CDA Toolkit are accepted.
Example 10-2:

Analysis Output of DDIF File

DDIF DOCUMENT
DDF DESCRIPTOR
DSC MAJOR VERSION 1 ! Longword Integer
DSC MINOR VERSION 0
Longword Integer
DSC_PRODUCT_IDENTIFIER "DDIF$"
DSC PRODUCT NAME

(

ISO LATINl

"Test Vl.0"
)

}

•

••
••

DDF HEADER
DHD EXTERNAL REFERENCES
ERF- DATA- TYPE

(

(continued on next page)

CDA Toolkit Example Program

10-33

Example 10-2 (Cont.):

Analysis Output of DDIF File

1 ! Object Identifier
3 ! Object Identifier
12 ! Object Identifier
1011 ! Object Identifier
1
Object Identifier
3
Object Identifier
1
Object Identifier
)

ERF DESCRIPTOR

•
•

ISO LATINl

"Style Guide"
)

ERF LABEL

ISO LATINl "defstyle"
! Char. string.
ERF_LABEL_TYPE STYLE_LABEL_TYPE "$STYLE"
ERF CONTROL NO_COPY_REFERENCE ! Integer = 2
}

DHD LANGUAGES C
•
•

IS0_639_LANGUAGE
I SO 6 3 9 LANGUAGE

Integer
Integer

0
0

)

DHD LANGUAGES
(

"E/USA/"
"Mandarin"

.{
•

DHD_STYLE_GUIDE

Longword Integer

DDF CONTENT

fJ) SEG_CONTENT

G){

•I•
••
•••
••
•

SEG SEGMENT TYPE "PARA"
SEG- SPECIFIC- ATTRIBUTES
'

{

SGA TYPE DEFNS

{

TYD LABEL "FRAME"
TYD ATTRIBUTES
{

SGA_CONTENT_CATEGORY TWOD_CATEGORY "$2D"
SGAjRM_FLAGS "%B01000000000000000000000000000000"
Flags
SGA_FRM_BOX_LL_X_C VALUE_CONSTANT ! Integer = 0
SGA_FRM_BOX_LL_X 0 ! Longword Integer
SGA_FRM_BOX_LL_Y_C VALUE_CONSTANT
Integer
0
SGA_FRM_BOX_LL_Y 0 ! Longword Integer
SGA_FRM_BOX_UR_X_C VALUE CONSTANT ! Integer
0
SGA_FRM_BOX_UR_X 6000 ! Longword Integer
SGA_FRM_BOX_UR_Y_C VALUE_CONSTANT ! Integer
0
SGA_FRM_BOX_UR_Y 2400 ! Longword Integer
SGA_FRM_POSITION_C FRAME GALLEY ! Integer = 2
SGA_FRMGLY_VERTICAL FRMGLY_BELOW_CURRENT
Integer
SGA_FRMGLY_HORIZONTAL FMT_CENTER_OF_PATH ! Integer

1
2

[Default]
[Default]

}

}
}

(continued on next page)

10-34 CDA Toolkit Example Program

Example 10-2 (Cont.):

9
~

SEG CONTENT
{
TXT CONTENT

Analysis Output of DDIF File

"This is the first line of the example text."

G
HRD DIRECTIVE

DIR SPACE

Integer

}

GTX CONTENT ISO LATINl "This is the second line of the example text,
and should be separated from the first line by a single space."
! Char. string.
}

HRD DIRECTIVE

DIR NEW LINE

Integer

}

{

GTX CONTENT ISO LATINl
begin on a new line."
! Char. string.

"The third line of the example text will

HRD DIRECTIVE

DIR NEW LINE

Integer

HRD DIRECTIVE

DIR NEW LINE

Integer

}
{
}
{

GTX CONTENT ISO LATINl "The fourth line of the example text will be
separated from the previous lines by a blank line, and will be the last
text on the first page."
Char. string.
}
{

HRD DIRECTIVE

DIR NEW PAGE

Integer

}
{

GTX_CONTENT ISO_LATINl "The following is a Bezier curve, using the
same path as the polyline, within a frame:"
! Char. string.
}

SEG ID

"pline"
SEG- SEGMENT- TYPE
SEG CONTENT

"FRAME"

{

••

LIN FLAGS "%B10000000000000000000000000000000"
LIN- DRAW- PATTERN "%Bllll" ! Bit string
LIN- PATH- C

Flags

(

VALUE CONSTANT ! Integer
0
VALUE CONSTANT ! Integer
0
VALUE CONSTANT
VALUE CONSTANT
VALUE CONSTANT
VALUE CONSTANT
VALUE CONSTANT
VALUE CONSTANT

Integer
Integer
Integer
Integer
Integer
Integer

0
0
0
0
0
0

)

(continued on next page)

CDA Toolkit Example Program

10-35

Example 10-2 (Cont.):

Analysis Output of DDIF File

LIN PATH

••

(

500
500

Integer
Integer
2500
Integer
2000
Integer
3500
Integer
2000
Integer
5500
Integer
500 ! Integer
)

••

}

HRD DIRECTIVE

DIR NEW LINE

Integer

HRD DIRECTIVE

DIR NEW LINE

! Integer = 2

}
{
}

within a frame:"

GTX CONTENT ISO LATINl
! Char. string.

"The following is a polyline

HRD DIRECTIVE

DIR NEW LINE

Integer

HRD DIRECTIVE

DIR_NEW_LINE

Integer

HRD DIRECTIVE

DIR_NEW_LINE

Integer

HRD DIRECTIVE

DIR NEW LINE

Integer

}

{
}
{
}

•

.
•

SEG ID

"bline"
SEG SEGMENT TYPE "FRAME"
SEG CONTENT
{
BEZ FLAGS "%B10000000000000000000000000000000"
BEZ PATH C
(

Flags

VALUE CONSTANT ! Integer
0
VALUE CONSTANT ! Integer
0
VALUE CONSTANT
VALUE CONSTANT
VALUE CONSTANT
VALUE CONSTANT
VALUE CONSTANT
VALUE CONSTANT

Integer
Integer
Integer
Integer
Integer
Integer

0
0
0
0
0
0

)

(continued on next page)

10-36

CDA Toolkit Example Program

Example 10-2 (Cont.):

Analysis Output of DDIF File

BEZ PATH
(

500
500

Integer
Integer
2500
Integer
2000
Integer
3500
Integer
2000
Integer
5500
Integer
500 ! Integer
)
}
}

HRD DIRECTIVE

DIR_NEW_LINE

Integer

HRD DIRECTIVE

DIR NEW LINE

! Integer = 2

}

{
}

GTX CONTENT ISO LATINl
basketweave-filled arc within a frame:"

"The following is a
'! Char. string.

}

HRD DIRECTIVE

DIR NEW LINE

Integer

HRD DIRECTIVE

DIR NEW LINE

Integer

}

.
(i

SEG ID

"filled arc"
SEG- SEGMENT- TYPE
SEG CONTENT
{
SEG SPECIFIC ATTRIBUTES

"FRAME"

SGA LIN WIDTH C VALUE CONSTANT ! Integer = 0
SGA LIN WIDTH 60 ! Longword Integer
SGA LIN STYLE SOLID_LINE STYLE ! Integer = 1
SGA_LIN END_START ROUND LINE END ! Integer
2
SGA_LIN END_FINISH ROUND LINE END ! Integer = 2
SGA_LIN_JOIN MITERED LINE_JOIN
Integer = 1
SGA LIN INTERIOR PATTERN 41 ! Longword Integer

(continued on next page)

CDA Toolkit Example Program

10-37

Example 10-2 (Cont.):

Analysis Output of DDIF File

SEG CONTENT

{
ARC FLAGS "%B11100000000000000000000000000000"
Flags
ARC_CENTER_X_C VALUE CONSTANT ! Integer
0
ARC CENTER X 3000 ! Longword Integer
ARC CENTER Y C VALUE_CONSTANT ! Integer
0
ARC_CENTER_Y 150 ! Longword Integer
ARC RADIUS X C VALUE_CONSTANT ! Integer
0
ARC_RADIUS_X 2000
Longword Integer
ARC_RADIUS_DELTA_Y_C VALUE_CONSTANT ! Integer = 0 [Default]
ARC RADIUS DELTA_Y 0 ! Longword Integer [Default]
ARC START C ANGLE CONSTANT ! Integer = 0
ARC-START-"%F4.5000ooe+01"

Single Pree. Floating Point

ARC_EXTENT_C ANGLE CONSTANT ! Integer = 0
ARC EXTENT "%F9.000000e+Ol"
Single Pree. Floating Point
ARC_ROTATION_C ANGLE_CONSTANT ! Integer = 0 [Default]
ARC ROTATION "%F0.000000e+00" ! Single Pree. Floating Point [Default]
}

}
}

HRD DIRECTIVE

DIR NEW LINE

Integer

HRD DIRECTIVE

DIR NEW LINE

Integer

}
{
}

GTX CONTENT

ISO LATINl

}
}

10-38 CDA Toolkit Example Program

"This ends the examples."

Char. string.

Chapter 11

CDA Converter Routines
This chapter provides detailed discussions of the converter routines and the
VMS and ULTRIX compile and link procedures that applications must create in
writing CDA-conforming front and back ends. Each routine description includes
the following information:
•

A routine definition that each application must name according to its
operating system-specific format

•

Descriptions of each routine argument

•

A description of the routine itself

•

A list of possible values returned by each routine argument
NOTE

11.1

Compile and Link Procedures for Converter Images
To create a VMS or ULTRIX front or back end image using the CDA Toolkit
routines, include the following public files in your source code:
VMS and ULTRIX
File Names

Description

SYS$LIBRARY:cda$deih
/usr/include/cda_def.h

CDA Toolkit keyword definitions

SYS$LIBRARY:ddif$def.h
/usr/include/ddif_def.h

DDIF aggregate definitions

SYS$LIBRARY:dtif$def.h
/usr/include/dtif_def.h

DTIF aggregate definitions

SYS$LIBRARY:cda$msg.h
/usr/include/cda_msg.h

CDA error messages

Section 11.1.1 describes the VMS compile and link procedure for CDA converters.
Section 11.1.2 describes the ULTRIX compile and link procedure for CDA
converters.

CDA Converter Routines

11-1

11.1.1

VMS Compile and Link Procedure
You can compile and link a front end on VMS using the following build procedure:
$ cc ddif$cvt src:cda$rtx
$ link /share=ddif$read text sys$input:/option
identification="DECwindows vl.0"
universal = ddif$read_text
gsmatch=lequal,1,0
psect=$char string constant,shr,exe,nowrt
psect=$data~shr,exe,nowrt

cda$rtx
sys$library:cda$access/share
sys$share:vaxcrtl/share

You can compile and link a back end on VMS using the following build procedure:
$ cc ddif$cvt src:cda$rtx
$ link /share=ddif$write text sys$input:/optio;
identification="DECwindows vl.0"
universal = ddif$write_text
gsmatch=lequal,1,0
psect=$char string constant,shr,exe,nowrt
psect=$data~shr,exe,nowrt

cda$rtx
sys$library:cda$access/share
sys$share:vaxcrtl/share

Note that this compile and link procedure does not provide debugging.
When the build is complete, define a logical named domain$read_format that
points to your executable image so that the CONVERT/DOCUMENT or cdoc
command will locate your converter when the CDA$_1NPUT_FORMAT value (for
front ends) or the CDA$_0UTPUT_FORMAT value (for back ends) is passed into
the std-item list.

11.1.2

ULTRIX Compile and Link Procedure
You can compile and link a front end on ULTRIX using the following build
procedure:
% cc -o ddif_read_myformat ddif_read_myformat.c -lddif fe -lddif -lm

You can compile and link a back end on ULTRIX using the following build
procedure:
% cc -o ddif_write_myformat ddif_write_myformat.c -lddif be -lddif -lm

In the build procedure for a front end or back end on ULTRIX systems, the -Im
parameter specifies the math library that is required by the CDA Toolkit routines
(-lddif).
When the build procedure on ULTRIX systems is complete, you should store the
output file in the /usr/bin directory for use with the cdoc command. Alternatively,
you can define CDAPATH (an environment variable) to be the directory containing
your front end or back end. The CDA Converter Kernel searches CDAPATH first
when you invoke the cdoc command.
11-2 CDA Converter Routines

Close Entry Point

Close Entry Point
Terminates the operation of a front end by closing all open files and releasing all
dynamic memory and other resources that have been allocated by the front end.
The close routine is one of the routines that compose a front end.

FORMAT

status

=close-procedure
(front-end-context)

Argument Information

Argument

Argument Iriformation

status

Usage:

cond_value

front-end-context

Data type:

longword (unsigned)

Access:

write only

Mechanism:
Usage:

by value
context

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

RETURNS

status
A condition value indicating the return status of the routine call.
front-end-context
Context returned by either ddif$read_format or dtif$read_format.

The front-end-context argument is the address of an unsigned longword that
contains this context. This context must specify the input file or stream to be
closed.

CDA Converter Routines

11-3

Close Entry Point

Description
In the document method of conversion, the input file or stream has already been
closed by the ddif$read_format or dtif$read_format routine. Therefore, the close
routine simply performs regular cleanup operations and returns control to the
CDA Converter Kernel.
In the aggregate method of conversion, the close routine must close the currently
open file or stream in addition to performing the regular cleanup work. If the
format of the input file is not DDIF, DTIF, or Text, the front end must supply its
own file-closing capability, typically through the use of the RMS $CLOSE service,
or the close C run-time library routine or equivalent language statement. Once
all cleanup work has been completed, the close routine passes control back to the
CDA Converter Kernel.
The name of this routine is defined by the user. The front end simply returns the
address of this routine to the CDA Converter Kernel.

RETURN VALUES··

Return Value

Description

CDA$_NORMAL

Normal successful completion

The close routine can also return any front end-specific error conditions.

11-4 CDA Converter Routines

Get-Aggregate Entry Point

Get-Aggregate Entry Point
Returns the next aggregate in the document to the converter kernel. The getaggregate routine is one of the routines that compose a front end.

FORMAT

status = get-aggregate-procedure
(front-end-context , aggregate-handle
,aggregate-type)

Argument Information

Argument

Argument Information

status

Usage:

cond_value

Data type:

longword (unsigned)

front-end-context

aggregate-handle

aggregate-type

Access:

write only

Mechanism:
Usage:

by value
context

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

Usage:

identifier

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

Usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

RETURNS
status
A condition value indicating the return status of the routine call.

CDA Converter Routines

11-5

Get-Aggregate Entry Point
front-end-context
Context returned from either ddif$read_format or dtif$read_format.

The front-end-context argument is the address of an unsigned longword that
contains this context. Typically, this argument is used to specify the type of
content aggregate to be created by the get-aggregate routine.
aggregate-handle
Receives the handle of the created and populated aggregate. The aggregatehandle argument is the address of an unsigned longword that receives this
aggregate handle. This handle must be used in all subsequent operations on that
aggregate.
aggregate-type
Receives the aggregate type. The aggregate-type argument is the address of an
unsigned longword that receives this aggregate type. If the aggregate is of type
DDIF$_EOS (end of segment), aggregate-handle is 0.

Description
Depending on the conversion used, the get-aggregate routine either creates and
populates the next document content aggregate (aggregate method of conversion)
or it reads the next aggregate from the in-memory document (document method
of conversion). In either case, the returned aggregate must not be part of a
sequence, and the DDIF$_SEG_CONTENT item of a DDIF$_SEG aggregate must
be empty; the content must be returned one aggregate at a time followed by a
DDIF$_EOS (end of segment) aggregate.
A front end should create aggregates on demand, rather than first creating the
entire document in memory. However, if the entire document must be available
in memory in order for the conversion to take place, the get-aggregate routine
must use the PRUNE AGGREGATE routine to return the next content aggregate
from the in-memory document. The PRUNE AGGREGATE routine removes the
next sequential document content aggregate from an existing in-memory DDIF
document and returns the aggregate identifier and type.
Before creating any of the document content aggregates, the get-aggregate routine
must first create the required aggregates. For document data, the required
aggregates are DDIF$_DSC, DDIF$_DHD, and DDIF$_SEG. For table data, the
required aggregates are DTIF$_HDR, DTIF$_DSC, and DTIF$_TBL. Once these
aggregates are created and the appropriate items have been stored (using the
STORE ITEM routine), the get-aggregate routine creates and populates each
sequential document content aggregate (and its subaggregates) that results from
the translation of the input document. Once these aggregates are created and
populated, the get-aggregate routine returns the handle and type of the parent
aggregate. The aggregate type created must be a top-level content type, as listed
in Table 11-1.

11-6

CDA Converter Routines

Get-Aggregate Entry Point

Table 11-1: Top-Level Aggregate Types
Aggregate Type

Meaning

DDIF$_DSC

Document descriptor

DDIF$_DHD
DDIF$_SEG

Document header
Document segment

DDIF$_TXT
DDIF$_GTX

Text content

DDIF$_HRD

General text content

DDIF$_SFT

Hard directive
Soft directive

DDIF$_HRV

Hard value directive

DDIF$_SFV

Soft value directive

DDIF$_BEZ

Bezier curve content

DDIF$_LIN

Polyline content

DDIF$_ARC

Arc content

DDIF$_FAS
DDIF$_IMG

Fill area set content
Image content

DDIF$_CRF

Content reference

DDIF$_EXT

External content

DDIF$_PVT
DDIF$_GLY

Private content
Layout galley

DDIF$_EOS

End of segment

DTIF$_DSC

Table descriptor

DTIF$_HDR

Table header

DTIF$_TBL

Table definition

DTIF$_ROW

Table row

DTIF$_CLD

Table cell

The name of this routine is defined by the user. The front end simply returns the
address of this routine to the CDA Converter Kernel.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA$_ENDOFDOC

End of document

The get-aggregate routine can also return any front end-specific error conditions.
Note that the get-aggregate routine must return the status CDA$_ENDOFDOC
when the document has been completely transferred.

CDA Converter Routines

11-7

Get-Position Entry Point

Get-Position Entry Point
Returns the current position in and total size of the current data stream. The
get-position routine is one of the routines that compose a front end.

FORMAT

status = get-position-procedure
(front-end-handle ,stream-position ,stream-size)

Argument Information

Argument
status

front-end-handle

stream-position

stream-size

Argument Information
Usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

Usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

Usage:
Data type:

longword_unsigned
longword (unsigned)

Access:

write only

Mechanism:

by reference

Usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by reference

RETURNS
status
A condition value indicating the return status of the routine call.

11-8 CDA Converter Routin~s

Get-Position Entry Point
front-end-handle
Identifier of the front end. The front-end-handle argument is the address of an
unsigned longword that contains this handle. The front end handle is returned
by either ddif$read_format or dtif$read_format.
stream-position
Receives the current position (in bytes) as measured from the start of the input
stream being processed. The stream-position argument is the address of an
unsigned longword that receives this position.
stream-size
Receives the total size (in bytes) of the input stream being processed. The
stream-size argument is the address of an unsigned longword that receives this
size.

Description
The get-position routine provides a method for a back end to determine the total
size of the current input stream, as well as to determine the current position
within the stream. This routine is useful for viewer back ends that provide a
scroll bar indicating the current position in the document being viewed.
The name of this routine is defined by the user. The front end simply returns the
address of this routine to the CDA Converter Kernel.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

CDA Converter Routines

11-9

domain$read_format Entry Point

domain$read_formatEntry Point
Initializes the conversion process and establishes any special processing information for the front end. The domain$read_format routine is one of the routines
that compose a front end.

FORMAT
status= domain$read_format (standard-item-list ,converter-context
, front-end-context
,get-aggregate-procedure
,get-position-procedure
, close-procedure)

Argument Information

Argument

Argument Information

status

Usage:

cond_value

Data type:

longword (unsigned)

Access:

write only

Mechanism:
Usage:

by value
item_list_2

Data type:

record

Access:

read only

Mechanism:

by reference,array reference

Usage:

context

standard-item-list

converter-context

front-end-context

11-10

CDA Converter Routines

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

Usage:

context

Data type:

longword

Access:

write only

Mechanism:

by reference

domain$read_format Entry Point

Argument

Argument Information

get-aggregate-procedure

Usage:

get-position-procedure

close-procedure

procedure

Data type:

procedure entry mask

Access:

write only

Mechanism:

by reference

Usage:

procedure

Data type:

procedure entry mask

Access:

write only

Mechanism:
Usage:

by reference
procedure

Data type:

procedure entry mask

Access:

write only

Mechanism:

by reference

RETURNS
status
A condition value indicating the return status of the routine call.

Arguments
standard-item-list
An item list that identifies the document source and may also contain options to
control processing. The standard-item-list argument is the address of this item
list.

Each entry in the item list is a 2-longword structure with the following format:

item code

buffer length
buffer address

0
4

To terminate the item list, you must specify the final entry or longword as zero.
Valid code values for the items in the front end standard-item-list are as
follows:
•

CDA$_INPUT_FILE
The address and length of the file specification of the input document.

CDA Converter Routines

11-11

domain$read_format Entry Point

•

CDA$_INPUT_DEFAULT
The address and length of a string that specifies the default input file type.
To simplify the porting of applications, the string should consist of only a file
type in lowercase characters. If this parameter is omitted, the front end must
supply an appropriate default file specification.

•

CDA$_INPUT_PROCEDURE
The address of a user get procedure that provides input. The item list length
field must be set to 0. The input procedure must conform to the requirements
for a user get routine. For more information on the calling sequence for a
user get routine, see the description of the Get entry point.

•

CDA$_INPUT_PROCEDURE_PARM
The address of a longword parameter to the input procedure. The item list
length field must be set to 4.

•

CDA$_INPUT_POSITION_PROCEDURE
The parameter is the address of a procedure that provides position information. The item-list length field must be set to 0. For more information on the
get-position procedure, see the description of the Get-Position entry point.

•

CDA$_PROCESSING_OPTION
The address and length of a string that contains an option to control processing. The format name and leading spaces and tabs have been removed from
the string. This item code may occur more than once in the item list.

Either the CDA$_INPUT_FILE item or the CDA$_INPUT_PROCEDURE item,
but not both, must occur once in the item list. If the CDA$_INPUT_PROCEDURE
item is specified, then a single value for CDA$_INPUT_PROCEDURE_PARM can
also be specified.
NOTE

If, in processing the standard item list, you encounter an unrecognized
item, your front or back end should ignore that item and not return an
error.
converter-context
Converter context required to call the OPEN CONVERTER routine. The
converter-context argument is the address of an unsigned longword that
contains this context.
front-end-context
Receives a front-end-defined value that identifies this particular instance of
the front end. The front-end-context argument is the address of an unsigned
longword that receives this context. This value is returned to the get-aggregateprocedure and the close-procedure arguments described later. All writable
memory used by the front end must be allocated from dynamic memory and
located by reference to this value.

11-12 CDA Converter Routines

domain$read_format Entry Point
get-aggregate-procedure
Receives the address of the get-aggregate routine. The get-aggregate-procedure
argument receives the address of this procedure entry mask. For more information on the calling sequence for the get-aggregate routine, see the description of
the Get-Aggregate entry point.
get-position-procedure
Receives the address of the get-position routine. The get-position-procedure
argument receives the address of this procedure entry mask. For more information on the calling sequence for the get-position routine, see the description of the
Get-Position entry point.
close-procedure
Receives the address of the close routine. The close-procedure argument
receives the address of this procedure entry mask. For more information on the
calling sequence for the close routine, see the description of the Close entry point.

Description
The read_form.at entry points (ddif$read_format and dtif$read_format) are
the initial entry points in the front end. The read_format routine initializes the
conversion process and establishes any special processing information for the
front end. The term format in the entry point name refers to the name of the
document format that is read by this particular front end. For example, the entry
point for the Text front end is ddif$read_TEXT.
On ULTRIX systems, front end and back end converters are invoked as subprocesses, rather than being dynamically loaded into the same address space, as
they are on VMS systems. Because of this, on ULTRIX systems the entry point
name for the read_format entry point is always the same, cda$read_format, no
matter what the format name. This is usually accomplished in source code by
using a "jacket" routine named cda$read_format that simply calls the real routine
(ddif$read_form.at or dtif$read_format) with the same parameters (see the Text
front end source code example in Chapter 12). Another way of accomplishing
this is to use compiler directives (#ifdef in the C language) to name the function
differently, depending on the operating system.
In order to initialize a document or aggregate method of conversion, the
ddif$read_format or dtif$read_format routine must first process the usersupplied item list, storing all pertinent information in the context block.
The item list structure that is used to pass this information between the front
end, back end, and the kernel is created by the CDA Converter Kernel; this
structure contains the following fields:
•

cda$w_item_length specifies the length of the item.

•

cda$w_item_code specifies the item code, selected from the list specified for
the standard-item-list argument.

•

cda$w_item_address specifies the address of the item.

These fields are defined in the file cda$def.h on VMS systems and in the file
cda_def.h on ULTRIX systems.

CDA Converter Routines

11-13

domain$read_format Entry Point

In addition, the ddif$read_format or dtif$read_format routine must process any
specified processing options that the user selects for this conversion.
If the format of the input file is not DDIF, DTIF, or Text, the front end must

supply its own file-opening capability, typically through the use of the RMS
$OPEN service, or the open C run-time library routine or equivalent language
statement.

It is also recommended that the ddif$read_format routine define values for at
least the following aggregate items:
•

DDIF$_DSC_PRODUCT_IDENTIFIER specifies the registered facility
mnemonic for the product that encoded the document.

•

DDIF$_DSC_PRODUCT_NAME specifies the name of the product that
encoded the document.

The ddif$read_format or dtif$read_format routine must call the CREATE ROOT
AGGREGATE routine to create the document root aggregate. In the case of
aggregate-method conversion, once the root aggregate is created, control passes
back to the CDA Converter Kernel.
In the case of document-method conversion, the read_format routine must
also create the appropriate aggregates before reading the entire document from
the input stream and placing it in memory. For document data, the required
aggregates are DDIF$_DSC, DDIF$_DHD, and DDIF$_SEG. For table data,
the required aggregates are DTIF$_HDR, DTIF$_DSC, and DTIF$_TBL. Once
the entire document is in memory, the ddif$read_format or dtif$read_format
routine must close the input stream (and, if applicable, the input file). Again, if
the format of the input file is not DDIF, DTIF, or Text, the read_format routine
must supply its own file-closing capability, typically through the use of the RMS
$CLOSE service, or the close C run-time library routine or equivalent language
statement. At this point, control passes back to the CDA Converter Kernel.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion

The read_format entry point can also return any front end-specific error conditions.

11-14 CDA Converter Routines

domain$write_format Entry Point

domain$write_formatEntry Point
Requests aggregates from the front end, converts them from the CDA in-memory
format to the specified output format, and writes the information to the specified
output file. The domain$write_format routine composes a back end.

FORMAT
status= domain$write_format (function-code ,standard-item-list
,private-item-list , front-end-handle
, back-end-context)

Argument Information

Argument

Argument Information

status

Usage:

cond_value

function-code

standard-item-list

private-item-list

front-end-handle

Data type:

longword (unsigned)

Access:

write only

Mechanism:

by value

Usage:

longword_unsigned

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

Usage:

item_list_2

Data type:

record

Access:

read only

Mechanism:

by reference, array reference

Usage:

unspecified

Data type:

unspecified

Access:

read only

Mechanism:

by reference

Usage:

identifier

Data type:

longword (unsigned)

Access:

read only

Mechanism:

by reference

CDA Converter Routines

11-15

domain$write_format Entry Point

Argument

Argument Information

back-end-context

Usage:

context

Data type:

longword (unsigned)

Access:

read only or write only

Mechanism:

by reference

RETURNS
status
A condition value indicating the return status of the routine call.
function-code
Symbolic constant that identifies the function to be performed. The functioncode argument is the address of an unsigned longword that contains this
symbolic constant. These constant values are defined in file cda$def.h on VMS
systems and in the file cda_def.h on ULTRIX systems. Valid values are as follows:

•

CDA$_START
Start conversion. This function code must be specified to begin a document
conversion.

•

CDA$_CONTINUE
Continue a conversion that was suspended. This function code may only be
specified if a previous call to either ddif$write_format or dtif$write_format
returned the value CDA$_SUSPEND. If CDA$_SUSPEND is returned by a
call to the write_format routine, either CDA$_CONTINUE or CDA$_STOP
must be specified so that resources locked by the conversion may be released.

•

CDA$_STOP
Discontinue a conversion that was suspended. This function code may only be
specified if the previous call to the write_format routine returned the value
CDA$_SUSPEND.
If CDA$_SUSPEND is returned by a call to ddif$write_format or dtif$write_
format, either CDA$_STOP or CDA$_CONTINUE must be specified so that
resources locked by the conversion may be released.

standard-item-list
An item list that identifies the document destination and may also contain
options to control processing. The standard-item-list argument is the address of
this item list.

Each entry in the item list is a 2-longword structure with the following format:

11-16 CDA Converter Routines

domain$write_format Entry Point

item code

buffer length

0
4

buffer address

To terminate the item list you must specify the final entry or longword as zero.
The standard-item-list argument is ignored when function-code is set to
either CDA$_CONTINUE or CDA$_STOP. Valid code values for the items in the
standard-item-list are as follows:
•

CDA$_0UTPUT_FILE
The address and length of the file specification of the output document.

•

CDA$_0UTPUT_DEFAULT
The address and length of the default file specification of the output document. If this parameter is omitted, the back end must supply an appropriate
default file specification.

•

CDA$_0UTPUT_PROCEDURE
The address of a procedure to receive output. The item list length field must
be set to 0. The output procedure must conform to the requirements for a
user put routine. For more information on the calling sequence for a user put
routine, see the description of the Put routine.

•

CDA$_0UTPUT_PROCEDURE_PARM
The address of a longword parameter to the output procedure. The item list
length field must be set to 4.

•

CDA$_0UTPUT_PROCEDURE_BUFFER
The address and length of the initial output buffer for the output procedure.

•

Either CDA$_0UTPUT_FILE or CDA$_0UTPUT_PROCEDURE, but not both,
must occur once in the item list. If the CDA$_0UTPUT_PROCEDURE item
occurs, then the CDA$_0UTPUT_PROCEDURE_PARM item and the CDA$_
OUTPUT_PROCEDURE_BUFFER item may each occur once in the item list.
NOTE

If, in processing the standard item list, you encounter an unrecognized
item, your front or back end should ignore that item and not return an
error.

CDA Converter Routines

11-17

domain$write_format Entry Point
private-item-list
A private item list that is passed directly to the back end. The private-item-list
argument is the address of this private item list. The specification of this item list
is the responsibility of the back end. Its purpose is to provide for direct two-way
communication between the caller of the CONVERT routine and the back end.

On ULTRIX systems, the CDA$_0UTPUT_BACK_END_PROCEDURE item must
be specified at the CONVERT routine call for this parameter to be used.
front-end-handle
Identifier of the front end that will process the document content. The frontend-handle argument is the address of an unsigned longword that contains this
front end handle. This handle is passed to either the CONVERT DOCUMENT
routine or the CONVERT AGGREGATE routine.
back-end-context
When function-code is set to CDA$_START, this argument receives a value
defined by the back end that identifies this particular instance of the back end.
The back-end-context argument is the address of an unsigned longword that
either receives or specifies the converter context. This value will be returned to
ddif$write_format or dtif$write_format for the functions CDA$_CONTINUE and
CDA$_STOP. If a back end returns CDA$_SUSPEND, all writable memory used
by the back end must be allocated from dynamic memory and located by reference
to this value.

Description
The write_format entry points (ddif$write_format and dtif$write_format) are
the entry points in the back end. This routine requests aggregates from the
front end, converts them from the CDA in-memory format to the specified output
format, and writes the information to the specified output file. The term format
in the entry point name refers to the name of the document format that is being
written by this particular back end. For example, the entry point for the Text
back end is ddif$write_TEXT.
On ULTRIX sytems, front end and back end converters are invoked as subprocesses, rather than being dynamically loaded into the same address space, as
they are on VMS systems. Because of this, on ULTRIX systems the entry point
name for the write_format entry point is always the same, cda$write_format, no
matter what the format name. This is usually accomplished in source code by
using a 'jacket" routine named cda$write_format that simply calls the real routine (ddif$write_format or dtif$write_format) with the same parameters (see the
Text front end source code example in Chapter 12). Another way of accomplishing
this is to use compiler directives (#ifdef in the C language) to name the function
differently depending on the operating system.
In order for the back end to call through to the front end, two routines are
provided:
•

The CONVERT DOCUMENT routine invokes the document-method conversion of an input file to the specified output format.

11-18 CDA Converter Routines

domain$write_format Entry Point
•

The CONVERT AGGREGATE routine invokes the aggregate-method conversion of an input file to the specified output format.

The back end must use one of these routines to request the appropriate information from the front end.
If the format of the output file is not DDIF, DTIF, or Text, the back end must
supply its own file-creation capability, typically through the use of the creat C
run-time library routine or equivalent language statement.

In order to initialize a document-method conversion, the write_format routine
must first process the user-supplied item list, storing all pertinent information in
the context block. The item list structure that is used to pass this information
between the front end, back end, and kernel is created in the CDA Converter
Kernel; this structure contains the following fields:
•

cda$w_item_length specifies the length of the item.

•

cda$w_item_code specifies the item code, selected from the list specified in
this section.

•

cda$w_item_address specifies the address of the item.

These fields are defined in the file cda$def.h on VMS systems and in the file
cda_def.h on ULTRIX systems.

RETURN VALUES

Return Value

Description

CDA$_NORMAL

Normal successful completion.

CDA$_SUSPEND

Converter is suspended.

CDA$_INVFUNCOD

Invalid function code.

CDA$_INVITMLST

Invalid item list.

CDA$_UNSUPFMT

Unsupported document format.

The write_format routine can also return any error returned by the specific front
end or the specific back end.

CDA Converter Routines 11-19

Chapter 12

Text Front End Source File
This chapter contains the source code for the Text front end provided with the
CDA Toolkit. This front end should be used as a sample when writing your own
front or back ends. The Text front end reads in a standard text file and creates a
DDIF in-memory document.
In this chapter, the source code for the Text front end is divided into subsections.
Where appropriate, the subsections are annotated with a list following each
section explaining the annotations.
The following callouts correspond to the callouts in the main module of the Text
front end.

0 All of these routines from the CDA Toolkit are used by the Text front end.
8 These are the additional entry points in the Text front end.
8 This is the context block that is used to share information between the front
end, the CDA Converter Kernel, and the back end.
/*
**++
**
** COPYRIGHT (c) 1987 BY
** DIGITAL EQUIPMENT CORPORATION, MAYNARD, MASS.
** ALL RIGHTS RESERVED.
**
** THIS SOFTWARE IS FURNISHED UNDER A LICENSE AND MAY BE USED AND COPIED
** ONLY IN ACCORDANCE WITH THE TERMS OF SUCH LICENSE AND WITH THE
** INCLUSION OF THE ABOVE COPYRIGHT NOTICE. THIS SOFTWARE OR ANY OTHER
** COPIES THEREOF MAY NOT BE PROVIDED OR OTHERWISE MADE AVAILABLE TO ANY
** OTHER PERSON. NO TITLE TO AND OWNERSHIP OF THE SOFTWARE IS HEREBY
** TRANSFERRED.
**
** THE INFORMATION IN THIS SOFTWARE IS SUBJECT TO CHANGE WITHOUT NOTICE
** AND SHOULD NOT BE CONSTRUED AS A COMMITMENT BY DIGITAL EQUIPMENT
** CORPORATION.
**
** DIGITAL ASSUMES NO RESPONSIBILITY FOR THE USE OR RELIABILITY OF ITS
** SOFTWARE ON EQUIPMENT WHICH IS NOT SUPPLIED BY DIGITAL.
**
** FACILITY:
**
Compound Document Converters
**
**
** ABSTRACT:
**
This is a Text Converter Front End that reads a text input
**
file (or stream), creates DDIF aggregates from this text, and
**
passes each DDIF Aggregate back to the calling converter kernel.
**
**
**-**/

Text Front End Source File

12-1

/*
**
** INCLUDE FILES
**
**/
#ifdef vms
#include <ddif$def.h>
#include <cda$def.h>
#include <cda$msg.h>

/* Contains values of al DDIF$xxxx keywords */
/* Contains values of all CDA$xxxx keywords */

/* CDA error messages */

#else
#include <ddif def.h>
#include <cda def.h>
#include <cda_msg.h>
#endif
#ifdef vms
#include <fab.h>
#include <rab.h>
#include <nam.h>
#include <rmsdef.h>

/* Use VMS RMS to manipulate files */
/* Defines the file access block structure */
/* Defines the record access block structure */
/* Defines the name block structure */
/* Defines the completion status codes that RMS returns
* after every file- or record-processing operation */

/* NOTE: The previous 4 #include statements can be replaced with <rms.h> */
#include <descrip.h> /* Allows program to pass arguments by descriptor.
* A descriptor is a structure that describes the
* data type, size, and address of a data structure. */
#endif
/* Declare routines used in the Toolkit */

extern unsigned long cda$open text file();
extern unsigned long cda$close text file();
extern unsigned long cda$read text file();
extern unsigned long cda$get aggregate();
extern unsigned long cda$get=text_position();
extern unsigned long cda$create root aggregate();
extern unsigned long cda$delete-root-aggregate();
extern unsigned long cda$create-aggregate();
extern unsigned long cda$store_item();
unsigned long get~aggregate();
unsigned long create_dsc();
unsigned long create_dhd();
unsigned long create_seg();
unsigned long create_txt();
unsigned long create_eos();
unsigned long look ahead();
unsigned long create dir();
unsigned long get_position();
unsigned long close_front_end();
/* Define literals for characters used */
#define HORIZONTAL TAB
9
#define FORM FEED 12
#define DDIF=BUFFER_SIZE
2048

12-2 Text Front End Source File

/* Front End Context structure (text context)
* The front end context contains all variables needed to keep track
* of a conversion in progress. Since the front end, back end, and
* converter kernel are re-entrant, it is possible to have several
* conversions occurring simultaneously. A pointer to this structure
* is passed back and forth between the front and back ends, so
* that the front end knows where it is in any particular conversion.
*/
struct text_cxt {
unsigned long text a file_handle;
unsigned long text a root_aggregate_handle;
unsigned long (*text a input routine)();
unsigned long text a-input routine param;
unsigned long (*text=a_position_routine) ();
unsigned long text_a_position_param;
unsigned long text l state;
unsigned char *text_a_buffer_address;
unsigned long text_l_buffer_length;
unsigned char *text a local_buffer;
unsigned char text l local length;
unsigned long text-1-directive type;
unsigned long text-1-directive-content;
unsigned char text-a-title[32];
unsigned long-text-1-title length;
unsigned long text=b=scope=level;
unsigned long text_l_newline_count;
unsigned char text_v_end_of_paragraph
1;
unsigned char text_v_root_segment
1;
unsigned char text_v_end_of document
1;
unsigned char : O;
};

/* Default file extension */
static unsigned char
default_file[]
static unsigned long
default_length

11
II .tXt
;
sizeof(default_file) - 1;

/* Name for Root Segment */
static unsigned char
seg id[] = "RootSegment";
static unsigned long
seg=id_length
sizeof(seg_id) - 1;
/* Name for style guide file */
static unsigned char
style_guide_narne[] = "defstyle";
static unsigned long
style_length = sizeof(style_guide_narne) - 1;
/* Name for paragraph */
static unsigned char
para_buffer[] = "PARA";
static unsigned long
para_length = sizeof(para_buffer) - 1;
/* Name for literal */
static unsigned char
static unsigned long

literal_buffer[] = "LITERAL";
literal_length
sizeof(literal_buffer) - 1;

/* Name for erf descriptor */
static unsigned char
erf_desc_type[]
static unsigned long
erf_desc_length

"Style Guide";
sizeof(erf_desc_type) - 1;

/* Name for erf label type */
static unsigned char
erf_label_type[] = "$STYLE";
static unsigned long
erf_length = sizeof(erf_label_type) - 1;
/*
**
** MACROS
**
**/

/* Error check macros */
#define FAILURE(status)
( ((status) & 1)

\
0)

Text Front End Source File

12-3

#define SUCCESS(status)
(((status) & 1)

\
==

/* Memory allocation and deallocation */
#ifdef vms
extern unsigned long lib$free vm();
extern unsigned long lib$get_~m();
#else
extern char *malloc();
extern free();
#endif
/* Literals used in creation of aggregates */
static unsigned char
static unsigned long
static unsigned char
static unsigned long
static unsigned char
static unsigned long
/*
*
*
*

dsc identifier[]
dsc~)d_length
dsc_prod_name []
dsc_nam_length
dhd_author []
dhd_aut_length

"DDIF$";
sizeof(dsc_identifier) - l;
"DDIF Text Front End";
sizeof(dsc_prod_name) - l;
"DDIF Text Front End";
sizeof(dhd_author) - l;

Lookup table for DEC MCS character set. These values are taken from DEC
Standard 169. This table has the space character inserted in the control
character and holes positions. This ensures no such characters appear
in the DDIF TXT aggregates.

*I
static unsigned char lookup_buffer[256]
32,
32,
32,
32,
32,
32,
32,
32,
{32,
32,
32,
32,
32,
32,
32,
32,
32,
32,
32,
32,
32,
32,
32,
32,
32,
32,
32,
32,
32,
32,
32,
32,
46,
47,
35,
41,
42,
43,
44,
45,
32,
33,
34,
36,
37,
38,
39,
40,
62,
63,
57,
59,
61,
48,
49,
50,
51,
52,
54,
55,
56,
58,
60,
53,
75,
78,
79,
71,
74,
76,
77,
64,
67,
70,
72,
73,
65,
66,
68,
69,
95,
94,
87,
89,
90,
91,
92,
93,
80,
81,
82,
83,
84,
85,
86,
88,
96,
97,
98,
99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111,
112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 32,
32,
32,
32,
176,
192,
208,
224,
240,

32,
32,
161,
177,
193,
209,
225,
241,

32,
32,
162,
178,
194,
210,
226,
242,

32,
32,
163,
179,
195,
211,
227,
243,

32,
32,
32,
32,
196,
212,
228,
244,

32,
32,
165,
181,
197,
213,
229,
245,

32,
32,
32,
182,
198,
214,
230,
246,

32,
32,
167,
183,
199,
215,
231,
247,

32,
32,
168,
32,
200,
216,
232,
248,

32,
32,
169,
185,
201,
217,
233,
249,

32,
32,
170,
186,
202,
218,
234,
250,

32,
32,
171,
187,
203,
219,
235,
251,

32,
32,
32,
188,
204,
220,
236,
252,

32,
32,
32,
32,
32,
32,
32,
32,
32,
189,
32, 191,
205, 206, 207,
221,
32, 223,
237, 238, 239,
32, 32};
253,

The following callout corresponds to the callout in the jacket entry point for the
Text front end.

8 This is a jacket routine that supports the ULTRIX entry point to the Text
front end.

12-4 Text Front End Source File

/*
**++
**

FUNCTIONAL DESCRIPTION:

**
The name of this routine is CDA$READ_FORMAT().
This routine is the jacket entry point for the text Front End on
Ultrix. It is called from the converter kernel to
call the "real" entry point which initializes the conversion.
When employed on VMS systems, this routine is not called {or even
compiled). On VMS systems, the converter kernel calls the
DDIF$READ_TEXT() routine.

**
**

**
**
**
**
**
**
**
**
**
**
**
**
**
**
**

FORMAL PARAMETERS:

**
**
**
**

IMPLICIT INPUTS:

**
**
**

IMPLICIT OUTPUTS:

item list.rr.ra

item list

cvt context.rlu.v
-

value for cda$open_converter

text- context.wlu.v

value to identify this converter

get_aggr.wa.r

address of get aggregate routine

get_pos.wa.r

address of get position routine

close text.wa.r

address of close front end routine

none

**
**
**
**
**
**
**

FUNCTION VALUE:
CDA$ NORMAL
CDA$=INVAGGTYP
Memory allocation error conditions
File error conditions

**
**
**

SIDE EFFECTS:

**
**
**--

none

**/
#ifdef ultrix
unsigned long

struct item list
unsigned long
unsigned long
unsigned long
unsigned long
unsigned long

cda$read_format{item_list,
cvtr_context,
text_context_ptr,
get_aggr,
get_pos,
close_text)
*item_list;
cvtr_context;
*text_context_ptr;
*get_aggr;
*get_pos;
*close_text;

unsigned long ddif$read_text{);
return {ddif$read_text{item_list, cvtr_context, text_context_ptr,
get_aggr, get_pos, close_text));
#endif

Text Front End Source File

12-5

The following callouts correspond to the callouts in the main entry point of the
Text front end.

0 This is the main entry point of the Text front end.
0) This loop reads the items in the item list passed to the Text front end. This
item list can contain information such as the file specification of the file to be
used for input, the routine to be used to read the input, a parameter to the
input routine, and so on.

0 This statement creates the DDIF root aggegate (type DDIF$_DDF). This
aggregate is required in every DDIF document.

0 The next aggregate to be created is the document descriptor aggregate (type
DDIF$_DSC). This aggregate is also required in every DDIF document.
/*
**++
** FUNCTIONAL DESCRIPTION:
**
This routine is the entry point for the Text Front End. It
**
is called from the converter kernel to initialize the
**
**
conversion.
**
** GENERAL DESCRIPTION:
**
The DDIF$READ format entry point is the initial entry point in the
**
front end. This routine initializes the conversion process and
**
establishes any special processing information for the front end.
**
The term "format" in the entry point name refers to the name of the
**
document format that is read by this particular front end --**
"TEXT", in this instance.
**
**
This routine is required and must be named according to the above
**
convention. Three other routines/entry points are also required.
**
The parameters to this routine specify their addresses to the
**
converter kernel.
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**

FORMAL PARAMETERS:

**
**
**
**
**
**
**

IMPLICIT INPUTS:

**
**
**

item_list.rr.ra

item list

cvt_context.rlu.v

value for cda$open_converter

text_context.wlu.v

value to identify this converter

The next three parameters are the addresses of the other required
entry points in any front end.
get_aggr.wa.r

address of get aggregate routine

get_pos.wa.r

address of get position routine

close_text.wa.r

address of close front end routine

text file or data stream
IMPLICIT OUTPUTS:
none
FUNCTION VALUE:
CDA$ NORMAL
CDA$=INVAGGTYP
Memory allocation error conditions
File error conditions

SIDE EFFECTS:

**
12-6 Text Front End Source File

**
**
**--

none

**/
unsigned long

struct item list
unsigned long
unsigned long
unsigned long
unsigned long
unsigned long

unsigned long
unsigned long
unsigned long
unsigned long
unsigned char
unsigned long
unsigned char
unsigned long
unsigned char
unsigned long
struct text_cxt

ddif$read_text (item_list,
cvtr_context,
text_context_ptr,
get_aggr,
get_pos,
close_text)
*item_list;
cvtr_context;
*text_context_ptr;
*get_aggr;
*get_pos;
*close_text;

status;
struct_size;
aggregate_type;
result_length;
result buffer[255];
filespec length;
*default=file_address;
default file length;
*input file address;
input_file_length;
*text_context;

/*
/*
/*
/*
/*
/*

return status */
holds context block size */
aggregate type*/
result file length *I
result file buffer */
file specification length */

/* points to context block ~1

/* Allocate the context block for this front end */
struct_size = sizeof (struct text_cxt);
text_context = O;
default file address
default_file;
default_length;
default=file=length
input_file_address
O;
input_file_length
0;
#ifdef vms
status= lib$get_vm(&struct_size, &text_context, 0);
#else
text_context = (struct text_cxt *) malloc(struct size);
(text_context == 0) ? (status= CDA$_ALLOCFAIL) ! (status
#endif

l);

if (FAILURE(status))
return (status) ;
/* Initialize the context block */
text context->text a file handle
text context->text a root aggregate handle
text-context->text-a-input routine text=context->text=a=input=routine_param
text_context->text_a_position_routine
text_context->text_a_position_param
text context->text 1 state
text=context->text=l=title_length
text_context->text_a_buffer_address
text_context->text_l_buffer_length
text_context->text_a_local_buffer
text context->text l local length
text-context->text-1-directive type
text=context->text=l=directive=content
text context->text b scope level

text=context->text=l=newli~e_count

text_context->text_v_root_segment
text_context->text_v_end_of_paragraph
text_context->text_v_end_of_document

O;
O;
0;

O;
O;
0;
0;

O;
O;

O;
O;
O;

O;
O;
O;
O;
l;

O;
0;

Text Front End Source File

12-7

/* Scan item list until item code is 0 */
while (item list->cda$w item code != 0)

{

status = 1;
switch (item_list->cda$w item code)
{

case CDA$_INPUT_FILE:
input file length
input=file=address

/* Input filename */
item list->cda$w item length;
(unsigned char *)
item_list->cda$a_item_address;

break;
case CDA$ INPUT DEFAULT:
default file length
default=file=address

/* Default input filename */
item list->cda$w item length;
(unsigned char *)
item_list->cda$a_item_address;

break;
case CDA$ INPUT PROCEDURE:
/* Input procedure address */
text_'Context->text_a_input_routine =
(unsigned long (*) ())
item_list->cda$a_item_address;
break;
case CDA$ INPUT PROCEDURE PARM: /* Input procedure param */
text_context->text_a_input_routine_param =
*((unsigned long*)
item_list->cda$a_item_address);
break;
case CDA$_INPUT_POSITION_PROCEDURE: /* Input position
proc address */
text_context->text_a_position_routine =
(unsigned long (*) ())
item_list->cda$a_item_address;
break;
/* All others */

default:
break;

/* Any problems? */
if (FAILURE(status))
return (status);
/* Point to next item in item list
*/
/* Note that this advances the item list a full two longwords */
/* (i.e. + 1 * sizeof(item_list))
*/
item_list += 1;
/* Create a DDIF root aggregate */
aggregate type = DDIF$ DDF;
status = cda$create root aggregate (0,
- 0, 0,
O,
&aggregate_type,
&text_context->text_a_root_aggregate_handle);
/* If there is an error, return */
if (FAILURE(status))
return (status);
/* Try to open the input file if specified */
if (input_file_address != 0)
{

result_length

= sizeof (result_buffer);

status = cda$open_text_file (&input_file_length,
input_file_address,
&default file length,
default_file_address,
&result_length,
result_buffer,
&result length,
&text_context->text_a_file handle);

12-8 Text Front End Source File

#ifdef vms
/* Parse filename from file specification
* for use as the Title field in the Header
*/
if (SUCCESS(status))
{

struct FAB fil_fab;
/* File access block */
struct NAM fil_nam;
/* Name block */
unsigned long
esa_length = 255
/* file length */
unsigned char
esa_buffer[255J;
/*file buffer*/
/* Initialize fab and nam blocks */
fil fab = cc$rms fab;
fil=nam = cc$rms=nam;
fil fab.fab$1 dna
fil-fab.fab$b-dns
fil-fab.fab$1-fna
fil-fab.fab$b-fns
fil-fab.fab$1-nam
fil=fab.fab$l=fop
fil nam.nam$b nop
fil-nam.nam$1-rlf
fil-nam.nam$1-esa
fil=nam.nam$b=ess

O;
O;
result_buffer;
result_length;
&fil nam;
FAB$M_NAM;
NAM$M_SYNCHK;

O;
esa_buffer;
esa_length;

/* Parse the file specification */
status= sys$parse(&fil_fab);
if (FAILURE(status))
return (status);
/* Copy the filename into the title area */
text context->text l title length = fil_nam.nam$b_name;
strncpy(text context~>text-a title,
fil nam.nam$1 name~ fil=nam.nam$b=name);
/* Copy the file extension into the title area */
strncpy(text context->text a title +
text-context->text l title length,
fil nam.nam$1 type;
- fil=nam.nam$b=type);
text_context->text_l_title_length += fil_nam.nam$b_type;
#endif

/* If an input procedure was specified, set
* the position parameter to the input parameter
* otherwise, use the file handle.
*/
if (text context->text a input routine != 0)
text_context->text_a_position_param =
text_context->text_a_input_routine_param;
else
text_context->text_a_position_param =
text_context->text_a_file_handle;

/*
* The state value tells the Get Aggregate routine what
*aggregate to return next. In this case (first), we want
* it to return a document descriptor.

*/
text_context->text_l_state = DDIF$_DSC;
/* Fill in get and close procedure addresses */
(unsigned long) text_context;
*text_context_ptr
*get_aggr
(unsigned long) get aggregate;
*get_pos
(unsigned long) get=1iosition;
(unsigned long) close_front_end;
*close_text

/* How did we do? */
return status;

Text Front End Source File

12-9

The following callouts correspond to the callouts in the get_aggregate routine in
the Text front end.
(!) This routine reads the input data and calls the appropriate routines.

I> Before reading the input and creating the appropriate content aggregates,
this routine creates a document descriptor (DDIF$_DSC) and document
header (DDIF$_DHD) aggregate. These aggregates, along with the document
root aggregate, are required in every DDIF document.
The text_context->text_l_state argument is used to specify the next
aggregate to be created. After the DDIF$_DSC and DDIF$_DHD aggregates
have been created, the state is set to DDIF$_SEG, so that the next aggregate
created will be the root segment aggregate.
/*
**++
**

FUNCTIONAL DESCRIPTION:

**
**

This routine is the entry point for the 'get_aggregate' procedure.
It reads an aggregate from the input DDIF stream and returns
this aggregate to the caller.

**
**
**

FORMAL PARAMETERS:

text context.wlu.v

value to identify this converter instance

**
**

aggregate_handle.wlu.r

address to store aggregate handle

aggregate_type.wlu.r

address to store aggregate type

**
**

**
**
**

**
**
**
**
**

IMPLICIT INPUTS:
none
IMPLICIT OUTPUTS:
none

**
**
**

**
**

FUNCTION VALUE:
CDA$ NORMAL
CDA$=ENDOFDOC
Memory allocation error conditions
File error conditions

**
**
**

SIDE EFFECTS:

none

**-**I
static unsigned long

unsigned long
unsigned long
unsigned long

get_aggregate (text_context_ptr,
aggregate_handle,
aggregate_type)
*text_context_ptr;
*aggregate_handle;
*aggregate_type;

unsigned long
status;
struct text_cxt *text_context;
/* Dereference */
text context
(struct text ext *) *text_context_ptr;

12-10 Text Front End Source File

* The state value tells the Get Aggregate routine what aggregate
* to return next. We will test the state value here to determine
* what type of aggregate is needed. Each time an aggregate is
* returned, the state value is set to return the next type of
* aggregate.

*/
/* Find what DDIF aggregate we need to return */

switch (text_context->text_l_state)
{

/* Build a document descriptor */
case DDIF$_DSC:

status = create_dsc (&text_context,
aggregate type,
aggregate=handle);
break;
/* Build a document header */
case DDIF$ DHD:
status = create_dhd (&text_context,
aggregate_type,
aggregate_handle);
break;
/* Build a document segment */
case DDIF$_SEG:
/* Create the SEG aggregate */
status = create_seg (&text_context,
aggregate_type,
aggregate_handle);

break;
/* Build a text aggregate */
case DDIF$_TXT:
/* Create a TXT aggregate */
status = create_txt (&text_context,
aggregate_type,
aggregate_handle);
break;
/* Build a directive (new_line or new_page) */
case DDIF$ SFT:
case DDIF$=HRD:
/* Create a hard or soft directive aggregate */
status = create_dir (&text_context,
aggregate_type,
aggregate_handle);
break;

/* Build an end of segment */
case DDIF$_EOS:
/* Create an end of segment aggregate */
status = create_eos (&text_context,
aggregate_type,
aggregate_handle);
break;
/* If we got here it is surely an insidious bug */
default:
status
CDA$_INTERR;
break;
/* Return the status */
return status;

Text Front End Source File

12-11

The following callout corresponds to the callout in the create_dsc routine in the
Text front end.

4D This routine creates and fills in the required DDIF$_DSC aggregate, sets the
state to DDIF$_DHD, and returns to the switch statement referenced by G.
/*
**++
** FUNCTIONAL DESCRIPTION:
**
**
This routine creates a document descriptor aggregate and
**
fills it in.
**
** FORMAL PARAMETERS:
**
value to identify this converter
text context.wlu.v
**
**
aggregate_type.wlu.r
pointer to aggregate type
**
**
aggregate_handle.wlu.r
pointer to aggregate handle
**
**
** IMPLICIT INPUTS:

•

**
**
**
**
**
**
**

none
IMPLICIT OUTPUTS:
none

FUNCTION VALUE:
**
**
CDA$ NORMAL
**
Aggregate creation errors
**
Memory deallocation error conditions
**
** SIDE EFFECTS:
**
none
**
**
**--

**I
static unsigned long

create_dsc (text_context_ptr,
aggregate_type,
aggregate_handle)

unsigned long
unsigned long
unsigned long

*text_context_ptr;
*aggregate_type;
*aggregate_handle;

unsigned long
status;
struct text_cxt *text context;
unsigned long
aggregate item;
unsigned long
item length;
item-index = O;
unsigned long
unsigned long
add_info;
unsigned long
major_version;
unsigned long
minor_version;
/* Dereference */
text_context = (struct text ext *) *text_context_ptr;
/* Set the aggregate type */
*aggregate_type = DDIF$_DSC;
/* Create the aggregate */
status = cda$create aggregate
(&text_context->text_a_root_aggregate_handle,
aggregate type,
aggregate=handle);
if (FAILURE(status))
return (status);

12-12 Text Front End Source File

/* First item to include is the major version. */
major_version = DDIF$K MAJOR VERSION;
item_length = sizeof(major_version);
aggregate item = DDIF$ DSC MAJOR VERSION
status = cda$store item (&text context->text a root aggregate handle,
aggregate handle, - &aggregate item,
&item_length,
&major_version);
if (FAILURE(status))
return (status);

/* The next item is the minor version */
minor version = DDIF$K MINOR VERSION;
item_length = sizeof(minor_version);
aggregate item = DDIF$ DSC MINOR VERSION
status = cda$store_item (&text_context->text_a_root_aggregate_handle,
aggregate_handle,
&aggregate item,
&item_length,
&minor_version);
if (FAILURE(status))
return (status);
/* Now the product identifier */
aggregate item = DDIF$ DSC PRODUCT IDENTIFIER;
status = cda$store_item (&text_context->text_a_root_aggregate_handle,
aggregate_handle,
&aggregate item,
&dsc_id_le;-gth,
dsc_identifier);
if (FAILURE(status))
return (status);
/* And the product name */
aggregate item = DDIF$ DSC PRODUCT NAME
add info ~ CDA$K ISO LATINl;
status = cda$store_item (&text_context->text_a_root_aggregate_handle,
aggregate handle,
&aggregate_item,
&dsc_nam_length,
dsc_prod_name,
&item index,
&add_info);
/* Document header next */
text_context->text_l_state= DDIF$_DHD;
/* Say how we did */
return (status);

The following callout corresponds to the callout in the create_dhd routine in the
Text front end.

e This routine creates and fills in the required DDIF$_DHD aggregate, sets the
state to DDIF$_SEG, and returns to the switch statement referenced by 8.

Text Front End Source File

12-13

/*
**++
** FUNCTIONAL DESCRIPTION:
**
**
This routine creates a document header aggregate and
**
fills it in.
**
** FORMAL PARAMETERS:
**
text_context.wlu.v
value to identify this converter
**
**
aggregate_type.wlu.r
pointer to aggregate type
**
**
aggregate_handle.wlu.r
pointer to aggregate handle
**
**
** IMPLICIT INPUTS:
**
none
**
**
** IMPLICIT OUTPUTS:
**
**
none
**
** FUNCTION VALUE:
**
CDA$_NORMAL
**
Aggregate creation errors
**
Memory deallocation error conditions
**
**
** SIDE EFFECTS:
**
**
none
**
**-**I
static unsigned long

create dhd (text_context_ptr,
aggregate_type,
aggregate_handle)

unsigned long
unsigned long
unsigned long

*text_context_ptr;
*aggregate type;
*aggregate=handle;

unsigned long status;
struct text ext *text context;
unsigned long aggregate item;
unsigned long item_index = O;
unsigned long
unsigned long
unsigned long
unsigned long
unsigned char
unsigned long

/* return status */
/* points to context block */

int_length;
add_info;
erf_type;
erf_handle;
*erf aggregate;
object_identifier[7];

/* Dereference */
text_context = (struct text_cxt *) *text_context_ptr;
/* Set the aggregate type to document header */
*aggregate type = DDIF$ DHD;
add_info =-CDA$K_ISO_LATIN1;
/* Create the aggregate */
status = cda$create_aggregate
(&text_context->text_a_root_aggregate_handle,
aggregate_type,
aggregate_handle);
if (FAILURE(status))
return (status);

12-14 Text Front End Source File

/* Fill in the Author */
aggregate item = DDIF$ DHD AUTHOR;
status = cda$store_item (&text_context->text_a_root_aggregate_handle,
aggregate handle,
&aggregate_item,
&dhd aut length,
cthct_author,
&item index,
&add_info);
/* Fill in the Title if we have one */
if ((text_context->text_l_title_length != 0) &&
(SUCCESS(status)))
aggregate_item = DDIF$_DHD_TITLE;
status = cda$store_item
(&text context->text a root aggregate handle,
aggregate handle, - &aggregate_item,
&text context->text 1 title length,
text context->text a title,&item_index,
- &add_info);

/* Create an external reference aggregate */
erf_type = DDIF$_ERF;
/* Create the aggregate */
status = cda$create aggregate

(&te~t_context->text_a_root_aggregate_handle,

&erf_type,
&erf_handle);
if (FAILURE(status))
return (status);

/* Store the object identifier of DDIF */
object identifier[O]
l;
object-identifier[l]
3;
object=identifier[2]
12;
object_identifier[3]
1011;
object identifier[4]
1;
object=identifier[S]
3;
object identifier[6]
1;
aggregate item = DDIF$ ERF DATA TYPE;
int length= sizeof(ob}ect-identifier);
status = cda$store_item (&text_context->text_a_root_aggregate_handle,
&erf handle,
&aggregate item,
&int length,
object_identifier);
if (FAILURE(status))
return (status);
/* Store the style guide name */
aggregate item = DDIF$ ERF LABEL;
add info ~ CDA$K ISO LATINl;
status = cda$store_item (&text_context->text_a_root_aggregate_handle,
&erf handle,
&aggregate_item,
&style length,
style guide name,
&item-index7
&add_info);
if (FAILURE(status))
return (status);

Text Front End Source File

12-15

/* Store the descriptor */
aggregate item = DDIF$ ERF DESCRIPTOR;
add_info ~ CDA$K_ISO_LATINl;
item index = O;
status = cda$store_item (&text_context->text_a_root_aggregate_handle,
&erf_handle,
&aggregate_item,
&erf_desc_length,
erf desc type,
&item_index,
&add_info);
if (FAILURE(status))
return (status);
/* Store the label type */
aggregate item = DDIF$ ERF LABEL TYPE;
add info ~ DDIF$K STYLE LABEL TYPE;
status = cda$store_item-(&text_context->text_a_root_aggregate_handle,
&erf_handle,
&aggregate_item,
&erf_length,
erf label type,
&item_index,
&add_info);
if (FAILURE(status))
return (status);
/* Store the copy info */
aggregate item = DDIF$ ERF CONTROL;
int_length = sizeof(unsigned long);
item index = DDIF$K NO COPY REFERENCE;
status = cda$store_item (&text_context->text_a_root_aggregate_handle,
&erf_handle,
&aggregate_item,
&int length,
&item_index);
if (FAILURE(status))
return (status);
/* Store the Style Guide External Reference */
aggregate item = DDIF$ DHD EXTERNAL REFERENCES;
int_length = sizeof(unsigned long);status = cda$store_item (&text_context->text_a_root_aggregate_handle,
aggregate_handle,
&aggregate_item,
&int_length,
&erf_handle);
if (FAILURE(status))
return (status);
/* Fill in the Style Guide */
aggregate item = DDIF$ DHD STYLE_GUIDE;
item_index = 1;
int length= sizeof(unsigned long);
status = cda$store_item (&text_context->text_a_root_aggregate_handle,
aggregate_handle,
&aggregate_item,
&int length,
&item_index);
/* Segment next */
text_context->text_l_state= DDIF$_SEG;
/* Say how we did */
return status;

The following callouts correspond to the callouts in the create_seg routine in the
Text front end.

48 The first time this entry point is invoked, this routine creates the required
document root segment and returns to the switch statement referenced by tl
with the state still set to DDIF$_SEG. All subsequent calls to this routine
create nested segments that contain the document content.
12-16 Text Front End Source File

e If the root segment has just been created, this routine also creates a segment
attributes aggregate (type DDIF$_SGA) and a type definition aggregate (type
DDIF$_TYD) to define types that are accessible to all of the document content
aggregates. Once these aggregates are created, this routine passes control
back to the switch statement referenced by I>. Because the state is still set to
DDIF$_SEG, I> immediately passes control back to this routine to create the
first nested segment of the document.

C3 If this routine is not creating the root segment, it simply creates a nested
segment aggregate and sets the state to DDIF$_TXT before passing control
back to I>.
/*
**++
**

FUNCTIONAL DESCRIPTION:

**
**
**
**
**

This routine creates a document segment aggregate and
fills it in.
FORMAL PARAMETERS:

**
**

text_context.wlu.v

value to identify this converter

aggregate_type.wlu.r

pointer to aggregate type

aggregate_handle.wlu.r

pointer to aggregate handle

**
**

**
**
**

IMPLICIT INPUTS:
none
IMPLICIT OUTPUTS:

**
**

none

**
**
**

**
**

**
**
**

FUNCTION VALUE:
CDA$_NORMAL
Aggregate creation errors
Memory deallocation error conditions
SIDE EFFECTS:

**
**

none

**
**-**I
static unsigned long

unsigned long
unsigned long
unsigned long

create_seg {text_context_ptr,
aggregate_type,
aggregate_handle)
*text_context_ptr;
*aggregate_type;
*aggregate_handle;

unsigned long
status;
struct text ext *text_context;
unsigned long
aggregate_item;
unsigned long
item length;
item-index = O;
unsigned long
unsigned long
add_info;
unsigned long
tyd_handle;
unsigned long
tyd_type;
unsigned long
sga_handle;
unsigned long
sga_type;
/* Dereference */
text_context = {struct text_cxt *) *text_context_ptr;
/* Set the aggregate type to segment */
*aggregate_type
DDIF$_SEG;

Text Front End Source File

12-17

/* Create the root segment */
status = cda$create_aggregate (&text_context->text_a_root_aggregate_handle,
aggregate_type,
aggregate_handle);
if (FAILURE(status))
return (status);

/* If this is the root segment, then setup to create a
/* child segment. */
if (text_context->text_v_root_segment == 1)

{

/* Reset flags */
text_context->text_v_root_segment

/* Store SEG ID in segment */

aggregate item = DDIF$ SEG ID;
status = cda$store item
(&text_context->text_a_root_aggregate_handle,
aggregate handle,
&aggregate_item,
&seg_id_length,
seg_id);
if (FAILURE(status))
return (status);
/* Create an attribute aggregate */
sga type = DDIF$ SGA;
status = cda$create aggregate
(&text_context->text_a_root_aggregate_handle,
&sga_type,
&sga handle);
if (FAILURE(status))return (status);
/* Store SGA in segment */
aggregate item = DDIF$ SEG SPECIFIC ATTRIBUTES;
item length= sizeof (sga handle); status = cda$store item (&text_context->text_a_root_aggregate_handle,
aggregate handle,
&aggregate_item,
&item_length,
&sga_handle);
if (FAILURE(status))
return (status);

/* Create a type definition aggregate */
tyd_type = DDIF$ TYD;
status = cda$create aggregate
(&text_context->text_a_root_aggregate_handle,
&tyd_type,
&tyd handle);
if (FAILURE(status))return (status);
/* Store TYD in SGA */
aggregate_item = DDIF$_SGA_TYPE_DEFNS;
item length= sizeof (tyd handle);
status = cda$store item (&text_context->text_a_root_aggregate_handle,
&sga handle,
&aggregate_item,
&itern_length,
&tyd_handle);
if (FAILURE(status))
return (status);

12-18 Text Front End Source File

/* Store TYD LABEL in TYD */
aggregate item = DDIF$ TYD LABEL;
status = cda$store item
(&text_context->text_a_root_aggregate_handle,
&tyd_handle,
&aggregate_item,
&para_length,
para_buffer);
if (FAILURE(status))
return (status);
/* Store TYD PARENT in TYD */
aggregate item = DDIF$ TYD PARENT;
status = cda$store_item
(&text_context->text_a_root_aggregate_handle,
&tyd handle,
&aggregate_item,
&literal_length,
literal_buffer);
if (FAILURE(status))
return (status) ;
else
{

/* Not a root segment; tag as paragraph */
aggregate item = DDIF$ SEG SEGMENT TYPE;
~
status = cda$store item
(&text_context->text_a_root_aggregate_handle,
aggregate handle,
&aggregate_item,
&para length,
para_buffer);
if (FAILURE(status))
return (status);

text_context->text_l_state= DDIF$_TXT;
/* Bump scope level */
text_context->text_b_scope_level += l;

I* Say how we did */
return status;

The following callouts correspond to the callouts in the create_txt routine in the
Text front end.
·

8 This routine creates and fills in a text content aggregate.
•

If a user-supplied text file input procedure was specified in the item list, use

that procedure. Otherwise, use the CDA Toolkit routine READ TEXT FILE.

8 If we reached the end of the document, pass control back to 8.

8 This loop reads each character on the line of text. If a form-feed character is
encountered, the ff_found flag is set.

9 If a horizontal tab character is encountered, the ht_found flag is set.
f) The characters are passed through a filter to ensure that there are no control
characters.

If write_length was not zero, there was text on the line, so a DDIF$_TXT
aggregate is created and the text is stored in the aggregate.

8 If a form-feed character was encountered (indicated by ff_found = 1), this
corresponds to a DDIF hard directive. Therefore, the value of the directive is
set to DDIF$K_DIR_NEW_PAGE and the state is set to DDIF$_HRD.

9 If a tab character was encountered (indicated by ht_found = 1), this
corresponds to a DDIF soft directive. Therefore, the value of the directive is
set to DDIF$K_DIR_TAB and the state is set to DDIF$_SFT.
Text Front End Source File

12-19

If the tab or form-feed directive was the first character encountered on
the line, pass control to the create_dir entry point to create the necessary

directive aggregate.
~ If there was no form feed or horizontal tab directive on the line, this

statement checks to see if the line was completely read or if there are more
characters on the line to be processed. If the line has been completely read,
the next aggregate to be created is a new line (DDIF$K_DIR_NEW_LINE)
soft directive aggregate (type DDIF$_SFT). Otherwise, create another
DDIF$_TXT aggregate because there is more text to read.
fj If the line was empty, the next aggregate to be created is new line (DDIF$K_
DIR_NEW_LINE) soft directive aggregate (type DDIF$_SFT). If this is the

case, the value of the directive is set to DDIF$K_DIR_NEW_LINE, the state
is set to DDIF$_SFT, and the create_dir routine is invoked.
/*
**++
** FUNCTIONAL DESCRIPTION:
**
This routine creates a text aggregate and fills it in.
**
**

FORMAL PARAMETERS:

text_context.wlu.v

value to identify this converter

aggregate_type.wlu.r

pointer to aggregate type

aggregate_handle.wlu.r

pointer to aggregate handle

**
**

IMPLICIT INPUTS:

none

IMPLICIT OUTPUTS:

none

FUNCTION VALUE:

**
**

CDA$_NORMAL
Aggregate creation errors
Memory deallocation error conditions

SIDE EFFECTS:

none

**-**/
static unsigned long

unsigned long
unsigned long
unsigned long

create_txt (text_context_ptr,
aggregate_type,
aggregate_handle)
*text_context_ptr;
*aggregate_type;
*aggregate_handle;

unsigned long
status;
struct text ext *text context;
unsigned long
aggregate item;
unsigned long
item_inde~;
unsigned long
add info;
unsigned long
write_length;
unsigned long
ff_found;
unsigned long
ht found;
unsigned long
junk;

12-20 Text Front End Source File

I* Dereference */
text context
(struct text ext *) *text_context_ptr;
write_length
0;
ff_found
O;
ht found
O;
item_index
O;
/* Do we need to get a line of text from the text file? */
if (text_context->text_l_buffer_length == 0)
{

/* File or procedure? */
if (text_context->text_a_input_routine

•

{

status = cda$read_text_file
(&text context->text a file handle,
&text-context->text-1-buffer length,
&text=context->text=a=buffer=address);
else
{

status

(*text context->text a input routine)
(text_context->text_a_input_routine_param,
&text context->text 1 buffer length,
&text=context->text=a=buffer=address);

/* Check for ENDOFDOC. If found, then
stack for later processing. */
if (status == CDA$_ENDOFDOC)
{

text context->text_v_end_of_document = l;

/* Create an end of segment aggregate */
status = create_eos (&text_context,
aggregate type,
aggregate-handle);
/* Get out of here; no further-processing in TXT */
return status;

if (FAILURE(status))
return (status);
else
text context->text_l_newline_count += 1;
/* Allocate text buffer */
if (text_context->text_l_local_length < text_context->text_l_buffer_length)
{

/* Deallocate old one first */
if text_context->text_l_local_length > 0)
#ifdef vms
lib$free_vm(&text_context->text_l_local length,
&text_context->text_a_local_buffer, 0);
#else
free(text_context->text_a_local_buffer);
#endif

Text Front End Source File

12-21

/* Allocate larger buffer */
if (DDIF_BUFFER_SIZE > text_context->text_l_buffer_length)
text_context->text_l_local_length
DDIF_BUFFER_SIZE;
else
text_context->text_l_local_length
text_context->text_l_buffer_length;
#ifdef vms
status = lib$get_vm(&text_context->text_l_local_length,
&text_context->text_a_local_buffer, 0);
#else
text_context->text_a_local_buffer = (unsigned char *)
malloc(text context->text 1 local length);
(text context->text a local buffer == 0) ?
- (status - CDA$=ALLOCFAIL) : (status= l);
#endif
if (FAILURE(status))
return (status);

/* Were there characters on the line? */
if(text context->text 1 buffer length != 0)
{
-while (write length < text context->text 1 buffer length)
{
--

f!>

/* Look for the Form Feed character (12) which is translated to
* a new_page soft directive
*/
if (text_context->text_a_buffer_address[write_length]
FORM_FEED)

ff_found
break;

else
if (text context->text a buffer address[write length]
HORIZ;;N;AL_TAB)
•
ht_found = l;
break;
else
{

/* Make sure no control characters
* pass through */
~
text_context->text_a_local_buffer[write_length]
= lookup buffer
[text_context->text_a_buffer_address[write_length]];
write_length += l;

/* Is there anything to write?
FF is first on line */
if (write_length != 0)

May not be if

{

/* There was text on the line so
we set the aggregate type to text */
*aggregate_type = DDIF$_TXT;
status = cda$create_aggregate
(&text_context->text_a_root_aggregate_handle,
aggregate_type,
aggregate_handle);
if (FAILURE(status))
return (status);

12-22 Text Front End Source File

/* We now store the text line as a text content item */
aggregate item = DDIF$ TXT CONTENT;
add info ~ CDA$K ISO LATINl;
status = cda$store_item
(&text_context->text_a_root_aggregate_handle,
aggregate_handle,
&aggregate_item,
&write_length,
text_context->text_a_local buffer,
&item_index,
&add info);
if (FAILURE(status))
return (status);

/* Adjust buffer count and address for next pass */
text context->text 1 buffer length
write length;
text=context->text=a=buffer=address += write=length;

/* Special case for FORM_FEED or HORIZONTAL_TAB characters;
skip over it */
if ( (ff_found
1) I I
(ht_found == 1))
text_context->text_l_buffer_length
l;
text_context->text_a_buffer_address += l;
/* Setup for directive */
if (ff_found == 1)
{

text context->text 1 directive content
DDIF$K_DIR_NEW=PAGE;
text context->text 1 state =
DDIF$ HRD;
text context->text 1 directive type
DDIF$_HRD;
-

•

else
{

text context->text 1 directive content
DDIF$K DIR TAB;
text context->text 1 state-= DDIF$ SFT;
text=context->text=l=directive_type = DDIF$_SFT;

/* Create a directive aggregate if it is

first on line */
if (write_length
0)
{

status = create dir (&text_context,
aggregate_type,
aggregate_handle);

/* Finished with the line? */
else
if (text_context->text_l_buffer_length

{

/* Set next aggregate as new_line directive */
text context->text l directive content =
DDIF$K DIR NEW-LINE;
text context->text 1 state-= DDIF$ SFT;
text=context->text=l=directive_type = DDIF$_SFT;
else
/* Otherwise, next aggregate is TXT */
text_context->text_l_state= DDIF$_TXT;

Text Front End Source File

12-23

/* Empty line */
else
{

/* Set directive to be new line */
text_context->text_l_directive_content = DDIF$K DIR NEW LINE;
text_context->text_l_directive_type
= DDIF$_SFT;/* Create a directive aggregate */
status = create_dir (&text_context,
aggregate_type,
aggregate_handle);
/* Say how we did */
return status;

The following callouts correspond to the callouts in the create_eos routine in the
Text front end.

9 This routine creates an end-of-segment (type DDIF$_EOS) aggregate. This
aggregate is a "dummy" aggregate in that it is not actually stored in the
DDIF document. Instead, it is used to indicate the end of a segment.

If the front end has reached the end of the document and if the scope level

is greater than or equal to 1 (the scope level indicates the level of nesting of
segments), the previous DDIF$_EOS aggregate completed a nested segment
and there are more segments to be completed before the document itself can
be completed. In this case, the routine must continue to create DDIF$_EOS
aggregates until the scope level is 0, meaning that the end of the root
segment has been reached. At that point, the status CDA$_ENDQFDOC can
be returned.

G If the front end has not reached the end of the document, this routine only
creates one DDIF$_EOS aggregate to complete the current nested segment.
In this case, the state is set to DDIF$_SEG so that the next aggregate created
is another nested segment.

e This statement decrements the scope level to indicate that a nested segment
has been completed by a DDIF$_EOS aggregate.
/*

**++
** FUNCTIONAL DESCRIPTION:
**
**
This routine creates an end of segment aggregate
**

**
**
**

**
**

FORMAL PARAMETERS:
text_context.wlu.v

value to identify this converter

aggregate_type.wlu.r

pointer to aggregate type

aggregate_handle.wlu.r

pointer to aggregate handle

**
**
**
**
**

IMPLICIT INPUTS:
none

**
**
**
**
**

IMPLICIT OUTPUTS:
none
FUNCTION VALUE:

**
**
**

CDA$_NORMAL
Aggregate creation errors
Memory deallocation error conditions

**
**

SIDE EFFECTS:

12-24 Text Front End Source File

**
**
**-**/

none

static unsigned long

create eos (text_context_ptr,
aggregate_type,
aggregate_handle)

unsigned long
unsigned long
unsigned long

*text_context_ptr;
*aggregate_type;
*aggregate_handle;

unsigned long
status;
struct text ext *text_context;
/* Dereference */
text_context = (struct text_cxt *) *text_context_ptr;
/* Return EOS as current aggregate */
*aggregate_type
= DDIF$_EOS;
*aggregate_handle = O;
/* If end of document, then set status */
if (text_context->text_v_end_of_document == 1)
{

if (text_context->text_b_scope_level >= 1)
{

/* Set next directive to be EOS for content */
text_context->text_l_state= DDIF$_EOS;
/* Set status to success */
status = CDA$_NORMAL;
else
/* Set status to end of document */
status
CDA$_ENDOFDOC;
else
{

/* Set state to be SEG*/
text_context->text_l_state= DDIF$_SEG;
/* Set status to success */
status
CDA$_NORMAL;
/* Decrement scope level */
text_context->text_b_scope_level

return (status);

The following callout corresponds to the callout in the look_ahead routine in the
Text front end.

G This routine is called by the create_dir routine to scan through multiple blank
lines in the text file.

Text Front End Source File

12-25

/*
**++
**

FUNCTIONAL DESCRIPTION:

**
**

This routine looks ahead for multiple blank lines in the text stream.
Multiple blank lines indicate end of paragraph. They become
hard newline directives.

**
**
**
**

FORMAL PARAMETERS:
text context.wlu.v

value to identify this converter

**
**

aggregate_type.wlu.r

pointer to aggregate type

aggregate_handle.wlu.r

pointer to aggregate handle

**
**

IMPLICIT INPUTS:

**
**
**
**

none
IMPLICIT OUTPUTS:

**
**

none

**
**
**

**
**

**
**
**

FUNCTION VALUE:
CDA$ NORMAL
Aggregate creation errors
Memory deallocation error conditions
SIDE EFFECTS:

**
**
**

none

**-**/
static unsigned long

look_ahead (text_context_ptr)

unsigned long

*text_context_ptr;

unsigned long
status = 1;
struct text_cxt *text_context;
/* Dereference */
text context = (struct text_cxt *) *text_context_ptr;
/* Look ahead and compress blank lines */
while ((text context->text 1 buffer length
(SUCCESS(status)))- /* File or procedure? */
if (text_context->text_a_input_routine

0) &

{

status = cda$read text file
(&text=context->text_a_file handle,
&text_context->text_l_buffer_length,
&text_context->text_a_buffer_address);
else
{

status

(*text context->text a input routine)
(text_context->text_~_input_~outine_param,
&text_context->text_l_buffer_length,
&text_context->text_a_buffer_address);

if (SUCCESS(status))
text context->text_l_newline_count += 1;

12-26 Text Front End Source File

/* Check for ENDOFDOC.
If found, then stack for later processing. */
if (status == CDA$_ENDOFDOC)
{

text context->text v end of document
status
CDA$_NORMAL;
- -

return status;

The following callouts correspond to the callouts in the create_dir routine in the
Text front end.

G If the directive content was set to DDIF$K_DIR_NEW_LINE (regardless of
whether it indicates the end of a paragraph or the end of the document), this
directive must be stored as a hard directive in a DDIF$_HRD aggregate.

G Otherwise, the appropriate type of aggregate is created a:nd filled in.
•

If the directive was a new-line directive, the new-line counter is decremented

and the routine checks to see if it is at the end of a paragraph, the end of the
document, or if there are more new lines to process. The appropriate values
are specified according to which case applies.
/*
**++
** FUNCTIONAL DESCRIPTION:
**
This routine creates a directive aggregate and
**
fills it in.
**
**
** FORMAL PARAMETERS:
**
value to identify this converter
text_context.wlu.v
**
**
pointer to aggregate type
aggregate_type.wlu.r
**
**
aggregate_handle.wlu.r
pointer to aggregate handle
**
**
** IMPLICIT INPUTS:
**
none
**

**
**
**
**
**

IMPLICIT OUTPUTS:
none

** FUNCTION VALUE:
**
CDA$_NORMAL
**
Aggregate creation errors
**
Memory ~eallocation error conditions
**
**
** SIDE EFFECTS:
**
none
**
**
**-**/
static unsigned long
create_dir (text_context_ptr,
aggregate_type,
aggregate_handle)
unsigned long
unsigned long
unsigned long
unsigned long
struct text ext
unsigned long
unsigned long

*text_context_ptr;
*aggregate_type;
*aggregate_handle;
status;
*text_context;
aggregate_item;
item_length;

Text Front End Source File 12-27

/* Dereference */
text_context = (struct text_cxt *) *text_context_ptr;
/* Look ahead for blank lines? */
if ((text_context->text_l_newline_count == 1) &&
(text_context->text_v_end_of_paragraph == 0) &&
(text_context->text_l_buffer_length == 0))
status= look ahead (&text context);
return (status);

i f (FAILURE (status))

/* Is this a new line? */
if (text_context->text_l_directive_content

DDIF$K_DIR_NEW_LINE)

{

/* End of paragraph? (current newline plus at least 2 more) */
if (text context->text 1 newline count > 2)
text_context->text_v_end=of_paragraph = l;
/* Set HRD directive if end of paragraph or document */
if (text_context->text_v_end_of_paragraph == 1)
text_context->text_l_directive_type = DDIF$_HRD;
if ((text context->text vend of document== 1) &&
(text-context->text-1-newline count== 1))
text=context->text=l=directi;e_type = DDIF$_HRD;

/* We are to return a directive */
*aggregate_type = text_context->text_l_directive_type;
/* Create the aggregate */
status = cda$create_aggregate
(&text_context->text_a_root_aggregate_handle,
aggregate_type,
aggregate handle);
i f (FAILURE (status) )
return (status);

/* Set the directive type */
if (text context->text 1 directive type == DDIF$ SFT)
aggregate_item- -DDIF$_SFT=DIRECTIVE;
else
aggregate_item
DDIF$_HRD_DIRECTIVE;
/* Store it */
item length= sizeof(text context->text 1 directive content);
status = cda$store_item (&text_context->text_a_root=aggregate_handle,
aggregate_handle,
&aggregate item,
&item length,
&text=context->text_l_directive content);
if (FAILURE(status))
return (status);
/* If this is a new line directive, then decrement counter */ . ,
if (text context->text 1 directive content
DDIF$K_DIR_NEW_LINE)
text_context->text_l_newline_count -= l;

12-28 Text Front End Source File

/* Decide what aggregate to process next */
/* End of Document? */
if (text_context->text_v_end_of_document
1)
{

/* Soft newlines to end of document */
if (text_context->text_l_newline_count >= 1)
{

text context->text 1 state = DDIF$ HRD;
text-context->text-1-directive typ; = DDIF$ HRD;
text=context->text=l=directive=content
DDIF$K_DIR_NEW_LINE;
else
/* EOS terminates paragraph and document */
text_context->text_l_state= DDIF$_EOS;
else
/* End of Paragraph? */
if (text_context->text_v_end_of_paragraph == 1)
{

/* Hard newlines to end of paragraph */
if (text_context->text_l_newline_count >= 2)
{

text context->text 1 state = DDIF$ HRD;
text-context->text-1-directive type= DDIF$ HRD;
text=context->text=l=directive=content
DDIF$K_DIR_NEW_LINE;
else
/* EOS terminates paragraph */
{

text_context->text_l_state= DDIF$_EOS;
text_context->text_v_end_of_paragraph = 0;

else

/* Not end of paragraph or document, but more newlines */
if (text_context->text_l_newline_count > 1)
{

text context->text 1 state= DDIF$ SFT;
text-context->text-1-directive type = DDIF$ SFT;
text=context->text=l=directive=content
DDIF$K_DIR_NEW_LINE;
}

/* No more newlines; just text */
else
text_context->text_l_state= DDIF$_TXT;
/* Say how we did */
return status;

The following callout corresponds to the callout in the get-position routine in the
Text front end.

8 This routine determines the current location of the front end within the input
stream. This routine is used primarily by viewer applications for scroll bar
support.

Text Front End Source File

12-29

/*
**++
**

•

FUNCTIONAL DESCRIPTION:

**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**

This routine is the entry point for the 'get_position' procedure.
It returns the total size of the text stream and the current
position (or offset) within the text stream.
FORMAL PARAMETERS:
text_context.wlu.v

value to identify this converter instance

stream_position.wlu.r

address to store stream position

stream size.wlu.r

address to store stream size

IMPLICIT INPUTS:
none
IMPLICIT OUTPUTS:
none

**
**

FUNCTION VALUE:

**
**
**
**
**
**
**

CDA$ NORMAL
CDA$-ENDOFDOC
Memory allocation error conditions
File error conditions
SIDE EFFECTS:

**
**
**

none

**-**I
static unsigned long

unsigned long
unsigned long
unsigned long

get_position (text context ptr,
stream_position,
stream_size)
*text_context_ptr;
*stream_position;
*stream_size;

unsigned long
status;
struct text ext *text_context;
/* Dereference */
text_context = (struct text_cxt *) *text_context_ptr;
/* Do we have a user supplied position routine? */
if (text context->text a position routine == 0)
f* Ask the CDA-Toolkit for the position and size information */
status = cda$get_text_position (&text_context->text_a_file_handle,
stream_position,
stream_size);
else
/* Ask user routine for position and size information */
status
(*text_context->text_a_position_routine)
(text_context->text_a_position_param,
stream position,
stream=:size);
return status;

The following callout corresponds to the callout in the close routine in the Text
front end.
•

This routine closes the front end and deallocates all resources.

12-30 Text Front End Source File

/*
**++
**

FUNCTIONAL DESCRIPTION:

**
**
**
**
**
**

This routine is the entry point for the 'close front end' procedure.
It closes the input DDIF file (or stream) and deallocates the
converter context.
FORMAL PARAMETERS:

**
**

text context.wlu.v

value to identify this converter

**
**
**

IMPLICIT INPUTS:
none
IMPLICIT OUTPUTS:

**
**
**
**

none
FUNCTION VALUE:

**
**
**
**
**
**

CDA$ NORMAL
Memory deallocation error conditions
File error conditions
SIDE EFFECTS:

**
**

none

**
**--

**/
static unsigned long
unsigned long

close_front_end (text_context_ptr)

*text_context_ptr;

unsigned long
status;
unsigned long
struct_size;
struct text_cxt *text_context;

/* return status */
/* holds context block size */
/* points to context block */

/* Dereference */
text context = (struct text_cxt *) *text_context_ptr;
/* Do we have a file or just a stream? */
status = CDA$_NORMAL;
if (text_context->text a file handle != 0)
{

/* Close the input file */
status = cda$close text file
(&text_context->text_a_file handle);
if (FAILURE(status))
return (status);

/* Delete the root aggregate */
status = cda$delete root aggregate
(&text_context->text_a_root_aggregate_handle);
/* Deallocate text buffer and front end context block if we have one */
struct size= sizeof (struct text_cxt);
#ifdef vms
if (text context->text 1 local length > 0)
lib$free_vm(&text_context->text_l_local_length,
&text context->text a local buffer, 0);
lib$free_vm (&struct_:'Size, &text_cont~xt, o);
#else
if (text_context->text_l_local_length > 0)
free(text_context->text_a_local_buffer);
free(text_context);
#endif
/* Say how we did */
return status; }

Text Front End Source File

12-31

Chapter 13

CDA Viewer Routines
This chapter describes the VMS and ULTRIX compile and link procedures and
routines used to write a viewer application.
There are two sets of viewer routines: 1) the character cell viewer routines, which
are listed first and which are preceded by DvrCC, and 2) the DECwindows viewer
routines. Each routine description includes the following information:
•

An ULTRIX C style binding that is supported on both VMS and ULTRIX
systems

•

A description of the value returned by the routine

•

A description of each routine argument

•

A description of the routine itself

•

A list of possible values returned by the routine

13.1 CDA Viewer Support of Adobe Font Metrics
The CDA Viewer uses the Adobe font metrics in processing a DDIF file for
viewing. The font name in a DDIF file follows the X-11 font naming convention.
When processing a file from a creating application that uses font metrics other
than Adobe font metrics, the CDA Viewer defaults to the Adobe Courier font.
The DECwindows CDA Viewer queries the X server for a list of available fonts
when processing a file for viewing. Although the CDA Viewer does not use these
fonts in its calculations, it tries to match the font from the file with an Xll font
on the server. If there is not an exact match, the CDA Viewer uses the font
from the list that is the closest lower point size for that font name. If there is
no match at all, the DECwindows CDA Viewer display type defaults to 12 point
Adobe Courier.
The character cell CDA Viewer displays all files in a 12 point Courier font. The
contents of each file are spaced and displayed correctly, based on the font that is
stored in the file.
·
The Adobe font metrics are stored in SYS$PS_FONT_METRICS:.AFM on VMS
systems and in /usr/lib/font/metrics/ on ULTRIX systems.

CDA Viewer Routines

13-1

1~.2

Compile and Link Procedures for Viewer Images
To create a VMS or ULTRIX program using the CDA Viewer callable interface,
include the following public files in your source code:
VMS and ULTRIX

File Names

Description

SYS$LIBRARY:DVR$MSG.H
/usr/include/dvr_msg.h

Status codes for both the character cell viewer
and the DECwindows viewer callable interfaces.

SYS$LIBRARY:DVR$CC_DEF.H
/usr/include/dvr_cc_def.h

Literals and structure definitions for the
character cell viewer callable interface.

SYS$LIBRARY:DVR$DECW_DEF.H
/usr/include/Xll/dvr_decw_def.h

Literals and structure definitions for the
DECwindows viewer callable interface.

On ULTRIX systems, you must also install the DECimage Application Services
libraries (libimg.a, libids.a, and libchf.a) before you can use the CDA DECwindows
viewer callable interface library (libdvr.a) and the CDA character cell viewer
callable interface library (libdvs.a).
Section 13.2.1 describes the VMS compile and link procedure for CDA viewers.
Section 13.2.2 describes the ULTRIX compile and link procedure for CDA viewers.

13.2.1

VMS Link Procedure
After you compile your source code into an object module (for example, YOUR_
MODULE.OBJ), link a C program (VIEWER_PROGRAM.EXE) using the
following link command on VMS:
$ LINK/EXE=VIEWER PROGRAM YOUR MODULE.OBJ, SYS$INPUT/OPT
SYS$SHARE:DDIF$VIEWSHR/SHARE

13.2.2

ULTRIX Link Procedures
After you compile your source code into an object module (for example, your_
module.o), link a DECwindows viewer program (dw_viewer_program) using the
following link command:
csh> cc -o dw_viewer_program
your module.o
/usr/lib/libdvr.a
/usr/lib/libids.a
/usr/lib/libdwt.a
/usr/lib/libimg.a
/usr/lib/libchf .a
/usr/lib/libXll.a
/usr/lib/1ibdvs.a
/usr/lib/libddif .a
/usr/lib/libm.a

\
\
\
\
\
\
\
\
\
\

To link a character cell viewer program (cc_viewer_program), use the following
command:

13-2 CDA Viewer Routines

csh> cc -o cc_viewer_program
your :module. o
/usr/lib/libdvs.a
/usr/lib/libimg.a
/usr/lib/libchf .a
/usr/lib/libddif .a
/usr/lib/libcurses.a
/usr/lib/libtermlib.a
/usr/lib/libm.a

\
\
\
\
\
\
\
\

Applications that call the viewer routines should use a general condition handling
routine for asynchronous signals that the viewer may generate. The signals
probably will occur when the viewer is processing images, rather than text or
graphics. The following example is a condition handling routine shell, written in
C, which can be included in applications that call the viewer:
int my condition handler(signal, mechanism)
struct chf$signal array
*signal;
struct chf$mech_array
*mechanism;
{

/* signal->chf$1 sig name contains the error status;
* process status and continue program execution

In the main routine of your application, add the following call to set up the
condition handler:
#if def VMS
LIB$ESTABLISH (my_condition_handler);
#endif
#ifdef ultrix
ChfEstablish (my_condition_handler);
#endif

LIB$ESTABLISH() is a VMS run-time library routine. ChfEstablish( ) is the
condition handling establish routine provided within libchf.a.

CDA Viewer Routines

13-3

CC DELETE PAGE

CC DELETE PAGE
Deallocates the page display structure allocated by the routine CC GET PAGE.

C FORMAT
status

=DvrCCDeletePage (cc_ viewer_context, line_array)

Argument Information
unsigned long
unsigned char

*cc_viewer_context;
***line_array;

RETURNS
status
A condition value indicating the return status of the routine call.

ARGUMENTS
cc_ viewer_context
The address of an unsigned longword that specifies the CC viewer context. This
value must be the value returned by the CC INITIALIZE routine.
line_array
The address of an unsigned longword that contains the address of the line array
returned by the CC GET PAGE routine. This parameter serves to identify the
line array and the corresponding line size array to be deallocated.

Description
The CC DELETE PAGE routine deallocates the page display structure allocated
by the routine CC GET PAGE. Applications may delete this structure once it is
no longer required. Page structures must be deallocated using the CC DELETE
PAGE routine; applications cannot directly deallocate these structures.

13-4 CDA Viewer Routines

CC DELETE PAGE

RETURN VALUES

Return Value

Description

DVR$_NORMAL

Page successfully deleted

DVR$_MEMDEALLOFAIL

Memory deallocation failure

CDA$_xxxx

Any CDA return status

CDA Viewer Routines 13-5

CC END

CC END
Deallocates all internal structures that were allocated and does general cleanup
required for CC viewer shutdown for the current file.

C FORMAT
status= DvrCCEnd

(cc_viewer_context)

Argument Information
unsigned long

*cc_viewer_context;

RETURNS
status
A condition value indicating the return status of the routine call.

ARGUMENTS
cc_ viewer_ context
The address of an unsigned longword that specifies the CC viewer context. This
value must be the value returned by the CC INITIALIZE routine.

Description
The CC END routine deallocates all internal structures that were allocated and
does general cleanup required for CC viewer shutdown for the current file. This
routine may be called at any point during document processing. Any outstanding
page structures not previously deleted by calls to the CC DELETE PAGE routine
are also deallocated.

13-6 CDA Viewer Routines

CC END

RETURN VALUES

Return Value

Description

DVR$_NORMAL

Structures successfully deallocated

DVR$_MEMDEALLOFAIL

Memory deallocation failure

CDA$_xxx

Any CDA return status

CDA Viewer Routines

13-7

CC GET PAGE

CC GET PAGE
Returns the next sequential formatted page from the CDA document.

C FORMAT
status

=DvrCCGetPage
(cc_viewer_context, number_ot_lines, fine_array,
line_size_array)

Argument Information
unsigned long
unsigned long
unsigned char
unsigned long

*cc viewer context;
*nurriber_of=lines;
***line_array;
**line_size_array;

RETURNS
status
A condition value indicating the return status of the routine call.

ARGUMENTS
cc_ viewer_ context
The address of an unsigned longword that specifies the CC viewer context. This
value must be the value returned by the CC INITIALIZE routine.
number_of_lines
The address of an unsigned longword that receives the number of lines in this
page.
line_array
The address of an unsigned longword that receives the address of an array of
longwords in which each element is the address of a null-terminated character
string that represents the characters to be displayed on a line. Each element in
the array represents a specific line number. Element 0 represents line 1, element
1 represents line 2, and so on.
line_size_array
The address of an unsigned longword that receives the address of an array of
longwords in which each element is the length of the character string for the
corresponding line-array element. If you specify 0 by value for this parameter, no
size array is returned.
13-8 CDA Viewer Routines

CC GET PAGE

Description
The CC GET PAGE routine returns the next sequential formatted page from the
CDA document. The page is returned as an array of character string pointers.
Each character string represents a line of text. After the last page in the
document has been processed, the CC GET PAGE routine returns a null page
structure and the status DVR$_EOD (end of document). The page structures
remain in memory until they are explicitly deleted by a call to either the CC
DELETE PAGE routine or the CC END routine.

RETURN VALUES

Return Value

Description

DVR$_NORMAL
DVR$_EOD

Page returned successfully.
The application is at the bottom of the file and cannot page
forward any further.

Any other error status codes.

CDA Viewer Routines

13-9

CC INITIALIZE

CC INITIALIZE
Initializes the character-cell CDA Viewer and returns a context block to the caller
for use in subsequent character-cell CDA Viewer routine calls.

C FORMAT

status= DvrCClnitialize
(select_ options, standard_item_list,
private_item_list, display_height, display_width,
cc_ viewer_ context)

Argument Information
unsigned long
ITEM LIST TYPE
ITEM LIST TYPE
unsigned long
unsigned long
unsigned long

select_options;
*standard item list;
*private Item list;
display:=height;
display width;
*cc_viewer_context;

RETURNS
status

A condition value indicating the return status of the routine call.

ARGUMENTS
select_ options

A flag vector that may contain any of the following CDA Viewer masks:
Mask Value

Meaning

DVR$M_Outfile

Output is directed to a text file. If set, the entire
document is written at once to the output file (or
standard output) in the CC INITIALIZE routine
without the application having to call the CC GET
PAGE routine or the CC END routine.
Obey DDIF soft directives (new line, new page, and so
on).

DVR$M_SoftDirectives

13-10 CDA Viewer Routines

CC INITIALIZE

Mask Value

Meaning

DVR$M_Auto_Wrap

Output is word wrapped at the specified page width or
galley width.

DVR$M_Text

Set to create text output.

DVR$M_Graphics

Set to note location of graphics in the output with a
replacement message.

DVR$M_Images

Set to note location of images in the output with a
replacement message.

DVR$M_Layout

Use generic layout.

DVR$M_SpecificLayout

Use generic and specific layout.

DVR$M_ReportErrors

Write all nonfatal error messages to SYS$ERROR or
stderr. Fatal errors are always reported.

DVR$M_Paging

If not set, the entire document is written at once to the

output file (or standard output) in the CC INITIALIZE
routine without the application having to call the CC
GET PAGE routine or the CC END routine.
DVR$M_Text_Backend

If set, the CC viewer acts as a text back end. It

expects the CDA front end handle to be passed in the
private item list, with item code
DVR$_FRONT_END_HANDLE.

These masks are defined in DVR$CC_DEF.H. Note that if DVR$M_Text is not
set, there will be no text output.
standard_item_list
Address of a standard CDA item list. An item list contains entries consisting of
two longwords. The item list is terminated by a null entry.

The item codes are the same CDA$ item codes accepted by the CONVERT
routine in its standard_item_list parameter. The CDA item codes are defined
in SYS$LIBRARY:cda$def. * on VMS systems and in /usr/include/cda_def.h on
ULTRIX systems. Item codes of the same names, but with the DVR$ prefix, are
provided in SYS$LIBRARY:DVR$CC_DEF.H on VMS systems and in /usr/include
/dvr_cc_def.h on ULTRIX systems.
The CDA$_INPUT_PROCEDURE and CDA$_INPUT_ PROCEDURE_
PARM codes are supported. These allow the calling application to supply DDIF
input rather than having the CDA Viewer get it from the specified input file.
The standard item list actually supports all the items listed for the CONVERT
routine, although not all item combinations make sense.
private_item_list
The address of a private item list, in the same format as the standard_item_
list. This item list only supports DVR$ item codes. Currently, the only item
codes expected in this private item list are shown in the following table.
Item Code

Meaning

DVR$_FRONT_END_HANDLE

Front end input procedure handle

DVR$_PAGE_HEIGHT

Formatted page height in lines of characters

CDA Viewer Routines 13-11

CC INITIALIZE

Item Code

Meaning

DVR$_PAGE_WIDTH

Formatted page width in columns of characters

display_height

The maximum height per page (in rows). If you specify 0 for this parameter, the
resulting screen height is set to a size adequate to include the entire original
page. This is useful for applications that would like the entire page formatted to
a specific number of rows.
display_ width

The maximum page width (in columns). If you specify 0 for this parameter, the
resulting screen width defaults to 132 columns.
cc_ viewer_ context

The address of an unsigned longword that receives the CC viewer context.
The address of this value must be specified as the cc_viewer_conte:xt input
parameter during calls to the other CC routines.

Description
The CC INITIALIZE routine initializes the character-cell CDA Viewer and
returns a context block to the caller for use in subsequent character-cell CDA
Viewer routine calls.

RETURN VALUES

Return Value

Description

DVR$_NORMAL

CC viewer successfully initialized

Any error status codes.

13-12 CDA Viewer Routines

BOTTOM DOCUMENT

BOTTOM DOCUMENT
Displays the last page of content in the file in the widget window.

C FORMAT

status =DvrBottomDocument

(w)

Argument Information
int
Widget

status;
w;

RETURNS
status
A condition value indicating the return status of the routine call.

ARGUMENTS

w
Identifier of the CDA Viewer widget.

Description
When an application calls the BOTTOM DOCUMENT routine, the CDA Viewer
displays the last page of content.

CDA Viewer Routines

13-13

BOTTOM DOCUMENT

RETURN VALUES

Return Value

Description

DVR$_NORMAL

The last page of content was displayed successfully.

DVR$_EOD

The application is at the bottom of the file and cannot
page forward any further.

DVR$_ERROR

An error. was encountered while reading the file, or
converting to in-memory DDIF.

DVR$_INVADDR

Invalid address.

DVR$_FILENOTOPEN

There is no open file.

CDA$_xxxx

Any CDA return status.

13-14 CDA Viewer Routines

CLOSE FILE

CLOSE FILE
Closes the file currently being read by the CDA Viewer and clears the window.

C FORMAT

status= DvrCloseFile

(w)

Argument Information
int
Widget

status;
w;

RETURNS

status
A condition value indicating the return status of the routine call.

ARGUMENTS
w
The identifier of the CDA Viewer widget.

Description
The CLOSE FILE routine closes the file currently being read by the CDA Viewer
and clears the window.

RETURN VALUES

Return Value

Description

DVR$_NORMAL

The file was closed successfully.

DVR$_FILENOTOPEN

There is no open file.

DVR$_INVADDR

Invalid address.

CDA$_xxxx

Any CDA return status.

CDA Viewer Routines

13-15

DOCUMENT INFO

DOCUMENT INFO
Returns information from the header aggregate of the currently open document.

C FORMAT
status= DvrDocumentlnfo

(w, buffer_dsc)

Argument Information
int
Widget
char

status;
w;
**buffer_dsc;

RETURNS
status
A condition value indicating the return status of the routine call.

ARGUMENTS

w
The identifier of the CDA Viewer widget.
buffer_dsc
The address of a string buffer to be allocated.

Description
The DOCUMENT INFO routine returns information from the header aggregate
of the currently open document. This information includes the document title,
author, version, and creation date.

13-16 CDA Viewer Routines

DOCUMENT INFO

RETURN VALUES

Return Value

Description

DVR$_NORMAL

The document's header was successfully read.

DVR$_BADPARAM

An invalid parameter was specified.

DVR$_FILENOTOPEN

There is no open file.

DVR$_DRMSTRINGFETCHFAIL

Failure to fetch a string.

DVR$_NODISPCONT

The requested information is not contained in the
document.

DVR$_MEMDEALLOFAIL

Failure to deallocate memory.

DVR$_MEMALLOFAIL

Failure to allocate memory.

CDA Viewer Routines

13-17

GOTO PAGE

GOTO PAGE
Attempts to move to the specified page number.

C FORMAT

status = DvrGotoPage

(w, page_num)

Argument Information
int
Widget
int

status;

w;
page_num;

RETURNS
status
A condition value indicating the return status of the routine call.

ARGUMENTS
w
Identifier of the CDA Viewer widget.
page_num
Page number of the desired page in the document.

Description
The GOTO PAGE routine attempts to move to the specified page number.

RETURN VALUES

Return Value

Description

DVR$_NORMAL

The CDA Viewer widget has successfully moved to the
requested page.

13-18 CDA Viewer Routines

GOTO PAGE

Return Value

Description

DVR$_EOD

End of document.

DVR$_PAGENOTFOUND

A page with the specified page number was not found
in the document.

DVR$_BADPARAM

An invalid parameter was specified.

CDA Viewer Routines

13-19

NEXT PAGE
Displays the next page of a CDA document.

C FORMAT
status = DvrNextPage

(w)

Argument Information
int
Widget

status;
w;

RETURNS
status
A condition value indicating the return status of the routine call.

ARGUMENTS
w
Identifier of the CDA Viewer widget.

Description
The NEXT PAGE routine displays the next page of a CDA document.

13-20 CDA Viewer Routines

RETURN VALUES

Return Value

Description

DVR$_NORMAL

The CDA Viewer widget has successfully moved to the
next page.

DVR$_INVADDR
DVR$_EOD

Invalid address.
End of document.

DVR$_FILENOTOPEN

There is no open file.

CDA$_xxxx

Any condition value returned by the CDA$ routines.

CDA Viewer Routines

13-21

PREVIOUS PAGE
Displays the previous page (if one exists) of a CDA document.

C FORMAT

status = DvrPreviousPage

(w)

Argument Information
int
Widget

status;
w;

RETURNS
status
A condition value indicating the return status of the routine call.

ARGUMENTS
w
Identifier of the CDA Viewer widget.

Description
The PREVIOUS PAGE routine displays the previous page (if one exists) of a CDA
document.

RETURN VALUES

Return Value

Description

DVR$_NORMAL

The CDA Viewer widget has successfully displayed the
previous page.

DVR$_INVADDR

Invalid address.

13-22 CDA Viewer Routines

Return Value

Description

DVR$_TOPOFDOC

The application is at the top of the file and cannot page
backward any further.

DVR$_FILENOTOPEN
CDA$_x:xxx

There is no open file.
Any condition value returned by the CDA$ routines.

CDA Viewer Routines

13-23

C FORMAT
status= DvrRegisterClass

()

RETURNS
status
A condition value indicating the return status of the routine call.

Description.
The REGISTER CLASS routine is used to indicate that the CDA Viewer widget is
registered with DRM. This call is only necessary for developers using UIL.

RETURN VALUES

Return Value

Description

DVR$_NORMAL

The CDA Viewer widget was successfully registered with DRM.

DVR$_INVADDR

Invalid address.

DVR$_FAILURE

The CDA Viewer widget was not successfully registered with
DRM.

13-24 CDA Viewer Routines

TOP DOCUMENT

Return Value

Description

DVR$_INVADDR

Invalid address.

DVR$_FILENOTOPEN

There is no open file.

CDA$_xxxx

Any CDA return status.

13-26 CDA Viewer Routines

VIEWER

VIEWER
Creates a widget for viewing a CDA file.

C FORMAT
Widget = DvrViewer
(parent, name, x, y, width, height, horz_scrol/_bar,
vert_scrol/_bar, proc_options, callback,
help_ callback)

Argument Information
Widget
parent;
char
*name;
int
x;
int
y;
int
width;
int
height;
Boolean
horz_scroll_bar;
Boolean
vert_scroll_bar;
int
proc_options;
DwtCallbackPtr callback;
DwtCallbackPtr help_callback;

RETURNS
Widget
Identifier of the created CDA Viewer widget.

ARGUMENTS
parent
The parent window of the widget.
name
The name of the widget to be created.

x
A signed longword that defines in pixels the placement of the left side of the
widget window relative to the inner upper left comer of the parent window. The
default is 0.

CDA Viewer Routines

13-27

VIEWER
y
A signed longword that defines in pixels the placement of the left side of the
widget window relative to the inner upper left corner of the parent window. The
default is 0.
width
The width in pixels of the widget window.
height
The height in pixels of the widget window.
horz_scroll_bar
A Boolean value indicating that a horizontal scroll bar should be included in the
CDA Viewer widget.
vert_scroll_bar
A Boolean value indicating that a vertical scroll bar should be included in the
CDA Viewer widget.
proc_ options
An integer mask indicating the options for processing the document. For a list
of possible processing options masks, see the low-level creation routine VIEWER
CREATE.
callback
The identifier of the application routine to be called back. The callback routine
should have the form callback(Widget, tag, reason).
help_callback
The identifier of the application help routine to be called back. The callback
routine should have the form callback(Widget, tag, reason).

CALLBACK ROUTINES
The format of the callback routines is as follows:
void

CallbackProc(WidgetID, tag, reason)
Widget
*Widget ID;
caddr_t
tag;
DvrCallbackStruct *cb_data;

CALLBACK DATA STRUCTURE
The format of the callback data structure is as follows:
typedef struct
{ int
reason;
Xevent
*event;
unsigned long status;
char
*string_ptr;
DvrCallbackStruct;

13-28 CDA Viewer Routines

VIEWER

CALL BACK REASONS
The application callback is called with the following values for reason:
DvrCRactivated
The CDA Viewer requests focus by clicking on MB1.
DvrCRendDocument
The end of the document has been displayed.
DvrCRcdaError
A nonrecoverable error was incurred while processing the document. See the
status field of the callback structure for the specific status returned. See the
string-ptr field for a character string describing the status.
DvrCRhelpRequested
Help was requested by clicking on HELP + MB1.

CALLBACK FIELD DESCRIPTIONS
The callback field descriptions are as follows:
reason
See the Callback Reasons section.
event
A pointer to the X event structure describing the event that generated this
callback.
status
The specific status returned.
string_ptr
The character string describing the status.

Description
The VIEWER routine creates a widget that can be used to view the information
content of an in-memory CDA document. If the document to be viewed is not
in DDIF format, then a front end converter must exist that can convert the
document from its non-DDIF format to in-memory DDIF. (A CDA Viewer widget
can also be created using the low-level creation routine VIEWER CREATE.)
To associate a file with the CDA Viewer widget, see the description of the
VIEWER FILE routine.

CDA Viewer Routines

13-29

VIEWER

RETURN VALUES
If the return value is successful, the VIEWER routine returns the ID of the
widget. If the return value is failure, the VIEWER routine returns 0.

13-30 CDA Viewer Routines

VIEWER CREATE

VIEWER CREATE
Creates a widget for viewing a CDA file.

C FORMAT
Widget = DvrViewerCreate
(parent, name, override_arglist, override_argcount)

Argument Information
Widget parent;
char
*name;
ArgList override_arglist;
int
override_argcount;

RETURNS
Widget
Identifier of the created CDA Viewer widget.

ARGUMENTS
parent
The parent window of the widget.
name
The name of the widget to be created.
override_arglist
The application override argument list. This list consists of name/value pairs
that describe the attributes of the created widget. For more information on
the override_arglist argument, see the VMS DECwindows Toolkit Routines
Reference Manual.

The override_arglist argument can contain any of the common arguments for
low-level widget creation routines, plus the following widget-specific arguments:
•

Boolean horz_scroll_bar

•

Boolean vert_scroll_bar

•

int processing_options

•

int paper_width

CDA Viewer Routines

13-31

VIEWER CREATE
•

int paper_height

override.....argcount
The number of arguments in the application override argument list. If there are
no arguments in the argument list, then override_argcount must equal zero,
but the override_arglist does not have to be null. In the VMS DECwindows
Toolkit Routines Reference Manual, see the Common Arguments section for
descriptions of the VAX and C formats of arguments common to all widgets.

Widget Specific Attributes
horz_scroll_bar
Boolean argument that, if true, results in a horizontal scroll bar being placed at
the bottom of the CDA Viewer widget window. The default value is true. The
name of this argument is DvrNscrollHorizontal. This is a create time only
resource and cannot be modified through XtSet Values.
vert_scroll_bar
Boolean argument that, if true, results in a vertical scroll bar being placed at the
right side of the CDA Viewer widget window. The default value is true. The name
of this argument is DvrNscrollVertical. This is a create time only resource and
cannot be modified through XtSet Values.
processing_ options
This argument is a mask formed by the union of processing options to be followed
when document content is displayed in the CDA Viewer. The name of this
argument is DvrNprocessingOptions. The supported processing options are
shown in the following table.
Processing Option

Mask Value

Word wrap

DvrWordWrap

Soft directives

DvrSoftDirectives

Layout

DvrLayout

Specific layout

DvrSpeci:ficLayout

The default is:
DvrWordWrap I DvrSoftDirectives I DvrLayout I DvrSpecificLayout
paper_ width
Integer value that specifies the desired width of the paper in millimeters. The
name of this argument is DvrNpaperWidth.

This argument does not apply to the CDA Viewer's window width; it applies
only to the size of the paper to be used for each page displayed in the CDA
Viewer's window. By default, the CDA Viewer uses the paper width stored in
the document. If this item is not encoded, the CDA Viewer uses a default paper
width of 8.5 inches.
paper_height
Integer value that specifies the desired height of the paper in millimeters. The
name of this argument is DvrNpaperHeight.
13-32 CDA Viewer Routines

VIEWER CREATE

This argument does not apply to the CDA Viewer's window height; it applies
only to the size of the paper to be used for each page displayed in the CDA
Viewer's window. By default, the CDA Viewer uses the paper height stored in
the document. If this item is not encoded, the CDA Viewer uses a default paper
height of 11 inches.

Description
The VIEWER CREATE routine is a low-level routine used to create a widget
for viewing an in-memory DDIF file. If the file is not in DDIF, there must be a
front end converter that can be called to convert the file into in-memory DDIF. To
associate a file with the CDA Viewer widget, see the description of the VIEWER
FILE routine. A CDA Viewer widget can also be created using the high-level
VIEWER creation routine.
See the description of the high-level creation routine VIEWER for the definition
of the callback structure and the reasons for a callback.
Defaults:
The default height is 723 pixels and the default width is 684 pixels.
The default x,y location of the widget is the upper left corner of the parent.
A CDA Viewer widget can also be created using the high-level VIEWER routine.

RETURN VALUES
If the return value is successful, the VIEWER CREATE routine returns the ID of
the widget. If the return value is failure, the VIEWER CREATE routine
returns 0.

CDA Viewer Routines

13-33

VIEWER FILE

VIEWER FILE
Opens a file and begins to view the information content of the file, provided the
file can be converted to in-memory DDIF.

C FORMAT

status = DvrViewerFile
(w, filename, format, optionsfile, getrtn, getprm)

Argument Information
int
Widget
char
char
char
int
int

status;
w;
*filename;
*format;
*optionsfile;
getrtn;
getprm

RETURNS
status
The result of attempting to open and begin the conversion of the file.

ARGUMENTS
w
The identifier of the CDA Viewer widget that should open and display the
information content of the file.
filename
A character string specifying the name of the file to be viewed.
format
A character string specifying the format of the file to be viewed. If the file is not
in DDIF format, a converter must exist that can convert the file to in-memory
DDIF.
optionsfile
A character string specifying a file with processing options for the front end
converter. If this argument is null, 0, or a zero-length string, it is not used.

13-34 CDA Viewer Routines

VIEWER FILE
getrtn
If the file should be read by other than the system default read routine, this
argument should identify the alternative read routine. If the standard read
routine is to be used, the value of getrtn should be 0.
getprm

The address of a longword used by getrtn. If the standard read routine is to be
used, this value should be 0.

Description
The VIEWER FILE routine opens a file and begins to convert the contents of the
file to in-memory DDIF. If there is currently a file that is open, it is immediately
closed, the viewer window is cleared, and the new file is opened.

RETURN VALUES

Return Value

Description

DVR$_NORMAL

The file was opened and a window of content was converted to in-memory DDIF and displayed in the CDA
Viewer widget window.

DVR$_NOCONVERTER

There was no converter for the specified format.

DVR$_DDIFERROR

There was an error when converting the file to in-memory
DDIF.

DVR$_FILENOTOPEN

The file could not be opened.
Any CDA return status.

CDA$_xxxx

CDA Viewer Routines

13-35

Appendix A

DDIF Fill Patterns
This appendix describes the various fill patterns ·supported by the CDA Toolkit.
These fill patterns correspond to those used by the Graphics Kernel System
(GKS). They are valid for the following aggregate items:
•

The text mask pattern item (DDIF$_SGA_TXT_MASK_PATTERN) in the
DDIF$_SGA aggregate

•

The line mask pattern item (DDIF$_SGA_LIN_MASK_PATTERN) in the
DDIF$_SGA aggregate

•

The line interior pattern item (DDIF$_SGA_LIN_INTERIOR_PATTERN) in
the DDIF$_SGA aggregate

•

The marker mask pattern item (DDIF$_SGA_MKR_MASK_PATTERN) in the
DDIF$_SGA aggregate

•

The pattern number item (DDIF$_PTD_NUMBER) in the DDIF$_PTD
aggregate

•

The pattern colors item (DDIF$_PTD_PAT_NUMBER) in the DDIF$_PTD
aggregate

Table A-1 describes each predefined fill pattern and shows its symbolic name and
its corresponding DDIF pattern number. Figure A-1 illustrates each predefined
fill pattern.
Table A-1:

DDIF Fill Patterns

Pattern Name

Number Description

DDIF$K_PATT_BACKGROUND

The pattern is white.

DDIF$K_PATT_FOREGROUND

The pattern is black.

DDIF$K_PATT_VERTl_l

The thickness ratio of black to
white vertical lines in the pattern
is 1 : 1.

DDIF$K_PATT_VERT1_3

The thickness ratio of black to
white vertical lines in the pattern
is 1 : 3.

DDIF$K_PATT_VERT2_2

The thickness ratio of black to
white vertical lines in the pattern
is 2 : 2.

(continued on next page)

DDIF Fill Patterns

A-1

Table A-1 (Cont.):

DDIF Fill Patterns

Pattern Name

Number Description

DDIF$K_PATT_VERT3_1

The thickness ratio of black to
white vertical lines in the pattern
is 3 : 1.

DDIF$K_PATT_VERTl_7

The thickness ratio of black to
white vertical lines in the pattern
is 1 : 7.

DDIF$K_PATT_VERT2_6

The thickness ratio of black to
white vertical lines in the pattern
is 2 : 6.

DDIF$K_PATT_VERT4_4

The thickness ratio of black to
white vertical lines in the pattern
is 4 : 4.

DDIF$K_PATT_VERT6_2

The thickness ratio of black to
white vertical lines in the pattern
is 6 : 2.

DDIF$K_PATT_HORIZ1_1

The thickness ratio of black to
white horizontal lines in the
pattern is 1 : 1.

DDIF$K_PATT_HORIZ1_3

The thickness ratio of black to
white horizontal lines in the
pattern is 1 : 3.

DDIF$K_PATT_HORIZ2_2

The thickness ratio of black to
white horizontal lines in the
pattern is 2 : 2.

DDIF$K_PATT_HORIZ3_1

The thickness ratio of black to
white horizontal lines in the
pattern is 3 : 1.

DDIF$K_FATT_HORIZ1_7

The thickness ratio of black to
white horizontal lines in the
pattern is 1 : 7.

DDIF$K_PATT_HORIZ2_6

The thickness ratio of black to
white horizontal lines in the
pattern is 2 : 6.

DDIF$K_PATT_HORIZ4_4

The thickness ratio of black to
white horizontal lines in the
pattern is 4 : 4.

DDIF$K_PATT_HORIZ6_2

The thickness ratio of black to
white horizontal lines in the
pattern is 6 : 2.

DDIF$K_PATT_GRID4

Each grid box has 4 units to a
side.

DDIF$K_PATT_GRID8

Each grid box has 8 units to a
side.

DDIF$K_PATT_UPDIAG1_3

The thickness ratio of black to
white upward diagonal lines
(going up from left to right) in
the pattern is 1 : 3.

(continued on next page)

A-2 DDIF Fill Patterns

Table A-1 (Cont.):

DDIF Fill Patterns

Pattern Name

Number Description

DDIF$K_PATT_UPDIAG2_2

The thickness ratio of black to
white upward diagonal lines
(going up from left to right) in
the pattern is 2 : 2.

DDIF$K_PATT_UPDIAG3_1

The thickness ratio of black to
white upward diagonal lines
(going up from left to right) in
the pattern is 3 : 1.

DDIF$K_PATT_UPDIAG1_7

The thickness ratio of black to
white upward diagonal lin~s
(going up from left to right) in
the pattern is 1 : 7.

DDIF$K_PATT_UPDIAG2_6

The thickness ratio of black to
white upward diagonal lines
(going up from left to right) in
the pattern is 2 : 6.

DDIF$K_PATT_UPDIAG4_4

The thickness ratio of black to
white upward diagonal lines
(going up from left to right) in
the pattern is 4 : 4.

DDIF$K_PATT_UPDIAG6_2

The thickness ratio of black to
white upward diagonal lines
(going up from left to right) in
the pattern is 6 : 2.

DDIF$K_PATT_DOWNDIAG1_3

The thickness ratio of black to
white downward diagonal lines
(going down from left to right) in
the pattern is 1 : 3.

DDIF$K_PATT_DOWNDIAG2_2

The thickness ratio of black to
white downward diagonal lines
(going down from left to right) in
the pattern is 2 : 2.

DDIF$K_PATT_DOWNDIAG3_1

The thickness ratio of black to
white downward diagonal lines
(going down from left to right) in
the pattern is 3 : 1.

DDIF$K_PATT_DOWNDIAG1_7

The thickness ratio of black to
white downward diagonal lines
(going down from left to right) in
the pattern is 1 : 7.

DDIF$K_PATT_DOWNDIAG2_6

The thickness ratio of black to
white downward diagonal lines
(going down from left to right) in
the pattern is 2 : 6.

DDIF$K_PATT_DOWNDIAG4_4

The thickness ratio of black to
white downward diagonal lines
(going down from left to right) in
the pattern is 4 : 4.

(continued on next page)

DDIF Fill Patterns A-3

Table A-1 (Cont.):

DDIF Fill Patterns

Pattern Name

Number Description

DDIF$K_PATT_DOWNDIAG6_2

The thickness ratio of black to
white downward diagonal lines
(going down from left to right) in
the pattern is 6 : 2.

DDIF$K_PATT_BRICK_HORIZ

The pattern is composed of bricks
oriented in a horizontal direction.

DDIF$K_PATT_BRICK_VERT

The pattern is composed of bricks
oriented in a vertical direction.

DDIF$K_PATT_BRICK_DOWNDIAG

The pattern is composed of bricks
oriented in a downward diagonal
pattern (going down from left to
right).

DDIF$K_PATT_BRICK_UPDIAG

The pattern is composed of bricks
oriented in an upward diagonal
pattern (going up from left to
right).

DDIF$K_PATT_GREY4_16D

The ratio of black dots to the total
number of dots in the pattern is
4 : 16.

DDIF$K_PATT_GREY12_16D

The ratio of black dots to the total
number of dots in the pattern is
12 : 16.

DDIF$K_PATT_BASKET_WEAVE

The pattern is composed of a
basket-weave pattern.

DDIF$K_PATT_SCALE_DOWN

The pattern is composed of
downward-oriented scales.

DDIF$K_PATT_SCALE_UP

The pattern is composed of
upward-oriented scales.

DDIF$K_PATT_SCALE_RIGHT

The pattern is composed of
rightward-oriented scales.

DDIF$K_PATT_SCALE_LEFT

The pattern is composed of
leftward-oriented scales.

DDIF$K_PATT_FILLER6

The pattern is a filler pattern.

DDIF$K_PATT_FILLER7

The pattern is a filler pattern.

DDIF$K_PATT_GREY1_16

The ratio of black dots to the total
number of dots in the pattern is
1 : 16.

DDIF$K_PATT_GREY2_16

The ratio of black dots to the total
number of dots in the pattern is
2 : 16.

DDIF$K_PATT_GREY3_16

The ratio of black dots to the total
number of dots in the pattern is
3 : 16.

DDIF$K_PATT_GREY4_16

The ratio of black dots to the total
number of dots in the pattern is
4 : 16.

(continued on next page)

A-4

DDIF Fill Patterns

Table A-1 (Cont.):

DDIF Fill Patterns

Pattern Name

Number Description

DDIF$K_PATT_GREY5_16

The ratio of black dots to the total
number of dots in the pattern is
5 : 16.

DDIF$K_PATT_GREY6_16

The ratio of black dots to the total
number of dots in the pattern is
6 : 16.

DDIF$K_PATT_GREY7_16

DDIF$K_PATT_GREY8_16

The ratio of black dots to the total
number of dots in the pattern is
7 : 16.
The ratio of black dots to the total
number of dots in the pattern is
8 : 16.

DDIF$K_PATT_GREY9_16

The ratio of black dots to the total
number of dots in the pattern is
9 : 16.

DDIF$K_PATT_GREY10_16

The ratio of black dots to the total
number of dots in the pattern is
10 : 16.

DDIF$K_PATT_GREY11_16

DDIF$K_PATT_GREY12_16

The ratio of black dots to the total
number of dots in the pattern is
11 : 16.
The ratio of black dots to the total
number of dots in the pattern is
12 : 16.

DDIF$K_PATT_GREY13_16

The ratio of black dots to the total
number of dots in the pattern is
13 : 16.

DDIF$K_PATT_GREY14_16

The ratio of black dots to the total
number of dots in the pattern is
14 : 16.

DDIF$K_PATT_GREY15_16

The ratio of black dots to the total
number of dots in the pattern is
15 : 16.

DDIF Fill Patterns A-5

Figure A-1:

CDA Fill Patterns

11 • •
m mrm mIID 11••111
r:; :ITT1 o ·~ •

-~~~···

f81illflfl~ll

llllll--~II
$BR~m•

1%]38BRICK
UPDIAG

~~..~~,.~~~..j~~..

r..

...., ._.."'"-l'...,...,,.."..'":-t'!'l"...r.."-.

.40GREY12
160

nm
11
m
m
1111
. . ri i, rii¥ij

4
BASKET
. WEAVE
1

-~-~-~~~~-~-~~~~-~

iiii

,~,,.

ri:j'V>::'_.::J

11
111111 jlfilIIJl 11 "°'~"-" ~~"'-"
-..·••·.:.:.:.:.. : ...:.. : ...·••·••

..· : .....
...:....·.......
: .:_ ...
....·_.__.__
..:.:.
·........
_.__·.:
.__.__._
:.:..·.:......:..·.:.:.:.:.:.

·..·.·::.:.·.·:.·.·.·.·::::.-.:..·....:.:.:..

·._..·::.:.:.:.::.".::::
_._ _ _._._._._._ _._._._..·_..._·::.::::.:..
._._ _._._._._ _
._._._._._._._._._._._._._._._._._._._._._._._._

·:.:::::::::::::.:..·.:.:.::.::.:.

:x:xxx:cxxxxxx:x:

·.:.:.:.:.: .·.:.:.:.:.:....
:...:.:..:.. :...:.. :.:.:.:.:.:.

·:::::.:.::.:.:..·.:..·:.·:.:::::::..
·:::::.:.:..·:::..·..·::::::::::..

xxxxxxxxxxxx
xxxxxxxxxxx

·.·.:::..·:.:::.:..•..".·::::..·:..::::..

.54GREY7
16

.55GREY8
16

xxxxxxxxxxx
xxxxxxxxxxx
xxxxxxx:cxxx

·.:-·.:.:.:.:.:..: ....-. ..·.:...

: ..: .. .:.. : •.:.:...:....•....·...:.. : .. :..

.53GREY6
16

xx:x:::x:xxxxxxxx

xx:ie:x:ie::ie:xxxxx

ZK-1873A-GE

A-6 DDIF Fill Patterns

Appendix B

DDIF Syntax Diagrams
This appendix lists the syntax diagrams for each construct defined by DDIF
(DIGITAL Document Interchange Format). The diagram for each construct
is listed alphabetically under Syntax diagrams in the index. For example,
Figure B-6 shows the syntax used to create a DDIF document construct and is
listed as DDIFDocument under Syntax diagrams in the index.
The abstract syntax notation used to define these constructs at the lowest level is
DDIS (DIGITAL Data Interchange Syntax). The elements of the DDIS abstract
syntax notation that are used in this appendix are summarized in the following
sections.

B.1

ODIS Built-In Data Types
Table B-1 lists the built-in types that are primitive data types.
Table B-1:

ODIS Built-In Primitives

Type

Definition

NULL

A data element with no value.

INTEGER

A signed, two's complement binary number.

BOOLEAN

A Boolean value, constrained to be true or false.

BIT STRING

A string of bits.

OCTET STRING

A character string or other data type that logically
consists of a series of "octet" (8-bit quantity) values.

FLOATING-POINT

An element that consists of a sign magnitude, with bit
7 of the second octet representing the sign bit. Bits
6 through 0 of the second octet and bits 7 through 0
of the first octet collectively encode an excess-16384
binary exponent. The bits of the exponent decrease in
significance from bit 6 to bit 0 of the second octet, and
then from bit 7 to bit 0 of the first octet. The remaining
(zero or more) octets of the value encode a normalized
fraction with the redundant most significant bit not
represented. The fraction is encoded such that bits
increase in significance from bit 0 through bit 15 of each
octet pair, and successive pairs of octets become less
significant.

(continued on next page)

DDIF Syntax Diagrams

B-1

Table B-1 (Cont.):

ODIS Built-In Primitives

Type

Definition

OBJECT IDENTIFIER

A list of object identifier components, which are integer
values that identify branches in a tree of object identifiers. The value field of an element of type OBJECT
IDENTIFIER consists of an ordered list of subidentifiers, where each subidentifier is an unsigned integer
value. Each subidentifier is represented as one or more
octets. If bit 7 of a given octet is set, the subidentifier
is continued in the next octet. Bits 6 through 0 of the
octets in the subidentifier collectively encode an integer
that represents a branch in the registration tree. These
bits are concatenated to form an unsigned integer whose
most significant bit is bit 6 of the first octet and whose
least significant bit is bit 0 of the last octet.

EXTERNAL

A data value whose basic encoding may or may not
conform to DDIS. The direct-reference element in
the EXTERNAL data type indicates the data type
(syntax and semantics) of the external element. The
data-value descriptor element is a text string that
describes the data value in a human-readable form. The
encoding field contains the data value itself. Refer to the
description of the corresponding DDIF$_EXT aggregate
in Chapter 4.

The DDIF syntax diagrams also refer to a Generalized Time universal defined
type. This type represents a calendar date and time of day to various precisions.
The time of day can be specified as local time only, as Coordinated Universal
Time (UTC) only, or as both local and UTC.
The Generalized Time type represents time by a string of characters consisting of:
•

A calendar date

•

A time of day

•

The local time differential factor (TDF)

In addition to these primitive data types, DDIS also provides built-in constructors
(records and arrays). Table B-2 shows the DDIS constructors used in the DDIF
syntax diagrams.
Table B-2:

ODIS Built-In Constructors

Constructor

Definition

SEQUENCE

A list of elements that can be primitive or themselves constructed, which must occur in the order in which the elements
are specified. A SEQUENCE can be viewed as a record in which
each field has a type identifier .in the data stream. All elements
of a SEQUENCE are enclosed within braces.

SEQUENCE OF

A list of elements that can be primitive or themselves constructed, which are all of a specified type. For example, a
"SEQUENCE OF INTEGER" models a list of integers.

DDIS also provides tagged types. Elements in the syntax are often assigned
tags for the purpose of making them unique within their context. These tags,
shown in the syntax as a number between square brackets, serve to identify the
B-2

DDIF Syntax Diagrams

element. Note that they are not counters; while they are conventionally assigned
in ascending order to elements of a constructor type, they are not constrained to
do so. Elements of a SEQUENCE occur in the order in which they are listed.
Tagged types can use the IMPLICIT keyword to specify that the tagged type
assumes the encoding of the referenced type, rather than forming a constructor
containing a built-in element. Use of the IMPLICIT keyword reduces the number
of bytes required to represent the encoded data, but requires that decoding
software have knowledge of the type.

B.2 Built-In Operators
Table B-3 describes the DDIS built-in operators. They are best described as
operators because they affect the way the built-in types are encoded. The
keywords for built-in operators are expressed in uppercase letters.
Table B-3:

ODIS Built-In Operators

Operator

Effects

CHOICE

Only one of the list of alternative types can be chosen. Note
that CHOICE is not a type that has a tag. It therefore cannot
be preceded by the IMPLICIT operator. CHOICE can force
a tagged type to become a constructor that then contains the
chosen alternative.

OPTIONAL

The designated element can be omitted at the option of the
sending application.

DEFAULT

The designated element has a default value. Elements with
default values are also optional and can be omitted at the
option of the sending application. The receiving application
uses the specified default value when the element is missing
from the encoding.

ANY

Any tagged element can be inserted in the encoding, at the
option of the sending application.

Assignment

The assignment operator, represented by two colons and an
equal sign(::=), assigns a name to a syntax definition by which
it can be referenced in other definitions. Elements of a syntax
can therefore share a definition.

Named number

The assignment of an identifier to a specific value represented
by identifier (number). Named numbers are often used for
clarity in referring to values with specific meaning, and to
provide for automatic generation of symbolic values for use in
software development. (By convention, named integer values
in DDIF start from 1 and named bits start from bit 0.)

Comments

The comment delimiter, represented by two consecutive hyphen
characters (- -), causes the text following this delimiter to be
treated as a comment.

B.3 ODIS Defined Types
Table B-4 shows the types defined by DDIS.

DDIF Syntax Diagrams

8-3

Table B-4:

ODIS Defined Types

Defined Type

Encoding

Latin I-String

An element encoded as an OCTET STRING in which
all octet values represent characters from the Latinl
character set. Characters 32 through 126 of this
character set are the same as the 7-bit ASCII code.
Refer to the description of the DDIF$_TXT aggregate
in Chapter 4.

Character-String

An element in which the first octet or octets identify
the character set, and the remaining octets constitute
the codes of characters selected from that character
set. The characters in a Character-String type can
be chosen from 8-bit, 16-bit, and 32-bit character
sets.

Text-String

An element that consists of a sequence of CharacterString elements, and can thus represent a text string
in which characters are selected from more than one
character set.

ObjectDescriptor

A type that models human-readable text that describes a data value. This text need not be unique
within any context, as it is purely descriptive.

Figure B-1 illustrates the syntax used to create an object descriptor construct.
Figure B-1 : Object Descriptor Syntax Diagram
ObjectDescriptor ::= [UNIVERSAL 7] IMPLICIT OCTET STRING

Figure B-2 illustrates the syntax used to create a Latinl construct.
Figure B-2:

Latin1 String Syntax Diagram

Latinl-String : := [PRIVATE 20] IMPLICIT OCTET STRING

8-4 DDIF Syntax Diagrams

Figure B-3 illustrates the syntax used to create a text string construct.
Figure 8-3:

Text String Syntax Diagram

Text-String::=[ PRIVATE 10] IMPLICIT SEQUENCE OF Character-String

Figure B-4 illustrates the syntax used to create a character string construct.
Figure 8-4:

Character String Syntax Diagram

Character-String ::= [PRIVATE 9) IMPLICIT OCTET STRING

Figure B-5 illustrates the syntax used to create an application private data
construct.
Figure 8-5:

Application Private Data Syntax Diagram

ApplPrivate ··= NamedValueList

8.4 DDIF Syntax Diagrams
This section lists all the syntax diagrams that are used to describe DDIF
constructs. Figure B-6 illustrates the syntax used to create a DDIF document
construct.
Refer to the description of the corresponding DDIF$_DDF aggregate in
Chapter 4.
Figure 8-6:

DDIF Document Syntax Diagram

DDIFDocument
document-descriptor
document-header
document-content

··= [PRIVATE 16383) IMPLICIT SEQUENCE
[0] IMPLICIT DocumentDescriptor,
[1] IMPLICIT DocumentHeader,
[2J IMPLICIT Content
}

Figure B-7 illustrates the syntax used to create a document descriptor construct.
Refer to the description of the corresponding DDIF$_DSC aggregate in
Chapter 4.

DDIF Syntax Diagrams

8-5

Figure B-7:

Document Descriptor Syntax Diagram

DocumentDescriptor
major-version
minor-version
product-identifier
product-name

: : = SEQUENCE {
[0] IMPLICIT INTEGER,
[1] IMPLICIT INTEGER,
[2] IMPLICIT ASCIIString,
[3] IMPLICIT Text-String
}

Figure B-8 illustrates the syntax used to create a document header construct.
Refer to the description of the corresponding DDIF$_DHD aggregate in
Chapter 4.
Figure B-8:

Document Header Syntax Diagram

DocumentHeader
private-header-data
title
author
version
date
conformance-tags
external-references
languages
iso-639-language
other-language
style-guide

::=

SEQUENCE {
[0] IMPLICIT NamedValueList OPTIONAL,
[1] IMPLICIT Text-String
OPTIONAL,
[2] IMPLICIT Text-String
OPTIONAL,
[3] IMPLICIT Text-String
OPTIONAL,
[4] IMPLICIT GeneralizedTime OPTIONAL,
[5] IMPLICIT SEQUENCE OF ConformanceTag OPTIONAL,
[6] IMPLICIT SEQUENCE OF ExternalReference
OPTIONAL,
[7] IMPLICIT SEQUENCE OF CHOICE {
[0] IMPLICIT ASCIIString,
[1] IMPLICIT Character-String
}
OPTIONAL,
[8] IMPLICIT ExternalRefindex OPTIONAL
}

Figure B-9 illustrates the syntax used to create a document root segment
construct.
Figure B-9:

Document Root Segment

Content

::=SEQUENCE OF ContentPrimitive

ContentPrimitive
::= CHOICE {
segment-primitive
SegmentPrimitive,
text-primitive
TextPrimitive,
formatting-primitive
FormattingPrimitive,
graphics-primitive
GraphicsPrimitive,
image-primitive
ImagePrimitive,
content-ref-primitive
ContentReferencePrimitive,
restricted-content
RestrictedContent,
layout-primitive
LayoutPrimitive
}

B-6

DDIF Syntax Diagrams

Figure B-10 illustrates the syntax used to create a segment primitive construct.
Figure B-10:

Segment Primitive Syntax Diagram

SegmentPrimitive
end-segment
begin-segment

: := CHOICE {
[APPLICATION 1] IMPLICIT NULL,
[APPLICATION 2] IMPLICIT BeginSegment
}

Figure B-11 illustrates the syntax used to create a construct.
Refer to the description of the corresponding DDIF$_SEG aggregate in
Chapter 4.
Figure B-11:

Begin-Segment Syntax Diagram

BeginSegment
segment-id
user-label
segment-type
specific-attributes
generic-layout
specific-layout

SEQUENCE {
[0] IMPLICIT SegmentLabel
OPTIONAL,
[1] IMPLICIT Text-String
OPTIONAL,
[2] IMPLICIT TypeDefnLabel
OPTIONAL,
(3] IMPLICIT SegmentAttributes OPTIONAL,
[4] ANY
OPTIONAL,
[5] ANY
OPTIONAL
}

Figure B-12 illustrates the syntax used to create a text primitive construct.
Refer to the description of the corresponding DDIF$_GTX aggregate in
Chapter 4.
Figure B-12:

Text Primitive Syntax Diagram

TextPrimitive
::=CHOICE {
latinl-content
[APPLICATION 3] IMPLICIT Latinl-String,
general-text-content
[APPLICATION 4] IMPLICIT Character-String
}

Figure B-13 illustrates the syntax used to create a text attributes construct.
Refer to the description of the corresponding Text Attributes, Text Font Attribute,
Text Rendition Attribute, Text Size Attribute, the Text Direction Attribute, the
Text Character Decimal Alignment Attribute, the Text Leader Attributes, and to
the Text Kerning Attribute for the DDIF$_SGA aggregate in Chapter 4.

DDIF Syntax Diagrams

B-7

Figure B-13:

Text Attributes Syntax Diagram

TextAttributes
text-mask-pattern
text-font
text-rendition

.. - SEQUENCE {
[0] IMPLICIT PatternNumber
[1] IMPLICIT FontNumber
[2] IMPLICIT SEQUENCE OF
RenditionCode
text-height
[3] Size
text-set-size
[4] IMPLICIT Ratio
text-direction
[5] IMPLICIT INTEGER
text-dir-forward(l),
text-dir-backward(2)
decimal-align-chars
[6] IMPLICIT SEQUENCE OF
Character-String
leader-attributes
[7] IMPLICIT LeaderStyle
pair-kerning
[8] IMPLICIT BOOLEAN

OPTIONAL,
OPTIONAL,
OPTIONAL,
OPTIONAL,
OPTIONAL,

OPTIONAL,
OPTIONAL,
OPTIONAL,
OPTIONAL

}

Figure B-14 illustrates the syntax used to create a rendition code construct.
Refer to the description of the corresponding Text Rendition Attribute for the
DDIF$_SGA aggregate in Chapter 4.
Figure B-14:

Rendition Code Syntax Diagram

RenditionCode
::=INTEGER {
default(O),
highlighted ( 1) ,
faint(2),
italic (3),
underlined(4),
slow-blink(5),
rapid-blink ( 6) ,
negative-image(7),
concealed-chars(8),
crossed-out(9),
double-underlined(21),
normal-intensity(22),
not-underlined(24),
steady (25),
positive(27),
revealed-chars(28),
boxed(51),
encircled(52),
overlined(53),
ideogram-underlined(60),
ideogram-db-underlined(61),
ideogram-overlined(62),
ideogram-db-overlined(63),
ideogram-stress-mark(64)

Figure B-15 illustrates the syntax used to create a leader style construct.
Refer to the description of the corresponding Text Leader Attributes for the
DDIF$_SGA aggregate in Chapter 4.

B-8

DDIF Syntax Diagrams

Figure B-15:

Leader Style Syntax Diagram

LeaderStyle
: := SEQUENCE {
leader-space
[0] Size
OPTIONAL,
leader-bullet
[1] IMPLICIT Character-String OPTIONAL,
leader-align
[2] IMPLICIT INTEGER {
aligned-leader(l),
staggered-leader(2),
non-aligned-leader(3) }
OPTIONAL,
leader-style
[3] IMPLICIT INTEGER
ls-x-rule(l),
ls-bullet (2)
OPTIONAL

Figure B-16 illustrates the syntax used to create a text layout construct.
Refer to the description of the corresponding Layout Attribute, to the GalleyBased Layout Attribute, to the Path-Based Layout Attribute, to the PositionRelative Layout Attribute, and to the Text Position Attribute for the DDIF$_SGA
aggregate in Chapter 4
Figure B-16: Text Layout Syntax Diagram
TextLayout
::= CHOICE {
galley-based-layout
[0] IMPLICIT SEQUENCE {
wrap-attributes
[0] ANY OPTIONAL,
galley-layout
[1] ANY OPTIONAL
}

path-based-layout
position-relative
vertical-offset
horizontal-offset

[1] IMPLICIT StringLayout,
[2] IMPLICIT SEQUENCE {
[0] IMPLICIT Escapement OPTIONAL,
[1] IMPLICIT Escapement OPTIONAL
}

text-position
[3] IMPLICIT INTEGER {
tp-base(l),
tp-left-subscript(2),
tp-left-superscript(3),
tp-right-subscript(4),
tp-right-superscript(5),
tp-top-center(6),
tp-bottom-center(7),
tp-rubi(B)
}'

Figure B-17 illustrates the syntax used to create a text string layout construct.
Refer to the description of the corresponding Path-Based Layout Attribute for the
DDIF$_SGA aggregate in Chapter 4.

DDIF Syntax Diagrams

8-9

Figure B-17:

Text String Layout Syntax Diagram

StringLayout
: := SEQUENCE {
string-layout-path
{0] IMPLICIT CompositePath,
string-layout-format
[1] IMPLICIT Format DEFAULT flush-path-begin,
character-orientation
CHOICE {
(2] IMPLICIT Angle,
char-angle-fixed
char-angle-path
[3] IMPLICIT RightAngle
}
DEFAULT { char-angle-path up },
char-horizontal-align
[4] IMPLICIT INTEGER {
normal-horizontal(l),
leftline (2),
centerline(3),
rightline (4)
DEFAULT normal-horizontal,
char-vertical-align
[5] IMPLICIT INTEGER {
normal-vertical(l),
baseline(2),
capline(3),
bottomline(4),
halfline ( 5),
top line ( 6)
}
DEFAULT normal-vertical

Figure B-18 illustrates the syntax used to create a formatting primitive construct.
Refer to the description of the corresponding DDIF$_HRD aggregate, DDIF$_HRV
aggregate, DDIF$_SFT aggregate, and DDIF$_SFV aggregate in Chapter 4.
Figure B-18:

Formatting Primitive Syntax Diagram

FormattingPrimitive
· ·= CHOICE {
soft-value-directive
[APPLICATION 7]
hard-value-directive
[APPLICATION 8]
hard-directive
[APPLICATION 9]
soft-directive
[APPLICATION 10]

ValueDirective,
ValueDirective,
IMPLICIT Directive,
IMPLICIT Directive

}

Figure B-19 illustrates the syntax used to create a value directive construct.
Refer to the description of the corresponding DDIF$_HRV aggregate in
Chapter 4.
Figure B-19:

Value Directive Syntax Diagram

ValueDirective
: := CHOICE {
escapement-directive
[0] IMPLICIT EscapementDirective,
variable-reset
[1] IMPLICIT VariableReset
}

Figure B-20 illustrates the syntax used to create a directive construct.

B-10

DDIF Syntax Diagrams

Refer to the description of the corresponding DDIF$_HRD aggregate, the
DDIF$_LL1 aggregate, and the DDIF$_SFT aggregate in Chapter 4.
Figure B-20:

Directive Syntax Diagram

Directive
new-page(l),
new-line(2),
new-galley(3),
tab(4),
space(5),
hyphen-new-line(6),
word-break-point(7),
leaders(8),
backspace(9),
null-directive(lO),
no-hyphen-word(ll)

· ·= INTEGER

Figure B-21 illustrates the syntax used to create an escapement directive
construct.
Refer to the description of the corresponding DDIF$_HRV aggregate in
Chapter 4.
Figure B-21 : Escapement Directive Syntax Diagram
EscapementDirective

· · = Escapement

Figure B-22 illustrates the syntax used to create a variable reset construct.
Refer to the description of the corresponding DDIF$_HRV aggregate in
Chapter 4.
Figure B-22:

Variable Reset Syntax Diagram

VariableReset ::=SEQUENCE {
reset-variable
[0] IMPLICIT VariableLabel,
reset-value
[1] Expression
}

Figure B-23 illustrates the syntax used to create a graphics primitive construct.
Figure B-23:

Graphics Primitive Syntax Diagram

GraphicsPrimitive
cubic-curve-object
polyline-object
arc-object
fill-area-set

· ·= CHOICE {
[APPLICATION 11]
[APPLICATION 12]
[APPLICATION 13]
[APPLICATION 14]

IMPLICIT CubicBezier,
IMPLICIT Polyline,
IMPLICIT Arc,
IMPLICIT FillAreaSet

}

Figure B-24 illustrates the syntax used to create a polyline construct.

DDIF Syntax Diagrams

B-11

Refer to the description of the corresponding DDIF$_LIN aggregate in Chapter 4.
Figure B-24:

Polyline Syntax Diagram

Polyline
SEQUENCE {
polyline-flags
[0] IMPLICIT BIT STRING {
draw-polyline(O),
fill-polyline(l),
draw-markers(2),
regular-polygon(3),
close-polyline(4),
rounded-polyline(5),
rectangular-polygon(6) } DEFAULT { draw-polyline },
polyline-draw-pattern
[1] IMPLICIT BIT STRING DEFAULT 'l'B,
polyline-path
[2] IMPLICIT PolyLinePath
}

Figure B-25 illustrates the syntax used to create a cubic Bezier construct.
Refer to the description of the corresponding DDIF$_BEZ aggregate in
Chapter 4.
Figure B-25:

Cubic Bezier Syntax Diagram

CubicBezier
cubic-Bezier-f lags
draw-cb(O),
fill-cb (1),
close-cb(2)
cubic-Bezier-path

: :=

SEQUENCE {
[0] IMPLICIT BIT STRING {

DEFAULT { draw-cb },
[1] IMPLICIT CubicBezierPath
}

Figure B-26 illustrates the syntax used to create an arc construct.
Refer to the description of the corresponding DDIF$_ARC aggregate in
Chapter 4.
Figure B-26:

Arc Syntax Diagram

Arc

: :=

arc-flags
draw-arc(O),
fill-arc(l),
pie-arc(2),
close-arc(3)
arc-path

SEQUENCE {
[0] IMPLICIT BIT STRING {

DEFAULT { draw-arc },
[1] IMPLICIT ArcPath
}

Figure B-27 illustrates the syntax used to create a fill area set construct.
Refer to the description of the corresponding DDIF$_FAS aggregate in
Chapter 4.
Figure B-28 illustrates the syntax used to create a line attributes construct.

B-12 DDIF Syntax Diagrams

Figure B-27:

Fill Area Set Syntax Diagram

FillAreaSet
··= SEQUENCE {
fas-flags
[0] IMPLICIT BIT STRING {
co-draw-border(O),
DEFAULT { co-draw-border },
co-fill-area(l) }
[1] IMPLICIT CompositePath
fas-path
}

Refer to the description of the corresponding Line Attributes for the DDIF$_SGA
aggregate in Chapter 4.

DDIF Syntax Diagrams

8-13

Figure B-28:

Line Attributes Syntax Diagram

LineAttributes
: := SEQUENCE {
line-width
[0] Size
line-style
[1] IMPLICIT LineStyleNumber
line-pattern-size
[2] Size
line-mask-pattern
[3] IMPLICIT PatternNumber
line-end-start
[4] IMPLICIT LineEndNumber
line-end-finish
[5] IMPLICIT LineEndNumber
[6] Size
line-end-size
line-join
[7] IMPLICIT LineJoin
line-miter-limit
[8] IMPLICIT Ratio
[9] IMPLICIT PatternNumber
line-interior-pattern

OPTIONAL,
OPTIONAL,
OPTIONAL,
OPTIONAL,
OPTIONAL,
OPTIONAL,
OPTIONAL,
OPTIONAL,
OPTIONAL,
OPTIONAL

}

Figure B-29 illustrates the syntax used to create a line style number construct.
Refer to the description of the Line Attributes for the DDIF$_SGA aggregate in
Chapter 4.
Figure B-29:

Line Style Number Syntax Diagram

LineStyleNumber
solid(l),
dash(2),
dot(3),
dash-dot(4)

· ·= INTEGER {

Figure B-30 illustrates the syntax used to create a line end number construct.
Refer to the description of the corresponding Line Attributes for the DDIF$_SGA
aggregate in Chapter 4.
Figure B-30:

Line End Number Syntax Diagram

LineEndNumber
butt-line-end(l),
round-line-end(2),
square-line-end(3),
arrow(4)

::=INTEGER {

Figure B-31 illustrates the syntax used to create a line join construct.
Refer to the description of the corresponding Line Attributes for the DDIF$_SGA
aggregate in Chapter 4.
Figure B-31:

Line Join Syntax Diagram

LineJoin
··=INTEGER
mitered-line-join(l),
rounded-line-join(2),
beveled-line-join(3)

B-14

DDIF Syntax Diagrams

Figure B-32 illustrates the syntax used to create a marker attributes construct.
Refer to the description of the corresponding Marker Attributes for the
DDIF$_SGA aggregate in Chapter 4.
Figure B-32:

Marker Attributes Syntax Diagram

MarkerAttributes
marker-style
marker-mask-pattern
marker-size

: : = SEQUENCE
(0) IMPLICIT MarkerNumber OPTIONAL,
(1) IMPLICIT PatternNumber OPTIONAL,
(2) Size
OPTIONAL
}

Figure B-33 illustrates the syntax used to create a marker number construct.
Refer to the description of the corresponding Marker Attributes for the
DDIF$_SGA aggregate in Chapter 4.
·
Figure B-33:

Marker Number Syntax Diagram

MarkerNumber
::=INTEGER {
marker-dot(l),
marker-plus-sign(2),
marker-asterisk(3),
marker-circle(4),
marker-diagonal-cross(5)
}

Figure B-34 illustrates the syntax used to create an image primitive construct.
Refer to the description of the corresponding DDIF$_IMG aggregate and to the
DDIF$_IDU aggregate in Chapter 4.
Figure B-34:

Image Primitive Syntax Diagram

ImagePrimitive
image-content

: := CHOICE {
[APPLICATION 17) IMPLICIT ImageDataDescriptor
}

ImageDataDescriptor
··= SEQUENCE OF ImageDataUnit
ImageDataUnit
··= SEQUENCE {
image-coding-attrs
(0) IMPLICIT ImageCodingAttrs,
image-comp-plane-data
(1) IMPLICIT OCTET STRING
}

Figure B-35 illustrates the syntax used to create an image coding attributes
construct.
Refer to the description of the corresponding DDIF$_IDU aggregate and to the
DDIF$_IMG aggregate in Chapter 4.

DDIF Syntax Diagrams

8-15

Figure B-35:

Image Coding Attributes Syntax Diagram

ImageCodingAttrs
• • = SEQUENCE {
pvt-img-coding-attrs
(0) IMPLICIT NamedValueList OPTIONAL,
pixels-per-line
[1] IMPLICIT INTEGER,
number-of-lines
(2) IMPLICIT INTEGER,
compression-type
(3) IMPLICIT INTEGER {
private-compression
( 1) '
pcm-compression
(2),
(raw bitmap)
g31d-compression
(3),
CCITT Group 3 1 dimensional
g32d-compression
(4),
CCITT Group 3 2 dimensional
g42d-compression
(5)
CCITT Group 4 2 dimensional
} DEFAULT pcm-compression,
compression-parameters
[4] IMPLICIT NamedValueList OPTIONAL,
data-offset
(5) IMPLICIT INTEGER
DEFAULT 0,
pixel-stride
[6] IMPLICIT INTEGER
OPTIONAL,
scanline-stride
[7] IMPLICIT INTEGER
OPTIONAL,
pixel-order
(8) IMPLICIT INTEGER
standard-pixel-order (1),
reverse-pixel-order (2) } DEFAULT standard-pixel-order,
planebits-per-pixel
[9] IMPLICIT INTEGER OPTIONAL
}

Figure B-36 illustrates the syntax used to create an image attributes construct.
Refer to the description of the corresponding Image Attributes for the
DDIF$_SGA aggregate in Chapter 4.
Figure B-36:

Image Attributes Syntax Diagram

ImageAttributes
img-present-attrs
img-comp-space-attrs

: :=

SEQUENCE {
[0] IMPLICIT ImgPresentAttrs OPTIONAL,
[1] IMPLICIT ImgCmptSpcAttrs OPTIONAL
}

ImgPresentAttrs
::= SEQUENCE {
prvt-img-present-attrs
(0) IMPLICIT NamedValueList OPTIONAL,
pixel-path
[1] IMPLICIT INTEGER
OPTIONAL,
line-progression
[2] IMPLICIT INTEGER
OPTIONAL,
pixel-aspect-ratio
(3) IMPLICIT SEQUENCE
pxl-path-pxl-distance
[0] IMPLICIT INTEGER
DEFAULT 1,
line-prog-pxl-distance
(1) IMPLICIT INTEGER
DEFAULT 1
}
OPTIONAL,
brightness-polarity
[4] IMPLICIT INTEGER {
zero-maximum-intensity(l),
zero-minimum-intensity(2)
}
OPTIONAL,
grid-type
[5] IMPLICIT INTEGER {
rectangular~grid(l),

hex-even-indent(2),
hex-odd-indent(3)
}
OPTIONAL,
timing-descriptor
[6] IMPLICIT Binary-Relative-Time OPTIONAL,
spectral-comp-mapping
[7] IMPLICIT INTEGER {
privately-mapped (1),
monochrome-mapped (2),
general-multispectral (3),
lut-mapped (4),
lookup table map
rgb-mapped (5),
red-green-blue
cmy-mapped (6),
cyan-magenta-yellow
yuv-mapped (7),
hsv-mapped (8),
hue saturation value
hls-mapped (9),
hue lightness value
yiq-mapped (10)
OPTIONAL,

(continued on next page)
8-16

DDIF Syntax Diagrams

Figure B-36 (Cont.):

Image Attributes Syntax Diagram

lookup-tables
[8] ImgLutData OPTIONAL,
component-wlength-info
[9] CHOICE {
application-wlen-info
[OJ IMPLICIT SEQUENCE OF OCTET STRING,
wavelength-measure
[lJ IMPLICIT SEQUENCE OF INTEGER,
wavelength-band-id
[2J IMPLICIT SEQUENCE OF Latinl-String
}
OPTIONAL

Figure B-37 illustrates the syntax used to create an image lookup table data
construct.
Refer to the description of the corresponding Image Attributes for the
DDIF$_SGA aggregate in Chapter 4.
Figure B-37:

Image Lookup Table Data Syntax Diagram

ImgLutData
application-pvt-luts
rgb-lut-entries

• •=

CHOICE {
[OJ IMPLICIT NamedValueList,
[lJ IMPLICIT SEQUENCE OF RgbLutEntry

RgbLutEntry
lut-index
red-value
green-value
blue-value

• •=

SEQUENCE {
[0] IMPLICIT
[lJ IMPLICIT
[2J IMPLICIT
[3J IMPLICIT

}

INTEGER,
Colorintensity,
Colorintensity,
Colorintensity

}

Figure B-38 illustrates the syntax used to create an image component space
attributes construct.
Refer to the description of the corresponding Image Component Space Attributes
for the DDIF$_SGA aggregate in Chapter 4.
Figure B-38:

Image Component Space Attributes Syntax Diagram

ImgCmptSpcAttrs
SEQUENCE {
comp-space-org
[0] IMPLICIT
full-compaction(l),
partial-expansion(2),
full-expansion(3) }
data-planes-per-pixel
[lJ IMPLICIT
data-plane-signif
[2J IMPLICIT
lsb-msb (1),
msb-lsb (2)
number-of-components
[3] IMPLICIT
bits-per-component-1st
[4J IMPLICIT

INTEGER {

OPTIONAL,
OPTIONAL,

INTEGER
INTEGER

OPTIONAL,
INTEGER,
SEQUENCE OF INTEGER

}

DDIF Syntax Diagrams

B-17

Figure B-39 illustrates the syntax used to create a restricted content construct.
Figure B-39:

Restricted Content Syntax Diagram

RestrictedContent ::=CHOICE {
pdl-content
[APPLICATION 18] IMPLICIT EXTERNAL,
private-content [APPLICATION 30] IMPLICIT NamedValue
}

Figure B-40 illustrates the syntax used to create a content reference primitive
construct.
Figure B-40:

Content Reference Primitive Syntax Diagram

ContentReferencePrimitive
content-ref

CHOICE {
[APPLICATION 15] IMPLICIT ContentReference
}

Figure B-41 illustrates the syntax used to create a content reference construct.
Refer to the description of the corresponding DDIF$_CRF aggregate in
Chapter 4.
Figure B-41 : Content Reference Syntax Diagram
ContentRef erence
content-transform
content-reference

· · = SEQUENCE {
[0] IMPLICIT Transformation OPTIONAL,
[1] IMPLICIT ContentDefnLabel
}

Figure B-42 illustrates the syntax used to create a bounding box construct.
Refer to the description of the corresponding DDIF$_GLY aggregate and to the
Frame Bounding Box Attributes for the DDIF$_SGA aggregate in Chapter 4.

B-18

DDIF Syntax Diagrams

Figure B-42:

Bounding Box Syntax Diagram

BoundihgBox
lower-left
upper-right

SEQUENCE {
[0] IMPLICIT Position,
[1] IMPLICIT Position

: :=

}

Figure B-43 illustrates the syntax used to create a color construct.
Refer to the description of the corresponding DDIF$_PTD aggregate in
Chapter 4.
Figure B-43:

Color Syntax Diagram

Color
rgb-color
transparency

· ·= CHOICE
[0] IMPLICIT RGB,
[1] IMPLICIT NULL
}

Figure B-44 illustrates the syntax used to create a red/green/blue construct.
Refer to the description of the corresponding DDIF$_PTD aggregate and to the
DDIF$_RGB aggregate in Chapter 4.
Figure B-44:

Red/Green/Blue Syntax Diagram

RGB
red-intensity
green-intensity
blue-intensity

.. - SEQUENCE {
[0] IMPLICIT Colorintensity DEFAULT 0.0,
[1] IMPLICIT Colorintensity DEFAULT 0.0,
[2] IMPLICIT Colorintensity DEFAULT 0.0
}

Colorintensity

::=FLOATING-POINT

Figure B-45 illustrates the syntax used to create a compute definition construct.
Refer to the description of the Computed Content Attributes for the DDIF$_SGA
aggregate in Chapter 4.

DDIF Syntax Diagrams

B-19

Figure B-45:

Compute Definition Syntax Diagram

ComputeDefn
copy-content
remote-content
variable-reference
cross-reference
function-link

. ·= CHOICE

{

IMPLICIT Reference,
IMPLICIT Reference,
[2] IMPLICIT VariableLabel,
[3] IMPLICIT CrossReference,
[4] IMPLICIT FunctionLink
[0]
[1]

}

Figure B-46 illustrates the syntax used to create a cross-reference construct.
Refer to the description of the corresponding Cross-Reference Computed Content
Attribute for the DDIF$_SGA aggregate in Chapter 4.
Figure B-46:

Cross-Reference Syntax Diagram

CrossReference
xref-seg-label
xref-var-label

: :=

SEQUENCE {
[0] IMPLICIT Reference,
[1] IMPLICIT VariableLabel
}

Figure B-47 illustrates the syntax used to create an escapement construct.
Refer to the description of the DDIF$_HRV aggregate, the DDIF$_LL1 aggregate,
and to the Position-Relative Layout Attribute for the DDIF$_SGA aggregate in
Chapter 4.
Figure B-47:

Escapement Syntax Diagram

Escapement
escapement-ratio
escapement-constant

• •=

SEQUENCE {
[0] IMPLICIT Ratio OPTIONAL,
[1] Measurement
OPTIONAL
}

Figure B-48 illustrates the syntax used to create an external reference construct.
Refer to the description of the corresponding DDIF$_ERF aggregate and the
DDIF$_DHD aggregate in Chapter 4.
Figure B-48:

External Reference Syntax Diagram

ExternalReference
··= SEQUENCE {
[0] IMPLICIT OBJECT IDENTIFIER,
reference-data-type
reference-descriptor
[1] IMPLICIT Text-String,
reference-label
[2] IMPLICIT Character-String,
reference-label-type
[3] IMPLICIT StorageSystemTag,
reference-control
[4] IMPLICIT INTEGER {
copy-reference(l),
no-copy-reference(2)
}
DEFAULT copy-reference

B-20 DDIF Syntax Diagrams

Figure B-49 illustrates the syntax used to create a font definition construct.
Refer to the description of the corresponding DDIF$_FTD aggregate and to the
Font Definitions Attribute for the DDIF$_SGA aggregate in Chapter 4.
Figure B-49:

Font Definition Syntax Diagram

FontDef n
f ont-nurnber
font-identifier
font-private

• ·=

SEQUENCE {
[0] IMPLICIT FontNurnber,
(1] IMPLICIT Latinl-String,
[2] IMPLICIT NamedValueList OPTIONAL
}

Figure B-50 illustrates the syntax used to create a format construct.
Refer to the description of the corresponding DDIF$_LW1 aggregate, the PathBased Layout Attribute, the Frame Position Attribute, and to the Galley Frame
Parameters for the DDIF$_SGA aggregate in Chapter 4.
Figure B-50:

Format Syntax Diagram

Format

.. - INTEGER { flush-path-begin(l), center-of-path(2),
flush-path-end(3), flush-path-both(4)
}

Figure B-51 illustrates the syntax used to create a frame parameters construct.
Refer to the description of the corresponding Frame Parameters Attributes, the
Frame Flags Attribute, the Frame Bounding Box Attribute, the Frame Outline
Attribute, the Frame Clipping Attribute, the Frame Position Attribute, the Fixed
Frame Parameters, the Inline Frame Parameters, the Galley Frame Parameters,
the Margin Frame Parameters, and to the Frame Content Transformation
Attribute for the DDIF$_SGA aggregate in Chapter 4.
Figure B-51 : Frame Parameters Syntax Diagram
FrameParameters
· ·= SEQUENCE {
frame-flags
[0] IMPLICIT BIT STRING {
flow-around (0),
frame-border(l),
frame-background-fill(2)
OPTIONAL,
frame-bounding-box
[1] IMPLICIT BoundingBox,
frame-outline
[2] IMPLICIT CompositePath OPTIONAL,
frame-clipping
[3] IMPLICIT CompositePath OPTIONAL,
frame-position
CHOICE {
fp-fixed
[4] IMPLICIT Position,
fp-inline
[5] IMPLICIT InlineFrameParams,
fp-galley
[6] IMPLICIT GalleyFrameParams,
fp-margin
[7] IMPLICIT MarginFrameParams
}

frame-content-trans

[8] IMPLICIT Transformation OPTIONAL
}

Figure B-52 illustrates the syntax used to create an inline frame parameters
construct.

DDIF Syntax Diagrams

B-21

Figure B-52:

lnline Frame Parameters Syntax Diagram

InlineFrameParams ·
ifp-base-off set

• •=

SEQUENCE {
[0] Size DEFAULT { integer-constant 0 }
}

Refer to the description of the corresponding Frame Position Attribute and to the
Inline Frame Parameters for the DDIF$_SGA aggregate in Chapter 4.
Figure B-53 illustrates the syntax used to create a galley frame parameters
construct.
Refer to the description of the corresponding Frame Position Attribute and to the
Galley Frame Parameters for the DDIF$_SGA aggregate in Chapter 4.
Figure B-53:

Galley Frame Parameters Syntax Diagram

GalleyFrameParams
gfp-vertical
gfp-horizontal

: : = SEQUENCE {
[0] IMPLICIT GalleyVerticalPosition
DEFAULT below-current-line,
[1] IMPLICIT Format DEFAULT center-of-path
}

Figure B-54 illustrates the syntax used to create a galley vertical position
construct.
Refer to the description of the corresponding Frame Position Attribute and to the
Galley Frame Parameters for the DDIF$_SGA aggregate in Chapter 4.
Figure B-54:

Galley Vertical Position Syntax Diagram

GalleyVerticalPosition ::=INTEGER
below-current-line(l),
bottom-of-galley(2),
top-of-galley(3)
}

Figure B-55 illustrates the syntax used to create a margin frame parameters
construct.
Refer to the description of the corresponding Frame Position Attribute and to the
Margin Frame Parameters for the DDIF$_SGA aggregate in Chapter 4.

8-22 DDIF Syntax Diagrams

Figure B-55:

Margin Frame Parameters Syntax Diagram

MarginFrameParams
mfp-base-of f set
mfp-near-off set
mfp-horizontal

: : = SEQUENCE {
[0] Size DEFAULT { integer-constant 0 },
[1] Size DEFAULT { integer-constant 0 },
[2] IMPLICIT MarginHorizontalPosition
DEFAULT side-closest-edge

Figure B-56 illustrates the syntax used to create a margin horizontal position
construct.
Refer to the description of the corresponding Frame Position Attribute and to the
Margin Frame Parameters for the DDIF$_SGA aggregate in Chapter 4.
Figure B-56:

Margin Horizontal Position Syntax Diagram

MarginHorizontalPosition ::=INTEGER {
side-closest-edge(l),
side-furthest-edge(2),
left-of-galleys(3),
right-of-galleys(4)
}

Figure B-57 illustrates the syntax used to create a function link construct.
Refer to the description of the corresponding Function Computed Content
Attribute for the DDIF$_SGA aggregate in Chapter 4.
Figure B-57:

Function Link Syntax Diagram

FunctionLink
function-name
function-parameters

: :=

SEQUENCE
[0] IMPLICIT ASCIIString,
[1] IMPLICIT NamedValueList
}

Figure B-58 illustrates the syntax used to create an external reference index
construct.
Refer to the description of the corresponding Copied and Remote Computed
Content Attributes for the DDIF$_SGA aggregate in Chapter 4.

DDIF Syntax Diagrams

B-23

Figure B-58:

External Reference Index Syntax Diagram

ExternalRefindex ::=INTEGER

Figure B-59 illustrates the syntax used to create a language index construct.
Refer to the description of the corresponding Language Attribute for the
DDIF$_SGA aggregate in Chapter 4.
Figure 8-59:

Language Index Syntax Diagram

Languageindex ::=INTEGER

Figure B-60 illustrates the syntax used to create a content definition construct.
Refer to the description of the corresponding DDIF$_CTD aggregate and to the
Content Definitions Attribute for the DDIF$_SGA aggregate in Chapter 4.
Figure 8-60:

Content Definition Syntax Diagram

ContentDefn
content-label
content-external
content-value
content-private

: : = SEQUENCE {
[0] IMPLICIT ContentDefnLabel,
[l] IMPLICIT Reference
OPTIONAL,
[2] IMPLICIT Content
OPTIONAL,
[3] IMPLICIT NamedValueList OPTIONAL
}

Figure B-61 illustrates the syntax used to create a label types construct.
Refer to the description of the corresponding DDIF$_CRF aggregate, the Variable
Computed Content Attribute for the DDIF$_SGA aggregate, and to the
DDIF$_TYD aggregate in Chapter 4.
Figure 8-61 : Label Types Syntax Diagram
VariableLabel

: := Label

Segment Label

. ·= Label

TypeDefnLabel

ContentDefnLabel

. ·= Label

GalleyLabel

: := Label

PageDescLabel

: := Label

PageLayoutLabel

: := Label

8-24 DDIF Syntax Diagrams

Label

Figure B-62 illustrates the syntax used to create a label construct.
Figure 8-62:

Label Syntax Diagram

Label

: := ASCIIString

Figure B-63 illustrates the syntax used to create an ASCII string construct.
Figure 8-63:

ASCII String Syntax Diagram

ASCIIString ··= Latinl-String

Figure B-64 illustrates the syntax used to create a variable label construct.
Figure B-64: Variable Label Syntax Diagram
VariableLabel

· ·= Label

used to ref er to variable by name

Figure B-65 illustrates the syntax used to create a legend units construct.
Refer to the description of the corresponding Legend Attribute for the
DDIF$_SGA aggregate in Chapter 4.
Figure 8-65:

Legend Units Syntax Diagram

Le.gendUnits
legend-unit
legend-unit-name

: :=

SEQUENCE {
[0] IMPLICIT Ratio,
[l] IMPLICIT Text-String
}

Figure B-66 illustrates the syntax used to create an angle construct.
Refer to the description of the corresponding DDIF$_TRN aggregate, the PathBased Layout Attribute, and to the Frame Content Transformation Attribute for
the DDIF$_SGA aggregate in Chapter 4.
Figure 8-66:
Angle

Angle Syntax Diagram
::=FLOATING-POINT

Figure B-67 illustrates the syntax used to create an AngleRef construct.
Refer to the description of the corresponding DDIF$_ARC aggregate and to the
DDIF$_PTH aggregate in Chapter 4.

DDIF Syntax Diagrams

B-25

Figure B-67:

AngleRef Syntax Diagram

AngleRef
angle-constant
angle-variable

: := CHOICE {

[0] IMPLICIT Angle,
[l] IMPLICIT VariableLabel
}

Figure B-68 illustrates the syntax used to create a measurement construct.
Refer to the description of the corresponding DDIF$_PTH aggregate and to the
Frame Position Attribute for the DDIF$_SGA aggregate in Chapter 4.
Figure B-68:

Measurement Syntax Diagram

Measurement
integer-constant
variable-measure

: := CHOICE {
[0] IMPLICIT INTEGER,
[l] IMPLICIT VariableLabel
}

Figure B-69 illustrates the syntax used to create a position construct.
Refer to the description of the corresponding Frame Bounding Box Attributes, the
Frame Position Attribute, and to the Fixed Frame parameters for the
DDIF$_SGA aggregate in Chapter 4.
Figure B-69:

Position Syntax Diagram

Position
x-coordinate
y-coordinate

· ·= SEQUENCE
[0] XCoordinate,
[l] YCoordinate
}

Figure B-70 illustrates the syntax used to create a ratio construct.
Refer to the description of the corresponding DDIF$_HRV aggregate and to the
Line Attributes for the DDIF$_SGA aggregate in Chapter 4.
Figure B-70:

Ratio Syntax Diagram

Ratio
numerator
denominator

: :=

SEQUENCE
[0] IMPLICIT INTEGER DEFAULT 1,
[1] IMPLICIT INTEGER DEFAULT 100
}

Figure B-71 illustrates the syntax used to create a right angle construct.
Refer to the description of the corresponding Path-Based Layout Attribute for the
DDIF$_SGA aggregate in Chapter 4.
Figure B-72 illustrates the syntax used to create a size construct.
Refer to the description of the corresponding DDIF$_ARC aggregate and to
the Text Size Attribute, the Frame Position Attribute, and the Inline Frame
Parameters for the DDIF$_SGA aggregate· in Chapter 4.

B-26 DDIF Syntax Diagrams

Figure B-71:

Right Angle Syntax Diagram

RightAngle

··=INTEGER { right(l),
left (2),
up (3),
down(4)

Figure B-72: Size Syntax Diagram
Size

: : = Measurement

Figure B-73 illustrates the syntax used to create an x-coordinate construct.
Refer to the description of the corresponding DDIF$_ARC aggregate, the
DDIF$_PTH aggregate, and to the Frame Position Attribute and the Fixed Frame
Parameters for the DDIF$_SGA aggregate in Chapter 4.

DDIF Syntax Diagrams

B-27

Figure 8-73:

X-Coordinate Syntax Diagram

XCoordinate

: :=

Measurement

Figure B-74 illustrates the syntax used to create a y-coordinate construct.
Refer to the description of the corresponding DDIF$_ARC aggregate, the
DDIF$_PTH aggregate, and to the Frame Position Attribute and the Fixed Frame
Parameters for the DDIF$_SGA aggregate in Chapter 4.
Figure 8-74:

Y-Coordinate Syntax Diagram

YCoordinate

: :=

Measurement

Figure B-75 illustrates the syntax used to create a measurement units construct.
Refer to the description of the corresponding Measurement Attribute for the
DDIF$_SGA aggregate in Chapter 4.
Figure 8-75:

Measurement Units Syntax Diagram

MeasurementUnits
: := SEQUENCE {
units-per-measurement
[0] IMPLICIT INTEGER,
unit-name
[1] IMPLICIT Text-String
}

Figure B-76 illustrates the syntax used to create a named value construct.
Figure 8-76: Named Value Syntax Diagram
NamedValue
value-name
value-data

: : =

SEQUENCE {
NamedValueTag,
ValueData
}

Figure B-77 illustrates the syntax used to create a value data construct.
Refer to the description of the DDIF$_PVT aggregate in Chapter 4.

8-28

DDIF Syntax Diagrams

Figure 8-77:

Value Data Syntax Diagram

ValueData
value-boolean
value-integer
value-text
value-general
value-reference
value-list
value-external

CHOICE {
[0] IMPLICIT BOOLEAN,
[1] IMPLICIT INTEGER,
[2] IMPLICIT Text-String,
[3] IMPLICIT OCTET STRING,
[4] IMPLICIT Reference,
[5] IMPLICIT SEQUENCE OF ValueData,
[6] IMPLICIT EXTERNAL
}

Figure B-78 illustrates the syntax used to create a named value list construct.
Refer to the description of the corresponding DDIF$_CTD aggregate, the
DDIF$_FTD aggregate, the DDIF$_DHD aggregate, the DDIF$_IDU aggregate, the DDIF$_LG1 aggregate, the DDIF$_PGD aggregate, the DDIF$_PHD
aggregate, the DDIF$_LSD aggregate, and to the DDIF$_TYD aggregate in
Chapter 4.
Figure B-78:

Named Value List Syntax Diagram

NamedValueList : := SEQUENCE OF NamedValue

Figure B-79 illustrates the syntax used to create a font number construct.
Refer to the description of the corresponding Font Definitions Attribute and to
the Text Font Attribute for the DDIF$_SGA aggregate in Chapter 4.
Figure 8-79:
FontNumber

Font Number Syntax Diagram
: := INTEGER

Figure B-80 illustrates the syntax used to create a marker number construct.
Figure 8-80:
MarkerNumber

Marker Number Syntax Diagram
· ·= INTEGER

Figure B-81 illustrates the syntax used to create a path number construct.

DDIF Syntax Diagrams

B-29

Figure B-81 : Path Number Syntax Diagram
PathNumber

: := INTEGER

Refer to the description of the corresponding DDIF$_PTH aggregate in
Chapter 4.
Figure B-82 illustrates the syntax used to create a pattern number construct.
Refer to the description of the corresponding Text Mask Pattern Attribute, the
Line Attributes, and to the Marker Attributes for the DDIF$_SGA aggregate in
Chapter 4.
Figure B-82:

Pattern Number Syntax Diagram

PatternNumber

: := INTEGER

Figure B-83 illustrates the syntax used to create a path definition construct.
Refer to the description of the corresponding DDIF$_PHD aggregate and to the
Path Definitions Attribute for the DDIF$_SGA aggregate in Chapter 4.
Figure B-83:

Path Definition Syntax Diagram

PathDefn
path-number
path-description
path-private

· ·= SEQUENCE
[0] IMPLICIT PathNumber,
[1] IMPLICIT CompositePath,
[2] IMPLICIT NamedValueList

OPTIONAL

}

Figure B-84 illustrates the syntax used to create a composite path construct.
Refer to the description of the corresponding DDIF$_FAS aggregate, the
DDIF$_GLY aggregate, the DDIF$_PHD aggregate, the DDIF$_PTH aggregate,
and to the Frame Outline Attribute and Frame Clipping Attribute for the
DDIF$_SGA aggregate in Chapter 4.
Figure B-84:

Composite Path Syntax Diagram

CompositePath
::=SEQUENCE OF CHOICE
line-path-component
[0] IMPLICIT PolyLinePath,
cubic-path-component
[1] IMPLICIT CubicBezierPath,
arc-path-component
[2] IMPLICIT ArcPath,
path-reference
[3] IMPLICIT PathNumber
}

Figure B-85 illustrates the syntax used to create an arc path construct.
Refer to the description of the corresponding DDIF$_ARC aggregate and to the
DDIF$_PTH aggregate in Chapter 4.

B-30 DDIF Syntax Diagrams

Figure B-85:

Arc Path Syntax Diagram

ArcPath
arc-center-x
arc-center-y
arc-radius-x
arc-radius-delta-y
arc-start
arc-extent
arc-rotation

SEQUENCE
[OJ XCoordinate,
[lJ YCoordinate,
[2J Size,
[3J Size DEFAULT { integer-constant 0 } '
[4J AngleRef
DEFAULT { angle-constant 0.0 } '
[SJ AngleRef
DEFAULT { angle-constant 360.0 } '
[6J AngleRef
DEFAULT { angle-constant 0.0 }

Figure B-86 illustrates the syntax used to create a cubic Bezier path construct.
Refer to the description of the corresponding DDIF$_BEZ aggregate and to the
DDIF$_PTH aggregate in Chapter 4.
Figure B-86:

Cubic Bezier Path Syntax Diagram

CubicBezierPath

::=SEQUENCE OF Measurement

Figure B-87 illustrates the syntax used to create a line definition construct.
Refer to the description of the corresponding DDIF$_LSD aggregate and to the
Line-Style Definitions Attribute for the DDIF$_SGA aggregate in Chapter 4.
Figure B-87:

Line Definition Syntax Diagram

LineDefn
: := SEQUENCE {
line-style-number
[OJ IMPLICIT LineStyleNumber,
line-style-pattern
[lJ IMPLICIT SEQUENCE OF INTEGER OPTIONAL,
line-style-private
[2J IMPLICIT NamedValueList OPTIONAL
}

Figure B-88 illustrates the syntax used to create a polyline path construct.
Refer to the description of the corresponding DDIF$_LIN aggregate and to the
DDIF$_PTH aggregate in Chapter 4.

DDIF Syntax Diagrams

B-31

Figure B-88:

Polyline Path Syntax Diagram

PolyLinePath

··=SEQUENCE OF Measurement

Figure B-89 illustrates the syntax used to create a pattern definition construct.
Refer to the description of the corresponding DDIF$_PTD aggregate and to the
Pattern Definitions Attribute for the DDIF$_SGA aggregate in Chapter 4.
Figure B-89:

Pattern Definition Syntax Diagram

PatternDefn
pattern-number
pattern-defn
solid-color
std-pattern
raster-pattern

· · = SEQUENCE {
[0] IMPLICIT PatternNumber,
CHOICE {
[1] Color,
[2] IMPLICIT StandardPattern,
[3] IMPLICIT ImageDataUnit
} I

pattern-private

[4] IMPLICIT NamedValueList OPTIONAL
}

Figure B-90 illustrates the syntax used to create a standard pattern construct.
~

Refer to the description of the corresponding DDIF$_PTD aggregate in
Chapter 4.
Figure B-90:

Standard Pattern Syntax Diagram

StandardPattern
std-pattern-number
pattern-colors

· · = SEQUENCE {
[0] IMPLICIT INTEGER,
[1] IMPLICIT SEQUENCE OF PatternNumber
DEFAULT {INTEGER 1, INTEGER 2}

Figure B-91 illustrates the syntax used to create a reference construct.
Refer to the description of the corresponding DDIF$_PVT aggregate and to the
Copied and Remote Computed Content Attributes for the DDIF$_SGA aggregate
in Chapter 4.

8-32

DDIF Syntax Diagrams

Figure B-91 : Reference Syntax Diagram
Reference
ref-target
ref-x-index

SEQUENCE
[0] IMPLICIT SegmentLabel OPTIONAL,
[1] IMPLICIT ExternalRefindex OPTIONAL

: :=

}

Figure B-92 illustrates the syntax used to create a segment attributes construct.
Refer to the description of the corresponding DDIF$_SEG aggregate, the
DDIF$_TYD aggregate, the DDIF$_SGA aggregate, and General Segment
Attributes and Alternate Presentation Attribute for the DDIF$_SGA aggregate in
Chapter 4.
Figure B-92:

Segment Attributes Syntax Diagram

. ·= SEQUENCE {
SegmentAttributes
[0] IMPLICIT NamedValueList
OPTIONAL,
private-attributes
[1] IMPLICIT SEQUENCE OF StreamTag OPTIONAL,
content-streams
[2] IMPLICIT CategoryTag
content-category
OPTIONAL,
[3] IMPLICIT SEQUENCE OF Segment Tag OPTIONAL,
segment-tags
[4] IMPLICIT SEQUENCE OF Binding
OPTIONAL,
segment-bindings
[5] ComputeDefn
OPTIONAL,
computed-content
[6] StructureDefn
OPTIONAL,
structure-description
[7] IMPLICIT Language Index
language
OPTIONAL,
[8] IMPLICIT LegendUnits
OPTIONAL,
legend-units
[9] IMPLICIT MeasurementUnits
measurement-units
OPTIONAL,
alt-presentation
[10] IMPLICIT Text-String
OPTIONAL,
[11] Text Layout
layout-attributes
OPTIONAL,
[12] IMPLICIT SEQUENCE OF FontDef n
OPTIONAL,
font-definitions
pattern-definitions
[13] IMPLICIT SEQUENCE OF PatternDefn
OPTIONAL,
[14] IMPLICIT SEQUENCE OF PathDefn
OPTIONAL,
path-definitions
line-style-definitions
[15] IMPLICIT SEQUENCE OF LineDef n
OPTIONAL,
[16] IMPLICIT SEQUENCE OF ContentDefn
content-defns
OPTIONAL,
[17] IMPLICIT SEQUENCE OF SegTypeDefn
OPTIONAL,
segment-type-defns
OPTIONAL,
text-attributes
[18] IMPLICIT TextAttributes
line-attributes
[19] IMPLICIT LineAttributes
OPTIONAL,
marker-attributes
[20] IMPLICIT MarkerAttributes
OPTIONAL,
[21] ANY
OPTIONAL,
galley-attributes
image-attributes
frame-parameters

[22]
[23]

IMPLICIT ImageAttributes
IMPLICIT FrameParameters

OPTIONAL,
OPTIONAL

}

Figure B-93 illustrates the syntax used to create a segment type definition
construct.
Refer to the description of the corresponding Type Definitions Attribute for the
DDIF$_SGA aggregate and to the DDIF$_TYD aggregate in Chapter 4.

DDIF Syntax Diagrams

B-33

Figure B-93:

Segment Type Definition· Syntax Diagram

SegTypeDefn
type-label
type-parent
type-attributes
type-private

: :=

SEQUENCE {
[0] IMPLICIT TypeDefnLabel,
[1] IMPLICIT TypeDefnLabel
OPTIONAL,
[2] IMPLICIT SegmentAttributes OPTIONAL,
[3] IMPLICIT NamedValueList
OPTIONAL
}

Figure B-94 illustrates the syntax used to create a structur~ definition construct.
Refer to the description of the corresponding DDIF$_0CC aggregate and to the
Structure Attributes for the DDIF$_SGA aggregate in Chapter 4.
Figure B-94:

Structure Definition Syntax Diagram

StructureDefn
sequence-structure
set-structure
choice-structure

: := CHOICE
[0] IMPLICIT SEQUENCE OF OccutrenceDefn,
[1]

IMPLICIT SEQUENCE OF OccurrenceDefn,

[2] IMPLICIT SEQUENCE OF OccurrenceDefn
}

Figure B-95 illustrates the syntax used to create an occurrence definition construct.
Refer to the description of the corresponding DDIF$_0CC aggregate in
Chapter 4.
Figure B-95:

Occurrence Definition Syntax Diagram

OccurrenceDefn
required-element
optional-element
repeat-element
opt-repeat-element

: := CHOICE {
[0] StructureElement,
[1] StructureElement,
[2] StructureElement,
[3] StructureElement
}

Figure B-96 illustrates the syntax used to create a structure element construct.
Refer to the description of the corresponding DDIF$_0CC aggregate in
Chapter 4.

8-34

DDIF Syntax Diagrams

Figure B-96:

Structure Element Syntax Diagram

StructureElement
expression-element
referenced-type

CHOICE {
StructureDefn,
TypeDefnLabel
}

Figure B-97 illustrates the syntax used to create a tag construct.
Figure B-97:

Tag Syntax Diagram

Tag

: :=

ASCIIString

Figure B-98 illustrates the syntax used to create a category tag construct.
Figure B-98:

Category Tag Syntax Diagram

CategoryTag

: := Tag

Figure B-99 illustrates the syntax used to create a conformance tag construct.
Figure B-99:

Conformance Tag Syntax Diagram

Conf ormanceTag

· ·= Tag

Figure B-100 illustrates the syntax used to create a named value tag construct.
Figure B-100:
NamedValueTag

Named Value Tag Syntax Diagram
: := Tag

Figure B-101 illustrates the syntax used to create a segment tag construct.
Refer to the description of the corresponding Counter Variable Values for the
DDIF$_SGB aggregate in Chapter 4.

DDIF Syntax Diagrams

B-35

Figure B-101 : Segment Tag Syntax Diagram
Segment Tag

Tag

Figure B-102 illustrates the syntax used to create a storage system tag
construct.
Figure B-102:

Storage System Tag Syntax Diagram

StorageSystemTag

.. - Tag

Figure B-103 illustrates the syntax used to create a stream tag construct.
Figure B-103:

Stream Tag Syntax Diagram
· ·= Tag

StreamTag

Figure B-104 illustrates the syntax used to create a transformation construct.
Refer to the description of the corresponding DDIF$_CRF aggregate, the Frame
Content Transformation Attribute for the DDIF$_SGA aggregate, and to the
DDIF$_TRN aggregate in Chapter 4.
Figure B-104:

Transformation Syntax Diagram

Transformation
x-scale
y-scale
x-translation
y-translation
xy-rotate
xy-skew
transform-2x3
transform-3x3

SEQUENCE OF CHOICE
[0] IMPLICIT FLOATING-POINT,
[1) IMPLICIT FLOATING-POINT,
[2] IMPLICIT FLOATING-POINT,
[3] IMPLICIT FLOATING-POINT,
[4] IMPLICIT Angle,
[5] IMPLICIT Angle,
[6] IMPLICIT SEQUENCE OF FLOATING-POINT,
[7] IMPLICIT SEQUENCE OF FLOATING-POINT
}

Figure B-105 illustrates the syntax used to create a variable binding construct.
Refer to the description of the corresponding DDIF$_SGB aggregate and to the
Counter Variable Values, Computed Variable Values, and to the List Variable
Values for the DDIF$_SGB aggregate in Chapter 4.

B-36

DDIF Syntax Diagrams

Figure B-105:

Variable Binding Syntax Diagram

Binding
··= SEQUENCE {
variable-name
[OJ IMPLICIT VariableLabel,
variable-value
CHOICE {
counter-variable
[1] IMPLICIT CounterDefn,
[2] IMPLICIT StringExpression,
computed-variable
list-variable
[3] IMPLICIT RecordList
}

Figure B-106 illustrates the syntax used to create a counter definition construct.
Refer to the description of the corresponding DDIF$_SGB aggregate and to the
Counter Variable Values for the DDIF$_SGB aggregate in Chapter 4.
Figure 8-106:

Counter Definition Syntax Diagram

CounterDefn
::=SEQUENCE {
counter-trigger
CHOICE {
counts-tagged-segments
[0] IMPLICIT SegmentTag,
counts-layout-objs
[1] IMPLICIT LayoutObjectType
} OPTIONAL,
[2] Expression DEFAULT { exp-integer 1 },
counter-init
counter-style
[3] IMPLICIT SEQUENCE OF CounterStyle OPTIONAL,
counter-type
[4] IMPLICIT INTEGER {
military(l),
office(2),
page-relative(3)
DEFAULT off ice

Figure B-107 illustrates the syntax used to create a layout object type construct.
Refer to the description of the corresponding Counter Variable Values for the
DDIF$_SGB aggregate in Chapter 4.
Figure B-107:

Layout Object Type Syntax Diagram

LayoutObjectType

INTEGER { document-layout-object(l),
page-set-layout-object(2),
page-layout-object(3),
frame-layout-object(4),
block-layout-object(5),
line-layout-object(6)
}

Figure B-108 illustrates the syntax used to create an expression construct.
Refer to the description of the corresponding Counter Variable Values for the
DDIF$_SGB aggregate in Chapter 4.

DDIF Syntax Diagrams

8-37

Figure B-108:

Expression Syntax Diagram

Expression
exp-integer
exp-variable

: := CHOICE {
[0] IMPLICIT INTEGER,
[l] IMPLICIT VariableLabel
}

Figure B-109 illustrates the syntax used to create a counter style construct.
Refer to the description of the corresponding DDIF$_CTS aggregate and to the
Counter Variable Values for the DDIF$_SGB aggregate in Chapter 4.
Figure B-109: Counter Style Syntax Diagram
CounterStyle
::=CHOICE {
number-style
[0] IMPLICIT INTEGER {
arabic(l),
l-roman(2),
u-roman(3), l-latin(4),
u-latin(5), w-arabic(6),
wl-roman(7), wu-roman(8),
wl-latin(9), wu-latin(lO),
w-katakana-50(11),
w-katakana-iroha(l2),
hebrew (13)
}'
bullet-style
[l] IMPLICIT SEQUENCE OF Character-String,
[2] IMPLICIT Character-String
style-separator
}

Figure B-110 illustrates the syntax used to create a string expression construct.
Refer to the description of the corresponding DDIF$_SGB aggregate and to the
Computed Variable Values for the DDIF$_SGB aggregate in Chapter 4.
Figure B-110: String Expression Syntax Diagram
StringExpression
··=SEQUENCE OF CHOICE
text-element
[0] IMPLICIT Character-String,
variable-ref-element
[1] IMPLICIT VariableLabel
}

Figure B-111 illustrates the syntax used to create a record list construct.
Refer to the description of the corresponding DDIF$_SGB aggregate and to the
List Variable Values for the DDIF$_SGB aggregate in Chapter 4.

B-38

DDIF Syntax Diagrams

F·igure B-111:

Record List Syntax Diagram

RecordList ::=SEQUENCE OF RecordDefn

Figure B-112 illustrates the syntax used to create a record definition construct.
Refer to the description of the corresponding DDIF$_RCD aggregate and to the
List Variable Values for the DDIF$_SGB aggregate in Chapter 4.
Figure B-112:

Record Definition Syntax Diagram

RecordDefn
record-type
record-tag
record-contents

: : = SEQUENCE {
[0] IMPLICIT TypeDefnLabel,
[1] IMPLICIT SegmentTag,
[2] IMPLICIT SEQUENCE OF VariableLabel
}

Figure B-113 illustrates the syntax used to create a generic layout construct.
Refer to the description of the corresponding DDIF$_LG1 aggregate in
Chapter 4.
Figure B-113:

Generic Layout Syntax Diagram

GenericLayout
::= [APPLICATION 31] IMPLICIT SEQUENCE {
gl-private-data
[0] IMPLICIT NamedValueList OPTIONAL,
gl-page-descriptions
[1] IMPLICIT SEQUENCE OF PageDescription
}

Figure B-114 illustrates the syntax used to create a page description construct.
Refer to the description of the corresponding DDIF$_LG1 aggregate, the DDIF$_
LSl aggregate, and to the DDIF$_PGD aggregate in Chapter 4.
Figure B-114:

Page Description Syntax Diagram

PageDescription
pd-label
pd-private-data
pd-desc
page-set-desc
page-layout

: : = SEQUENCE {
[0] IMPLICIT PageDescLabel,
[1] IMPLICIT NamedValueList OPTIONAL,
CHOICE {
[2] IMPLICIT PageSet,
[3] IMPLICIT PageLayout
}

Figure B-115 illustrates the syntax used to create a page set construct.
Refer to the description of the corresponding DDIF$_PGD aggregate and to the
DDIF$_PGS aggregate in Chapter 4.

DDIF Syntax Diagrams

B-39

Figure B-115:

Page Set Syntax Diagram

Page Set

::=SEQUENCE OF PageSelect

PageSelect
· · = SEQUENCE {
page-side-criteria
[0] IMPLICIT INTEGER {
left-page (1),
right-page(2),
either-page(3)
DEFAULT either-page,
selected-page-layout
CHOICE {
select-by-label
[1] IMPLICIT PageLayoutLabel,
select-by-defn
[2] IMPLICIT PageLayout

Figure B-116 illustrates the syntax used to create a page layout construct.
Refer to the description of the corresponding DDIF$_PGD aggregate, the
DDIF$_PGL aggregate, and to the DDIF$_PGS aggregate in Chapter 4.
Figure B-116:

Page Layout Syntax Diagram

PageLayout
page-layout-id
page-size
page-orientation
portrait (1),
landscape(2)
page-prototype
page-content

· · = SEQUENCE {
[0] IMPLICIT PageLayoutLabel,
[1] IMPLICIT GenSize,
[2] IMPLICIT INTEGER {
DEFAULT portrait,
[3] IMPLICIT PageLayoutLabel OPTIONAL,
[4] IMPLICIT PageFrame
OPTIONAL
}

PageFrame

· ·= Content -- Must be a frame

Figure B-117 illustrates the syntax used to create a layout primitive construct.

Figure B-117:

Layout Primitive Syntax Diagram

LayoutPrimitive

··= [APPLICATION 35] ANY

Figure B-118 illustrates the syntax used to create a layout galley construct.
Refer to the description of the corresponding DDIF$_GLY aggregate in
Chapter 4.

B-40

DDIF Syntax Diagrams

Figure B-118:

Layout Galley Syntax Diagram

Layout Galley
galley-id
galley-bounding-box
galley-outline
galley-flags

··= [APPLICATION 36] IMPLICIT SEQUENCE
[0]
[1]
[2]
[3]

IMPLICIT GalleyLabel,
IMPLICIT BoundingBox,
IMPLICIT CompositePath
IMPLICIT BIT STRING {

OPTIONAL,

galley-vertical-align(O),
galley-border(l),
galley-autoconnect(2),
galley-background-fill(3)
}

galley-streams
galley-successor
generic-galley
specific-galley
no-successor-galley

OPTIONAL,
[4] IMPLICIT SEQUENCE OF StreamTag OPTIONAL,
CHOICE {
[5] IMPLICIT GalleyLabel,
[6] IMPLICIT GalleyLabel,
[7] IMPLICIT NULL
}

Figure B-119 illustrates the syntax used to create a galley attributes construct.
Refer to the description of the corresponding DDIF$_GLA aggregate and to the
Galley Attributes for the DDIF$_SGA aggregate in Chapter 4.
Figure B-119: Galley Attributes Syntax Diagram
GalleyAttributes
::= [APPLICATION 37] IMPLICIT SEQUENCE
galley-top-margin
[0] Measurement
galley-left-margin
[1] Measurement
galley-right-margin
[2] Measurement
galley-bottom-margin
[3] Measurement

OPTIONAL,
OPTIONAL,
OPTIONAL,
OPTIONAL

}

Figure B-120 illustrates the syntax used to create a specific layout construct.
Refer to the description of the corresponding DDIF$_LS1 aggregate in Chapter 4.
Figure B-120: Specific Layout Syntax Diagram
SpecificLayout
::= [APPLICATION 32) IMPLICIT SEQUENCE OF CHOICE {
specific-page
[0] IMPLICIT PageDescription,
referenced-page
[1] IMPLICIT PageDescLabel
}

Figure B-121 illustrates the syntax used to create a wrap attributes construct.
Refer to the description of the corresponding DDIF$_LW1 aggregate in
Chapter 4.

DDIF Syntax Diagrams

8-41

Figure B-121 : Wrap Attributes Syntax Diagram
WrapAttributes
::= [APPLICATION 33) IMPLICIT SEQUENCE
wrap-format
[0] IMPLICIT Format OPTIONAL,
quad-format
[1] IMPLICIT Format OPTIONAL,
hyphenation-flags
[2] IMPLICIT BIT STRING {
hyphenation-allowed(O),
paragraph-end(l),
galley-end(2),
page-end(3),
capitalized-word(4)
OPTIONAL,
maximum-hyph-lines
[3] IMPLICIT INTEGER OPTIONAL,
maximum-orp~an-size
[4] IMPLICIT INTEGER OPTIONAL,
maximum-widow-size
[5) IMPLICIT INTEGER OPTIONAL
}

Figure B-122 illustrates the syntax used to create a layout attributes construct.
Refer to thE:i description of the corresponding DDIF$_LL1 aggregate in Chapter 4.
Figure B-122:

Layout Attributes Syntax Diagram

LayoutAttributes
initial-directive
galley-select
break-before
break-within
break-after
initial-indent
left-indent
right-indent
space-before
space-after
leading
tab-stops

··= [APPLICATION 34) IMPLICIT SEQUENCE {
[0]
[1]
[2]
[3]
[4]
[5]
[6]
[7]
[8]
[9]
[10)
[11)

IMPLICIT Directive
OPTIONAL,
IMPLICIT GalleyLabel
OPTIONAL,
IMPLICIT BreakCriteria OPTIONAL,
IMPLICIT BreakCriteria OPTIONAL,
IMPLICIT BreakCriteria OPTIONAL,
Measurement OPTIONAL,
Measurement OPTIONAL,
Measurement OPTIONAL,
Measurement OPTIONAL,
Measurement OPTIONAL,
IMPLICIT Escapement OPTIONAL,
IMPLICIT TabStopList OPTIONAL

}

Figure B-123 illustrates the syntax used to create a break criteria construct.
Refer to the description of the corresponding DDIF$_LL1 aggregate in Chapter 4.
Figure B-123:

Break Criteria Syntax Diagram

BreakCriteria
break-always(l),
break-never(2),
break-if-needed(3)

: : = INTEGER {

Figure B-124 illustrates the syntax used to create a general measure construct.
Refer to the description of the corresponding DDIF$_PGL aggregate in
Chapter 4.

B-42

DDIF Syntax Diagrams

Figure B-124:

General Measure Syntax Diagram

GenMeasure
nominal-measure
stretch-measure
shrink-measure

. ·= SEQUENCE

{

[0] Measurement DEFAULT
[1] Measurement DEFAULT
[2] Measurement DEFAULT

integer-constant 0 } ,
integeJ?-constant 0 } ,
integer-constant 0 }

}

Figure B-125 illustrates the syntax used to create a general size construct.
Refer to the description of the corresponding DDIF$_PGL aggregate in
Chapter 4.
Figure B-125:

General Size Syntax Diagram

GenSize
x-size
y-size

: : = SEQUENCE {
[0] IMPLICIT GenMeasure,
[1] IMPLICIT GenMeasure
}

Figure B-126 illustrates the syntax used to create a tab stop list construct.
Refer to the description of the corresponding DDIF$_LL1 aggregate in Chapter 4.
Figure B-126:

Tab Stop List Syntax Diagram

TabStopList

::=SEQUENCE OF TabStop

Figure B-127 illustrates the syntax used to create a tab stop construct.
Refer to the description of the corresponding DDIF$_TBS aggregate in
Chapter 4.
Figure B-127:

Tab Stop Syntax Diagram

TabStop
horizontal-position
tab-stop-type
left-tab (1),
center-tab(2),
right-tab (3),
decimal-tab(4)
tab-stop-leader

· ·= SEQUENCE
[0] Measurement,
[1] IMPLICIT INTEGER

DEFAULT left-tab,
[2] IMPLICIT Character-String OPTIONAL
}

DDIF Syntax Diagrams

B-43

Figure B-128 illustrates the syntax used to create a generalized time construct.
Refer to the description of the corresponding DDIF$_DHD aggregate in
Chapter 4.
Figure B-128:

Generalized Time Diagram

GeneralizedTime

8-44 DDIF Syntax Diagrams

··= [UNIVERSAL 24] IMPLICIT OCTET STRING

Appendix C

DTIF Syntax Diagrams
This appendix lists the syntax diagrams for each construct defined by DTIF
(DIGITAL Table Interchange Format). The diagram for each construct is listed
alphabetically under Syntax diagrams in the index. For example, Figure C-1
shows the syntax used to create a DTIF document construct and is listed as
DTIFDocument under Syntax diagrams in the index. For a description of the
DDIS types referred to in the syntax diagrams, see Appendix B.
Figure C-1 illustrates the syntax used to create a DTIF dqcument construct.
Refer to the description of the corresponding DTIF$_DTF aggregate in Chapter 5.

Figure C-1:

DTIF Document Syntax Diagram

DTIFDocument ::= [PRIVATE
document-descriptor
document-header
document-tables

16382] IMPLICIT SEQUENCE {
[OJ IMPLICIT DocumentDescriptor,
[1] IMPLICIT DocumentHeader,
[3] IMPLICIT SEQUENCE OF TableDefn
}

Figure C-2 illustrates the syntax used to create a document descriptor construct.
Refer to the description of the corresponding DTIF$_DSC aggregate in Chapter 5.

Figure C-2:

Document Descriptor Syntax Diagram

DocumentDescriptor ::= SEQUENCE {
major-version
[0] IMPLICIT INTEGER,
minor-version
[1] IMPLICIT INTEGER,
product-identifier
[2] IMPLICIT ASCIIString,
product-name
[3] IMPLICIT Text-String,
encode-major-version
[4] IMPLICIT INTEGER,
encode-minor-version
[5] IMPLICIT INTEGER

product version
product version

DTIF encoding version
DTIF encoding version

}

DTIF Syntax Diagrams C-1

Figure C-3 illustrates the syntax used to create a document header construct.
Refer to the description of the corresponding DTIF$_HDR aggregate in Chapter 5.

Figure C-3:

Document Header Syntax Diagram

DocumentHeader ::=SEQUENCE {
private-header-data
[OJ IMPLICIT NamedValueList OPTIONAL,
title
[l] IMPLICIT Text-String OPTIONAL,
OPTIONAL,
date
[4J IMPLICIT DateTime
external-references
[6] IMPLICIT SEQUENCE OF ExternalRef erence OPTIONAL,
languages
[7] IMPLICIT SEQUENCE OF CHOICE {
iso-639-language
[OJ IMPLICIT ASCIIString,
other-language
[l] IMPLICIT Character-String
}
OPTIONAL,
language-pref-tables
[9] IMPLICIT SEQUENCE OF LangPrefTable OPTIONAL,
generic-columns
(10] IMPLICIT ColAttrList OPTIONAL
}

Figure C-4 illustrates the syntax used to create an external reference construct.
Refer to the description of the corresponding DTIF$_ERF aggregate in Chapter 5.

Figure C-4:

External Reference Syntax Diagram

ExternalReference ::=SEQUENCE {
reference-data-type
[0] IMPLICIT OBJECT IDENTIFIER,
reference-descriptor [l] IMPLICIT Text-String,
reference-label
[2J IMPLICIT Character-String,
reference-label-type [3J IMPLICIT StorageSystemTag,
reference-control
[4J IMPLICIT INTEGER {
copy-reference
(1),
no-copy-reference (2)
DEFAULT {copy-reference}

C-2

DTI F Syntax Diagrams

Figure C-5 illustrates the syntax used to create a storage system tag construct.
Refer to the description of the corresponding DTI$_ERF aggregate in Chapter 5.
Figure C-5:

Storage System Tag Syntax Diagram

StorageSystemTag ::= ASCIIString

Figure C-6 illustrates the syntax used to create an external references index
construct.
Refer to the description of the corresponding DTIF$_ERF aggregate in Chapter 5.

Figure C-6:

External References Index Syntax Diagram

ExternalRefindex

INTEGER -- index into ExternalRef erences

Figure C-7 illustrates the syntax used to create a language preference table
construct.
Refer to the description of the corresponding DTIF$_LPT aggregate in Chapter 5.

Figure C-7:

Language Preference Table Syntax Diagram

LangPrefTable ::=SEQUENCE {
pref-language-index (0] IMPLICIT INTEGER OPTIONAL,
pref-appl-priv
(1] IMPLICIT ApplPrivate
OPTIONAL,
pref-items
[2] IMPLICIT NamedValueList OPTIONAL,
pref-editstrs
[3] IMPLICIT SEQUENCE OF NamedEditString OPTIONAL,
pref-collate-seq
[4] IMPLICIT Latinl-String
OPTIONAL,
pref-collate-table
(5] IMPLICIT OCTET STRING
OPTIONAL
}

DTIF Syntax Diagrams

C-3

Figure C-8 illustrates the syntax used to create a named edit string construct.
Refer to the description of the corresponding DTIF$_NES aggregate in Chapter 5.

Figure C-8:

Named Edit String Syntax Diagram

NamedEditString ::=SEQUENCE {
editstring-name [0] IMPLICIT ASCIIString
editstring-defn [1] EditString

OPTIONAL,

}

Figure C-9 illustrates the syntax used to create a table definition construct.
Refer to the description of the corresponding DTIF$_TBL aggregate in Chapter 5.

Figure C-9:

Table Definition Syntax Diagram

TableDefn
: := SEQUENCE {
table-max-cols
[0] IMPLICIT INTEGER OPTIONAL,
table-max-rows
[1] IMPLICIT INTEGER OPTIONAL,
table-appl-private
[2] IMPLICIT ApplPrivate OPTIONAL,
table-metadata
[3] IMPLICIT TableMD OPTIONAL,
table-windows
[4] IMPLICIT SEQUENCE OF WindowDefn OPTIONAL,
table-rows
[5] IMPLICIT SEQUENCE OF RowDefn OPTIONAL

C-4 DTIF Syntax Diagrams

Figure C-10 illustrates the syntax used to create a table metadata construct.
Refer the description of the corresponding DTIF$_TMD aggregate in Chapter 5.
Figure C--10:

Table Metadata Syntax Diagram

TableMD
trod-naroe
trod-id
trod-appl-priv
trod-description
trod-flags

tmd-default-frots
trod-columns
trod-ranges
trod-symbols

SEQUENCE {
[ 0] IMPLICIT Text-String OPTIONAL,
[l] IMPLICIT INTEGER OPTIONAL,
[ 2] IMPLICIT ApplPrivate OPTIONAL,
[3] IMPLICIT Text-String OPTIONAL,
[4] IMPLICIT BIT STRING {
trod-autorecalc
(0),
trod-autoresort
(1),
tmd-calcbycol
(2),
trod-calcbyrow
(3),
tmd-calcnatural (4),
tmd-fmtbycol
(5),
trod-fmtbyrow
(6)
} DEFAULT {tmd-fmtbycol},
[5] IMPLICIT FormatinfoList OPTIONAL,
[6] IMPLICIT ColAttrList OPTIONAL,
[7] IMPLICIT SEQUENCE OF RangeDefn OPTIONAL,
[8] IMPLICIT NamedValueList OPTIONAL
}

Figure C-11 illustrates the syntax used to create a table window construct.
Refer to the description of the corresponding DTIF$_WND aggregate in
Chapter 5.
Figure C-11:

Table Window Syntax Diagram

WindowDef n
wnd-naroe
wnd-id
wnd-appl-priv

: := SEQUENCE {

wnd-description
wnd-f lags

[0]
[l]
[2]
[3]
[4]
[5]

wnd-f ormats
wnd-ranges
wnd-active-loc

(0),
(1),
window-formula-hidden (2),
window-value-hidden
(3),
window-colhdr-hidden
(4),
window-rowhdr-hidden
(5),
window-lines-hidden
(6)
} DEFAULT {window-formula-hidden},
[6] IMPLICIT FormatinfoList OPTIONAL,
[7] IMPLICIT SEQUENCE OF RangeDefn OPTIONAL,
[8) IMPLICIT CellCoord OPTIONAL

wnd~cardinal-num

IMPLICIT Text-String OPTIONAL,
IMPLICIT INTEGER OPTIONAL,
IMPLICIT ApplPrivate OPTIONAL,
IMPLICIT INTEGER OPTIONAL,
IMPLICIT Text-String OPTIONAL,
IMPLICIT BIT STRING {
window-active
window~hidden

}

DTIF Syntax Diagrams

C-5

Figure C-12 illustrates the syntax used to create a table rows construct.
Refer to the description of the corresponding DTIF$_ROW aggregate in Chapter 5.

Figure C-12:

Table Rows Syntax Diagram

RowDefn
row-num
row-appl-priv
row-formats
row-flags

row-cells

: : = SEQUENCE {
[0] IMPLICIT RowNum OPTIONAL,
[1] IMPLICIT ApplPrivate OPTIONAL,
[2] IMPLICIT FormatinfoList OPTIONAL,
[3] IMPLICIT BIT STRING {
row-annotation (0)
} OPTIONAL,
[4] IMPLICIT SEQUENCE OF CellData OPTIONAL
}

Figure C-13 illustrates the syntax used to create a cell data construct.
Refer to the description of the corresponding DTIF$_CLD aggregate in Chapter 5.

Figure C-13:

Cell Data Syntax Diagram

CellData ::=SEQUENCE
cell-col-num
cell-state

cell-description
cell-appl-priv
cell-formats
cell-value
cell-formula-cfe

[0] IMPLICIT ColNum OPTIONAL,
[1] IMPLICIT INTEGER {
-- Basic cell states:
cs-isvalue
(0),
cs-isnull
(1),
cs-iserror
(2),
cs-isnovalue (3),

[2]
[3]
[4]
[5]
[6]
}

C-6

DTIF Syntax Diagrams

-- Additional Error States.
cs-isunderflow (10),
cs-isoverflow
(11),
cs-isundefref
(12),
cs-isdivzero
(13),
cs-isrecursive
(14)
} DEFAULT {cs-isvalue},
IMPLICIT Text-String OPTIONAL,
IMPLICIT ApplPrivate OPTIONAL
IMPLICIT FormatinfoList OPTIONAL,
CellValue OPTIONAL,
Expression OPTIONAL

Figure C-14 illustrates the syntax used to create a cell value construct.
Refer to the description of the corresponding DTIF$_CLD aggregate in Chapter 5.

Figure C-14:

Cell Value Syntax Diagram

. ·= CHOICE
Cell Value
cv-integer
[OJ IMPLICIT INTEGER,
cv-latinl-text
[1] IMPLICIT Latinl-String,
cv-simple-text
[2] IMPLICIT Character-String,
cv-date
[3] IMPLICIT DateTime,
[5] IMPLICIT SCALED-INTEGER,
cv-scaled-integer
[6] IMPLICIT VaryingText,
cv-vtext
[7] IMPLICIT ArrayDefn,
cv-array
[8] IMPLICIT ComplexFloat,
cv-complex
[9] IMPLICIT FLOATING-POINT,
cv-f loat
cv-boolean
[10] IMPLICIT BOOLEAN
}

Figure C-15 illustrates the syntax used to create a varying text construct.
Refer to the description of the corresponding DTIF$_VTX aggregate in
Chapter 5.
Figure C-15:

Varying Text Syntax Diagram

VaryingText ··=SEQUENCE {
vtext-len
[0] IMPLICIT INTEGER,
vtext-str
[1] IMPLICIT Character-String
}

DTIF Syntax Diagrams

C-7

Figure C-16 illustrates the syntax used to create an array definition construct.
Refer to the description of the corresponding DTIF$_ARD aggregate in Chapter 5.

Figure C-16:

Array Definition Syntax Diagram

ArrayDefn
::=SEQUENCE {
array-description
[0] IMPLICIT Latinl-String OPTIONAL,
array-elem-type-size [1] CHOICE {
std-type [0] IMPLICIT INTEGER {
elem-word (0),
elem-long (1),
elem-ffloat (2),
elem-dfloat (3),
elem-gfloat (4),
elem-hfloat (5)
}'

var-type [1] IMPLICIT INTEGER
array-x-dimension
array-y-dimension
array-z-dimension
array-values

[2]
[3]
[4]
[5]

IMPLICIT INTEGER,
IMPLICIT INTEGER OPTIONAL,
IMPLICIT INTEGER OPTIONAL,
IMPLICIT OCTET STRING

}

Figure C-17 illustrates the syntax used to create a complex floating-point
construct.
Refer to the description of the corresponding DTIF$_CFT aggregate in Chapter 5,
and to the CFE$_CFT aggregate and CFE$_EXL aggregate in Chapter 6 float
construct.
Figure C-17:

Complex Float Syntax Diagram

ComplexFloat

::=SEQUENCE

{

real-part
[0] IMPLICIT FLOATING-POINT,
imaginary-part [1] IMPLICIT FLOATING-POINT
}

C-8 DTIF Syntax Diagrams

Figure C-18 illustrates the syntax used to create a column attributes construct.
Refer to the description of the corresponding DTIF$_CAT aggregate in Chapter 5.

Figure C-18:

Column Attributes Syntax Diagram

ColAttrList ::=SEQUENCE OF ColAttributes
ColAttributes ::=SEQUENCE {
col-name
[0) IMPLICIT ASCIIString OPTIONAL,
col-id
[1) IMPLICIT INTEGER OPTIONAL,
col-appl-priv
[2) IMPLICIT ApplPrivate OPTIONAL
col-generic-ref
[3] IMPLICIT INTEGER OPTIONAL,
-- not used in generic-columns;
-- used by table-col to reference generic col-id
col-description
[4] IMPLICIT Text-String OPTIONAL,
col-formats
[5) IMPLICIT FormatinfoList OPTIONAL,
col-computed-by
[6) Expression OPTIONAL,
col-default-value
[7] CellValue OPTIONAL,
col-missing-value
[8] CellValue OPTIONAL,
OPTIONAL,
col-query-name
[9] IMPLICIT Character-String
OPTIONAL,
col-column-hdr
[10) IMPLICIT Character-String
col-data-type
[12) IMPLICIT Datatype OPTIONAL,
col-data-length
[13) IMPLICIT INTEGER OPTIONAL,
col-scale-factor
[14) IMPLICIT INTEGER OPTIONAL,
col-flags
[15) IMPLICIT BIT STRING {
col-autorecalc (0),
col-readonly
(1),
col-annotation (2)
} OPTIONAL

DTIF Syntax Diagrams C-9

Figure C-19 illustrates the syntax used to create a data type construct.
Refer to the description of the corresponding DTIF$_CAT aggregate in Chapter 5.

Figure C-19:
Data type

Data Type Syntax Diagram
. ·= INTEGER {
dt-unknown ( 0) '
dt-word
( 1) '
dt-long
(2) '
dt-quad
( 3) '
dt-ffloat
( 4) '
dt-dfloat
( 5) '
dt-gfloat
( 6) '
dt-hf loat
( 7) '
dt-absdate (8)'
dt-text
( 9) '
dt-vtext
(10)'
dt-segstr (11)

signed word integer (16 bits)
signed longword integer (32 bits)
signed quadword integer (64 bits)

absolute date/time
text string
varying text string
segmented string

}

Figure C-20 illustrates the syntax used to create a format information list
construct.
Refer to the description of the corresponding DTIF$_FMI aggregate in Chapter 5.

Figure C-20:

Format Info List Syntax Diagram

FormatinfoList ::=SEQUENCE OF Formatinfo
Formatinfo ::=SEQUENCE
format-window-id
format-type
format-flags
format-width
format-lang-id
format-direction

{

[0]
[1]
[2]
[3]
[4]
[5]

IMPLICIT INTEGER OPTIONAL,
FormatType OPTIONAL,
IMPLICIT FmtFlags OPTIONAL,
IMPLICIT INTEGER OPTIONAL,
IMPLICIT LangPrefindex OPTIONAL,
IMPLICIT INTEGER {
dir-opposite (0)
} OPTIONAL,
[6] IMPLICIT Text-String OPTIONAL,
[7] IMPLICIT INTEGER {

format-unit-desc
format-alignment
fmt-left
(0)'
fmt-center
( 1)'
(2)
fmt-right
OPTIONAL,
format-border
[8] IMPLICIT BIT STRING {
border-left
( 0) '
border-noleft
( 1) '
border-top
(2)'
border-not op
(3) '
border-right
( 4) '
border-noright
( 5) '
border-bottom
( 6) '
border-nobottom (7)
OPTIONAL

C-10

DTIF Syntax Diagrams

Figure C-21 illustrates the syntax used to create a language preference index
construct.
Refer to the description of the corresponding DTIF$_FMI aggregate in Chapter 5.

Figure C-21 : Language Preference Index Syntax Diagram
LangPrefindex ::=INTEGER -- into LangPrefTable

Figure C-22 illustrates the syntax used to create a format type construct.
Refer to the description of the corresponding DTIF$_FMI aggregate in Chapter 5.

Figure C-22:

Format Type Syntax Diagram

FormatType ::=CHOICE
format-numeric [0] IMPLICIT SEQUENCE {
numdatatype
[0] IMPLICIT BIT STRING
{ numtyp-all
(0),
numtyp-integer (1),
numtyp-float
(2)
DEFAULT { num-all },
numfmt
[l] CHOICE {
num-std-fmt
[0] IMPLICIT NumericFmt,
num-editstr
[1] EditString,
num-editstr-id [2] IMPLICIT EditStrindex
}'

numrndtrunc

[2] IMPLICIT INTEGER
{ round-display
(0),
truncate-display (1)
OPTIONAL
}'

format-text
[1] CHOICE
textfmt
[0] IMPLICIT TextFmt,
textestr
[1] EditString,
textestrid
[2] IMPLICIT EditStrindex
}'

format-date
[2] CHOICE {
datefmt
[0] IMPLICIT DateFmt,
dateestr
[1] EditString,
dateestrid
[2] IMPLICIT EditStrindex

DTIF Syntax Diagrams

C-11

Figure C-23 illustrates the syntax used to create an edit string index construct.
Refer to the description of the corresponding DTIF$_FMI aggregate in Chapter 5.

Figure C-23:

Edit String Index Syntax Diagram

EditStrindex ··=INTEGER

-- index into pref-editstrs

Figure C-24 illustrates the syntax used to create a numeric format type construct.
Refer to the description of the corresponding DTIF$_FMI aggregate in Chapter 5.

Figure C-24:

Numeric Format Type Syntax Diagram

NumericFmt ::=SEQUENCE {
numfmttype [0] IMPLICIT INTEGER {
numfmt-general
numfmt-integer
numfmt-fixedpt
numfmt-scientific
numfmt-money
numfmt-comma
numfmt-percent
numfmt-phone
numfmt-bar
numfmt-text
} OPTIONAL,
numfmtprec (1) IMPLICIT FmtPrec OPTIONAL

(0),
(1),
(2),
(3),
(4),
(5),
(6),
(7),
(8),
(9)

}

Figure C-25 illustrates the syntax used to create a numeric format precision
syntax diagram.
Refer to the description of the corresponding DTIF$_FMI aggregate in Chapter 5.

C-12 DTIF Syntax Diagrams

Figure C-25: Numeric Format Precision Syntax Diagram
FmtPrec
::=SEQUENCE
fmtprecdigits
[OJ IMPLICIT INTEGER OPTIONAL,
fmtprecfrac
[lJ IMPLICIT INTEGER OPTIONAL
}

Figure C-26 illustrates the syntax used to create a predefined text type construct.
Refer to the description of the corresponding DTIF$_FMI aggregate in Chapter 5.

Figure C-26:

Predefined Text Types Syntax Diagram

TextFmt
::=SEQUENCE {
textfmttype [OJ IMPLICIT INTEGER {
text-phone
text-text
text-repeat
} OPTIONAL

(0),
(1),
(2)

Figure C-27 illustrates the syntax used to create a predefined date type construct.
Refer to the description of the corresponding DTIF$_FMI aggregate in Chapter 5.

Figure C-27:

Predefined Date Types Syntax Diagram

DateFmt
::=SEQUENCE {
datefmttype [OJ IMPLICIT INTEGER {
date-dateonly
(0),
date-timeonly
(1),
date-dateandtime
(2)
} OPTIONAL,
datefmtorder [lJ IMPLICIT INTEGER {
dateorder-mdy (0),
dateorder-dmy (1)
} OPTIONAL

DTI F Syntax Diagrams

C-13

Figure C-28 illustrates the syntax used to create a format flags construct.
Refer to the description of the corresponding DTIF$_FMI aggregate in
Chapter 5.
Figure C-28:

Format Flags Syntax Diagram

FmtFlags ::=BIT STRING {
fmt-readonly
( 0) '
fmt-noreadonly
( 1) '
fmt-bold
(2) '
fmt-nobold
(3)'
fmt-italic
( 4)'
fmt-noitalic
( 5) '
fmt-underline
( 6) '
fmt-nounderline
(7)'
fmt-valuehidden
( 8) '
fmt-novaluehidden
( 9) '
fmt-formulahidden
(10)'
fmt-noformulahidden (11),
fmt-running
(12)'
fmt-norunning
(13)

Figure C-29 illustrates the syntax used to create a date time construct.
Refer to the description of the corresponding DTIF$_DAT aggregate in Chapter 5,
to the CFE$_DAT aggregate and CFE$_EXL aggregate in Chapter 6 and to the
ESF$_DAT aggregate in Chapter 7.
Figure C-29:

Date Time Syntax Diagram

DateTime ::=SEQUENCE {
datetime
[0] IMPLICIT OCTET STRING,
time-diff
[1] CHOICE {
UTC-time
[OJ IMPLICIT NULL,
plus-diff [1] IMPLICIT OCTET STRING,
neg-diff
[2] IMPLICIT OCTET STRING
} OPTIONAL

Figure C-30 illustrates the syntax used to create a date time construct.
Figure C-30:
ApplPrivate

C-14

Application Private Syntax Diagram
NamedValueList

DTIF Syntax Diagrams

Figure C-31 illustrates the syntax used to create a named value list construct.
Refer to the description of the corresponding DTIF$_NVL aggregate in Chapter 5
and to the ESF$_NVL aggregate in Chapter 7.
Figure C-31 : Named Value List Syntax Diagram
NamedValueList ::=SEQUENCE OF NamedValue
NamedValue ::=SEQUENCE {
value-name NamedValueTag,
value-data ValueData
}

Figure C-32 illustrates the syntax used to create a value data construct.
Refer to the description of the corresponding DTIF$_NVL aggregate in Chapter 5.

Figure C-32: Value Data Syntax Diagram
ValueData : := CHOICE {
value-boolean
value-integer
value-text
value-general
value-list
value-external
value-float
value-date
value-expr

[0)
[1]
[2)
[3)
[5)
[6)
[7)
[8]
[9)

IMPLICIT BOOLEAN,
IMPLICIT INTEGER,
IMPLICIT Text-String,
IMPLICIT OCTET STRING,
IMPLICIT SEQUENCE OF ValueData,
IMPLICIT EXTERNAL,
IMPLICIT FLOATING-POINT,
IMPLICIT DateTime,
Expression

Figure C-33 illustrates the syntax used to create an ASCII string construct.
Refer to the description of the corresponding DTIF$_CAT, DTIF$_DSC, DTIF$_
ERF, DTIF$_HDR, and DTIF$_NES aggregates in Chapter 5.
Figure C-33:

ASCII String Syntax Diagram

ASCIIString

··= Latinl-String

--- limited to ASCII character set

DTIF Syntax Diagrams C-15

Figure C-34 illustrates the syntax used to create a column number construct.
Refer to the description of the corresponding DTIF$_CCD aggregate in Chapter 5
and to the CFE$_EXL aggregate in Chapter 6.
Figure C-34:
ColNum

Column Number Syntax Diagram

::=INTEGER

Figure C-35 illustrates the syntax used to create a row number construct.
Refer to the description of the corresponding DTIF$_CCD aggregate in Chapter 5
and to the CFE$_EXL aggregate in Chapter 6.
Figure C-35:
RowNum

Row Number Syntax Diagram

: : = INTEGER

Figure C-36 illustrates the syntax used to create a cell coordinates construct.
Refer to the description of the corresponding DTIF$_CCD aggregate in Chapter 5
and to the CFE$_CCD aggregate and CFE$_EXL aggregate in Chapter 6.
Figure C-36:

Cell Coordinates Syntax Diagram

CellCoord ::=SEQUENCE {
cell-row
[0] IMPLICIT RowNum,
cell-column [1] IMPLICIT ColNum,
cell-flags [2] IMPLICIT INTEGER
relrow-relcol (0),
relrow-abscol (1),
absrow-relcol (2),
absrow-abscol (3)
} DEFAULT {relrow-relcol}

C-16 DTIF Syntax Diagrams

Figure C-37 illustrates the syntax used to create a range definition construct.
Refer to the description of the corresponding DTIF$_RNG aggregate in Chapter 5.

Figure C-37: Range Definition Syntax Diagram
RangeDefnList ::=SEQUENCE OF RangeDefn
RangeDefn ::=SEQUENCE {
range-name
[0] IMPLICIT Text-String OPTIONAL,
range-type
[l] IMPLICIT INTEGER {
rt-named-range
(0),
rt-view-range
(1),
rt-col-title
(2),
rt-row-title
(3),
rt-display-data (4),
rt-data-range
(5),
rt-sort-range
(6)
} DEFAULT {rt-named-range},
range-region
[2] IMPLICIT SEQUENCE OF Range OPTIONAL,
range-sort-keynum
[3] IMPLICIT INTEGER OPTIONAL
}

Figure C-38 illustrates the syntax used to create a range construct.
Refer to the description of the corresponding DTIF$_RNG aggregate in Chapter 5.

Figure C-38: Range Syntax Diagram
Range ::=CHOICE {
cell-range [0]
row-range
[l]
col-range
[2]
named-range [3]

IMPLICIT CellRange,
IMPLICIT RowRange,
IMPLICIT ColRange,
IMPLICIT NamedRange

}

DTIF Syntax Diagrams C-17

Figure C-39 illustrates the syntax used to create a cell range construct.
Refer to the description of the corresponding DTIF$_CLR aggregate in Chapter 5
and to the CFE$_EXL aggregate in Chapter 6.
Figure C-39:

Cell Range Syntax Diagram

CellRange ::=SEQUENCE {
range-begin [0] IMPLICIT CellCoord,
range-end
[1] IMPLICIT CellCoord OPTIONAL
}

Figure C-40 illustrates the syntax used to create a row range construct.
Refer to the description of the corresponding DTIF$_RWR aggregate in Chapter 5
and to the CFE$_EXL aggregate and CFE$_RWR aggregate in Chapter 6.
Figure C-40:

Row Range Syntax Diagram

RowRange ::=SEQUENCE {
row-begin [0] IMPLICIT RowNum,
row-end
[1] IMPLICIT RowNum OPTIONAL
}

Figure C-41 illustrates the syntax used to create a column range construct.
Refer to the description of the corresponding DTIF$_COR aggregate in Chapter 5
and to the CFE$_COR aggregate and CFE$_EXL aggregate in Chapter 6.
Figure C-41:

Column Range Syntax Diagram

ColRange ::=SEQUENCE {
col-begin [0] IMPLICIT ColNum,
col-end
[1] IMPLICIT ColNum OPTIONAL
}

Figure C-42 illustrates the syntax used to create a named range construct.
Refer to the description of the corresponding DTIF$_NMR aggregate in Chapter 5
and to the CFE$_EXL aggregate in Chapter 6.
Figure C-42:

Named Range Syntax Diagram

NamedRange ::=Text-String

C-18

DTIF Syntax Diagrams

Appendix D

CFE Syntax Diagrams
This appendix lists the syntax diagrams for each construct defined by CFE
(Canonical Form Expressions). The diagram for each construct is listed
alphabetically under Syntax diagrams in the index. For example, Figure D-1
shows the syntax used to create a CFE private expression and is listed as
PrivateFuncExpr under Syntax diagrams in the index. For a description of the
DDIS types referred to in the syntax diagrams, see Appendix B.
Figure D-1 illustrates the syntax used to create a private function expression
construct.
Refer to the description of the corresponding CFE$_EXL aggregate and to the
CFE$_PFE aggregate in Chapter 6.
Figure D-1:

Private Function Expression Syntax Diagram

PrivateFuncExpr ::=SEQUENCE {
pf-facility
[OJ
pf-name
[1]
pf-reference-label
[2]
pf-reference-label-type[3]
pf-return-type
[4]
{ fncret-numeric (0),
fncret-boolean (1),
fncret-date
(2),
fncret-text
(3)
OPTIONAL,
pf-pa rams
[5]

IMPLICIT ASCIIString,
IMPLICIT ASCIIString,
IMPLICIT ASCIIString OPTIONAL,
IMPLICIT StorageSystemTag OPTIONAL,
IMPLICIT BIT STRING
returns numeric value
returns boolean value
returns date value
returns text value
IMPLICIT SEQUENCE OF NamedParameter OPTIONAL

}

CFE Syntax Diagrams

D-1

Figure D-2 illustrates the syntax used to create a storage system tag construct.
Refer to the description of the corresponding CFE$_PFE aggregate in Chapter 6.
Figure D-2:

Storage System Tag Syntax Diagram

St'orageSystemTag

::= ASCIIString

Figure D-3 illustrates the syntax used to create a named parameter construct.
Refer to the description of the corresponding CFE$_NPM aggregate in Chapter 6.

Figure D-3:

Named Parameter Syntax Diagram

NamedParameter ::=SEQUENCE
param-name
[0] IMPLICIT Latinl-String OPTIONAL,
param-value [1] IMPLICIT ExpressionList
}

Figure D-4 illustrates the syntax used to create an expression construct.
Refer to the description of the corresponding CFE$_EXP aggregate in Chapter 6.
Figure D-4:

Expression Syntax Diagram

Expression ::= [PRIVATE 16376] IMPLICIT SEQUENCE
{ major-version [0] IMPLICIT INTEGER OPTIONAL, - omit within DTIF
minor-version [1] IMPLICIT INTEGER OPTIONAL, - omit within DTIF
expr-list
[2] IMPLICIT ExpressionList

D-2 CFE Syntax Diagrams

Figure D-5 illustrates the syntax used to create an expression list construct.
Refer to the description of the corresponding CFE$_CCD aggregate, CFE$_CFT
aggregate, CFE$_CLR aggregate, CFE$_COR aggregate, CFE$_DAT aggregate,
CFE$_EXL aggregate, CFE$_FRF aggregate, CFE$_PEX aggregate, CFE$_
PFE aggregate, CFE$_RWR aggregate, CFE$_SLL aggregate, CFE$_STF aggregate, CFE$_STP aggregate, CFE$_TXC aggregate, and CFE$_VTX aggregate in
Chapter 6.
Figure D-5:

Expression List Syntax Diagram

ExpressionList ::=SEQUENCE OF ExprChoice
ExprChoice ::=CHOICE
{

Variables/Literals
lit-integer
lit-float
lit-text
lit-date
lit-scaled-integer
lit-complex-float
lit-vtext

[0] IMPLICIT INTEGER,
[l] IMPLICIT FLOATING-POINT,
[2] Text,
[3] IMPLICIT DateTime,
[4] IMPLICIT SCALED-INTEGER,
[5] IMPLICIT ComplexFloat,
[6] IMPLICIT VaryingText,

cell-coord
cell-range
row-range
col-range
named-range
col-num
row-num
col-name
current-value
identifier

[8] IMPLICIT CellCoord,
[9] IMPLICIT CellRange,
[10] IMPLICIT RowRange,
[11] IMPLICIT ColRange,
[12] IMPLICIT NamedRange,
[13] IMPLICIT ColNum,
[14] IMPLICIT RowNum,
[15] IMPLICIT ASCIIString,
[179] IMPLICIT NULL,
[180] Text,

Functions:

varying length text
cell coordinate
cell range
row range
column range
named range
column number
column name

Listed in order of decreasing (perceived) frequency

Arithmetic Functions
negate
[16] IMPLICIT ExpressionList,
add
[17] IMPLICIT ExpressionList,
subtract
[18] IMPLICIT ExpressionList,
divide
[19] IMPLICIT ExpressionList,
multiply
[20] IMPLICIT ExpressionList,
power
[21] IMPLICIT ExpressionList,
unary-plus
[171] IMPLICIT ExpressionList,
percent
[172] IMPLICIT ExpressionList,

(continued on next page)

CFE Syntax Diagrams

D-3

Figure D-5 (Cont.):

Expression List Syntax Diagram

-- Boolean, Relational Expressions
if-then-else
[23) IMPLICIT ExpressionList,
not
[24) IMPLICIT ExpressionList,
and
[25) IMPLICIT ExpressionList,
or
[26) IMPLICIT ExpressionList,
eql
[27] IMPLICIT ExpressionList,
gtr
[28] IMPLICIT ExpressionList,
[29] IMPLICIT ExpressionList,
geq
lss
[30] IMPLICIT ExpressionList,
leq
[31) IMPLICIT ExpressionList,
neq
[32) IMPLICIT ExpressionList,
between
[33) IMPLICIT ExpressionList,
abs-value
[34) IMPLICIT ExpressionList,
modulo
[35) IMPLICIT ExpressionList,
sqrt
[36) IMPLICIT ExpressionList,
-- Statistical Functions
sum
[37) IMPLICIT SelectorList,
avg
[38] IMPLICIT SelectorList,
count
[39] IMPLICIT SelectorList,
min
[40] IMPLICIT SelectorList,
max
[41] IMPLICIT SelectorList,
stdev
[42) IMPLICIT SelectorList,
var
[43] IMPLICIT SelectorList,
-- Conversion Functions
cvt-to-value
[44] IMPLICIT ExpressionList,
round
[45] IMPLICIT ExpressionList,
truncate
[46] IMPLICIT ExpressionList,
int
[47] IMPLICIT ExpressionList,
decimal-string
[151) IMPLICIT DecimalString,

logical NOT
logical AND
logical OR
greater than
greater than or equal to
less than
less than or equal to
not equal to
absolute value
modulus
square root

average
minimum
maximum
standp.rd deviation
variance
-- convert to value

-- integer

-- Identification Functions
iserror
isblank
isnull
isdate
is number
is string
is ref
isnot-avail
isnot-calc

[48]
[49]
[50]
[51]
[52]
[53]
[54]
[173]
[174]

IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,

-- String Functions
str-char
[55]
str-code
[56]
str-concat
[57]
str-extract
[58)
str-f ind
[59]
str-fixed
[60)
str-format
[61)
{ source
[0]
edit-string [1]

IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT SEQUENCE
IMPLICIT ExpressionList,
Edit String

string character
string characater code
string concatenate
string extract
string find substring
string fixed
string format

(continued on next page)

D-4 CFE Syntax Diagrams

Figure D-5 (Cont.):

Expression List Syntax Diagram

str-left
[62) IMPLICIT ExpressionList,
str-length
(63] IMPLICIT ExpressionList,
str-lower
(64] IMPLICIT ExpressionList,
str-pretty
[65] IMPLICIT SEQUENCE
{ string-expr
[0] IMPLICIT ExpressionList,
pretty-flags
[1] IMPLICIT BIT STRING
{
pretty-collapse
(0),
pretty-compress
(1),
pretty-lowercase
(2),
pretty-trim
(3),
pretty-uncomment
(4),
pretty-upcase
(5) }

extract substring left
string length
string lowercase
string pretty

} I

str-proper
str-repeat
str-replace
str-reverse
str-right
str-trim
str-upper
contains
starts

(66] IMPLICIT ExpressionList,
[67] IMPLICIT ExpressionList,
[68] IMPLICIT ExpressionList,
(69] IMPLICIT ExpressionList,
[70] IMPLICIT ExpressionList,
(71] IMPLICIT ExpressionList,
[72] IMPLICIT ExpressionList,
[168] IMPLICIT ExpressionList,
[170) IMPLICIT ExpressionList,

-- Choose and Lookup Functions
choose
(73] IMPLICIT ExpressionList,
index
[74) IMPLICIT ExpressionList,
vlookup
[75] IMPLICIT ExpressionList,
hlookup
(76] IMPLICIT ExpressionList,
table
[77] IMPLICIT ExpressionList,
matches
[169] IMPLICIT ExpressionList,
in-table
[152] IMPLICIT ExpressionList,
-- Date/Time Functions
name-day
[78]
name-month
[79]
name-daynum
[80]
name-monthnum
(81]
now
(82]
today
[83]
tomorrow
[84]
yesterday
[85]
ext-day
(86]
ext-month
[87]
ext-year
(88]
ext-hour
[89)
ext-minute
[90]
ext..:..second
(91]
di ff-day
[92]
dif f-week
[93]
dif f-month
[94)

IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,

string proper
string repeat
string replace
string reverse
extract substring right
string trim
string uppercase
contains substring
string starts with

field in table
date day of the week
date month name
day of the week
month name

date/time extraction
date/time extraction
date/time extraction
date/time extraction
date/time extraction
date/time extraction
date/difference
date/difference
date/difference

(continued on next page)

CFE Syntax Diagrams

D-5

Figure D-5 (Cont.):

Expression List Syntax Diagram

dif f-year
di ff-hour
di ff-min
di ff-sec
cvt-to-date
cvt-to-time
plus-days
plus-weeks
plus-months
plus-years
plus-hours
plus-mins
plus-secs

[95] IMPLICIT ExpressionList,
[96] IMPLICIT ExpressionList,
[97] IMPLICIT ExpressionList,
[98] IMPLICIT ExpressionList,
[99] IMPLICIT ExpressionList,
[100] IMPLICIT ExpressionList,
[101] IMPLICIT ExpressionList,
[102] IMPLICIT ExpressionList,
[103] IMPLICIT ExpressionList,
(104] IMPLICIT ExpressionList,
(105] IMPLICIT ExpressionList,
(106] IMPLICIT ExpressionList,
(107] IMPLICIT ExpressionList,

date/difference
date/difference
date/difference
date/difference
convert string to date
convert string to time
date/time addition
date/time addition
date/time addition
date/time addition
date/time addition
date/time addition
date/time addition

-- Cell-Related Functions
error
(108] IMPLICIT NULL,
null
(109] IMPLICIT NULL,
cur-row
(110] IMPLICIT NULL,
current row
cur-col
[111] IMPLICIT NULL,
current column
cur-cell
(112] IMPLICIT NULL,
current cell
cell-row
(113] IMPLICIT ExpressionList,
cell row
cell-col
(114] IMPLICIT ExpressionList,
cell column
cell-name
(115] IMPLICIT ExpressionList,
cell name
(116] IMPLICIT ExpressionList,
count-rows
count rows
count-cols
(117] IMPLICIT ExpressionList,
count columns
cell-extract
(118] IMPLICIT ExpressionList,
cell extract
not-avail
(175] IMPLICIT NULL, -- not available
not-calc
[176] IMPLICIT NULL, -- not calculable
cell-indirect
[177] IMPLICIT ExpressionList, -- cell indirect
-- Financial Functions
apprec
(119] IMPLICIT ExpressionList,
dep-cross
(120] IMPLICIT ExpressionList,

dep-db

(121] IMPLICIT ExpressionList,

dep-ddb

(122] IMPLICIT ExpressionList,

dep-sline
dep-soyd

(123] IMPLICIT ExpressionList,
[124] IMPLICIT ExpressionList,

discount
fv
f va
fvpv
interest
irr
mirr

(125]
(126]
[127]
(128]
[129]
[130]
(131]

npv
payback
perpmt

(132] IMPLICIT ExpressionList,
[133] IMPLICIT ExpressionList,
(134] IMPLICIT ExpressionList,

perpv

(135] IMPLICIT ExpressionList,

IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,

appreciation
depreciation, declining
balance w/ crossover
to straight line
depreciation, declining
balance
depreciation, double
declining balance
depreciation, straight line
depreciation, sum of year's
digits
discount
future value
future value of an annuity
future value of a single sum
interest payments
internal rate of return
modified internal rate of
return
net present value
payback
number of periods to achieve
future value
number of periods given
present value

(continued on next page)

D-6

CFE Syntax Diagrams

Figure D-5 (Cont.): Expression List Syntax Diagram
pmtpv

(136] IMPLICIT ExpressionList,

pmtfv

(137] IMPLICIT ExpressionList,

principal
pva
pvf v

(138] IMPLICIT ExpressionList,
(139] IMPLICIT ExpressionList,
(140] IMPLICIT ExpressionList,

rate
perfv

(141] IMPLICIT ExpressionList,
(178] IMPLICIT ExpressionList,

-- Series Functions
loge st
(142]
ls qr
(143]
(144]
integrate
sigma
(145]
trend
(146]

IMPLICIT ExpressionList,
IMPLICIT ExpressionList;
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,
IMPLICIT ExpressionList,

-- Additional Constants
(147] IMPLICIT NULL,
lit-true
lit-false
(148] IMPLICIT NULL,
lit-pi
(149] IMPLICIT NULL,

payment per period given
present value
payment per period to achievE
future value
principal
present value of an annuity
present value to achieve
future value
interest rate
periods to achieve future
value

loge st
least squares
integrate
sigma
trend

TRUE
FALSE
PI

-- Miscellaneous Functions
random-u
(150] IMPLICIT NULL,
sign
(167] IMPLICIT ExpressionList,
parenthesized
(7] IMPLICIT ParenthesizedExpr,
private-function
(998] IMPLICIT PrivateFuncExpr,
field-reference
(999] IMPLICIT FieldRef,

random number
sign
parenthesized expression
private Function
field Reference

-- Trigonometric Functions
sin
(153] IMPLICIT ExpressionList,
(154] IMPLICIT ExpressionList,
cos
tan
(155] IMPLICIT ExpressionList,
a sin
(156] IMPLICIT ExpressionList,
a cos
(157] IMPLICIT ExpressionList,
atan
(158] IMPLICIT ExpressionList,
atan2
(159] IMPLICIT ExpressionList,

sine
cosine
tangent
arc sine
arc cosine
arc tangent
arc tangent 2

-- Transcendental Functions
loglO
(160] IMPLICIT ExpressionList,
logn
(161] IMPLICIT ExpressionList,
a log
(162] IMPLICIT ExpressionList,
factorial
(163] IMPLICIT ExpressionList,
exponent
(22] IMPLICIT ExpressionList,

log, base 10
log, base e
anti log
factorial
exponent

-- Binary Functions
asl
(164] IMPLICIT ExpressionList,
asr
(165] IMPLICIT ExpressionList,
ones-crop
(166] IMPLICIT ExpressionList,

arithmetic shift left
arithmetic shift right
one's complement

} -- End of ExprChoice CHOICE

CFE Syntax Diagrams

D-7

Figure D-6 illustrates the syntax used to create a text construct.
Refer to the description of the corresponding CFE$_EXL aggregate and to the
CFE$_TXC aggregate in Chapter 6.
Figure D-6:

Text Syntax Diagram

Text : : = CHOICE
latinl-text
[0] IMPLICIT Latinl-String,
simple-text
[1] IMPLICIT Character-String,
complex-text [2] IMPLICIT Text-String
}

Figure D-7 illustrates the syntax used to create a varying text construct.
Refer to the description of the corresponding CFE$_EXL aggregate and to the
CFE$_VTX aggregate in Chapter 6.
Figure D-7:

Varying Text Syntax Diagram

VaryingText

::= DTIF.VaryingText

Figure D-8 illustrates the syntax used to create a selector list construct.
Refer to the description of the corresponding CFE$_EXL aggregate and to the
CFE$_SLL aggregate in Chapter 6.
Figure D-8:

Selector List Syntax Diagram

SelectorList ::=SEQUENCE
{ criteria
[0] IMPLICIT ExpressionList OPTIONAL, - defaults to TRUE
selection [1] IMPLICIT ExpressionList

D-8 CFE Syntax Diagrams

Figure D-9 illustrates the syntax used to create a decimal string construct.
Refer to the description of the corresponding CFE$_EXL aggregate in Chapter 6.
Figure D-9:

Decimal String Syntax Diagram

DecimalString

::= Latinl-String

--- consisting of 0-9,

., +, -

Figure D-10 illustrates the syntax used to create an edit string construct.
Refer to the description of the corresponding CFE$_EXL aggregate and to the
CFE$_STF aggregate in Chapter 6.
Figure D-10:

Edit String Syntax Diagram

EditString

::= ESF.EditString

Figure D-11 illustrates the syntax used to create a parenthesized expression
construct.
Refer to the description of the corresponding CFE$_EXL aggregate and to the
CFE$_PEX aggregate in Chapter 6.
Figure 0.-:11 : Parenthesized Expressions Syntax Diagram
ParenthesizedExpr ::=SEQUENCE {
begin-expr
[0] IMPLICIT Text-String
OPTIONAL,
value-expr
[1] IMPLICIT ExpressionList,
end-expr
[2] IMPLICIT Text-String
OPTIONAL
}

Figure D-12 illustrates the syntax used to create a field reference construct.
Refer to the description of the corresponding CFE$_EXL aggregate and to the
CFE$_FRF aggregate in Chapter 6.
Figure D-12:

Field Reference Syntax Diagram

FieldRef ::=SEQUENCE
{

field-context
field-path

[0] IMPLICIT ContextVariable OPTIONAL,
[1] IMPLICIT SEQUENCE OF Latinl-String

CFE Syntax Diagrams

D-9

Appendix E

ESF Syntax Diagrams
This appendix lists the syntax diagrams for each construct defined by ESF (Edit
String Format). The diagram for each construct is listed alphabetically under
Syntax diagrams in the index. For example, Figure E-1 shows the syntax used to
create an ESF edit string and is listed as EditString under Syntax diagrams in
the index. For a description of the DDIS types referred to in the syntax diagrams,
see Appendix B.
Figure E-1 illustrates the syntax used to create an edit string construct.
Refer to the description of the corresponding ESF$_EDS aggregate in Chapter 7.
Figure E-1 : Edit String Syntax Diagram
EditString ::= [PRIVATE 16375) IMPLICIT SEQUENCE
{major-version [0] IMPLICIT INTEGER OPTIONAL,
minor-version [1) IMPLICIT INTEGER OPTIONAL,
edit-string
[2] IMPLICIT EditStrBuff

omit within DTIF
omit within DTIF

}

Figure E-2 illustrates the syntax used to create an edit string buffer construct.
Refer to the description of the corresponding ESF$_EDS aggregate in Chapter 7.
Figure E-2:

Edit String Buffer Syntax Diagram

EditStrBuff

::=SEQUENCE OF CHOICE
{ single-tag
repeat-tag [0]

Single,
IMPLICIT Repeat

ESF Syntax Diagrams

E-1

Figure E-3 illustrates the syntax used to create a single construct.
Refer to the description of the corresponding ESF$_EDS aggregate and to the
ESF$_TXT aggregate in Chapter 7.
Figure E-3:

Single Syntax Diagram

Single : := CHOICE {
alphabetic
am-pm
any-char
any-case
binary-digit
digit-sep
day-number
decimal-digit
radix-point
encoded-minus
encoded-plus
encoded-sign
exponent
zero-replace
currency
minus
plus
sign
f loat-blank-supr
fraction-second
hex-digit
hour-12
hour-24
julian-digit
logical-char
long-text
lowercase
minus-literal
minus-lit-end
minute
month-name
month-number
octal-digit
plus-literal
reverse
second
str-literal
missing-sep
uppercase
weekdayname
year
appl-private
digit-sep-lit
radix-point-lit
currency-lit
}

E-2 ESF Syntax Diagrams

[1]
[2]
[3]
[4]
[5]
[6]

IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
[7] IMPLICIT NULL,
[8] IMPLICIT NULL,
[9] IMPLICIT NULL,
[10] IMPLICIT NULL,
[11] IMPLICIT NULL,
[12] IMPLICIT NULL,
[13] IMPLICIT NULL,
[14]
[15]
[16]
[17]
[18]
[19]
[20]
[21]
[22]
[23]
[24]
[25]
[26]
[27]
[28]
[29]
[30]
[31]
[32]
[33]
[34]
[35]
[36]
[37]
[38]
[39]
[40]
[41]
[42]
[43]
[44]
[45]

IMPLICIT Text-String,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT Text-String,
IMPLICIT Text-String,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT Text-String,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT Text-String,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT NULL,
IMPLICIT ApplPrivate,
IMPLICIT Text-String,
IMPLICIT Text-String,
IMPLICIT Text-String

Figure E-4 illustrates the syntax used to create a repeat construct.
Refer to the description of the corresponding ESF$_EDS aggregate and to the
ESF$_RPT aggregate in Chapter 7.
Figure E-4:

Repeat Syntax Diagram

Repeat ::=SEQUENCE
{ repeat-count [0] IMPLICIT INTEGER,
repeat-seq
Single

Figure E-5 illustrates the syntax used to create an application private construct.
Refer to the description of the corresponding ESF$_EXT aggregate in Chapter 7.
Figure E-5:

Application Private Edit String. Syntax Diagram

ApplPrivate ::= NamedValueList

ESF Syntax Diagrams E-3

Appendix F

VMS Support for CDA in DECwindows
VMS commands and utilities, as well as existing application programs that accept
text input, can now use the text content of DECwindows compound documents.
To support the use of DDIF text, VMS RMS has implemented a new RMS file
attribute, stored semantics, and a DD IF-to-Text RMS extension. The value of the
stored semantics attribute is called the file tag; it specifies how file data is to
be interpreted. When file data is to be interpreted in accordance with the DDIF
specification, the appropriate file tag is DDIF. The use of file tags is limited to
disk files on VMS DECwindows systems.
The DDIF-to-Text RMS extension transparently extracts text from DDIF files
as variable-length text records that can be accessed through the VMS RMS
interface.
The enhancements made to support the reading of text from DDIF files are
transparent to the user and to the application programmer. This support requires
that all DDIF files in a VMS DECwindows environment be tagged with the
DDIF file tag. DDIF files created by VMS DECwindows software are tagged
appropriately.
Section F.1 describes various VMS file management commands and utilities
that display, create, and preserve file tags where appropriate. Section F.1 also
describes the way various VMS commands and utilities respond to DDIF file
input. Section F.2 describes VMS support for DDIF files in heterogeneous
computing environments. Section F.3 describes the changes made to the VMS
RMS program interface to support the stored semantics attribute and to control
access to the content of DDIF files.

F.1

VMS Commands and Utilities
This section describes the VMS commands and utilities that support tag
maintenance by displaying, creating, and preserving the RMS file tags used with
DDIF files. It also provides additional information that is relevant to the way
selected VMS commands and utilities respond to DDIF file input.
The following table lists the VMS commands and utilities that support tag
maintenance:
Command/Utility

Tag Maintenance Function

DIRECTORY/FULL

Displays file tag

ANALYZE/RMS_FILE

Displays file tag

SET FILE/SEMANTICS

Creates file tag

VMS Support for CDA in DECwindows

F-1

Command/Utility

Tag Maintenance Function

VMS MAIL

Preserves file tag 1

COPY
BACKUP

Preserves file tag1
Preserves file tag

1See text for exceptions.

Tags are made up of binary values that can be up to 64 bytes long and can be
expressed using hexadecimal notation. The hexadecimal value of the DDIF tag,
for example, is 2BOC8773010301. VMS permits you to assign mnemonics to tag
values so that DCL commands like DIRECTORY/FULL and VMS utilities like
FDL and ANALYZE/RMS_FILE display a mnemonic for the DDIF tag instead of
the hexadecimal value. The following DCL commands have been included in the
system startup command file to assign the mnemonic DDIF to the hexadecimal
value for a DDIF tag.
$
$

DEFINE/TABLE=RMS$SEMANTIC TAGS DDIF 2BOC8773010301

DEFINE/TABLE=RMS$SEMANTI(~OBJECTS "2BOC8773010301" DDIF

Using the appropriate DEFINE commands, you can assign mnemonics for other
tags, including tags used with international program applications.

F.1.1

Displaying RMS File Tags
The DIRECTORY/FULL command and the Analyze/RMS_File Utility now display
the RMS file tag for DDIF files.

F.1.1.1

DIRECTORY/FULL

Where applicable, the DIRECTORY/FULL command now provides the value of
the stored semantics tag as part of the file information returned to the user.
This is the recommended method for quickly determining whether or not a file is
tagged. The following display illustrates how the DIRECTORY/FULL command
returns the RMS attributes for a DDIF file named X.DDIF.
X.DDIF;l

RMS attributes:

F.1.1.2

File ID:

(767,20658,0)

Stored semantics: DDIF

ANALYZE/RMS_FILE

When you use the ANALYZE/RMS_FILE command to analyze a DDIF file, the
utility returns the file tag as an RMS file attribute.
FILE HEADER
File Spec: USERD$: [TEST]X.DDIF;l

Stored semantics: DDIF

F-2

VMS Support for CDA in DECwindows

One ANALYZE/RMS_FILE command option is to create an output FDL file that
reflects the results of the analysis.
$

ANALYZE/RMS_FILE/FDL filespec

When you use this option for analyzing a tagged file, the output FDL file includes
the file tag as a secondary attribute to the FILE primary attribute. This is
illlustrated in the following FDL file excerpt:
IDENT

" 9-JUN-1988 13:27:30

VMS/VMS ANALYZE/RMS_FILE Utility"

SOURCE

VMS

ALLOCATION

STORED SEMANTICS

%X'2BOC8773010301'

SYSTEM
FILE

F.1.2

DDIF

Creating RMS File Tags
The CDA$CREATE_FILE routine in the Compound Document Architecture
toolkit creates and tags DDIF files. However, you may encounter a DDIF file that
was created without a file tag or a DDIF file whose file tag was not preserved
during file processing.
The DCL command SET FILE provides a new qualifier, /[NO]SEMANTICS, that
permits you to tag a DDIF file through the DCL interface for VMS DECwindows
systems. You can also use the qualifier to change a tag or to remove a tag from a
file.
The following command line tags the file X.DDIF as a DDIF file by assigning the
appropriate value to the /SEMANTICS qualifier:
$

SET FILE X.DDIF/SEMANTICS=DDIF

See Section F.1 for information about how to use logical name tables to assign a
mnemonic to a tag.
A subsequent DIRECTORY/FULL command displays the following line as part of
the file header:

RMS attributes:

Stored semantics: DDIF

The next example illustrates how to use the SET FILE command to delete an
RMS file tag:
$

SET FILE X.DDIF/NOSEMANTICS

VMS Support for CDA in DECwindows

F-3

F.1.3

Preserving RMS File Tags and DDIF Semantics
The COPY command and the VMS Mail Utility preserve RMS file tags and DDIF
semantics when you copy or mail a DDIF file on a VMS DECwindows system,
except for conditions described in Section F.1.3.1 and Section F.1.3.2.
The Backup Utility always preserves file tags and semantics when you back up a
DDIF file to magnetic tape.

F.1.3.1

COPY Command

This section describes the results of using the COPY command with DDIF files
for various operations.
When you copy a DDIF file to a disk on a VMS DECwindows system using the
COPY command, VMS RMS preserves the DDIF tag and the DDIF semantics of
the input file in the output file.
When you copy a DDIF file to a nondisk device on a VMS DECwindows system
using the COPY command, VMS RMS does not preserve the DDIF tag or the
DDIF semantics of the input file in the output file. Instead, VMS RMS writes the
text from the input file to the output file as variable-length records.
When you copy two or more DDIF and text files in any combination to a single
output file, the output file takes the characteristics of the first input file, as shown
in the following examples.
1. In the first example, the first input file is a text file, so the output file
(FOO.TXT) contains variable-length text records from X.TXT, Y.DDIF, and
Z.TXT, but does not include the DDIF tag from Y.DDIF.
$

COPY X.TXT,Y.DDIF,Z.TXT FOO.TXT

2. In. the next example, the first input file (A.DD IF) is a DDIF file, so the output
file (FOO.DDIF) includes the DDIF tag as well as the DDIF semantics from
A.DDIF. The attempt to copy the text input file (Z.TXT) fails because there
is no Text-to-DDIF RMS extension, but the contents of B.DDIF and C.DDIF
are copied to the output file. However, the output file has no practical use
because, as a result of the way DDIF files are structured, only the data from
the first input file (A.DDIF) is accessible in the output file.
$

COPY A.DDIF,B.DDIF,Z.TXT,C.DDIF FOO.DDIF

3. In the final example, the first input file (A.DDIF) is a DDIF file, so the output
file (FOO.DDIF) includes the DDIF tag as well as the contents of A.DDIF.
FOO.DDIF also includes the contents of B.DDIF and C.DDIF. Again, however,
the output file has no practical use because, as a result of the way DDIF files
are structured, only the data from the first input file (A.DDIF) is accessible in
the output file.
$

F.1.3.2

COPY A.DDIF,B.DDIF,C.DDIF FOO.DDIF

VMS Mail Utility

The VMS Mail Utility preserves the DDIF file tag when DDIF files are mailed between systems running VMS DECwindows. The VMS Mail Utility also preserves
the DDIF file tag when you create an output file on a VMS DECwindows system
using the EXTRACT command.

F-4

VMS Support for CDA in DECwindows

When you read a mail message that is a DDIF file, the VMS Mail Utility outputs
only the text portion of the file. Similarly, if you edit a DDIF mail file, you can
access only the file text; the output file is a text file that can no longer be used as
a DDIF file. However, if you forward a message that consists of a DDIF file, the
VMS Mail Utility sends the entire DDIF file, including DDIF semantics and the
DDIF tag, to the addressee.

F.1.4

APPEND Command
This section describes what happens when you attempt to use the APPEND
command in conjunction with DDIF and text files.
In the first example, the APPEND command appends a DDIF file to a text file:
$ APPEND X. DDIF Y. TXT

The output file, Y.TXT, contains its original text records as well as text from the
input file, X.DDIF, reformatted as variable-length text records.
In the next example, the APPEND command appends a DDIF file to another
DDIF file:
$

APPEND X. DDIF Y. DDIF

The output file, Y.DDIF, contains the DDIF tag, the original contents of Y.DDIF,
and the contents of X.DDIF. However, the portion of the file that contains X.DDIF
is not accessible because of the way DDIF files are structured.
In the final example, the APPEND command attempts to append a text file to a
DDIF file:
$ APPEND X. TXT Y. DDIF

This append operation fails because there is no Text-to-DDIF RMS extension.

F.2 DDIF Support in a Heterogeneous Environment
This section describes the implementation of DDIF support in two heterogeneous
environments. The first heterogeneous environment includes VMS DECwindows
systems and non-VMS systems. The second heterogeneous environment includes
VMS DECwindows systems and VMS systems that do not support VMS
DECwindows.

F.2.1

EXCHANGE/NETWORK Command
A new DCL command, EXCHANGE/NETWORK, has been created to support the
transfer of files between VMS systems and non-VMS systems that do not support
VMS file types. The EXCHANGE/NETWORK command transfers files in either
record mode or block mode but can only be used when both systems support
DECnet file transfers.

VMS Support for CDA in DECwindows

F-5

To interactively tag a DDIF file and transfer the file between a non-VMS operating system and a VMS system running DECwindows, do the following:
1.

Create the following file, assigning it the name DDIF.FDL:
FILE
ORGANIZATION
STORED SEMANTICS

sequential
DDIF

CARRIAGE CONTROL
FORMAT
SIZE

none
fixed
512

RECORD

2. Use the following DCL command to transfer the desired file:
$

EXCHANGE/NETWORK/TRANSFER_MODE=block/FDL=DDIF.FDL input_filespec output_filespec

F.2.2

Using the COPY Command in a Heterogeneous Environment
If you use the COPY command to copy tagged DDIF files to systems other than

VMS DECwindows systems, the results will vary depending on the target system:
•

If the target system is a non-VMS system, the file is copied, but the DDIF tag

is not preserved.
•

If the target system is a VMS system that does not support VMS

DECwindows, the copy operation fails.

F.2.3

VMS Mail Utility in a Heterogeneous Environment
If you try to send mail messages containing DDIF files to non-VMS systems that

do not support tagged files, the VMS Mail Utility returns the NOACCEPTMSG
error message, indicating that the remote node cannot accept the message format.
Similarly, the VMS Mail Utility does not support the mailing of DDIF files to
VMS systems that do not support VMS DECwindows. As with non-VMS systems,
the VMS Mail Utility returns the NOACCEPTMSG error message, indicating
that the remote node cannot accept the message format.

F.3 VMS RMS Interface Changes
This section provides details about the changes made to the VMS RMS interface
that support access to text in VMS DECwindows DDIF files. It includes
information related to tagging files and accessing tagged files through the VMS
RMS interface. The section also describes how tags are preserved at the VMS
RMS interface.

F.3.1

Programming Interface for File Tagging
This appendix focuses on the use of the DDIF tag for supporting VMS
DECwindows files, although VMS RMS also supports file tagging for other
compound document data formats.
You can tag a file from the VMS RMS interface by using the $CREATE service
in conjunction with a new extended attribute block (XAB) called the item XAB
($XABITM). The $XABITM macro is a general-purpose macro that was added to
the RMS interface to support several Version 5.0 features. Tagged file support
involves the use of the two item codes shown in Table F-1.

F-6

VMS Support for CDA in DECwindows

Table F-1 : Tag Support Item Codes
Item

Buffer Size

Function

XAB$_STORED_SEMANTICS

64 bytes maximum

Defines the file semantics
established when the file is
created

XAB$_ACCESS_SEMANTICS

64 bytes maximum

Defines the file semantics
desired by the accessing
program

The entries XAB$_STORED_SEMANTICS and XAB$.;..ACCESS_SEMANTICS
in the item list can represent either a control (set) function or a monitor (sense)
function that can be passed to VMS RMS from the application program by way of
the RMS interface.
The symbolic value XAB$K_SEMANTICS_MAX_LEN represents the tag length.
This value may be used to allocate buffer space for sensing and setting stored
semantics for the DDIF file.
Within any one $XABITM, you can activate either the set function or the sense
function for the XAB$_STORED_SEMANTICS and XAB$_ACCESS_SEMANTICS
items, because a common field (XAB$B_MODE) determines which function is
active. If you want to activate both the set function and the sense function for
either or both items, you must use two $XABITM control blocks, one for setting
the functions and one for sensing the functions.
Each entry in the item list addressed by the $XABITM is made up of three
longwords, and a longword 0 terminates the list. You can locate the item list
anywhere within the readable address space for a process, but any buffers
required by the related function must be located in read/write memory. If the
item list is invalid, RMS returns a status of RMS$_XAB in the RAB$L_STS field
and the address of the XAB in RAB$L_STv.
The format and arguments of the $XABITM macro are as follows. Note that
the block length field and the type code field are statically initialized by the
$XABITM macro, or may be explicitly initialized using a high-level language.

Format
$XABITM

ITEMLIST=item-list-address,
MODE= { sensemode },
setmode
NXT=next-xab-address

Arguments
The ITEMLIST argument defaults to 0 but a valid pointer must be specified when
you use a XABITM. MODE defaults to sensemode. The symbolic offset, size, and
a brief description of each XABITM field are described in the following list:
•

The block length field (XAB$B_BLN) is a 1-byte static field that defines the
length of the XABITM, in bytes. This field is initialized to the value XAB$C_
ITMLEN.

•

The type code (XAB$B_COD) field is a 1-byte static field that identifies this
control block as a XABITM. This field is initialized to the value XAB$C_ITM.

VMS Support for CDA in DECwindows

F-7

F-8

•

The XAB$L_ITEMLIST field is a longword field that contains the symbolic
address of the item list.

•

The XAB$B_MODE field is a 1-byte field that specifies whether or not the
items can be set by the program. It contains either the symbolic value
XAB$K_SETMODE or the symbolic value XAB$K_SENSEMODE (default).

•

The XAB$L_NXT field is a longword field that contains the symbolic address
of the next XAB in the XAB chain. A value of 0 (the default) indicates that
the current XAB is the last (or only) XAB in the chain.

VMS Support for CDA in DECwindows

Example F-1 illustrates a BLISS-32 program that tags a file through the RMS
interface. The tag value shown is a 6-byte hexadecimal number representing
the code for the DDIF tag. The VMS RMS program interface accepts only
hexadecimal tag values.
To write to a tagged file without using an RMS extension, the application program
must specify access semantics that match the file's stored semantics. As shown
in the example, the $CREATE service tags the file and the $CONNECT service
specifies the appropriate access semantics.
Example F-1: Tagging a File
MODULE TYPE$MAIN (
IDENT = 'X-1' I
MAIN = MAIN,
ADDRESSING MODE (EXTERNAL=GENERAL)
) =
BEGIN
FORWARD ROUTINE
MAIN : NOVALUE;

Main routine

INCLUDE FILES:
LIBRARY 'SYS$LIBRARY:LIB';
OWN
NAM
: $NAM() I
RETLEN,
DDIF TAG
: BLOCK[ 7, BYTE]
INITIAL { BYTE { %X' 2B' I %X' OC' I %X' 87' %X' 7 3 I I
%X'03', %X'01')),
FAB XABITM
$xabitm
( itemlist=
$ITMLST_UPLIT

%X' 01' I

(

(ITMCOD=XAB$_STORED SEMANTICS,
BUFADR=DDIF_TAG,
BUFSIZ=%ALLOCATION(DDIF_TAG))
)

SE~MODE),

mode=
RAB XABITM

$xabitm
( itemlist=
$ITMLST_UPLIT
(

(ITMCOD=XAB$_ACCESS SEMANTICS,
BUFADR=DDIF_TAG,
BUFSIZ=%ALLOCATION(DDIF_TAG))

mode = SETMODE) ,

(continued on next page)

VMS Support for CDA in DECwindows

F-9

Example F-1 (Cont.): Tagging a File
FAB

REC
STATUS,
RAB

DESC

: $FAB( fnm = 'TAGGED-FILE.TEST',
nam = NAM,
mrs = 512,
rfm = FIX,
fac = <GET,PUT,UPD>,
xab = FAB_XABITM),
BLOCK[512,BYTE],
$RAB( xab = RAB_XABITM,
f ab = FAB,
rsz = 512,
rbf = REC,
usz = 512,
ubf = REC),
BLOCK[8,BYTE] INITIAL(O);

ROUTINE MAIN
NOVALUE =
BEGIN
STATUS= $CREATE( FAB = FAB );
IF NOT .STATUS
THEN
SIGNAL (.STATUS);
STATUS= $CONNECT( RAB
RAB);
IF NOT .STATUS
THEN
SIGNAL (.STATUS);
STATUS= $CLOSE( FAB = FAB );
IF NOT .STATUS
THEN
SIGNAL (.STATUS);
END;
END
ELUDOM

F.3.2

Accessing a Tagged File
This section provides details of how VMS RMS handles access to tagged files
at the program level. When a program accesses a tagged file, VMS RMS must
determine whether and when to associate an RMS extension with the access.
This is important to the programmer because an RMS extension may change the
attributes of the accessed file.
For example, a DDIF file is stored as a sequentially organized file having 512byte, fixed-length records. If the DDIF-to-Text RMS extension is used to extract
text data from a DDIF file, the accessed file appears as a sequentially organized
file having variable-length records with an implicit carriage return.
One consideration in determining whether an access requires the RMS extension
is the type of access (FAB$B_FAC). When an application program opens a file
through the VMS RMS program interface, it must specify whether it will be doing
record I/O (default), block I/O (BIO), or mixed I/O (BRO), where the program has
the option of using either block I/O or record 1/0 for each access. For example,
if block I/O operations are specified, VMS RMS does not associate the RMS
extension with the file access.

F-10 VMS Support for CDA in DECwindows

Another consideration is whether the program senses the tag when it opens a file.
If the program does not sense the tag when it opens a DDIF file for record access,
VMS RMS associates the RMS extension during the $OPEN and returns the file
attributes that have been modified by the extension.
The final consideration is the access semantics the program specifies and the
file's stored semantics (tag). If the program specifies block I/O (FAB$V_BIO)
operations, RMS does not associate the RMS extension and the $OPEN service
returns the file's stored attributes to the accessing program regardless of whether
the program senses tags.
F.3.2.1

File Accesses That Do Not Sense Tags

This section describes what happens when a program does not use the XABITM
to sense a tag when it opens a file.
When a program opens a DDIF file for record operations and does not sense the
tag, VMS RMS assumes that the program wants to access text data in the file. In
this case, VMS RMS associates the RMS extension, which provides file attributes
that correspond to record-mode access.
When a program opens a DDIF file with the FAB$V_BRO option and does not
sense the tag, any subsequent attempt to use block I/O fails. If the program
specifies block 1/0 (FAB$V_BIO) when it invokes the $CONNECT service, the
operation fails because the file attributes returned at $OPEN permit record
access only. Similarly, if the program specifies the FAB$V_BRO option when it
opens the file, and then specifies mixed mode (block/record) operations by not
specifying RAB$V_BIO at $CONNECT time, block operations such as READ and
WRITE are disallowed.
F.3.2.2

File Accesses That Sense Tags

VMS RMS does not associate the RMS extension as part of the $OPEN service
if a program opens a DDIF file and senses the stored semantics. This allows the
program to specify access semantics with the $CONNECT service. VMS RMS
returns the file attributes, including the stored semantics attribute (tag value), to
the program as part of the $OPEN service.
When the program subsequently invokes the $CONNECT service, VMS RMS uses
the specified operations mode to determine its response. If the program specified
FAB$V_BRO with the $OPEN service and then specifies block I/O (RAB$V_BIO)
when it invokes the $CONNECT service, VMS RMS does not associate the RMS
extension.
But if the program specifies record access or FAB$V_BRO when it opens the
file and then decides to use record I/O when it invokes the $CONNECT service,
VMS RMS compares the access semantics with the file's stored semantics to
determine whether to associate the RMS extension. If the access semantics
match the stored semantics, VMS RMS does not associate the RMS extension. If
the access semantics do not match the stored semantics, VMS RMS associates
the access with the RMS extension. In this case, the program must use the
$DISPLAY service to obtain the modified file attributes. If VMS RMS cannot find
the appropriate RMS extension, the operation fails and the $CONNECT service
returns the EXTNOTFOU error message.
If the application program senses the file's stored semantics, VMS RMS allows
mixed-mode operations. In this case, mixed block and record operations are
permitted because the application gets record mode file attributes and data from
the RMS extension and block mode file attributes and data from the file.

VMS Support for CDA in DECwindows

F-11

Example F-2 illustrates a BLISS-32 program that accesses a tagged file from an
application program that does not use an RMS extension.
Example F-2:

Accessing a Tagged File

MODULE TYPE$MAIN (
IDENT = 'X-1',
MAIN = MAIN,
ADDRESSING MODE (EXTERNAL=GENERAL)
)

BEGIN
FORWARD ROUTINE
MAIN : NOVALUE;

Main routine

INCLUDE FILES:
LIBRARY 'SYS$LIBRARY:STARLET';
OWN
NAM
: $NAM(),
ITEM BUFF
BLOCK[ XAB$K_SEMANTICS MAX LEN,BYTE ],
RETLEN,
FAB XABITM
$xabitm
itemlist=
$ITMLST_UPLIT
((ITMCOD=XAB$_STORED SEMANTICS,
BUFADR=ITEM_BUFF,
BUFSIZ=XAB$K_SEMANTICS_MAX_LEN,
RETLEN=RETLEN)),
mode= SENSEMODE),
RAB ITEMLIST
RAB XABITM

FAB

REC
STATUS,
RAB

DESC

BLOCK [ ITM$S_ITEM + 4, BYTE ] ,
$XABITM
itemlist=RAB_ITEMLIST,
mode=SETMODE ) ,
$FAB( fnm = 'TAGGED-FILE.TEST',
nam
NAM,
fac = <GET,PUT,UPD>,
xab = FAB_XABITM),
BLOCK[512,BYTE],
$RAB( xab
RAB_XABITM,
f ab
FAB,
rsz
512,
rbf
REC,
usz
512,
ubf
REC),
BLOCK[8,BYTE] INITIAL(O);

(continued on next page)

F-12

VMS Support for CDA in DECwindows

Example F-2 (Cont.):

Accessing a Tagged File

ROUTINE MAIN : NOVALUE =
BEGIN
STATUS= $OPEN( FAB = FAB );
IF NOT .STATUS
THEN
SIGNAL (.STATUS);
RAB_ITEMLIST[ ITM$W_BUFSIZ
= .RETLEN;
RAB_ITEMLIST[ ITM$L_BUFADR
= ITEM BUFF;
RAB_ITEMLIST[ ITM$W_ITMCOD
= XAB$=ACCESS_SEMANTICS;
STATUS= $CONNECT( RAB= RAB);
IF NOT .STATUS
THEN
SIGNAL (.STATUS);
STATUS= $CLOSE( FAB = FAB );
IF NOT .STATUS
THEN
SIGNAL (.STATUS);
END;
END
ELUDOM

F.3.3

Preserving Tags
In order to preserve the integrity of a tagged file that is being copied or transmitted, the tag must be preserved in the destination (output) file. The most efficient
way to use the RMS interface for propagating tags is to open the source file
(input) and sense the tag using a $XABITM with the item code XAB$_STORED_
SEMANTICS:

ITEMLIST[
ITEMLIST[
ITEMLIST[
ITEMLIST[

ITM$W BUFSIZ
ITM$L-BUFADR
ITM$L-RETLEN
ITM$W=ITMCOD

= XAB$K_SEMANTICS_MAX_LEN;
= ITEM_BUFF;
= RETLEN;
XAB$_STORED_SEMANTICS;

XABITM[ XAB$B MODE ] = XAB$K SENSEMODE;
STATUS= $OPEN( FAB = FAB );-

Then create the destination (output) file and set the tag using a $XABITM with
the item code XAB$_STORED_SEMANTICS:

IF .RETLEN GTR 0
THEN
BEGIN
ITEMLIST[ ITM$W_ITMCOD ] = XAB$_STORED_SEMANTICS;
ITEMLIST[ ITM$L_SIZE
] = .RETLEN;
XABITM[ XAB$B_MODE ] = XAB$K_SETMODE;
END;

VMS Support for CDA in DECwindows

F-13

STATUS= $CREATE( FAB = FAB );

END;
END
ELUDOM

F.4 Distributed File System Support for DDIF Tagged Files
Version 1.1 of the Distributed File System (DFS) includes limited support
for DDIF tagged files. You can create and read DDIF files on a DFS device
when the DFS client node is running VMS DECwindows. You can also use the
DIRECTORY/FULL command to determine whether or not a DDIF file on a DFS
device is tagged.
You cannot use the SET FILE/[NO]SEMANTICS command either to tag DDIF
files or to remove the tags from DDIF files on a DFS device. Furthermore, the
Backup Utility does not preserve the DDIF tag or the DDIF stored semantics for
data files on a DFS device.

F.5 VMS RMS Errors
Four VMS RMS error messages signal the user when the appropriate error
condition exists:
•

RMS$_EXTNOTFOU

•

RMS$_SEMANTICS

•

RMS$_EXT_ERR

•

RMS$_0PNOTSUP

The RMS$_EXTNOTFOU error message indicates that VMS RMS has not found
the specified RMS extension. Verify that the file is correctly tagged, using the
DIRECTORY/FULL command, and that the application program is specifying the
appropriate access semantics.
VMS RMS returns the RMS$_SEMANTICS error message when you try to create
a tagged file on a remote VMS system that does not support VMS DECwindows
from a system that does support VMS DECwindows.
VMS RMS returns the RMS$_EXT_ERR error when the DDIF RMS extension
detects an inconsistency.
VMS RMS retums the RMS$_0PNOTSUP error when the RMS DDIF extension
is invoked by an RMS ·operation. For example, if the extension does not support
write access to a DDIF file, verify that the application program is not performing
record operations that modify the file.

F-14 VMS Support for CDA in DECwindows

Appendix G

CDA$ Facility Messages
This appendix lists the CDA$_ facility messages generated by the CDA Toolkit.
A brief explanation and recommended user action follows each message, unless
a user action is not required. The messages are listed in alphabetical order, by
message name.
ALLOCFAIL, memory allocation failure

Level: Error
Explanation: The standard memory allocation procedure failed to
allocate dynamic memory.
CLOSEFAIL, close failure

Level: Error
Explanation: The standard close function has failed.
DCVNOTFND, domain converter not found

Level: Error
Explanation: The required domain converter could not be found.
DEFAULT, item present by default

Level: Success
Explanation: The application called CDA$LOCATE_ITEM, which
determined that the item was present by default in the input stream.
DEFNOTFOU, definition not found

Level: Error
Explanation: The application called CDA$FIND_DEFINITION referencing an entity that is not defined.
EMPTY, empty item

Level: Error
Explanation: The application called a CDA access procedure referencing an item that is empty.
ENDOFDOC, end of document

Level: Error
Explanation: The application called CDA$GET_AGGREGATE, which
determined that no more aggregates exist in the document.

CDA$ Facility Messages

G-1

ENDOFSEQ, end of sequence

Level: Error
Explanation: The application called CDA$NEXT_AGGREGATE referencing an aggregate that was at the end of a sequence.
ERRINPLOG, error messages produced during
input conversion, see error log

Level: Error
Explanation: The input conversion did not complete and some error
messages were produced.
User Action: Refer to the error log for more details.
ERROUTLOG, error messages produced during
output conversion, see error log

Level: Error
Explanation: The output conversion did not complete and some error
messages were produced.
User Action: Refer to the error log for more details.
FLTTRN, floating-point truncation

Level: Error
Explanation: During CDA$LOCATE_ITEM for a general floating-point
value, floating truncation occurred.
ICVNOTFND, input converter not found

Level: Error
Explanation: The specified input converter could not be found.
INDEX, index out of range

Level: Error
Explanation: The application called CDA$LOCATE_ITEM, CDA$STORE_
ITEM, or CDA$ERASE_ITEM referencing an array-valued item, but the
index is out of range.
INFINPLOG, informational messages produced during
input conversion, see error log

Level: Informational
Explanation: The input conversion completed but some informational
messages were produced.
User Action: Refer to the error log for more details.
INFOUTLOG, informational messages produced during
output conversion, see error log

Level: Informational
Explanation: The output conversion completed but some informational
messages were produced.
User Action: Refer to the error log for more details.

G-2 CDA$ Facility Messages

INHERIT, item present by inheritance

Level: Success
Explanation: The application called CDA$LOCATE_ITEM, which
determined that the item was present by inheritance in the input
stream.
INTERR, internal error

Level: Fatal
Explanation: The CDA Toolkit detected an internal error.
INVADDINF, invalid additional information

Level: Error
Explanation: The add-info parameter in a call to CDA$LOCATE_ITEM
or CDA$STORE_ITEM is invalid.
INVAGGTYP, invalid aggregate type

Level: Error
Explanation: The application called a CDA access procedure referencing an aggregate type code that is undefined, or an aggregate that has
an undefined type code.
INVBUFLEN, invalid buffer length

Level: Error
Explanation: The application called CDA$_STORE_ITEM referencing
an item that is required to have a specified buffer length. The value of
the buffer length parameter is not the required value.
INVDATLEN, invalid data length

Level: Error
Explanation: The length of the value data exceeded the specified length
for the data type.
INVDOC, invalid document syntax

Level: Error
Explanation: The CDA access procedures determined that the document contains invalid syntax.
INVFLTVAL, invalid floating-point value

Level: Error
Explanation: A floating-point datum has a reserved value.
INVFUNCOD, invalid function code

Level: Error
Explanation: The application called CDA$CONVERT with an invalid
function code.

CDA$ Facility Messages

G-3

INVINPDMN, invalid input domain
Level: Error
Explanation: An invalid input domain was specified for the front end.
Only DDIF and DTIF are supported as domains.
INVINSERT, invalid insert
Level: Error
Explanation: The application called CDA$INSERT_AGGREGATE or
CDA$STORE_ITEM referencing an aggregate that was already part of a
sequence, but was not the first aggregate of the sequence.
INVITMCOD, invalid item code
Level: Error
Explanation: The application called a CDA access. procedure referencing an aggregate item code that is not defined.
INVITMLST, invalid item list
Level: Error
Explanation: The application called CDA$0PEN_FILE or CDA$CREATE_
ROOT_AGGREGATE with a processing options item list that contained
an invalid item.
INVOPTION, invalid converter option
Level: Error
Explanation: An invalid option was specified for the converter.
User Action: Refer to the documentation for this converter to see the
valid options.
INVOUTDMN, invalid output domain
Level: Error
Explanation: An invalid output domain was specified for the back end.
Only DDIF and DTIF are supported as domains.
INVSCOCOD, invalid scope code
Level: Error
Explanation: The application called CDA$ENTER_SCOPE or
CDA$LEAVE_SCOPE referencing a scope code that is not defined or
invalid in following correct document scoping rules.
INVSCOTRAN, invalid scope transition
Level: Error
Explanation: The application made a call to CDA$ENTER_SCOPE or
CDA$LEAVE_SCOPE that did not follow correct scoping rules.
INVTAGCOD, invalid tag code
Level: Error
Explanation: The application called CDA$_STORE_ITEM referencing
an item that has a special tag encoding, but the value of the add-info
parameter is not defined for the item.
G-4 CDA$ Facility Messages

NORMAL, normal successful completion
Level: Success
Explanation: The specified action has been successfully completed.
OCVNOTFND, output converter not found
Level: Error
Explanation: The specified output converter could not be found.
OPENFAIL, open failure
Level: Error
Explanation: The standard open function has failed.
READFAIL, read failure
Level: Error
Explanation: The standard read function has failed.
READONLY, aggregate is read-only
Level: Error
Explanation: The application requested input processing options that
require an aggregate to be read-only. The application attempted to write
or delete the aggregate.
SUSPEND, converter is suspended
Level: Success
Explanation: The application called CDA$CONVERT, which determined that the back end suspended conversion. This message can only
be returned by the CDA viewer.
UNSUPCNv, unsupported document conversion
Level: Error
Explanation: The input and output document formats are incompatible
for conversion.
UNSUPFMT, unsupported document format
Level: Error
Explanation: The application called CDA$CONVERT with an unsupported document format name. The document format name may be
misspelled, or the required conversion module may not be installed.
VAREMPTY, empty variant item
Level: Error
Explanation: The application called CDA$LOCATE_ITEM, CDA$STORE_
ITEM, or CDA$ERASE_ITEM referencing an item that has a variable
data type. The item that specifies the data type is empty.

CDA$ Facility Messages

G-5

VARINDEX, variant index out of range
Level: Error
Explanation: The application called CDA$LOCATE_ITEM, CDA$STORE_
ITEM, or CDA$ERASE_ITEM referencing an array-valued item that has
a variable data type, but the index is out of range for the item that
specifies the data type.
VARVALUE, variant value out of range
Level: Error
Explanation: The application called CDA$LOCATE_ITEM, CDA$STORE_
ITEM, or CDA$ERASE_ITEM referencing an item that has a variable
data type, but the item that specifies the data type has an invalid value.
VERSKEW, major version skew between
input file and CDA Toolkit
Level: Error
Explanation: The file's major version is different from the Toolkit's.
Thus, the Toolkit cannot properly process the file.
WRITFAIL, write failure
Level: Error
Explanation: The standard write function has failed.

G-6

CDA$ Facility Messages

Glossary of Terms

This glossary alphabetically lists and defines terminology associated with the
CDA architecture, data structures, and routines.
add-info
Additional information. This is a parameter to the LOCATE ITEM and
STORE ITEM routines.
aggregate
An in-memory structure that is used to pass compound document data
between the application and the CDA Toolkit routines. An aggregate
corresponds to a manageable unit of the compound document. Aggregates
are typed and self-describing; the type of an aggregate is indicated by a
symbolic constant. An aggregate can be a member of an aggregate sequence,
which can be traversed from beginning to end. Aggregates are defined for
such objects as document roots, document descriptors, document headers,
document segments, text content, and so on.
AngleRef enumeration
A compound document data type that is an enumeration specifying the data
type of an item of DDIF type AngleRef, which is encoded as a floating-point
or string value.
arc

A graphics object representing a circle or piece of a circle.
attribute
A term used to describe content characteristics such as font, line thickness,
and color.
back end
A CDA application that converts a document from DDIF or DTIF format into
a document in another format, such as PostScript or plain text.
bit string
A compound document data type that is encoded as a string of bits. The
length of the item is expressed in bits.

BMU
Basic Measuring Unit. A BMU is 111200 of an inch.
Boolean
A compound document data type, encoded as a byte, that represents a
Boolean value, which is always either True or False.

Glossary-1

byte
A compound document data type that is encoded as 8-bits of storage. The
term "octet" is also used to describe an 8-bit byte.
calling format
A calling format is the interface specification for a routine. The calling format
describes how the routine is to be called by other routines. The specification
includes the routine's name or address, and all of the routine's parameters.
CDA

Compound Document Architecture. An architecture for interchanging
complex and simple data in a computer architecture independent manner.
CFE

Canonical Form Expressions. A CDA format for defining revisable expressions
at the cell or column level within a DTIF document.
character string
A compound document data type that is encoded as a string of bytes in a
particular character set.
compound document
A unified collection of data that can be edited, formatted, or otherwise
processed as a document.
computed content
Document content (most often text content) that is calculated based on the
current formatting state or other inclusion of external data. For example,
page numbers are often stored as computed content.
condition value
An error that causes normal processing to stop is called a condition. The
condition value identifies the error that caused processing to stop.
content
The class of data that makes up the fundamental units of documents.
Document content includes text, graphics, raster images, and so on. The
standard content aggregates are the basic units of content.
content reference
A shorthand notation for the phrase "reference to generic content." A content
reference is a relationship in a revisable document that defines the situation
in which a content reference causes the generic content to be inserted into the
final form when the document is formatted.
content tag
CDA content is uniquely identified by the context it appears in and a tag. For
example, the tag for DDIF Latinl text content is DDIF$_TXT.
converter
A CDA application that converts data to or from a CDA format. See also,
front end, back end, base system converter, and third-party converter.
DOif

Digital Document Interchange Format. A CDA format that can be used to
interchange simple or complex documents containing text, images, and/or
graphics.
Glossary-2

ODIS
Digital Data Interchange Syntax. A method of encoding data for machineindependent interchange. DDIS is a subset of the International Standards
Organization Open Systems Interconnect ASN.1 transfer syntax.
DTIF
Digital Table Interchange Format. A CDA format that can be used to
interchange simple or complex spreadsheet data.
document
An entire hierarchical structure in memory, created by the CDA Toolkit
routines.
document content
See content.
document segment
See segment.
enumeration
Assigns names to numbers or bits. Enumeration is a compound document
data type that is encoded as a longword integer. An item that is encoded as
an enumeration must specify the possible values for the enumeration. If the
item following the enumeration item is of DDIF type variable, then the value
selected for the enumeration item affects the encoding of the subsequent
item.
ESF
Edit String Format. A CDA format for defining revisable, user-defined
edit strings that define specialized display formats for numeric, text, and
date/time data values.
expression enumeration
A compound document data type that is an enumeration that specifies the
data type of an item of DDIF type expression.
final form
Stage of a document in which all the formatting decisions (such as
hyphenation, line breaks, and page breaks) have been resolved. Final form
documents are generally not revisable/editable.
floating-point
See general floating-point and single-precision :floating-point.
formatting
The process of fixing text in galleys. Formatting involves breaking the stream
of characters and :floating frames into lines that fit within the assigned
galleys. Formatting can also involve optimization of page layouts, the
selection of appropriate page templates, and hyphenation decisions.
frame
A DDIF frame specifies a region in a document. The frame region may be
anchored to a particular place in a document, or it may be associated with a
section of text. Content within the frame is positioned relative to the frame.
Graphics and image content must always be contained in a frame of the
appropriate content category.

Glossary-3

front end converter
A CDA application that converts a document or data from a particular format
to a CDA format. For example, the WKl front end converts Lotus 1-2-3
spreadsheets to DTIF format.
galley
A rectangular guide, such as a column or footnote area. DDIF galleys are
modeled by areas that are filled with text and relocatable illustrations during
the formatting process.
galley-based layout
In galley-based layout, characters and frames flow through a set of connected
galleys and across pages instead of being fixed with respect to a coordinate
system.
general floating-point
A floating-point value for which the format is specified by the add-in
parameter. Upon storing a floating-point value, the CDA Toolkit transforms
the value to a generic DDIS H-floating-point value. During a call to the
LOCATE ITEM routine, an application specifies whether the DDIS-encoded
floating-point data should be converted to VAX or IEEE format by the CDA
Toolkit.
generic attributes
A relationship in a revisable document that defines attributes that can be
applied to a number of segments, as opposed to being associated with a single
segment.
generic content
A relationship in a revisable document that defines document content that
can be included in multiple places in the document.
generic layout
A set of rules that are used to determine the layout of a document or set of
documents.
generic type
A relationship in a revisable document that defines a set of attributes and
processing tags that define a type. Elements of the document can reference
a defined type and become an instance of the type, thus inheriting the
attributes and processing characteristics of the generic type.
GKS

Graphical Kernel System. A standard way of specifying graphics objects.
graphics content
Content that consists of primitives such as arcs, polylines, and filled areas.
handle
The identifier of an aggregate, stream, file, front end, or back end.
hard content
Content that is entered by the creator of the document.
image content
Content that consists of digitized images represented by actual values of
monochrome, grey-level, or color pixels.
Glossary--4

inheritance
A relationship in a revisable document that defines a method for defaulting
the attributes of content so that each segment of content does not need to
specify all its attributes. Instead, each segment inherits the attributes of
the surrounding segment, and specifies only the differences between the
attributes of its content and those of the surrounding content.
integer
A compound document data type that represents a longword integer.
item
A specific unit of information stored in an aggregate.
item change list
A compound document data type that specifies a vector of longwords in which
each longword contains the item code of an item in a segment attributes
aggregate that has changed.
kerning
In typesetting, subtracting the space between two characters so that they
appear closer together.
language
One of the languages specified by ISO 639.
leaders
In composition, rows of dashes or dots that are used to guide the eye across
the page. Leaders are used in tabular work, programs, tables of contents, and
so on.
leading
In composition, the distance between lines of type, measured in points.
legend
Like the legend of a map, the DDIF legend is used to describe the coordinate
system of a segment. The legend information is used to indicate the scale of
an illustration. See also Measurement.
longword
A compound document data type representing a 32 bit-encoded structure.
The bits are interpreted according to a defined structure.
marker
An object used to mark a place. For example, markers can be used to mark
data points on a graph.
measurement
DDIF measurements are specified using the units-per-measure segment
attribute. By default, all measurements are in BMUs, 1/1200 of an inch.
Scaling can be accomplished changing the units-per-measure for a document,
or by using a transformation aggregate.
measurement enumeration
A compound document data type that is an enumeration specifying the data
type of an item of DDIF type measurement, which is encoded as an integer or
string.

Glossary-5

object identifier
A com pound document data type that contains two or more longwords that
specify the value of the DDIS type object identifier. Object identifiers are
used to uniquely identify a class of object.
octet
An 8-bit byte.
page
A unit of display, such as a traditional sheet of paper, a video display, or a
35mm slide. A page is a discrete unit of content presented for viewing.
raster image content
See image content.
revisable document
A document that contains abstract relationships between the components of
the document. That is, the characteristics of the document that determine
the final appearance are specified as parameters and directives that are used
to create the final form.
root aggregate
An aggregate that represents the root of the in-memory document hierarchy.
A root aggregate contains context private to the Toolkit routines. The type of
a root aggregate is DDIF$_DDF.
root segment
A top-level segment that contains the document content. This document
content can consist of content aggregates as well as nested segments. If
a document contains only one segment, that segment is the root segment
and contains all the document content. If the document contains multiple
segments, they must be nested within a root segment.
segment
A quantity of content that is set off from surrounding data by a change in
presentation or processing attributes.
sequence
A linked series of aggregates.
sequence of
A linked series of aggregates, all of which are the same type.
single-precision floating-point
A VAX F _floating-point value on VAX systems; an IEEE Standard 754
single-precision floating-point value on non-VAX systems. The length of the
buffer is always 4. Upon writing a floating•point value to a DDIS stream,
the CDA Toolkit transforms the value to a generic DDIS floating-point value.
When reading a single-precision floating-point value from a DDIS stream, the
DDIS-encoded floating-point data is converted to the native (VAX or IEEE)
format by the CDA Toolkit.
soft content
Content that is generated by software and is subject to recalculation when
the document is revised.

Glossary-6

specific attributes

Attributes that are associated only with a single segment of content. These
types of attributes are deliberately limited to a specific segment of the
document.
specific layout

The layout of a particular document or document element.
stream

An access path by which encoded compound document data is read from or
written to a storage medium.
string

A compound document data type that is encoded as a string of bytes. The
length of the string is also specified in bytes.
string with add-info

A string whose character set is identified in an add-info parameter.
style guide

A relationship in a revisable document that defines a collection of generic
types defined for use by a set of documents. For example, a style guide could
be used to define a default newspaper layout or a standard letterhead.
tag

Tags are used to identify the type of a CDA item. For example, $2D is used
to identify a segment's content category as graphics.
text content

Content that consists of text in ASCII and alternate character sets.
type reference

A shorthand notation for the phrase "reference to generic type." A type
reference is a relationship in a revisable document that defines the situation
of segments referencing the same generic type and therefore inheriting
common attributes and processing and presentation styles.
variable

A compound document data type for which the data type of the item is
determined by a preceding enumeration item. The enumeration item
determines the data type of the variable item.
variables

A relationship in a revisable document that defines content that can be
generated based on the values of variables, thereby ensuring that multiple
elements of content are identical, have the same position, or can be modified
by standard functions.
Viewer

The CDA Viewer is an application that can be used to look at a CDA (DDIF
or DTIF) format document on a character-cell or a DECwindows display.
widget

A DECwindows object providing a user-interface abstraction, for example, a
scroll bar or the CDA Viewer.

Glossary-7

word
A compound document data type that is encoded as a 16-bit structure.
wrapping
The process of breaking a stream of characters into lines that fit within the
assigned galleys.

Glossary-8

Index
A
Absolute value construct
See Expressionlist syntax diagram and CFE
expressions, Boolean and relational
Abs-value syntax diagram
See Expressionlist syntax diagram
Acos syntax diagram
See Expressionlist syntax diagram
Add-info
See LOCATE ITEM routine; STORE ITEM routine
Addition construct
See Expressionlist syntax diagram and CFE
expressions, arithmetic
Add syntax diagram
See Expressionlist syntax diagram
aggregate
DTIF$_LPT_APPL_PRIVATE item in, 5-46
Aggregate
See also Root aggregate
copying, 8-33
creating, 8-36
deleting, 8-58
determining number of array elements in 8-94
inserting, 8-108
'
locating an item in, 8-115
locating next in sequence, 8-120
reading from a front end, 8-24
reading from a stream, 8-88
removing from a document, 8-145
removing from a sequence, 8-158
writing the contents of, 8-150, 8-160
Aggregates, DDIF, 1-5
Aggregates, list of, 1-5
AGGREGATE TYPE TO OBJECT ID routine, 8-3
Allocate/Deallocate routines, 9-2
Alog syntax diagram
See Expressionlist syntax diagram
Alternate presentation, 4-101
Analysis back end, 2-8
And syntax diagram
See Expressionlist syntax diagram
AngleRef enumeration, 1-1
AngleRef syntax diagram, B-25
Angle syntax diagram, B-25
$AN tag, defined, 4-91
Antilog construct
See Expressionlist syntax diagram and CFE
expressions, transcendental
ANY built-in operator, defined, B-3

Application images
linking on ULTRIX, 8-2
linking on VMS, 8-2
Application private data
See DTIF application private aggregate
ApplPrivate syntax diagram, B-5, C-14, E-3
Appreciation construct
See Expressionlist syntax diagram and CFE
expressions, financial
Apprec syntax diagram
See Expressionlist syntax diagram
Arc
controlling the rendition of, 4-3
specifying angle of rotation of, 4-4
specifying center x-coordinate of, 4-3
specifying center y-coordinate of, 4-3
specifying delta y radius of, 4-4
specifying the extent of, 4-4
specifying the starting angle of, 4-4
specifying x radius of, 4-3
Arc content aggregate, 4-2 to 4-4
See also DDIF$_ARC aggregate
arc extent indicator item in, 4-4
arc start indicator item in, 4-4
center x indicator item in, 4-3
center y indicator item in, 4-3
delta y indicator item, 4-4
flags item in, 4-3
items in, 4-2t
rotation indicator item in, 4-4
x radius item in, 4-3
Arc cosine construct
See Expressionlist syntax diagram and CFE
expressions, trigonometric
ArcPath syntax diagram, B-30
Arc sine construct
See Expressionlist syntax diagram and CFE
expressions, trigonometric
Arc syntax diagram, B-12
Arc tangent 2 construct
See Expressionlist syntax diagram and CFE
expressions, trigonometric
Arc tangent construct
See Expressionlist syntax diagram and CFE
expressions, trigonometric
Arithmetic shift left construct
See Expressionlist syntax diagram and CFE
expressions, binary

lndex-1

Arithmetic shift right construct
See ExpressionList syntax diagram and CFE
expressions, binary
Array definition aggregate, 5-2 to 5-3
array values item in, 5-3
descriptor item in, 5-2
element type size indicator item in, 5-2
items in, 5-2
value item in, 5-3
x dimension item in, 5-3
y dimension item in, 5-3
z dimension item in, 5-3
ArrayDefn syntax diagram, C-8
Arrays
See Array values
Array values
specifying array element type size indicator for,
5-2
specifying descriptor item for, 5-2
specifying nonstandard data types for, 5-3
specifying standard data types for, 5-2
specifying the x dimension for, 5-3
specifying they dimension for, 5-3
specifying the z dimension for, 5-3
specifying value item for, 5-3
$ASCII collating sequence, 5-49
ASCllString syntax diagram, B-25, C-15
Asin syntax diagram
See ExpressionList syntax diagram
Asl syntax diagram
See ExpressionList syntax diagram
Asr syntax diagram
See Expressionlist syntax diagram
Assignment built-in operator, defined, 8-3
Atan2 syntax diagram
See ExpressionList syntax diagram
Atan syntax diagram
See ExpressionList syntax diagram
Attribute
specifying for a galley, 4-133
specifying for a line, 4-128 to 4-131
specifying for a marker, 4-132
specifying for an image, 4-134 to 4-136
specifying for image component space, 4-137 to
4-138
specifying for text, 4-118 to 4-127
Average construct
See ExpressionList syntax diagram and CFE
expressions, statistical
Avg syntax diagram
See ExpressionList syntax diagram

B
Back end
analysis, 2-8
DDIF, 2-3
ddif$write_format entry point, 11-16
domain$write _format entry point, 11-15
dtif$write_format entry point, 11-16
entry point, 8-16
Postscript, 2-5 to 2-8
text, 2-4 to 2-5

lndex-2

Background
See Pattern definition; Pattern definition aggregate;
Image component space
BeginSegment syntax diagram, B-7
Between construct
See ExpressionList syntax diagram and CFE
expressions, Boolean and relational
Bezier curve
controlling rendition of, 4-5
specifying layout of, 4-6
Bezier curve aggregate, 4-5 to 4-6
See also DDIF$_BEZ aggregate
curve path indicator item in, 4-6
flags item in, 4-5
items in, 4-5t
Binding syntax diagram, B-36
BIT STRING built-in primitive, defined, B-1
BMU (Basic Measurement Unit)
definition of, 4-1 00
BOOLEAN built-in primitive, defined, B-1
BoundingBox syntax diagram, B-18
BreakCriteria syntax diagram, B-42

c
Callable interlace
CDA viewer routines, 13-1
CategoryTag syntax diagram, B-35
cda$aggregate_type_to_,object_id, 8-3
cda$close_file, 8-6
cda$close_stream, 8-9
cda$close_text_file, 8-11
cda$convert, 8-13
cda$convert_aggregate, 8-24
cda$convert_document, 8-28
cda$convert__position, 8-31
cda$copy_aggregate, 8-33
cda$create_aggregate, 8-36
cda$create_file, 8-39
cda$create_root_aggregate, 8-45
cda$create_stream, 8-50
cda$create_text_file, 8-54
cda$delete_aggregate, 8-58
cda$delete_root_aggregate, 8-60
cda$enter_scope, 8-62
cda$erase_item, 8-76
cda$find_definition, 8-79
cda$find_transformation, 8-83
cda$flush_stream, 8-86
cda$get_aggregate, 8-88
cda$get_array_size, 8-94
cda$get_document, 8-97
cda$get_external_encoding, 8-100
cda$get_stream__position, 8-103
cda$get_text__position, 8-1 06
cda$insert_aggregate, 8-108
cda$1eave_scope, 8-112
cda$1ocate_item, 8-115
cda$next_aggregate, 8-120
cda$objecUd_to_aggregate_type, 8-123
cda$open_converter, 8-126
cda$open_file, 8-130
cda$open_stream, 8-138
cda$open_text_file, 8-141
cda$prune_aggregate, 8-145
cda$prune__position, 8-148

cda$put_aggregate, 8-150
cda$put_document, 8-153
cda$read_text_file, 8-156
cda$remove_aggregate, 8-158
cda$store_item, 8-160
cda$write_text_file, 8-168
CDA$_ facility messages, G-1 to G-6
CdaAggregateTypeToObjectld, 8-3
CdaCloseFile, 8-6
CdaCloseStream, 8-9
CdaCloseTextFile, 8-11
CdaConvert, 8-13
CdaConvertAggregate, 8-24
CdaConvertDocument, 8-28
CdaConvertPosition, 8-31
CdaCopyAggregate, 8-33
CdaCreateAggregate, 8-36
CdaCreateFile, 8-39
CdaCreateRootAggregate, 8-45
CdaCreateStream, 8-50
CdaCreateTextFile, 8-54
CDA default values, 1-4
CdaDeleteAggregate, 8-58
CdaDeleteRootAggregate, 8-60
CdaEnterScope, 8-62
CdaEraseltem, 8-76
CdaFindDefinition, 8-79
CdaFindTransformation, 8-83
CdaFlushStream, 8-86
CdaGetAggregate, 8-88
CdaGetArraySize, 8-94
CdaGetDocument, 8-97
CdaGetExternalEncoding, 8-100
CdaGetStreamPosition, 8-103
CdaGetTextPosition, 8-106
CdalnsertAggregate, 8-108
CDA item data types, 1-1 t
CdaleaveScope, 8-112
Cdalocateltem, 8-115
CdaNextAggregate, 8-120
CdaObjectldToAggregateType, 8-123
CdaOpenConverter, 8-126
CdaOpenFile, 8-130
CdaOpenStream, 8-138
CdaOpenTextFile, 8-141
CdaPruneAggregate, 8-145
CdaPrunePosition, 8-148
CdaPutAggregate, 8-150
CdaPutDocument, 8-153
CdaReadTextFile, 8-156
CdaRemoveAggregate, 8-158
CdaStoreltem, 8-160
CDA viewer
callable interface, 13-1
CdaWriteTextFile, 8-168
cdoc command, 2-16 to 2-17
-d format qualifier, 2-16
-0 options qualifier, 2-17
-s format qualifier, 2-16
Cell-col syntax diagram
See Expressionlist syntax diagram
Cell coordinate construct
See ExpressionList syntax diagram and CFE
expressions, variables
Cell coordinates aggregate
See CFE cell coordinates aggregate

Cell coordinates aggregate (Cont.)
See DTIF cell coordinates aggregate
Cell-coord syntax diagram
See ExpressionList syntax diagram
CellCoord syntax diagram, C-16
Cell data
empty cells in, 5-13
missing values in, 5-13
null cells in, 5-13
sparse encoding of, 5-13
specifying a cell state in, 5-14
specifying a column number in, 5-14
specifying a descriptor item for, 5-15
specifying a value data indicator for, 5-15
specifying expressions for, 5-16
specifying formats for, 5-15
specifying private data for, 5-15
Cell data aggregate, 5-13 to 5-17
cell descriptor item in, 5-15
cell state item in, 5-14
column number item in, 5-14
expression item in, 5-16
format item in, 5-15
items in, 5-14
private cell data item in, 5-15
value data indicator item in, 5-15
value item in, 5-16
CellData syntax diagram, C-6
Cell extract construct
See Expressionlist syntax diagram and CFE
expressions, cell-related
Cell-extract syntax diagram
See Expressionlist syntax diagram
Cell indirection construct
See Expressionlist syntax diagram and CFE
expressions, cell-rel?ted
Cell-indirect syntax diagram
See Expressionlist syntax diagram
Cell-name syntax diagram
See ExpressionList syntax diagram
Cell range aggregate
See CFE cell range aggregate
See DTIF ·cell range aggregate
Cell range construct
See Expressionlist syntax diagram and CFE
expressions, variables
Cell-range syntax diagram
See Expressionlist syntax diagram
CellRange syntax diagram, C'-18
Cell-row syntax diagram
See Expressionlist syntax diagram
Cells
See Cell data
Cell states
to determine valid cell values, 5-15
CellValue syntax diagram, C-7
CFE$_AGGREGATE_TYPE aggregate item, 6-1
CFE$_CCD aggregate, 6-2 to 6-3
CFE$_CCD_COLUMN item in, 6-2
CFE$~CD_FLAGS item in, 6-2
CFE$_CCD_ROW item in, 6-2
items in, 6-2
CFE$_CFT aggregate, 6-4
CFE$_CFT_REAL_PART item in, 6-4
ttems in, 6-4

lndex-3

CFE$_CLR aggregate, 6-5
CFE$_CLR_RANGE_BEGIN item in, 6-5
CFE$_CLR_RANGE_END item in, 6-5
items in, 6-5
CFE$_COR aggregate, 6-6
CFE$_COR_COL_BEGIN item in, 6-6
CFE$_COR_COL_END item in, 6-6
items in, 6-6
CFE$_DAT aggregate, 6-7 to 6-8
CFE$_DAT_DATETIME item in, 6-7
CFE$_DAT_ TIME_DIFF item in, 6-8
CFE$_DAT_ TIME_DIFF_c item tn, 6-7
items in, 6-7
CFE$_EXL aggregate, 6-9 to 6-52
CFE$_EXL_EXPR item in, 6-52
items in, 6-9
CFE$_EXP aggregate, 6-53 to 6-54
CFE$_EXP_LIST item in, 6-53
CFE$_EXP_MAJOR_VERSION item in, 6-53
CFE$_EXP_MINOR_VERSION item in, 6-53
items in, 6-53
CFE$_FLT aggregate
CFE$_CFT_IMAGINARY_PART item in, 6-4
CFE$_FRF aggregate, 6-55
CFE$_FRF_FIELD_CONTEXT item in, 6-55
CFE$_FRF_PATH item in, 6-55
items in, 6-55
CFE$_NPM aggregate, 6-56
CFE$_NPM_NAME item in, 6-56
CFE$_NPM_VALUE item in, 6-56
items in, 6-56
CFE$_PEX
CFE$_PEX_END_EXPR item in, 6-57
CFE$_PEX aggregate, 6-57
CFE$_PEX_BEGIN_EXPR item in, 6-57
CFE$_PEX_VALUE_EXPR item in, 6-57
CFE$_PFE_FACILITY item in, 6-58
CFE$_PFE_NAME item in, 6-58
items in, 6-57
CFE$_PFE aggregate, 6-58 to 6-59
CFE$_PFE_PARAMS item in, 6-59
CFE$_PFE_REF_LABEL item in, 6-58
CFE$_PFE_REF_LABEL_TYPE item in, 6-58
CFE$_PFE_RETURN_TYPE item in, 6-59
items in, 6-58
CFE$_RWR aggregate, 6-60
CFE$_RWR_ROW_BEGIN item in, 6-60
CFE$_RWR_ROW_END item in, 6-60
items in, 6-60
CFE$_SLL aggregate, 6-61
CFE$_SLL_CRITERIA item in, 6-61
CFE$_SLL_SELECTION item in, 6-61
items in, 6-61
CFE$_STF aggregate, 6-62
CFE$_STF_EDIT_STRING item in, 6-62
CFE$_STF_SOURCE item in, 6-62
items in, 6-62
CFE$_STP aggregate, 6-63
CFE$_STP_PRETTY_FLAGS item in, 6-63
CFE$_STP_STRING_EXPR item in, 6-63
items in, 6-63
CFE$_TXC aggregate, 6-64
CFE$_TXC_TEXT_C item in, 6-64
items in, 6-64
CFE$_USER_CONTEXT aggregate item, 6-1
CFE$_VTX aggregate, 6-65
CFE$_VTX_VTEXT_LEN item in, 6-65

lndex-4

CFE$_VTX aggregate (Cont.)
CFE$_VTX_VTEXT_STR item in, 6-65
items in, 6-65
CFE application private aggregate, 6-58 to 6-59
facility name item in, 6-58
function name item in, 6-58
items in, 6-58
parameters item in, 6-59
reference label item in, 6-58
reference storage item in, 6-58
return type item in, 6-59
CFE cell coordinates
absolute references, 6-2
relative references, 6-2
CFE cell coordinates aggregate, 6-2 to 6-3
column identifier item in, 6-2
flags item in, 6-2
items in, 6-2
row identifier item in, 6-2
CFE cell range aggregate, 6-5
items in, 6-5
range begin item in, 6-5
range end item in, 6-5
CFE column range aggregate, 6-6
column begin item in, 6-6
column end item in, 6-6
items in, 6-6
CFE complex float aggregate, 6-4
imaginary portion value item in, 6-4
items in, 6-4
real portion value item in, 6-4
CFE date and time aggregate, 6-7 to 6-8
date and time item in, 6-7
items in, 6-7
time difference item in, 6-7
CFE document
specifying date and time values for, 6-7
CFE expressions
arithmetic
addition, 6-1 O
division, 6-1 O
multiplication, 6-1 O
negation, 6-1 O
percent, 6-1 o
raise to a power, 6-1 O
subtraction, 6-11
unary plus, 6-11
binary
arithmetic shift left, 6-11
arithmetic shift right, 6-11
one's complement, 6-11
Boolean and relational
absolute value, 6-12
between, 6-12
conditional (if-then-else), 6-13
equal to, 6-12
greater than, 6-12
greater than or equal to, 6-12
less than, 6-13
less than or equal to, 6-13
logical AND, 6-12
logical NOT, 6-13
logical OR, 6-14
modulus, 6-13
not equal to, 6-13
square root, 6-14

CFE expressions (Cont.)
cell-related
cell extract, 6-14
cell indirection, 6-15
column portion of cell name, 6-14
constructed cell reference, 6-15
count columns, 6-15
count rows, 6-16
current cell, 6-16
current column, 6-16
current row, 6-16
error, 6-16
not available, 6-16
not calculable, 6-16
null, 6-16
row portion of cell name, 6-15
choose and lookup
choose, 6-17
field in table, 6-18
hlookup, 6-17
index, 6-17
matches, 6-18
table, 6-18
vlookup, 6-19
contants
true, 6-42
conversion
convert to value, 6-19
decimal string, 6-19
integer, 6-19
round to the nearest whole number, 6-20
truncate, 6-20
convert string to date, 6-21
convert string to time, 6-21
date difference
day, 6-21
hour, 6-21
minute, 6-21
month, 6-22
second, 6-22
week, 6-22
year, 6-22
date/time
date day of the week, 6-23
date month name, 6-24
day of the week, 6-24
month name, 6-25
date/time addition
days, 6-25
hours, 6-25
minutes, 6-25
months, 6-25
seconds, 6-26
weeks, 6-26
years, 6-26
date/time extraction
day, 6-22
hour, 6-22
minute, 6-23
month, 6-23
second, 6-23
year, 6-23
date/time literals
now, 6-25
today, 6-26
tomorrow, 6-26
yesterday, 6-26

CFE expressions (Cont.)
field reference, 6-42
financial
appreciation, 6-27
depreciation-declining balance, 6-29
depreciation-declining balance with crossover
to straight line, 6-28
depreciation-straight line, 6-30
depreciation-sum of year's digits, 6-30
discount, 6-31
financial
depreciation-double declining balance,

6-29
future value, 6-31
future value of an annuity, 6-32
future value of a single sum, 6-32
interest payments, 6-33
interest rate, 6-39
internal rate of return, 6-34
modified internal rate of return, 6-34
net present value, 6-35
number of periods given present value, 6-36
number of periods to achieve future value,

6-36
payback, 6-35
payment per period given present value, 6-37
payment per period to achieve future value,

6-37
periods to achieve future value, 6-35
present value of an annuity, 6-38
present value to achieve future value, 6-39
principal, 6-38
identification
isblank, 6-39
isdate, 6-39
iserror, 6-40
is not available, 6-40
is not calculable, 6-40
isnull, 6-40
isnumber, 6-40
isref, 6-40
isstring, 6-41
literals
complex floating-point, 6-41
date, 6-41
floating-point, 6-41
integer, 6-41
scaled integer, 6-42
text string, 6-42
varying length text, 6-42
miscellaneous
parenthesized, 6-42
private, 6-43
random number, 6-43
series
integrate, 6-43
least squares, 6-43
logest, 6-43
sigma, 6-43
trend, 6-44
sign, 6-43
specifying for a cell, 5-16
specifying for a column, 5-5
statistical
average, 6-44
count, 6-44
maximum, 6-44

lndex-5

CFE expressions
statistical (Cont.)
minimum, 6-45
standard deviation, 6-45
summation, 6-45
variance, 6-46
string
contains substring, 6-47
extract substring left, 6-48
extract substring right, 6-49
string character, 6-46
string character code, 6-46
string concatenate, 6-46
string extract, 6-47
string find substring, 6-47
string fixed, 6-47
string format, 6-48
string length, 6-48
string lowercase, 6-48
string pretty, 6-48
string proper, 6-48
string repeat, 6-48
string replace, 6-49
string reverse, 6-49
string starts with, 6-47
string trim, 6-49
string uppercase, 6-49
transcendental
antilog, 6-49
exponent, 6-50
factorial, 6-50
log, base 1O, 6-50
log, base e (natural), 6-50
trigonometric
arc cosine, 6-50
arc sine, 6-50
arc tangent, 6-50
arc tangent 2, 6-51
cosine, 6-51
sine, 6-51
tangent, 6-51
variables
cell coordinate, 6-51
cell range, 6-51
column name, 6-51
column number, 6-51
column range, 6-52
current value, 6-52
false, 6-41
identifier, 6-52
named range, 6-52
Pl, 6-41
row number, 6-52
row range, 6-52
CFE generic aggregate items, 6-1
CFE$_AGGREGATE_TYPE, 6-1
CFE$_USER_CONTEXT, 6-1
CFE row range aggregate, 6-60
items in, 6-60
row begin data item in, 6-60
row end data item in, 6-60
CFE syntax diagrams, D-1 to D-9
CFE varying text aggregate, 6-65
character string data item in, 6-65
items in, 6-65
varying text length item in, 6-65

lndex-6

Character set
identifiers for, 4-32t
Character string, defined, 1-2
Character-String defined type, defined, B-4
Character-String syntax diagram, B-5
CHOICE built-in operator, defined, B-3
Choose construct
See ExpressionList syntax diagram and CFE
expressions, choose and lookup
Circle
See Arc
Close entry point, 11-3
CLOSE FILE routine, 8-6
CLOSE STREAM routine, 8-9
CLOSE TEXT FILE routine, 8-11
ColAttributes syntax diagram, C-9
Collating sequences
ASCII, 5-49
Danish, 5-49
Finnish, 5-49
Multinational Character Set, 5-49
Norwegian, 5-49
private, 5-49
Spanish, 5-49
Col-name syntax diagram
See ExpressionList syntax diagram
Col-num syntax diagram
See ExpressionList syntax·diagram
ColNum syntax diagram, C-16
Color
See also Image component space
See Pattern definition
Color syntax diagram, B-19
Col-range syntax diagram
See ExpressionList syntax diagram
ColRange syntax diagram, C-18
Column attributes
specifying a column header name for, 5-8
specifying a column query name for, 5-7
specifying a descriptor for, 5-5
specifying a generic attribute reference in, 5-5
specifying an identifier for, 5-4
specifying a value for, 5-5
specifying default values for, 5-5
specifying expressions for, 5-5
specifying flags for, 5-8
specifying formats for, 5-5
specifying numeric or character string indicator for,
5-6
specifying private data for, 5-5
specifying the data length of, 5-8
specifying the data type of, 5-8
specifying the scale factor of, 5-8
specifying within table metadata, 5-63
Column attributes aggregate, 5-4 to 5-9
column descriptor item in, 5-5
column header name item in, 5-8
column query name item in, 5-7
data length item in, 5-8
data type item in, 5-8
default values indicator item in, 5-5
default values item in, 5-6
expression item in, 5-5
flags item in, 5-8
format item in, 5-5
generic attribute reference item in, 5-5

Column attributes aggregate (Cont.)
identifier item in, 5-4
items in, 5-4
numeric or missing character string item in, 5-7
private column attribute data item in, 5-5
scale factor item in, 5-8
value item in, 5-5
Column name construct
See Expressionlist syntax diagram and CFE
expressions, variables
Column number construct
See Expressionlist syntax diagram and CFE
expressions, variables
Column portion of cell name construct
See Expressionlist syntax diagram and CFE
expressions, cell-related
Column range aggregate
See CFE column range aggregate
See DTIF column range aggregate
Column range construct
See Expressionlist syntax diagram and CFE
expressions, variables
Columns
See Column attributes
Comment built-in operator, defined, 8-3
Complex float aggregate
See CFE complex float aggregate
See DTIF complex float aggregate
Complex floating-point construct
See Expressionlist syntax diagram and CFE
expressions, literals
Complex floating-point values
specifying the imaginary portion for, 5-12, 6-4
specifying the real portion for, 5-12, 6-4
ComplexFloat syntax diagram, C-8
Composite path
arc component of, 4-71
8ezier component of, 4-71
indicating angle of rotation of, 4-73
indicating center x-coordinate of an arc in, 4-72
indicating center y-coordinate of an arc in, 4-72
indicating delta y radius of an arc in, 4-72
indicating extent of an arc in, 4-73
indicating type of path defined in, 4-71
indicating x radius of an arc in, 4-72
polyline component of, 4-71
referencing a component of, 4-71, 4-73
specifying layout of the curve in, 4-72
specifying polyline path in, 4-71
specifying starting angle of an arc in, 4-73
Composite path aggregate, 4-70 to 4-73
See also DDIF$_PTH aggregate
arc center x indicator item in, 4-72
arc center y indicator item in, 4-72
arc extent indicator item in, 4-73
arc radius delta y indicator item in, 4-72
arc radius x indicator item in, 4-72
arc rotation indicator item in, 4-73
arc start indicator item in, 4-73
curve path indicator item in, 4-72
items in, 4-70t
line path indicator item in, 4-71
path indicator item in, 4-71
path reference item in, 4-73
CompositePath syntax diagram, 8-30

Compound document
validating contents of, 8-130
Computed content
copied, 4-93
cross-reference, 4-95
function, 4-96
indicating function parameters for, 4-96
specifying an index into a list of references for,
4-93
specifying attributes for, 4-92 to 4-96
specifying function name in, 4-96
specifying label of a segment being referenced by,
4-93
specifying label of the target segment, 4-95
specifying name of the variable in, 4-94
specifying reference index for, 4-95
specifying the name of the referenced variable in,
4-95
variable, 4-94
Computed content external, 1-16
ComputeDefn syntax diagram, 8-19
ConformanceTag syntax diagram, B-35
Constructed cell reference construct
See Expressionlist syntax diagram and CFE
expressions, cell-related
Contains substring construct
See Expressionlist syntax diagram and CFE
expressions, string
Contains syntax diagram
See Expressionlist syntax diagram
Content
computed
specifying attributes for, 4-92 to 4-96
indicating relational position of a segment of, 4-111
presentation styles for, 4-78
restricted
external, 4-21 to 4-22
specifying alternate presentation string for, 4-101
specifying character horizontal alignment point for,
4-107
specifying character vertical alignment point for,
4-108
specifying general character set for, 4-32
specifying general layout attributes for, 4-104
specifying Latin1 character set for, 4-164
specifying magnitude of coordinate system ratio for,
4-99
specifying name of the measurement system of,
4-100
specifying number of units per inch of, 4-100
specifying precision in coordinate system ratio for,
4-99
specifying string format of, 4-106
specifying the character orientation in, 4-106
specifying the layout of, 4-103
specifying the name of the coordinate system of,
4-99
specifying the string imaging path of, 4-105
specifying world coordinate system for, 4-99
specifying wrap attributes for, 4-104
text
general, 4-32
Latin1, 4-164
Content aggregates, defined, 1-5
Content definition
specifying elements in, 4-9

lndex-7

Content definition (Cont.)
specifying index into list of external references in,
4-9
specifying label of, 4-8
specifying label of the referenced segment in, 4-8
specifying private data for, 4-9
Content definition aggregate, 4-8 to 4-9
See also DDIF$_CTD aggregate
external reference index item in, 4-9
external target item in, 4-8
items in, 4-8t
label item in, 4-8
private data item in, 4-9
value item in, 4-9
Content definitions, 1-16
ContentDefnlabel syntax diagram, B-24
ContentDefn syntax diagram, 8-24
ContentPrimitive syntax diagram, B-6
Content reference
specifying label for, 4-7
specifying transformation for, 4-7
Content reference aggregate, 4-7
See also DDIF$_CRF aggregate
items in, 4-7t
label item in, 4-7
transformation item in, 4-7
ContentReferencePrimitive syntax diagram, B-18
Content references, 1-15, 1-16
ContentReference syntax diagram, B-18
Content syntax diagram, B-6
Content tags
See DDIF tags
Contiguous ranges, 5-55
See also Ranges
Conversion
input formats, 2-1 to 2-3
output formats, 2-3 to 2-9
Conversion restrictions
DTIF back end, 2-4
DTIF front end, 2-2
in DDIF back end, 2-3
in DDIF front end, 2-1
in Postscript back end, 2-5
in Text back end, 2-4
in Text front end, 2-3
CONVERT AGGREGATE routine, 8-24
CONVERT/DOCUMENT command, 2-11 to 2-12
/OPTIONS qualifier, 2-11
CONVERT DOCUMENT routine, 8-28
Converter
activating, 8-126
calling from an application, 8-13
Converters
linking on ULTRIX, 11-2
linking on VMS, 11-2
CONVERT POSITION routine, 8-31
CONVERT routine, 8-13
Convert string to date construct
See Expressionlist syntax diagram and CFE
expressions, convert string to date
Convert string to time construct
See Expressionlist syntax diagram and CFE
expressions, convert string to time
Convert to value construct
See Expressionlist syntax diagram and CFE
expressions, conversion

lndex-8

Copied computed content, 4-93
COPY AGGREGATE routine, 8-33
Copying CDA documents
on an ULTRIX system, 3-3
on a VMS system, 3-3
Cosine construct
See Expressionlist syntax diagram and CFE
expressions, trigonometric
Cos syntax diagram
See Expressionlist syntax diagram
Count-cols syntax diagram
See Expressionlist syntax diagram
Count columns construct
See Expressionlist syntax diagram and CFE
expressions, cell-related
Count construct
See Expressionlist syntax diagram and CFE
expressions, statistical
Counter
specifying style for, 4-11
CounterDefn syntax diagram, B-37
Counter style aggregate, 4-10 to 4-11
See also DDIF$_CTS aggregate
items in, 4-1 Ot
style indicator item in, 4-11
CounterStyle syntax diagram, B-38
Count rows construct
See Expressionlist syntax diagram and CFE
exprssions, cell-related
Count-rows syntax diagram
See Expressionlist syntax diagram
CREATE AGGREGATE routine, 8-36
CREATE FILE routine, 8-39
CREATE ROOT AGGREGATE routine, 8-45
CREATE STREAM routine, 8-50
CREATE TEXT FILE routine, 8-54
$CRF tag, defined, 4-91
Cross-reference computed content, 4-95
CrossRef syntax diagram, B-20
CubicBezier
See also Bezier curve
CubicBezierPath syntax diagram, B-31
CubicBezier syntax diagram, B-12
Cur-cell syntax diagram
See Expressionlist syntax diagram
Cur-col syntax diagram
See Expressionlist syntax diagram
Current cell construct
See Expressionlist syntax diagram and CFE
expressions, cell-related
Current column construct
See Expressionlist syntax diagram and CFE
expressions, cell-related
Current row construct
See Expressionlist syntax diagram and CFE
expressions, cell-related
Current value construct
See Expressionlist syntax diagram and CFE
expressions, variables
Current-value syntax diagram
See Expressionlist syntax diagram
Cur-row syntax diagram
See Expressionlist syntax diagram
Curve
See Bezier curve

Cvt-to-date syntax diagram
See Expressionlist syntax diagram
Cvt-to-time syntax diagram
See Expressionlist syntax diagram
Cvt-to-value syntax diagram
See Expressionlist syntax diagram

D
$DANISH collating sequence, 5-49
Data
private, 4-74
Data mapping
DTIF back end, 2-3
DTIF front end, 2-2
in DDIF back end, 2-3
in DDIF front end, 2-1
in Postscript back end, 2-5
in Text back end, 2-4
in Text front end, 2-2
Datatype syntax diagram, C-1 O
Date construct
See Expressionlist syntax diagram and CFE
expressions, literals
Date day of the week construct
See Expressionlist syntax diagram and CFE
expressions, date/time
$DATE editstring-name, 5-49
DateFmt syntax diagram, C-13
Date month name construct
See Expressionlist syntax diagram and CFE
expressions, date/time
Date/time addition constructs
See Expressionlist syntax diagram and CFE
expressions, date/time addition
Date/time difference constructs
See Expressionlist syntax diagram and CFE
expressions, date difference
$DATETIME editstring-name, 5-49
Date/time extraction constructs
See Expressionlist syntax diagram and CFE
expressions, date/time extraction
DateTime syntax diagram, C-14
Day of the week construct
See Expressionlist syntax diagram and CFE
expressions, date/time
$DB tag, defined, 4-30, 4-90
DDDIF$_FTD aggregate
DIF$_FTD_NUMBER item in, 4-25
DDIF$READ_format, 8-15
ddif$write_format, 8-16
DDIF$_AGGREGATE_TYPE aggregate item, defined,
4-1
DDIF$_ARC aggregate, 4-2 to 4-4
DDIF$_ARC_CENTER_X item in, 4-3
DDIF$_ARC_CENTER_X_C item in, 4-3
DDIF$_ARC_CENTER_Y item in, 4-3
DDIF$_ARC_CENTER_Y_C item in, 4-3
DDIF$_ARC_EXTENT item in, 4-4
DDIF$_ARC_EXTENT_C item in, 4-4
DDIF$_ARC_FLAGS item in, 4-3
DDIF$_ARC_RADIUS_DELTA_Y item in, 4-4
DDIF$_ARC_RADIUS_DELTA_Y_C item in, 4-4
DDIF$_ARC_RADIUS_X item in, 4-3
DDIF$_ARC_RADIUS_X_C item in, 4-3
DDIF$_ARC_ROTATION item in, 4-4

DDIF$_ARC aggregate (Cont.)
DDIF$_ARC_ROTATION_C item in, 4-4
DDIF$_ARC_START item in, 4-4
DDIF$_ARC_START_C item in, 4-4
items in, 4-2t
DDIF$_BEZ aggregate, 4-5 to 4-6
DDIF$_BEZ_FLAGS item in, 4-5
DDIF$_BEZ_PATH item in, 4-6
DDIF$_BEZ_PATH_C item in, 4-6
items in, 4-5t
DDIF$_CRF aggregate, 4-7
DDIF$_CRF_REFERENCE item in, 4-7
DDIF$_CRF_TRANSFORM item in, 4-7
items in, 4-7t
DDIF$_CTD aggregate, 4-8 to 4-9
DDIF$_CTD_EXTERNAL_ERF_INDEX item in,
4-9
DDIF$_CTD_EXTERNAL_TARGET item in, 4-8
DDIF$_CTD_LABEL item in, 4-8
DDIF$_CTD_PRIVATE_DATA item in, 4-9
DDIF$_CTD_VALUE item in, 4-9
items in, 4-8t
DDIF$_CTS aggregate, 4-10 to 4-11
DDIF$_CTS_STYLE item in, 4-11
DDIF$_CTS_STYLE_C item in, 4-11
items in, 4-1 Ot
DDIF$_DDF aggregate, 4-12
DDIF$_DDF_CONTENT item in, 4-12
DDIF$_DDF_DESCRIPTOR item in, 4-12
DDIF$_DDF_HEADER item in, 4-12
DDIF$_DDIF$_SGB aggregate
DDIF$_SGB_CTR_TRIGGER item in, 4-156
DDIF$_DHD aggregate, 4-13
DDIF$_DHD_AUTHOR item in, 4-14
DDIF$_DHD_CONFORMANCE_TAGS item in,
4-14
DDIF$_DHD_DATE item in, 4-14
DDIF$_DHD_EXTERNAL_REFERENCES item in,
4-14
DDIF$_DHD_LANGUAGES item in, 4-15
DDIF$_DHD_LANGUAGES_C item in, 4-14
DDIF$_DHD_PRIVATE_DATA item in, 4-13
DDIF$_DHD_STYLE_GUIDE item in, 4-15
DDIF$_DHD_TITLE item in, 4-13
DDIF$_DHD_VERSION item in, 4-14
DDIF$_DSC aggregate, 4-16 to 4-17
DDIF$_DSC_MAJOR_VERSION item in, 4-16
DDIF$_DSC_MINOR_VERSION item in, 4-16
DDIF$_DSC_PRODUCT_IDENTIFIER item in,
4-17
DDIF$_DSC_PRODUCT_NAME item in, 4-17
DDIF$_ERF aggregate, 4-18 to 4-20
DDIF$_ERF_CONTROL item in, 4-20
DDIF$_ERF_DATA_TYPE item in, 4-18
DDIF$_ERF_DESCRIPTOR item in, 4-18
DDIF$_ERF_LABEL item in, 4-18
DDIF$_ERF_LABEL_TYPE item in, 4-18
items in, 4-18t
DDIF$_EXT aggregate, 4-21 to 4-22
DDIF$_EXT_DATA_VALUE_DESCRIPTOR item in,
4-21
DDIF$_EXT_DIRECT_REFERENCE item in, 4-21
DDIF$_EXT_ENCODING item in, 4-22
DDIF$_EXT_ENCODING_C item in, 4-22
DDIF$_EXT_ENCODING_L item in, 4-22
DDIF$_EXT_INDIRECT_REFERENCE item in,
4-21

lndex-9

DDIF$_EXT aggregate (Cont.)
items in, 4-21 t
DDIF$_FAS aggregate, 4-23 to 4-24
DDIF$_FAS_FLAGS item in, 4-23
DDIF$_FAS_PATH item in, 4-24
items in, 4-23t
DDIF$_FTD aggregate, 4-25
DDIF$_FTD_IDENTIFIER item in, 4-25
DDIF$_FTD_PRIVATE_DATA item in, 4-25
items in, 4-25t
DDIF$_GLA aggregate, 4-26 to 4-27
DDIF$_GLA_BOTTOM_MARGIN item in, 4-27
DDIF$_GLA_BOTTOM_MARGIN_C item in, 4-27
DDIF$_GLA_LEFT_MARGIN item in, 4-27
DDIF$_GLA_LEFT_MARGIN_C item in, 4-26
DDIF$_GLA_RIGHT_MARGIN item in, 4-27
DDIF$_GLA_RIGHT_MARGIN_C item in, 4-27
DDIF$_GLA_TOP_MARGIN item in, 4-26
DDIF$_GLA_TOP_MARGIN_C item in, 4-26
items in, 4-26t
DDIF$_GLY aggregate, 4-28 to 4-31
DDIF$_GLY_BOUNDING_BOX_LL_X item in,
4-29
DDIF$_GLY_BOUNDING_BOX_LL_X_C item in,
4-29
DDIF$_GLY_BOUNDING_BOX_LL_Y item in,
4-29
DDIF$_GLY_BOUNDING_BOX_LL_Y_C item in,
4-29
DDIF$_GLY_BOUNDING_BOX_UR_X item in,
4-29
DDIF$_GLY_BOUNDING_BOX_UR_X_C item in,
4-29
DDIF$_GLY_BOUNDING_BOX_UR_Y item in,
4-30
DDIF$_GLY_BOUNDING_BOX_UR_Y_C item in,
4-29
DDIF$_GLY_FLAGS item in, 4-30
DDIF$_GLY_ID item in, 4-29
DDIF$_GLY_OUTLINE item in, 4-30
DDIF$_GLY_STREAMS item in, 4-30
DDIF$_GLY_SUCCESSOR item in, 4-31
DDIF$_GLY_SUCCESSOR_C item in, 4-31
items in, 4-28t
DDIF$_GTX aggregate, 4-32
DDIF$_GTX_CONTENT item in, 4-32
DDIF$_HRD aggregate, 4-34
DDIF$_HRD_DIRECTIVE item in, 4-35
DDIF$_HRV aggregate, 4-36 to 4-37
DDIF$_HRV_C item in, 4-37
DDIF$_HRV_ESC_CONSTANT item in, 4-37
DDIF$_HRV_ESC_CONSTANT_C item in, 4-37
DDIF$_HRV_ESC_RATIO_D item in, 4-37
DDIF$_HRV_ESC_RATIO_N item in, 4-37
DDIF$_HRV_RESET_VALUE item in, 4-37
DDIF$_HRV_RESET_VALUE_C item in, 4-37
DDIF$_HRV_RESET_VARIABLE item in, 4-37
DDIF$_1DU aggregate, 4-38 to 4-40
DDIF$_1DU_BITS_PER_PIXEL item in, 4-40
DDIF$_1DU_COMPRESSION_PARAMS item in,
4-39
DDIF$_1DU_COMPRESSION_TYPE item in, 4-39
DDIF$_1DU_DATA_OFFSET item in, 4-39
DDIF$_1DU_NUMBER_OF_LINES item in, 4-39
DDIF$_1DU_PIXELS_PER_LINE item in, 4-38
DDIF$_1DU_PIXEL_ORDER item in, 4-40
DDIF$_1DU_PIXEL_STRIDE item in, 4-39

lndex-10

DDIF$_1DU aggregate (Cont.)
DDIF$_1DU_PLANE_DATA item in, 4-40
DDIF$_1DU_PRIVATE_CODING_ATTR item in,
4-38
DDIF$_1DU_SCANLINE_STRIDE item in, 4-39
items in, 4-38t
DDIF$_1MG aggregate, 4-41
DDIF$_1MG_CONTENT item in, 4-41
items in, 4-41 t
DDIF$_LG1 aggregate, 4-42
DDIF$_LG1_PAGE_DESCRIPTIONS item in, 4-42
DDIF$_LG1_PRIVATE_DATA item in, 4-42
items in, 4-42t
DDIF$_LIN aggregate, 4-43 to 4-44
DDIF$_LIN_DRAW_PATTERN item in, 4-44
DDIF$_LIN_FLAGS item in, 4-43
DDIF$_LIN_PATH item in, 4-44
DDIF$_LIN_PATH_C item in, 4-44
items in, 4-43t
DDIF$_LL1 aggregate, 4-45 to 4-49
DDIF$_LL1_BREAK_AFTER item in, 4-47
DDIF$_LL 1_BREAK_BEFORE item in, 4-46
DDIF$_LL1_BREAK_WITHIN item in, 4-47
DDIF$_LL1_GALLEY_SELECT item in, 4-46
DDIF$_LL 1_1NITIAL_DIRECTIVE item in, 4-46
DDIF$_LL1_1NITIAL_INDENT item in, 4-47
DDIF$_LL1_1NITIAL_INDENT_C item in, 4-47
DDIF$_LL1_LEADING_CONSTANT item in, 4-48
DDIF$_LL1_LEADING_CONSTANT_C item in,
4-48
DDIF$_LL1_LEADING_RATIO_D item in, 4-48
DDIF$_LL 1_LEADING_RATIO_N item in, 4-48
DDIF$_LL1_LEFT_INDENT item in, 4-47
DDIF$_LL1_LEFT_INDENT_C item in, 4-47
DDIF$_LL 1_RIGHT_INDENT item in, 4-48
DDIF$_LL1_RIGHT_INDENT_C item in, 4-47
DDIF$_LL1_SPACE_AFTER item in, 4-48
DDIF$_LL 1_SPACE_AFTER_C item in, 4-48
DDIF$_LL1_SPACE_BEFORE item in, 4-48
DDIF$_LL 1_SPACE_BEFORE_C item in, 4-48
DDIF$_LL1_TAB_STOPS item in, 4-49
items in, 4-45t
DDIF$_LS1 aggregate, 4-50 to 4-51
DDIF$_LS1_LAYOUTitem in, 4-51
DDIF$_LS1_LAYOUT_C item in, 4-50
items in, 4-50t
DDIF$_LSD aggregate, 4-52 to 4-53
DDIF$_LSD_NUMBER item in, 4-52
DDIF$_LSD_PATTERN item in, 4-52, 4-129
DDIF$_LSD_PRIVATE_DATA item in, 4-53
items in, 4-52t
DDIF$_LW1 aggregate, 4-54 to 4-56
DDIF$_LW1_HYPHENATION_FLAGS item in,
4-55
DDIF$_LW1_MAXIMUM_HYPH_LINES item in,
4-56
DDIF$_LW1_MAXIMUM_ORPHAN_SIZE item in,
4-56
DDIF$_LW1_MAXIMUM_WIDOW_SIZE item in,
4-56
DDIF$_LW1_QUAD_FORMAT item in, 4-55
DDIF$_LW1_WRAP_FORMAT item in, 4-55
items in, 4-54t
DDIF$_0CC aggregate, 4-57 to 4-58
DDIF$_0CC_OCCURRENCE_C item in, 4-57
DDIF$_0CC_STRUCTURE_ELEMENT item in,
4-58

DDIF$_0CC aggregate (Cont.)
DDIF$_0CC_STRUCTURE_ELEMENT_C item in,
4-58
items in, 4-57t
DDIF$_PGD aggregate, 4-59 to 4-60
DDIF$_PGD_DESC item in, 4-60
DDIF$_PGD_DESC_C item in, 4-60
DDIF$_PGD_LABEL item in, 4-59
DDIF$_PGD_PRIVATE_DATA item in, 4-59
items in, 4-59t
DDIF$_PGL aggregate, 4-61 to 4-63
DDIF$_PGL_CONTENT item in, 4-63
DDIF$_PGL_LAYOUT_ID item in, 4-62
DDIF$_PGL_ORIENTATION item in, 4-63
DDIF$_PGL_PROTOTYPE item in, 4-63
DDIF$_PGL_SIZE_X_NOM item in, 4-62
DDIF$_PGL_SIZE_X_NOM_C item in, 4-62
DDIF$_PGL_SIZE_X_SHR item in, 4-62
DDIF$_PGL_SIZE_X_SHR_C item in, 4-62
DDIF$_PGL_SIZE_X_STR item in, 4-62
DDIF$_PGL_SIZE_X_STR_C item in, 4-62
DDIF$_PGL_SIZE_Y_NOM item in, 4-62
DDIF$_PGL_SIZE_Y_NOM_C item in, 4-62
DDIF$_PGL_SIZE_Y_SHR item in, 4-63
DDIF$_PGL_SIZE_Y_SHR_C item in, 4-63
DDIF$_PGL_SIZE_Y_STR item in, 4-63
DDIF$_PGL_SIZE_Y_STR_C item in, 4-62
items in, 4-61t
DDIF$_PGS aggregate, 4-64 to 4-65
DDIF$_PGS_SELECT_PAGE_LAYOUT item in,
4-65
DDIF$_PGS_SELECT_PAGE_LAYOUT_C item in,
4-65
DDIF$_PGS_SIDE_CRITERIA item in, 4-64
items in, 4-64t
DDIF$_PHD aggregate, 4-66
DDIF$_PHD_DESCRIPTION item in, 4-66
DDIF$_PHD_NUMBER item in, 4-66
DDIF$_PHD_PRIVATE_DATA item in, 4-66
items in, 4-66t
DDIF$_PTD aggregate, 4-67 to 4-69
DDIF$_PTD_DEFN_C item in, 4-68
DDIF$_PTD_NUMBER item in, 4-67
DDIF$_PTD_PAT_COLORS item in, 4-69
DDIF$_PTD_PAT_NUMBER item in, 4-68
DDIF$_PTD_PRIVATE_DATA item in, 4-69
DDIF$_PTD_RAS_PATTERN item in, 4-69
DDIF$_PTD_SOL_COLOR_B item in, 4-68
DDIF$_PTD_SOL_COLOR_C item in, 4-68
DDIF$_PTD_SOL_COLOR_G item in, 4-68
DDIF$_PTD_SOL_COLOR_R item in, 4-68
items in, 4-67t
DDIF$_PTH aggregate, 4-70 to 4-73
DDIF$_PTH_ARC_CENTER_X item in, 4-72
DDIF$_PTH_ARC_CENTER_X_C item in, 4-72
DDIF$_PTH_ARC_CENTER_Y item in, 4-72
DDIF$_PTH_ARC_CENTER_Y_C item in, 4-72
DDIF$_PTH_ARC_EXTENT item in, 4-73
DDIF$_PTH_ARC_EXTENT_C item in, 4-73
DDIF$_PTH_ARC_RADIUS_DELTA_Y item in,
4-73
DDIF$_PTH_ARC_RADIUS_DELTA_Y_C item in,
4-72
DDIF$_PTH_ARC_RADIUS_X item in, 4-72
DDIF$_PTH_ARC_RADIUS_X_C item in, 4-72
DDIF$_PTH_ARC_ROTATION item in, 4-73
DDIF$_PTH_ARC_ROTATION_C item in, 4-73

DDIF$_PTH aggregate (Cont.)
DDIF$_PTH_ARC_START item in, 4-73
DDIF$_PTH_ARC_START_C item in, 4-73
DDIF$_PTH_BEZ_PATH item in, 4-72
DDIF$_PTH_BEZ_PATH_C item in, 4-72
DDIF$_PTH_C item in, 4-71
DDIF$_PTH_LIN_PATH item in, 4-71
DDIF$_PTH_LIN_PATH_C item in, 4-71
DDIF$_PTH_REFERENCE item in, 4-73
items in, 4-70t
DDIF$_PVT aggregate, 4-74 to 4-75
DDIF$_PVT_DATA item in, 4-75
DDIF$_PVT_DATA_C item in, 4-75
DDIF$_PVT_NAME item in, 4-75
DDIF$_PVT_REFERENCE_ERF_INDEX item in,
4-75
items in, 4-74t
DDIF$_RCD aggregate, 4-76
DDIF$_RCD_CONTENTS item in, 4-76
DDIF$_RCD_TAG item in, 4-76
DDIF$_RCD_TYPE item in, 4-76
items in, 4-76t
DDIF$_RGB aggregate, 4-77
DDIF$_RGB_BLUE_VALUE item in, 4-77
DDIF$_RGB_GREEN_VALUE item in, 4-77
DDIF$_RGB_LUT_INDEX item in, 4-77
DDIF$_RGB_RED_VALUE item in, 4-77
items in, 4-77t
DDIF$_SEG aggregate, 4-78
DDIF$_SEG_CONTENT item in, 4-80
DDIF$_SEG_GENERIC_LAYOUT item in, 4-79
DDIF$_SEG_ID item in, 4-78
DDIF$_SEG_SEGMENT_TYPE item in, 4-79
DDIF$_SEG_SPECIFIC_ATTRIBUTES item in,
4-79
DDIF$_SEG_SPECIFIC_LAYOUT item in, 4-79
DDIF$_SEG_USER_LABEL item in, 4-79
DDIF$_SFT aggregate, 4-81
DDIF$_SFT_DIRECTIVE item in, 4-82
DDIF$_SFV aggregate, 4-83 to 4-84
DDIF$_SFV_C item in, 4-84
DDIF$_SFV_ESC_CONSTANT item in, 4-84
DDIF$_SFV_ESC_CONSTANT_C item in, 4-84
DDIF$_SFV_ESC_RATIO_D item in, 4-84
DDIF$_SFV_ESC_RATIO_N item in, 4-84
DDIF$_SFV_RESET_VALUE item in, 4-84
DDIF$_SFV_RESET_VALUE_C item in, 4-84
DDIF$_SFV_RESET_VARIABLE item in, 4-84
DDIF$_SGA aggregate, 4-85 to 4-153
DDIF$_SGA_ALT_PRESENTATION item in, 4-101
DDIF$_SGA_BINDING_DEFNS item in, 4-91
DDIF$_SGA_COMPUTE_C item in, 4-92
DDIF$_SGA_CONTENT_CATEGORY item in,
4-90
DDIF$_SGA_CONTENT_DEFNS item in, 4-116
DDIF$_SGA_CONTENT_STREAMS item in, 4-90
DDIF$_SGA_CPTCPY_ERF_INDEX item in, 4-93
DDIF$_SGA_CPTCPY_TARGET item in, 4-93
DDIF$_SGA_CPTFNC_NAME item in, 4-96
DDIF$_SGA_CPTFNC_PARAMETERS item in,
4-96
DDIF$_SGA_CPTVAR_VARIABLE item in, 4-94
DDIF$_SGA_CPTXRF_ERF_INDEX item in, 4-95
DDIF$_SGA_CPTXRF_TARGET item in, 4-95
DDIF$_SGA_CPTXRF_VARIABLE item in, 4-95
DDIF$_SGA_FONT_DEFNS item in, 4-112

lndex-11

DDIF$_SGA aggregate (Cont.)
DDIF$_SGA_FRMFXD_POSITION_X item in,
4-147
DDIF$_SGA_FRMFXD_POSITION_X_C item in,
4-147
DDIF$_SGA_FRMFXD_POSITION_Y item in,
4-147
DDIF$_SGA_FRMFXD_POSITION_Y_C item in,
4-147
DDIF$_SGA_FRMGLY_HORIZONTAL item in,
4-149
DDIF$_SGA_FRMGLY_VERTICAL item in, 4-149
DDIF$_SGA_FRMINL_BASE_OFFSET item in,
4-148
DDIF$_SGA_FRMINL_BASE_OFFSET_C item in,
4-148
DDIF$_SGA_FRMMAR_BASE_OFFSET item in,
4-150
DDIF$_SGA_FRMMAR_BASE_OFFSET_C item in,
4-150
DDIF$_SGA_FRMMAR_HORIZONTAL item in,
4-151
DDIF$_SGA_FRMMAR_NEAR_OFFSET item in,
4-150
DDIF$_SGA_FRMMAR_NEAR_OFFSET_C item in,
4-150
DDIF$_SGA_FRM_BOX_LL_X item in, 4-141
DDIF$_SGA_FRM_BOX_LL_X_C item in, 4-141
DDIF$_SGA_FRM_BOX_LL_Y item in, 4-141
DDIF$_SGA_FRM_BOX_LL_Y_C item in, 4-141
DDIF$_SGA_FRM_BOX_UR_X item in, 4-141
DDIF$_SGA_FRM_BOX_UR_X_C item in, 4-141
DDIF$_SGA_FRM_BOX_UR_Y item in, 4-142
DDIF$_SGA_FRM_BOX_UR_Y_C item in, 4-141
DDIF$_SGA_FRM_CLIPPING item in, 4-144
DDIF$_SGA_FRM_FLAGS item in, 4-140
DDIF$_SGA_FRM_OUTLINE item in, 4-143
DDIF$_SGA_FRM_POSITION_C item in, 4-146
DDIF$_SGA_FRM_TRANSFORM item in, 4-152
DDIF$_SGA_GLY_ATTRIBUTES item in, 4-133
DDIF$_SGA_IMG_BITS_PER_COMP item in,
4-138
DDIF$_SGA_IMG_BRT_POLARITY item in, 4-135
DDIF$_SGA_IMG_COMP_SPACE_ORG item in,
4-137
DDIF$_SGA_IMG_COMP_WAVELENGTH item in,
4-136
DDIF$_SGA_IMG_COMP_WAVELENGTH_C item
in, 4-136
DDIF$_SGA_IMG_GRID_TYPE item in, 4-135
DDIF$_SGA_IMG_LINE_PROGRESSION item in,
4-134
DDIF$_SGA_IMG_LOOKUP_TABLES item in,
4-136
DDIF$_SGA_IMG_LOOKUP_ TABLES_C item in,
4-136
DDIF$_SGA_IMG_LP_PIXEL_DIST item in, 4-134
DDIF$_SGA_IMG_NUMBER_OF_COMP item in,
4-138
DDIF$_SGA_IMG_PIXEL_PATH item in, 4-134
DDIF$_SGA_IMG_PLANES_PER_PIXEL item in,
4-138
DDIF$_SGA_IMG_PLANE_SIGNIF item in, 4-138
DDIF$_SGA_IMG_PP_PIXEL_DIST item in, 4-134
DDIF$_SGA_IMG_PRIVATE_DATA item in, 4-134
DDIF$_SGA_IMG_SPECTRAL_MAPPING item in,
4-135

lndex-12

DDIF$_SGA aggregate (Cont.)
DDIF$_SGA_ITEM_CHANGE_LIST item in, 4-153
DDIF$_SGA_LANGUAGE item in, 4-98
DDIF$_SGA_LAYGLY_LAYOUT item in, 4-104
DDIF$_SGA_LAYGLY_WRAP item in, 4-104
DDIF$_SGA_LAYOUT_C item in, 4-103
DDIF$_SGA_LAYPOS_TEXT_POSITION item in,
4-111
DDIF$_SGA_LAYPTH_FORMAT item in, 4-106
DDIF$_SGA_LAYPTH_H_ALIGN item in, 4-107
DDIF$_SGA_LAYPTH_ORIENTATION item in,
4-106
DDIF$_SGA_LAYPTH_ORIENTATION_C item in,
4-106
DDIF$_SGA_LAYPTH_PATH item in, 4-105
DDIF$_SGA_LAYPTH_V_ALIGN item in, 4-108
DDIF$_SGA_LAYREL_H_CONSTANT item in,
4-109
DDIF$_SGA_LAYREL_H_CONSTANT_C item in,
4-109
DDIF$_SGA_LAYREL_H_RATIO_D item in, 4-109
DDIF$_SGA_LAYREL_H_RATIO_N item in, 4-109
DDIF$_SGA_LAYREL_V_CONSTANT item in,
4-110
DDIF$_SGA_LAYREL_V_CONSTANT_C item in,
4-110
DDIF$_SGA_LAYREL_V_RATIO_D item in, 4-110
DDIF$_SGA_LAYREL_V_RATIO_N item in, 4-109
DDIF$_SGA_LEGEND_UNIT_D item in, 4-99
DDIF$_SGA_LEGEND_UNIT_NAME item in, 4-99
DDIF$_SGA_LEGEND_UNIT_N item in, 4-99
DDIF$_SGA_LINE_STYLE_DEFNS item in, 4-115
DDIF$_SGA_LIN_END_FINISH item in, 4-130
DDIF$_SGA_LIN_END_SIZE item in, 4-130
DDIF$_SGA_LIN_END_SIZE_C item in, 4-130
DDIF$_SGA_LIN_END_START item in, 4-129
DDIF$_SGA_LIN_INTERIOR_PATTERN item in,
4-130
DDIF$_SGA_LIN_JOIN item in, 4-130
DDIF$_SGA_LIN_MASK_PATTERN item in, 4-129
DDIF$_SGA_LIN_MITER_LIMIT_D item in, 4-130
DDIF$_SGA_LIN_MITER_LIMIT_N item in, 4-130
DDIF$_SGA_LIN_PATTERN_SIZE item in, 4-129
DDIF$_SGA_LIN_PATTERN_SIZE_C item in,
4-129
DDIF$_SGA_LIN_STYLE item in, 4-128
DDIF$_SGA_LIN_WIDTH item in, 4-128
DDIF$_SGA_LIN_WIDTH_C item in, 4-128
DDIF$_SGA_MKR_MASK_PATTERN item in,
4-132
DDIF$_SGA_MKR_SIZE item in, 4-132
DDIF$_SGA_MKR_SIZE_C item in, 4-132
DDIF$_SGA_MKR_STYLE item in, 4-132
DDIF$_SGA_PATH_DEFNS item in, 4-114
DDIF$_SGA_PATTERN_DEFNS item in, 4-113
DDIF$_SGA_PRIVATE_DATA item in, 4-90
DDIF$_SGA_SEGMENT_TAGS item in, 4-91
DDIF$_SGA_STRUCTURE_DESC item in, 4-97
DDIF$_SGA_STRUCTURE_DESC_C item in,
4-97
DDIF$_SGA_TXT_DEC_ALIGNMENT item in,
4-125
DDIF$_SGA_TXT_DIRECTION item in, 4-124
DDIF$_SGA_TXT_FONT item in, 4-120
DDIF$_SGA_TXT_HEIGHT item in, 4-123
DDIF$_SGA_TXT_HEIGHT_C item in, 4-123
DDIF$_SGA_TXT_LEADER_ALIGN item in, 4-126

DDIF$_SGA aggregate (Cont.)
DDIF$_SGA_TXT_LEADER_8ULLET item in,
4-126
DDIF$_SGA_TXT_LEADER_SPACE item in,
4-126
DDIF$_SGA_TXT_LEADER_SPACE_C item in,
4-126
DDIF$_SGA_TXT_LEADER_STYLE item in, 4-126
DDIF$_SGA_TXT_MASK_PATTERN item in,
4-119
DDIF$_SGA_TXT_PAIR_KERNING item in, 4-127
DDIF$_SGA_TXT_RENDITION item in, 4-122
DDIF$_SGA_TXT_SET_SIZE_D item in, 4-123
DDIF$_SGA_TXT_SET_SIZE_N item in, 4-123
DDIF$_SGA_TYPE_DEFNS item in, 4-117
DDIF$_SGA_UNITS_PER_MEASURE item in,
4-100
DDIF$_SGA_UNIT_NAME item in, 4-100
items in, 4-86t
DDIF$_SG8 aggregate, 4-154 to 4-159
DDIF$_SG8_COM_STRING_EXPR item in, 4-158
DDIF$_SG8_COM_STRING_EXPR_C item in,
4-158
DDIF$_SG8_CTR_INIT item in, 4-157
DDIF$_SG8_CTR_INIT_C item in, 4-157
DDIF$_SG8_CTR_STYLE item in, 4-157
DDIF$_SG8_CTR_TRIGGER_C item in, 4-156
DDIF$_SG8_CTR_TYPE item in, 4-157
DDIF$_SG8_RCD_LIST item in, 4-159
DDIF$_SG8_VARIA8LE_NAME item in, 4-154
DDIF$_SG8_VARIA8LE_VALUE_C item in, 4-155
items in, 4-154t
DDIF$_TBS aggregate, 4-160 to 4-161
DDIF$_TBS_HORIZONTAL_POSITION item in,
4-160
DDIF$_TBS_HORIZONTAL_POSITION_C item in,
4-160
DDIF$_T8S_LEADER item in, 4-161
DDIF$_TBS_TYPE item in, 4-161
items in, 4-160t
DDIF$_TRN aggregate, 4-162 to 4-163
DDIF$_TRN_PARAMETER item in, 4-163
DDIF$_TRN_PARAMETER_C item in, 4-163
items in, 4-162t
DDIF$_TXT aggregate, 4-164
DDIF$_TXT_CONTENT item in, 4-164
DDIF$_TYD aggregate, 4-165 to 4-166
DDIF$_TYD_ATTRl8UTES item in, 4-165
DDIF$_TYD_LA8EL item in, 4-165
DDIF$_TYD_PARENT item in, 4-165
DDIF$_TYD_PRIVATE_DATA item in, 4-166
items in, 4-165t
DDIF$_USER_CONTEXT aggregate item, defined,
4-1
DDIF (DIGITAL Document Interchange Format)
analyzing files encoded in, 2-8
VMS RMS support of, F-1
DDIF aggregate hierarchy, 1-6fig
DDIF aggregates, list of, 1-5
DDIF back end, 2-3
conversion restrictions, 2-3
data mapping in, 2-3
DDIFDocument syntax diagram, B-5
DDIF front end, 2-1
conversion restrictions, 2-1
data mapping in, 2-1
document syntax errors in, 2-1

DDIF front end (Cont.)
external file references in, 2-1
DDIF initial values, 1-9
DDIF processing options, 1-13
attribute inheritance, 1-14
discard segments, 1-17
evaluate content, 1-15
computed content, 1-16
content definitions, 1-16
content references, 1-16
retain definitions, 1-15
DDIF standard aggregates, 1-5t
DDIF tags, 1-7
DDIF-to-Text RMS extension, F-1
ODIS built-in constructors
SEQUENCE, B-2
SEQUENCE OF, B-2
ODIS built-in operators
ANY, B-3
assignment, 8-3
CHOICE, 8-3
comment, 8-3
DEFAULT, B-3
name.d number, 8-3
OPTIONAL, 8-3
ODIS built-in primitives
BIT STRING, B-1
BOOLEAN, B-1
EXTERNAL, 8-2
FLOATING-POINT, 8-1
INTEGER, B-1
NULL, 8-1
OBJECT IDENTIFIER, 8-2
OCTET STRING, 8-1
ODIS defined types
Character-String, 8-4
Latin1-String, 8-4
ObjectDescriptor, 8-4
Text-String, B-4
ODIS encoding
definition of, 1-2
Decimal string construct
See Expressionlist syntax diagram and CFE
expressions, conversion
Decimal-string syntax diagram
See Expressionlist syntax diagram
DEFAULT built-in operator, defined, B-3
Default values
for CDA, 1-4
DELETE AGGREGATE routine, 8-58
DELETE ROOT AGGREGATE routine, 8-60
Dep-cross syntax diagram
See Expressionlist syntax diagram
Dep-db syntax diagram
See Expressionlist syntax diagram
Dep-ddb syntax diagram
See Expressionlist syntax diagram
Depreciation, declining balance construct
See Expressionlist syntax diagram and CFE
expressions, financial
Depreciation, declining balance with crossover to
straight line construct
See Expressionlist syntax diagram and CFE
expressions, financial

lndex-13

Depreciation, straight line construct
See ExpressionList syntax diagram and CFE
expressions, financial
Depreciation, sum of year's digits construct
See ExpressionList syntax diagram and CFE
expressions, financial
Depreciation double declining balance construct
See ExpressionList syntax diagram and CFE
expressions, financial
Dep-sline syntax diagram
See ExpressionList syntax diagram
Dep-soyd syntax diagram
See ExpressionList syntax diagram
-d format qualifier
for the cdoc command, 2-16
Diff-day syntax diagram
See ExpressionList syntax diagram
Diff-hour syntax diagram
See ExpressionList syntax diagram
Diff-min syntax diagram
See ExpressionList syntax diagram
Diff-month syntax diagram
See ExpressionList syntax diagram
Diff-sec syntax diagram
See ExpressionList syntax diagram
Diff-week syntax diagram
See ExpressionList syntax diagram
Diff-year syntax diagram
See ExpressionList syntax diagram
DIGITAL Document Interchange Format
See DDIF
Directive
hard, 4-34
hard value, 4-36 to 4-37
soft, 4-81
soft value, 4-83 to 4-84
values for, 4-34t, 4-81 t
Directive syntax diagram, B-1 O
Discard segments processing options, 1-17
Discount construct
See ExpressionList syntax diagram and CFE
expressions, financial
Disjoint ranges, 5-55
See also Ranges
Divide syntax diagram
See ExpressionList syntax diagram
Division construct
See ExpressionList syntax diagram and CFE
expressions, arithmetic
Document
creating for output, 8-39
describing the encoding of, 4-12
distinguishing versions of, 4-14
indicating the name of, 4-17
reading from a stream, 8-97
representing the encoding software of, 4-17
returning position in, 8-148
returning size of, 8-148
specifying external style guide for, 4-15
specifying file references in, 4-14
specifying parameters for, 4-12
specifying private information for, 4-13
specifying processing languages in, 4-14
specifying processing restrictions for, 4-14

lndex-14

Document (Cont.)
specifying the author of, 4-14
specifying the content of, 4-12
specifying the title of, 4-13
specifying version date of, 4-14
structure of, 4-1
testing the compatibility of versions for, 4-16
writing, 8-153
Document content aggregate, 4-78
See also DDIF$_SEG aggregate
generic layout item in, 4-79
items in, 4-78t
segment attribute item in, 4-79
segment content item in, 4-80
segment identifier item in, 4-78
segment type item in, 4-79
segment user label item in, 4-79
specific layout item in, 4-79
Document descriptor aggregate, 4-16 to 4-17
See also DDIF$_DSC aggregate
items in, 4-16t
major version item in, 4-16
minor version item in, 4-16
product identifier item in, 4-17
product name item in, 4-17
DocumentDescriptor syntax diagram, B-5, C-1
Document header aggregate, 4-13
See also DDIF$_DHD aggregate
author item in, 4-14
conformance tags item in, 4-14
date item in, 4-14
external references item in, 4-14
items in, 4-13t
language item in, 4-15
languages indicator item in, 4-14
private header data item in, 4-13
style guide item in, 4-15
title item in, 4-13
version item in, 4-14
DocumentHeader syntax diagram, B-6, C-2
Document root segment syntax diagram, B-6
Document scope
completing, 8-112
entering, 8-62
Document syntax errors
in DDIF front end, 2-1
in Text front end, 2-3
domain$read_format entry point routine, 11-1 O
domain$write _format entry point, 11-15
$2D tag, defined, 4-90
DTIF$K_MAJOR_VERSION literal, 5-23
DTIF$K_MINOR_VERSION literal, 5-23
dtif$write_format, 8-16
DTIF$_AGGREGATE_TYPE aggregate item, 5-1
DTIF$_ARD aggregate, 5-2 to 5-3
DTIF$_ARD_DESCRIPTION item in, 5-2
DTIF$_ARD_ELEM_TYPE_SIZE item in, 5-3
DTIF$_ARD_ELEM_TYPE_SIZE_C item in, 5-2
DTIF$_ARD_VALUES item in, 5-3
DTIF$_ARD_X_DIMENSION item in, 5-3
DTIF$_ARD_Y_DIMENSION item in, 5-3
DTIF$_ARD_Z_DIMENSION item in, 5-3
items in, 5-2
DTIF$_CAT aggregate, 5-4 to 5-9
DTIF$_CAT_APPL_PRIVATE item in, 5-5
DTIF$_CAT_COLUMN_HDR item in, 5-8

DTIF$_CAT aggregate (Cont.)
DTIF$_CAT_COMPUTED_BY item in, 5-5
DTIF$_CAT_DATA_LENGTH item in, 5-8
DTIF$_CAT_DATA_TYPE item in, 5-8
DTIF$_CAT_DEFAULT_VALUE item in, 5-6
DTIF$_CAT_DEFAULT_VALUE_C item in, 5-5
DTIF$_CAT_DESCRIPTION item in, 5-5
DTIF$_CAT_FLAGS item in, 5-8
DTIF$_CAT_FORMATS item in, 5-5
DTIF$_CAT_GENERIC_REF item in, 5-5
DTIF$_CAT_ID item in, 5-5
DTIF$_CAT_MISSING_VALUE item in, 5-7
DTIF$_CAT_NAME item in, 5-4
DTIF$_CAT_QUERY_NAME item in, 5-7
DTIF$_CAT_SCALE_FACTOR item in, 5-8
items in, 5-4
DTIF$_CCD aggregate, 5-10 to 5-11
DTIF$_CCD_COLUMN item in, 5-10
DTIF$_CCD_FLAGS item in, 5-10
DTIF$_CCD_ROW item in, 5-1 O
items in, 5-1 O
DTIF$_CFT aggregate, 5-12
DTIF$_CFT_IMAGINARY_PART item in, 5-12
DTIF$_CFT_REAL_PART item in, 5-12
items in, 5-12
DTIF$_CLD aggregate, 5-13 to 5-17
DTIF$_CLD_APPL_PRIVATE item in, 5-15
DTIF$_CLD_COL_NUM item in, 5-14
DTIF$_CLD_DESCRIPTION item in, 5-15
DTIF$_CLD_FORMATS item in, 5-15
DTIF$_CLD_FORMULA_CFE item in, 5-16
DTIF$_CLD_STATE item in, 5-14
DTIF$_CLD_VALUE item in, 5-16
DTIF$_CLD_VALUE_C item in, 5-15
items in, 5-14
DTIF$_CLR aggregate, 5-18
DTIF$_CLR_RANGE_BEGIN item in, 5-18
DTIF$_CLR_RANGE_END item in, 5-18
items in, 5-18
DTIF$_COR aggregate, 5-19
DTIF$_COR_COL_BEGIN item in, 5-19
DTIF$_COR_COL_END item in, 5-19
items in, 5-19
DTIF$_DAT aggregate, 5-20 to 5-21
DTIF$_DAT_DATETIME item in, 5-20
DTIF$_DAT_TIME_DIFF item in, 5-21
DTIF$_DAT_TIME_DIFF_C item in, 5-20
items in, 5-20
DTIF$_DSC aggregate, 5-22 to 5-23
DTIF$_DSC_ENCODE_MAJOR_VERSION item in,
5-23
DTIF$_DSC_ENCODE_MINOR_VERSION, 5-23
DTIF$_DSC_MAJOR_VERSION item in, 5-22
DTIF$_DSC_MINOR_VERSION item in, 5-22
DTIF$_DSC_PRODUCT_IDENTIFIER item in,
5-22
DTIF$_DSC_PRODUCT_NAME item in, 5-22
items in, 5-22
DTIF$_DTF aggregate, 5-24
DTIF$_DTF_DESCRIPTOR item in, 5-24
DTIF$_DTF_HEADER item in, 5-24
DTIF$_DTF_TABLES item in, 5-24
items in, 5-24
DTIF$_ERF aggregate, 5-25 to 5-26
DTIF$_ERF_CONTROL item in, 5-26
DTIF$_ERF_DATA_TYPE item in, 5-25
DTIF$_ERF_DESCRIPTOR item in, 5-25

DTIF$_ERF aggregate (Cont.)
DTIF$_ERF_LABEL item in, 5-25
DTIF$_ERF_LABEL_TYPE item in, 5-26
items in, 5-25
DTIF$_EXT aggregate, 5-27 to 5-28
DTIF$_EXT_DATA_VALUE_DESCRIPTOR item in,
5-27
DTIF$_EXT_DIRECT_REFERENCE item in, 5-27
DTIF$_EXT_ENCODING item in, 5-28
DTIF$_EXT_ENCODING_C item in, 5-27
DTIF$_EXT_ENCODING_L item in, 5-28
DTIF$_EXT_INDIRECT_REFERENCE item in,
5-27
items in, 5-27
DTIF$_FMI aggregate, 5-29 to 5-42
DTIF$_FMl_ALIGNMENT item in, 5-40
DTIF$_FMl_BORDER item in, 5-40
DTIF$_FMl_C item in, 5-30
DTIF$_FMl_DATEDS_EDITSTR item in, 5-38
DTIF$_FMl_DATEID_EDITSTR_ID item in, 5-38 .
DTIF$_FMl_DATSTD_ORDER item in, 5-37
DTIF$_FMl_DATSTD_TYPE item in, 5-37
DTIF$_FMl_DAT_C item in, 5-36
DTIF$_FMl_DIRECTION item in, 5-40
DTIF$_FMl_FLAGS item in, 5-38
DTIF$_FMl_LANG_ID item in, 5-39
DTIF$_FMl_NUMEDS_EDITSTR item in, 5-34
DTIF$_FMl_NUMEID_EDITSTR_ID item in, 5-34
DTIF$_FMl_NUMSTD_DIGITS item in, 5-34
DTIF$_FMl_NUMSTD_FRAC item in, 5-34
DTIF$_FMl_NUMSTD_TYPE item in, 5-32
DTIF$_FMl_NUM_C item in, 5-31
DTIF$_FMl_NUM_DATATYPE item in, 5-31
DTIF$_FMl_NUM_RNDTRUNC item in, 5-34
DTIF$_FMl_TXTEDS_EDITSTR item in, 5-36
DTIF$_FMl_TXTEID_EDITSTR_ID item in, 5-36
DTIF$_FMl_TXTSTD_TYPE item in, 5-35
DTIF$_FMl_UNIT_DESC item in, 5-40
DTIF$_FMl_WIDTH item in, 5-39
DTIF$_FMl_WINDOW_ID item in, 5-30
DTIF$_TXT_C item in, 5-35
items in, 5-29
DTIF$_HDR aggregate, 5-43 to 5-45
DTIF$_HDR_DATE item in, 5-43
DTIF$_HDR_EXTERNAL_REFERENCES item in,
5-44
DTIF$_HDR_GENERIC_COLUMNS item in, 5-44
DTIF$_HDR_LANGUAGES item in, 5-44
DTIF$_HDR_LANGUAGES_C item in, 5-44
DTIF$_HDR_LANGUAGE_PREF_TABLES item in,
5-44
DTIF$_HDR_PRIVATE_DATA item in, 5-43
DTIF$_HDR_TITLE item in, 5-43
items in, 5-43
DTIF$_LPT aggregate, 5-46 to 5-50
DTIF$_LPT_COLLATE_SEQ item in, 5-49
DTIF$_LPT_COLLATE_TABLE item in, 5-49
DTIF$_LPT_EDITSTRS item in, 5-48
DTIF$_LPT_ITEMS item in, 5-47
DTIF$_LPT_LANGUAGE_INDEX item in, 5-46
items in, 5-46
DTIF$_NES aggregate, 5-51
DTIF$_NES_DEFN item in, 5-51
DTIF$_NES_NAME item in, 5-51
items in, 5-51
DTIF$_NMR aggregate, 5-52
DTIF$_NMR_NAMEDRANGE item in, 5-52

lndex-15

DTIF$_NMR aggregate (Cont.)
items in, 5-52
DTIF$_NVL
items in, 5-53
DTIF$_NVL aggregate, 5-53 to 5-54
DTIF$_NVL_NAME item in, 5-53
DTIF$_NVL_VALUE item in, 5-54
DTIF$_NVL_VALUE_C item in, 5-53
DTIF$_READ_format, 8-15
DTIF$_RNG aggregate, 5-55 to 5-56
DTIF$_RNG_NAME item in, 5-55
DTIF$_RNG_REGION item in, 5-56
DTIF$_RNG_SORT_KEYNUM item in, 5-56
DTIF$_RNG_TYPE item in, 5-55
items in, 5-55
DTIF$_ROW aggregate, 5-57 to 5-58
DTIF$_ROW_APPL_PRIVATE item in, 5-57
DTIF$_ROW_CELLS item in, 5-58
DTIF$_ROW_FLAGS item in, 5-58
DTIF$_ROW_FORMATS item in, 5-57
DTIF$_ROW_NUM item in, 5-57
items in, 5-57
DTIF$_RWR aggregate, 5-59
DTIF$_RWR_ROW_BEGIN item in, 5-59
DTIF$_RWR_ROW_END item in, 5-59
items in, 5-59
DTIF$_TBL aggregate, 5-60 to 5-61
DTIF$_TBL_APPL_PRIVATE item in, 5-61
DTIF$_TBL_MAX_COLS item in, 5-60
DTIF$_TBL_MAX_ROWS item in, 5-61
DTIF$_TBL_METADATA item in, 5-:-61
DTIF$_TBL_ROWS item in, 5-61
DTIF$_TBL_WINDOWS item in, 5-61
items in, 5-60
DTIF$_TMD aggregate, 5-62 to 5-64
DTIF$_TMD_APPL_PRIVATE item in, 5-62
DTIF$_TMD_COLUMNS item in, 5-63
DTIF$_TMD_DEFAULT_FMTS item in, 5-63
DTIF$_TMD_DESCRIPTION item in, 5-62
DTIF$_TMD_FLAGS item in, 5-63
DTIF$_TMD_ID item in, 5-62
DTIF$_TMD_NAME item in, 5-62
DTIF$_TMD_RANGES item in, 5-64
DTIF$_TMD_SYMBOLS item in, 5-64
items in, 5-62
DTIF$_USER_CONTEXT aggregate item, defined,

5-1
DTIF$_VTX aggregate, 5-65
DTIF$_VTX_VTEXT_LEN item in, 5-65
DTIF$_VTX_VTEXT_STR item in, 5-65
items in, 5-65
DTIF$_WND aggregate, 5-66 to 5-68
DTIF$_WND_ACTIVE_LOC item in, 5-67
DTIF$_WND_APPL_PRIVATE item in, 5-66
DTIF$_WND_CARDINAL_NUM item in, 5-67
DTIF$_WND_DESCRIPTION item in, 5-67
DTIF$_WND_FLAGS item in, 5-67
DTIF$_WND_FORMATS item in, 5-67
DTIF$_WND_ID item in, 5-66
DTIF$_WND_NAME item in, 5-66
DTIF$_WND_RANGES item in, 5-67
items in, 5-66
DTIF application private aggregate, 5-27 to 5-28
data value descriptor item in, 5-27
dir~ct reference item in, 5-27
encoding indicator item in, 5-27
encoding item in, 5-28

lndex-16

DTIF application private aggregate (Cont.)
encoding length item in, 5-28
indirect reference item in, 5-27
items in, 5-27
DTIF back end
conversion restrictions, 2-4
data mapping, 2-3
external file references, 2-4
overview, 2-3
DTIF cell coordinates
absolute references to, 5-11
relative references to, 5-11
DTIF cell coordinates aggregate, 5-10 to 5-11
column identifier item in, 5-10
flags item in, 5-1 O
items in, 5-1 O
row identifier item in, 5-1 O
DTIF cell range aggregate, 5-18
items in, 5-18
range begin item in, 5-18
range end item in, 5-18
DTIF column range aggregate, 5-19
column begin item in, 5-19
column end item in, 5-19
items in, 5-19
DTIF complex float aggregate, 5-12
imaginary portion value item in, 5-12
items in, 5-12
real portion value item in, 5-12
DTIF date and time aggregate, 5-20 to 5-21
date and time item in, 5-20
items in, 5-20
time difference item in, 5-20
DTIF document
distinguishing versions of, 5-23
encoding edit strings in, 7-4
encoding expressions in, 6-53
generic aggregate items
DTIF$_AGGREGATE_TYPE, 5-1
DTIF$_USER_CONTEXT, 5-1
representing the encoding software of, 5-23
specifying array values, 5-2
specifying cell coordinates for, 5-1 O
specifying cell data for, 5-13
specifying cell ranges for, 5-18
specifying column attributes for, 5-4
specifying column ranges for, 5-19
specifying complex floating-point values, 5-12
specifying date and time values for, 5-20, 7-2
specifying external references for, 5-44
specifying format information for, 5-29
specifying generic attributes for, 5-44
specifying language preference tables for, 5-44,

5-46
specifying named edit strings for, 5-51
specifying named ranges for, 5-52
specifying named values for, 5-53, 7-22
specifying natural and programming languages for,

5-44
specifying private data for, 5-27, 5-43
specifying product identifier in, 5-22
specifying product name in, 5-22
specifying ranges for, 5-55
specifying row ranges for, 5-59
specifying rows for, 5-57
specifying table definitions for, 5-60
specifying table metadata for, 5-62

DTIF document (Cont.)
specifying table windows for, 5-66
specifying the title of, 5-43
specifying the version date of, 5-43
specifying varying text string values, 5-65
DTIF document aggregate
language item in, 5-44
product identifier item in, 5-22
DTIF document descriptor aggregate, 5-22 to 5-23
encoding major version indicator item in, 5-23
encoding minor version indicator item in, 5-23
items in, 5-22
major version indicator item in, 5-22
minor version indicator item in, 5-22
product name item in, 5-22
DTIF document header aggregate, 5-43 to 5-45
date item in, 5-43
external references item in, 5-44
generic attributes item in, 5-44
items in, 5-43
language preference table item in, 5-44
languages indicator item in, 5-44
private header data item in, 5-43
title item in, 5-43
DTIF document root aggregate, 5-24
document descriptor item in, 5-24
document header item in, 5-24
document tables item in, 5-24
items in, 5-24
DTIFDocument syntax diagram, C-1
DTIF external reference
specifying data type of, 5-25
specifying description of the data type of, 5-25
specifying label for, 5-25
specifying storage system of, 5-26
specifying treatment of, 5-26
DTIF external reference aggregate, 5-25 to 5-26
control item in, 5-26
items in, 5-25
reference data type item in, 5-25
reference descriptor item in, 5-25
reference label item in, 5-25
storage item in, 5-26
DTIF front end
conversion restrictions, 2-2
data mapping, 2-2
external file references, 2-2
overview, 2-2
DTIF named value aggregate, 5-53 to 5-54
items in, 5-53
value data item in, 5-53, 5-54
value name item in, 5-53
DTIF named values
specifying the name for, 5-53
specifying the value data for, 5-53
DTIF row range aggregate, 5-59
items in, 5-59
row begin data item in, 5-59
row end data item in, 5-59
DTIF syntax diagrams, C-1 to C-18
DTIF tables
See DTIF document
See Table definition
See Table metadata
DTIF varying text aggregate, 5-65
character string data item in, 5-65
items in, 5-65

DTIF varying text aggregate (Cont.)
text length item in, 5-65
dxvdoc command, 2-18 to 2-19
-fformat qualifier, 2-18
-h paper-height qualifier, 2-19
-0 options qualifier, 2-19
-r qualifier, 2-19
-w paper-width qualifier, 2-19

E
EditStrBuff syntax diagram, E-1
EditStrlndex syntax diagram, C-12
Edit string aggregate, 7-4 to 7-19
edit string indicator item in, 7-5
items in, 7-4
major version item in, 7-4
minor version item in, 7-4
Edit strings
See ESF edit strings
EditString syntax diagram, E-1
Ellipse
See Arc
$EN tag, defined, 4-30, 4-90
ENTER SCOPE routine, 8-62
Enumeration
AngleRef, 1-1
encoding of, 1-2
expression, 1-2
measurement, 1-3
Eql syntax diagram
See Expressionlist syntax diagram
Equal to construct
See Expressionlist syntax diagram and CFE
expressions, Boolean and relational
ERASE ITEM routine, 8-76
ERF
See External reference; External reference
aggregate
Error conditions
for cell values, 5-15
Error construct
See Expressionlist syntax diagram and CFE
expressions, cell-related
EscapementDirective syntax diagram, B-11
Escapement syntax diagram, B-20
Escapement type, B-20
ESF$_AGGREGATE_TYPE aggregate item, 7-1
ESF$_DAT aggregate, 7-2 to 7-3
ESF$_DAT_DATETIME item in, 7-2
ESF$_DAT_TIME_DIFF item in, 7-3
ESF$_DAT_TIME_DIFF_C item in, 7-3
items in, 7-2
ESF$_EDS aggregate, 7-4 to 7-19
ESF$_EDS_EDIT_STRING_C item in, 7-5
ESF$_EDS_MAJOR_VERSION item in, 7-4
ESF$_EDS_MINOR_VERSION item in, 7-4
ESF$_EXT_DIRECT_REFERENCE item in, 7-20
items in, 7-4
ESF$_EXT aggregate, 7-20 to 7-21
ESF$_EXT_DATA_VALUE_DESCRIPTOR item in,
7-20
ESF$_EXT_ENCODING_C item in, 7-20
ESF$_EXT_INDIRECT_REFERENCE item in,
7-20
items in, 7-20

lndex-17

ESF$_NVL
items in, 7-22
ESF$_NVL aggregate, 7-22 to 7-23
ESF$_NVL_NAME item in, 7-22
ESF$_NVL_VALUE item in, 7-23
ESF$_NVL_VALUE_C item in, 7-22
ESF$_RPT aggregate, 7-24 to 7-26
ESF$_RPT_COUNT item in, 7-24
ESF$_RPT_SEQ item in, 7-26
ESF$_RPT_SEQ_C item in, 7-24
items in, 7-24
ESF$_TXS aggregate, 7-27
ESF$_TXS_TEXT_STRING item in, 7-27
items in, 7-27
ESF$_USER_CONTEXT aggregate item, 7-1
ESF application private aggregate, 7-20 to 7-21
data value descriptor item in, 7-20
direct reference item in, 7-20
encoding indicator item in, 7-20
indirect-reference item in, 7-20
items in, 7-20
ESF date and time aggregate, 7-2 to 7-3
date and time item in, 7-2
items in, 7-2
time difference item in, 7-3
ESF edit strings
alphabetic, 7-5
am-pm, 7-5
any case, 7-6
any character, 7-6
application private, 7-6
binary digit, 7-6
CURRENCY_LIT, 7-7
day number, 7-7
decimal digit, 7-8
digit separator, 7-8
digit separator literal, 7-9
encoded minus, 7-9
encoded plus, 7-9
encoded sign, 7-10
exponent, 7-10
float currency, 7-6
floating blank suppression, 7-10
floating minus, 7-12
floating plus, 7-15
floating sign, 7-17
float zero replace, 7-19
fraction second, 7-11
hexadecimal digit, 7-11
hour 12, 7-11
hour 24, 7-11
julian digit, 7-11
logical character, 7-11
long text, 7-12
lowercase, 7-12
minute, 7-13
missing separator, 7-14
month name, 7-14
month number, 7-14
octal digit, 7-14
radix point, 7-16
radix-point literal, 7-17
repeat, 7-17
reverse, 7-17
second, 7-17
string literal, 7-18
UPPERCASE, 7-18

lndex-18

ESF edit strings (Cont.)
week day name, 7-18
year, 7-19
ESF generic aggregate items, 7-1
ESF$_AGGREGATE_TYPE, 7-1
ESF$_USER_CONTEXT, 7-1
ESF named value aggregate, 7-22 to 7-23
items in, 7-22
value data item in, 7-22, 7-23
value name item in, 7-22
ESF named values
specifying the name for, 7-22
specifying the value data for, 7-22
ESF syntax diagrams, E-1 to E-3
$E tag, defined, 4-91
Exponent construct
See ExpressionList syntax diagram and CFE
expressions, transcendental
ExprChoice syntax diagram, D-3
See also ExpressionList syntax diagram
Expression aggregate, 6-53 to 6-54
items in, 6-53
list item in, 6-53
major version item in, 6-53
minor version item in, 6-53
Expression enumeration, 1-2
Expression list aggregate, 6-9 to 6-52
expression item in, 6-52
items in, 6-9
ExpressionList syntax diagram, D-3
Expressions
See CFE expressions
Expression syntax diagram, B-37, D-2
Ext-day syntax diagram
See ExpressionList syntax diagram
EXTERNAL built-in primitive, defined, B-2
External content, 1-15
External file references
DTIF back end, 2-4
DTIF front end, 2-2
External reference
identifying data type of, 4-18
identifying storage system of, 4-18
in DDIF front end, 2-1
in Text front end, 2-3
processing, 8-126
specifying description of the data type of, 4-18
specifying label for, 4-18
specifying treatment of, 4-20
External reference aggregate, 4-18 to 4-20
See also DDIF$_ERF aggregate
See DTIF external reference aggregate
control item in, 4-20
items in, 4-18t
reference data type item in, 4-18
reference descriptor item in, 4-18
reference label item in, 4-18
storage item in, 4-18
External reference computed content, 1-16
ExternalReference syntax diagram, B-20, C-2
ExternalReflndex syntax diagram, 8-23, C-3
External restricted content aggregate, 4-21 to 4-22
See also DDIF$_EXT aggregate
data value descriptor item in, 4-21
direct reference item in, 4-21
encoding indicator item in, 4-22

External restricted content aggregate (Cont.)

Fill area set content aggregate (Cont.)

encoding length item in, 4-22
indirect reference item in, 4-21
items in, 4-21 t
Ext-hour syntax diagram
See ExpressionList syntax diagram
Ext-minute syntax diagram
See ExpressionList syntax diagram
Ext-month syntax diagram
See ExpressionList syntax diagram
Extract substring left construct
See ExpressionList syntax diagram and CFE
expressions, string
Extract substring right construct
See ExpressionList syntax diagram and CFE
expressions, string
Ext-second syntax diagram
See ExpressionList syntax diagram
Ext-year syntax diagram
See ExpressionList syntax diagram

set path item in, 4-24
FillAreaSet syntax diagram, B-12
FIND DEFINITION routine, 8-79
FIND TRANSFORMATION routine, 8-83
$FINSWD collating sequence, 5-49
$FLOAT editstring-name, 5-49
FLOATING-POINT built-in primitive, defined, B-1
Floating-point construct
See ExpressionList syntax diagram and CFE
expressions, literals
Floating-point data type, defined, 1-4
Flush routine, 9-4
FLUSH STREAM routine, 8-86
FmtFlags syntax diagram, C-14
FmtPrec syntax diagram, C-13
$FN tag, defined, 4-30, 4-90, 4-91
Font definition
specifying for the defining segment, 4-25
specifying name for, 4-25
specifying private data for, 4-25
Font definition aggregate, 4-25
See also DDIF$_FTD aggregate
identifier item in, 4-25
items in, 4-25t
number item in, 4-25
private data item in, 4-25
FontDefn syntax diagram, B-21
FontNumber syntax diagram, 8-29
Foreground
See pattern definition; Pattern definition aggregate;
Image component space
Format information
generic format attributes, 5-29
guidelines for storing, 5-41
inheritance of, 5-29
specifying a format descriptor for, 5-40
specifying a format type indicator for, 5-30
specifying a language preference index in, 5-39
specifying a numeric data type indicator for, 5-31
specifying display width for, 5-39
specifying format direction for, 5-40
specifying window identifier for, 5-30
Format information aggregate, 5-29 to 5-42
date format indicator item in, 5-36
descriptor item in, 5-40
display width item in, 5-39
format direction item in, 5-40
items in, 5-29
language preference index item in, 5-39
numeric format indicator item in, 5-31
specifying a date edit string index for, 5-38
specifying a date ESF format for, 5-38
specifying a date standard order for, 5-37
specifying a numeric edit string index for, 5-34
specifying a numeric ESF format for, 5-34
specifying a text edit string index for, 5-36
specifying a text ESF format for, 5-36
specifying a text format type indicator for, 5-35
specifying borders for, 5-40
specifying digits of precision for, 5-34
specifying flags for, 5-38
specifying format alignment for, 5-40
specifying rounded or truncated values for, 5-34
specifying standard date types for, 5-37
specifying standard numeric types for, 5-32

F
Factorial construct
See ExpressionList syntax diagram and CFE
expressions, transcendental
False construct
See ExpressionList syntax diagram and CFE
expressions, variables
FAX image
See Image data unit aggregate, compression
parameters item in, compression type item in
-f format qualifier
for the dxvdoc command, 2-18
for the vdoc command, 2-20
Field in table construct
See ExpressionList syntax diagram and CFE
expressions, choose and lookup
Field reference aggregate, 6-55
field context item in, 6-55
field path item in, 6-55
items in, 6-55
Field-reference construct
See ExpressionList syntax diagram and CFE
expressions, field reference
File
See also Text file
closing, 8-6
creating, 8-39
opening, 8-130
File tag
accessing, F-1 O
creation of, F-1
DDIF, F-1
disposition by COPY command, F-4
preserving, F-13
requirement for, F-1
use of, F-1
Fill area set
controlling the rendition of, 4-23
specifying the composite path of, 4-24
Fill area set content aggregate, 4-23 to 4-24
See also DDIF$_FAS aggregate
flags item in, 4-23
items in, 4-23t

lndex-19

Format information aggregate (Cont.)
specifying standard text types for, 5-35
specifying the number of fractional digits of
precision for, 5-34
window identifier item in, 5-30
Formatlnfo syntax diagram, C-1 o
/FORMAT qualifier
for the VIEW command, 2-13
Formats
See Format information
Format syntax diagram, B-21
Formatting Primitive syntax diagram, B-10
FormatType syntax diagram, C-11
Frame
bounding box, 4-142
controlling presentation of, 4-140
fixed position, 4-147
galley, 4-149
inline position, 4-148
margin, 4-150
specifying a coordinate transformation for, 4-152
specifying attributes of, 4-139 to 4-152
specifying lower left corner x position of, 4-141
specifying lower left corner y position of, 4-141
specifying the clipping path of, 4-144
specifying the horizontal offset of the base for,
4-150
specifying the horizontal positioning of, 4-149
specifying the horizontal position of the lower left
corner of, 4-151
specifying the outline path of, 4-143
specifying the vertical offset from the base for,
4-150
specifying the vertical offset of the origin of, 4-148
specifying the vertical positioning of the lower edge
of, 4-149
specifying the x position of the origin of, 4-147
specifying they position of the origin of, 4-147
specifying upper right corner x position of, 4-141
specifying upper right corner y position of, 4-141
FrameParameters syntax diagram, B-21
FRM
See Frame
Front end
DDIF, 2-1
ddif$read_format entry point, 11-1 O to 11-14
dtif$read_format entry point, 11-10 to 11-14
entry point, 8-15
text, 2-2 to 2-3
$F tag, defined, 4-91

FTD
See Font definition; Font definition aggregate
Function computed content, 4-96
FunctionLink syntax diagram, B-23
Functions
See CFE expressions
Future value construct
See ExpressionList syntax diagram and CFE
expressions, financial
Future value of an annuity construct
See ExpressionList syntax diagram and CFE
expressions, financial
Future value of a single sum construct
See ExpressionList syntax diagram and CFE
expressions, financial

lndex-20

Fva syntax diagram
See ExpressionList syntax diagram
Fvpv syntax diagram
See Expressionlist syntax diagram
Fv syntax diagram
See ExpressionList syntax diagram

G
Galley
specifying attributes for, 4-133
specifying bottom margin for, 4-27
specifying left margin for, 4-26
specifying right margin for, 4-27
specifying top margin for, 4-26
Galley attributes aggregate, 4-26 to 4-27
See also DDIF$_GLA aggregate
galley bottom margin item in, 4-27
galley left margin item in, 4-26
galley right margin item in, 4-27
galley top margin item in, 4-26
items in, 4-26t
GalleyAttributes syntax diagram, B-41
Galley-based layout, 4-102, 4-104
GalleyFrameParams syntax diagram, B-22
GalleyLabel syntax diagram, B-25
GalleyVerticalPosition syntax diagram, B-22
Generalized Time universal defined type, defined, B-2
General text content, 4-32
General text content aggregate, 4-32
See also DDIF$_GTX aggregate
text content item in, 4-32
Generic aggregate items
CFE$_AGGREGATE_TYPE, 6-1
CFE$_USER_CONTEXT, 6-1
DDIF$_AGGREGATE_TYPE, 4-1
DDIF$_USER_CONTEXT; 4-1
DTIF$_AGGREGATE_TYPE, 5-1
DTIF$_USER_CONTEXT, 5-1
ESF$_AGGREGATE_TYPE, 7-1
ESF$_USER_CONTEXT, 7-1
Generic layout
specifying descriptions of page templates and rules
for, 4-42
specifying private data in, 4-42
Generic layout aggregate, 4-42
See also DDIF$_LG1 aggregate
items in, 4-42t
page descriptions item in, 4-42
private data item in, 4-42
GenericLayout syntax diagram, B-39
GenMeasure syntax diagram, B-42
GenSize syntax diagram, B-43
Geq syntax diagram
See ExpressionList syntax diagram
Get-Aggregate entry point, 11-5
GET AGGREGATE routine, 8-88
GET ARRAY SIZE routine, 8-94
GET DOCUMENT routine, 8-97
GET EXTERNAL ENCODING routine, 8-100
Get-Position entry point, 11-8
Get-position routine, 9-8
Get routine, 9-6, 9-7
GET STREAM POSITION routine, 8-103
GET TEXT POSITION routine, 8-106

GLY
See Galley; Galley attributes aggregate
$GO tag, defined, 4-91
Graphics
controlling interior fill pattern for, 4-130
Graphics discard option, 1-17
GraphicsPrimitive syntax diagram, B-11
Greater than construct
See Expressionlist syntax diagram and CFE
expressions, Boolean and relational
Greater than or equal to construct
See Expressionlist syntax diagram and CFE
expressions, Boolean and relational
$GRP tag, defined, 4-91
Gtr syntax diagram
See Expressionlist syntax diagram

H
Hard directive, 4-34
values for, 4-34t, 4-81t
Hard directive aggregate, 4-34
See also DDIF$_HRD aggregate
hard directive item in, 4-35
Hard value directive, 4-36 to 4-37
specifying escapement constant for, 4-37
specifying escapement ratio denominator for, 4-37
specifying escapement ratio numerator for, 4-37
specifying new variable value for, 4-37
specifying type of, 4-37
specifying variable to be reset by, 4-37
Hard value directive aggregate, 4-36 to 4-37
See also DDIF$_HRV aggregate
directive choice item in, 4-37
escapement constant indicator in, 4-37
escapement ratio item in, 4-37
items in, 4-36t
reset value item in, 4-37
reset variable item in, 4-37
Hlookup construct
See Expressionlist syntax diagram and CFE
expressions, choose and lookup
-h paper-height qualifier
for the dxvdoc command, 2-19
for the vdoc command, 2-21

Identification constructs
See Expressionlist syntax diagram and CFE
expressions, identification
Identifier construct
See Expressionlist syntax diagram and CFE
expressions, variables
If-then-else construct
See Expressionlist syntax diagram and CFE
expressions, Boolean and relational
Image
specifying application-private lookup tables for,
4-136
specifying aspect ratio along the pixel path of,
4-134
specifying attributes for, 4-134 to 4-136
specifying correlation between physical image data
and spectral components of, 4-135
specifying direction of scanline capture for, 4-134

Image (Cont.)
specifying line progression path aspect ratio for,
4-134
specifying private data for, 4-134
specifying the contents of, 4-41
specifying the direction of pixel capture path for,
4-134
specifying the physical format of the pixel grid of,
4-135
specifying the representation of intensity levels in,
4-135
specifying wavelength information for, 4-136
ImageAttributes syntax diagram, B-16
lmageCodingAttrs syntax diagram, B-15
Image component space
specifying attributes for, 4-137 to 4-138
specifying number of bits used for each image in,
4-138
specifying number of data planes for pixel in,
4-138
specifying number of spectral components in,
4-138
specifying physical organization of, 4-137
specifying significance of data planes in, 4-138
Image content aggregate, 4-41
image content item in, 4-41
items in, 4-41 t
See also DDIF$_1MG aggregate, 4-41
Image data
containing parameters for compression of, 4-39
indicating compression scheme for a plane of,
4-39
specifying actual values of, 4-40
specifying distance between pixels in, 4-39
specifying distance between scanlines in, 4-39
specifying number of pixels per scanline in, 4-38
specifying number of scanlines in, 4-39
specifying offset to first bit of, 4-39
specifying pixel order in, 4-40
specifying private data in, 4-38
specifying total number of bits per pixel in, 4-40
Image data unit aggregate, 4-38 to 4-40
See also DDIF$_1DU aggregate
compression parameters item in, 4-39
compression type item in, 4-39
data offset item in, 4-39
items in, 4-38t
number of lines item in, 4-39
pixel order item in, 4-40
pixels per line item in, 4-38
pixel stride item in, 4-39
plane bits per pixel item in, 4-40
plane data item in, 4-40
private data item in, 4-38
scanline stride item in, 4-39
Image discard processing option, 1-17
lmagePrimitive syntax diagram, B-15
Image resolution, 4-41
See Segment attributes aggregate, frame bounding
box items
lmgCmptSpcAttrs syntax diagram, B-17
lmgLutData syntax diagram, B-17
Index construct
See Expressionlist syntax diagram and CFE
expressions, choose and lookup
Inherit attributes processing option, 1-14

lndex-21

Inherit attributes processing option (Cont.)
initial values, 1-14
segment binding attributes, 1-14
segment initial values, 1-14
Initial values, 1-9, 1-14
Initial values, defined, 1-14
lnlineFrameParams syntax diagram, B-21
Input formats, 2-1 to 2-3
INSERT AGGREGATE routine, 8-108
In-table syntax diagram
See ExpressionList syntax diagram
INTEGER built-in primitive, defined, 8-1
Integer construct
See ExpressionList syntax diagram and CFE
expressions, literals
$INTEGER editstring-name, 5-49
Integrate construct
See ExpressionList syntax diagram and CFE
expressions, series
Interest construct
See ExpressionList syntax diagram and CFE
expressions, financial
Interest rate construct
See ExpressionList syntax diagram and CFE
expressions, financial
/INTERFACE qualifier
for the VIEW command, 2-14
Internal rate of return construct
See ExpressionList syntax diagram and CFE
expressions, financial
Int syntax diagram
See ExpressionList syntax diagram
Irr syntax diagram
See ExpressionList syntax diagram
lsblank syntax diagram
See ExpressionList syntax diagram
lsdate syntax diagram
See ExpressionList syntax diagram
lserror syntax diagram
See ExpressionList syntax diagram
lsnot-avail syntax diagram
See ExpressionList syntax diagram
lsnot-calc syntax diagram
See ExpressionList syntax diagram
lsnull syntax diagram
See ExpressionList syntax diagram
lsnumber syntax diagram
See ExpressionList syntax diagram
lsref syntax diagram
See ExpressionList syntax diagram
lsstring syntax diagram
See ExpressionList syntax diagram
$1 tag, defined, 4-90, 4-91
Item
array-valued, 8-94
erasing, 8-76
finding definition of, 8-79
locating, 8-115
writing the contents of, 8-160
Item change list, 4-153
Item change list, defined, 1-3
Item data types, 1-1t
$IX tag, defined, 4-30, 4-90

lndex-22

K
Kerning
definition of, 4-127

L
Label syntax diagram, 8-25
Label types syntax diagram, 8-24
LangPreflndex syntax diagram, C-11
LangPrefTable syntax diagram, C-3
Languagelndex syntax diagram, 8-24
Language preference table aggregate, 5-46 to 5-50
collating sequence item in, 5-49
customized collating sequence item in, 5-49
data type format item in, 5-48
items in, 5-46
preference table index in, 5-46
presentation attributes item in, 5-47
private preference data item in, 5-46
Language preference tables
specifying an index to, 5-39
specifying collating sequence for, 5-49
specifying customized collating sequence for, 5-49
specifying data type format for, 5-48
specifying presentation attributes for, 5-47
specifying private data for, 5-46
Languages
specifying for processing, 4-14
Languge preference tables
specifying the index for, 5-46
Latin1-String defined type, defined, 8-4
Latin1-String syntax diagram, 8-4
Latin1 text content, 4-164
Latin1 text content aggregate, 4-164
See also DDIF$_TXT aggregate
Layout, 4-102
forcing new line, galley, or page through, 4-46
galley-based, 4-102, 4-104
path-based, 4-102, 4-105
position-relative, 4-102, 4-109
selecting new galley for, 4-46
specifying amount of space after a segment in,
4-48
specifying amount of space before a segment in,
4-48
specifying indentation distance in, 4-47
specifying in-segment break condition in, 4-47
specifying leading space between lines in, 4-48
specifying new left indent in, 4-47
specifying new right indent in, 4-47
specifying post-segment break condition in, 4-47
specifying pre-segment break condition in, 4-46
specifying tab stops in, 4-49
text-position, 4-102, 4-111
Layout attributes aggregate, 4-45 to 4-49
See also DDIF$_LL1 aggregate
galley selection item in, 4-46
initial directive item in, 4-46
initial indent indicator item in, 4-47
in-segment break condition item in, 4-47
items in, 4-45t
leading ratio item in, 4-48
left indent indicator item in, 4-47
post-segment break condition item in, 4-47
pre-segment break condition item in, 4-46
right indent indicator item in, 4-47

Layout attributes aggregate (Cont.)
space-after indicator item in, 4-48
space-before indicator item in, 4-48
tab stops item in, 4-49
LayoutAttributes syntax diagram, B-42
Layout galley
specifying bounding box information for, 4-29
specifying content streams for, 4-30
specifying flag parameters for, 4-30
specifying outline path for content in, 4-30
specifying reference label for, 4-29
specifying text overflow galley type in, 4-31
Layout galley aggregate, 4-28 to 4-31
See also DDIF$_GLY aggregate
bounding box items for, 4-29
flags item in, 4-30
galley label item in, 4-29
galley outline item in, 4-30
galley streams item in, 4-30
galley successor item in, 4-31
items in, 4-28t
LayoutGalley syntax diagram, B-40
LayoutGalley type, B-40
LayoutObjectType syntax diagram, B-37
LayoutPrimitive syntax diagram, B-40
LayoutPrimitive type, 8-40
$LBL tag, defined, 4-91
LeaderStyle syntax diagram, 8-8
Least squares construct
See Expressionlist syntax diagram and CFE
expressions, series
LEAVE SCOPE routine, 8-112
Legend
See Content
Legend attributes, 4-99
LegendUnits syntax diagram, 8-25
Leq syntax diagram
See Expressionlist syntax diagram
Less than construct
See Expressionlist syntax diagram and CFE
expressions, Boolean and relational
Less than or equal to construct
See Expressionlist syntax diagram and CFE
expressions, Boolean and relational
$LE tag, defined, 4-91
Line
specifying attributes for, 4-128 to 4-131
specifying denominator of miter ratio of, 4-130
specifying ending shape of, 4-129
specifying ending size of, 4-130
specifying mask pattern of, 4-129
specifying numerator of miter ratio of, 4-130
specifying pattern for, 4-128
specifying pattern size of, 4-129
specifying shape of joins of, 4-130
specifying shape of the endings of, 4-130
specifying width of, 4-128
LineAttributes syntax diagram, B-12
LineDefn syntax diagram, B-31
LineEndNumber syntax diagram, B-14
LineJoin syntax diagram, B-14
Line-style definition
specifying line-style pattern in, 4-52
specifying private data for, 4-53
specifying reference number for, 4-52
Line-style definition aggregate, 4-52 to 4-53

Line-style definition aggregate (Cont.)
See also DDIF$_LSD aggregate
items in, 4-52t
line-style number item in, 4-52
line-style pattern item in, 4-52
line-style private data item in, 4-53
LineStyleNumber syntax diagram, B-14
Linking application images
on ULTRIX, 8-2
on VMS, 8-2
Linking converter images
on ULTRIX, 11-2
on VMS, 11-2
Linking viewer images
on ULTRIX, 13-2
on VMS, 13-2
Lit-complex-float syntax diagram
See Expressionlist syntax diagram
Lit-date syntax diagram
See Expressionlist syntax diagram
Lit-false syntax diagram
See Expressionlist syntax diagram
Lit-float syntax diagram
See Expressionlist syntax diagram
Lit-integer syntax diagram
See Expressionlist syntax diagram
Lit-pi syntax diagram
See Expressionlist syntax diagram
Lit-scaled-integer syntax diagram
See Expressionlist syntax diagram
$LIT tag, defined, 4-91
Lit-text syntax diagram
See Expressionlist syntax diagram
Lit-true syntax diagram
See Expressionlist syntax diagram
Lit-vtext syntax diagram
See Expressionlist syntax diagram
LOCATE ITEM routine, 8-115
Log, base 1O construct
See Expressionlist syntax diagram and CFE
expressions, transcendental
Log, base e construct
See Expressionlist syntax diagram and CFE
expressions, transcendental
Log1 O syntax diagram
See Expressionlist syntax diagram
Logest construct
See Expressionlist syntax diagram and CFE
expressions, series
Logical AND construct
See Expressionlist syntax diagram and CFE
expressions, Boolean and relational
Logical NOT construct
See Expressionlist syntax diagram and CFE
expressions, Boolean and relational
Logical OR construct
See Expressionlist syntax diagram and CFE
expressions, Boolean and relational
Logn syntax diagram
See Expressionlist syntax diagram
Lookup table entry aggregate, 4-77
See also DDIF$_RGB aggregate
blue value item in, 4-77

lndex-23

Lookup table entry aggregate (Cont.)
green value item in, 4-77
index item in, 4-77
items in, 4-77t
red value item in, 4-77
Lsqr syntax diagram
See Expressionlist syntax diagram
Lss syntax diagram
See Expressionlist syntax diagram
$L tag, defined, 4-91

M
Mailing CDA documents
See Transferring CDA documents
MarginFrameParams syntax diagram, 8-22
MarginHorizontalPosition syntax diagram, B-23
Marker
specifying attributes for, 4-132
specifying pattern for, 4-132
specifying size for, 4-132
specifying symbol used as, 4-132
MarkerAttributes syntax diagram, B-15
MarkerNumber syntax diagram, B-15, B-29
Matches construct
See Expressionlist syntax diagram and CFE
expressions, choose and lookup
Maximum construct
See Expressionlist syntax diagram and CFE
expressions, statistical
Max syntax diagram
See Expressionlist syntax diagram
$MCS collating sequence, 5-49
Measurement
See Segment attributes aggregate, units per
measure item in; Legend
Measurement enumeration, 1-3
Measurement imported, 1-16
MeasurementUnits syntax diagram, 8-28
Measure syntax diagram, B-26
Messages
CDA$_ facility, G-1 to G-6
Minimum construct
See Expressionlist syntax diagram and CFE
expressions, statistical
Min syntax diagram
See Expressionlist syntax diagram
Mirr syntax diagram
See Expressionlist syntax diagram
$MN tag, defined, 4-30, 4-90
Modified internal rate of return construct
See Expressionlist syntax diagram and CFE
expressions, financial
Modulo syntax diagram
See Expressionlist syntax diagram
Modulus construct
See Expressionlist syntax diagram and CFE
expressions, Boolean and relational
$MONEY editstring-name, 5-49
Month name construct
See Expressionlist syntax diagram and CFE
expressions, date/time
Multiplication construct
See Expressionlist syntax diagram and CFE
expressions, arithmetic

lndex-24

Multiply syntax diagram
See Expressionlist syntax diagram

N
Name-daynum syntax diagram
See Expressionlist syntax diagram
Name-day syntax diagram
See Expressionlist syntax diagram
Named edit string aggregate, 5-51
edit string definition item in, 5-51
edit string name item in, 5-51
items in, 5-51
Named edit strings
$DATE, 5-49
$DATETIME, 5-49
$FLOAT, 5-49
$INTEGER, 5-49
$MONEY, 5-49
$PERCENT, 5-49
$PHONE, 5-49
specifying the definition of, 5-51
specifying the name for, 5-51
$TEXT, 5-49
$TIME, 5-49
NamedEditString syntax diagram, C-4
Named number built-in operator, defined, B-3
Named parameter aggregate, 6-56
items in, 6-56
name item in, 6-56
value item in, 6-56
NamedParameter syntax diagram, D-2
Named range aggregate, 5-52
items in, 5-52
name range data item in, 5-52
Named range construct
See Expressionlist syntax diagram and CFE
expressions, variables
Named ranges, 5-56
See also Ranges
Named-range syntax diagram
See Expressionlist syntax diagram
NamedRange syntax diagram, C-18
NamedValuelist syntax diagram, B-29, C-15
NamedValue syntax diagram, B-28
NamedValueTag syntax diagram, B-35
Name-monthnum syntax diagram
See Expressionlist syntax diagram
Name-month syntax diagram
See Expressionlist syntax diagram
Negate syntax diagram
See Expressionlist syntax diagram
Negation construct
See Expressionlist syntax diagram and CFE
expressions, arithmetic
Neq syntax diagram
See Expressionlist syntax diagram
Net present value construct
See Expressionlist syntax diagram and CFE
expressions, financial
NEXT AGGREGATE routine, 8-120
$NORWEG collating sequence, 5-49

Not available construct
See ExpressionList syntax diagram and CFE
expressions, cell-related
Not-avail syntax diagram
See ExpressionList syntax diagram
Not-calc syntax diagram
See ExpressionList syntax diagram
Not calculable construct
See ExpressionList syntax diagram and CFE
expressions, cell-related
Not equal to construct
See ExpressionList syntax diagram and CFE
expressions, Boolean and relational
Not syntax diagram
See ExpressionList syntax diagram
Now construct
See ExpressionList syntax diagram and CFE
expressions, date/time literals
/[NO]OUTPUT qualifier
for the VIEW command, 2-14
/[NO]OVERRIDE_FORMAT qualifier
for the VIEW command, 2-14
/[NO]PAGE qualifier
for the VIEW command, 2-14
Npv syntax diagram
See ExpressionList syntax diagram
NULL built-in primitive, defined, B-1
Null construct
See ExpressionList syntax diagram and CFE
expressions, cell-related
Number of periods given present value construct
See ExpressionList syntax diagram and CFE
expressions, financial
Number of periods to achieve future value construct
See ExpressionList syntax diagram and CFE
expressions, financial
NumericFmt syntax diagram, C-12

0
ObjectDescriptor defined type, defined, B-4
ObjectDescriptor syntax diagram, B-4
Object identifier, defined, 1-3
OBJECT IDENTIFIER built-in primitive, defined, B-2
OBJECT ID TO AGGREGATE TYPE routine, 8-123
Occurrence definition
specifying permitted types of, 4-57
specifying structure definition in, 4-58
Occurrence definition aggregate, 4-57 to 4-58
See also DDIF$_0CC aggregate
items in, 4-57t
occurrence indicator item in, 4-57
structure element indicator item in, 4-58
OccurrenceDefn syntax diagram, B-34
OCTET STRING built-in primitive, defined, B-1
One's complement construct '
See Expressionlist syntax diagram and CFE
expressions, binary
Ones-cmp syntax diagram
See ExpressionList syntax diagram
-0 options qualifier
for the cdoc command, 2-17
for the dxvdoc command, 2-19
for the vdoc command, 2-21
OPEN CONVERTER routine, 8-126

OPEN FILE routine, 8-130
OPEN STREAM routine, 8-138
OPEN TEXT FILE routine, 8-141
OPTIONAL built-in operator, defined, B-3
/OPTIONS qualifier
for the CONVERT/DOCUMENT command, 2-11
for the VIEW command, 2-14
Or syntax diagram
See ExpressionList syntax diagram
Output formats, 2-3 to 2-9

p
PageDesclabel syntax diagram, B-25
Page description
including private data in, 4-59
specifying reference label for, 4-59
specifying the type of, 4-60
Page description aggregate, 4-59 to 4-60
See also DDIF$_PGD aggregate
indicator item in, 4-60
items in, 4-59t
label item in, 4-59
private data item in, 4-59
Page descriptions language discard option, 1-17
PageDescription syntax diagram, B-39
Page layout
specifying frame for, 4-63
specifying nominal measure for, 4-62
specifying orientation of, 4-63
specifying prototype for, 4-63
specifying reference label for, 4-62
specifying x shrink amount for, 4-62
specifying x stretch amount for, 4-62
specifying y nominal measurement for, 4-62
specifying y shrink amount for, 4-63
specifying y stretch amount for, 4-62
Page layout aggregate, 4-61 to 4-63
See also DDIF$_PGL aggregate
content item in, 4-63
items in, 4-61 t
layout identifier item in, 4-62
nominal measure indicator item in, 4-62
orientation item in, 4-63
prototype item in, 4-63
x shrink indicator item in, 4-62
x stretch indicator item in, 4-62
y shrink indicator item in, 4-63
y stretch indicator item in, 4-62
PageLayoutLabel syntax diagram, B-25
PageLayout syntax diagram, B-40
Page selection
specifying page-side criteria for, 4-64
specifying selected layout for, 4-65
Page selection aggregate, 4-64 to 4-65
See also DDIF$_PGS aggregate
items in, 4-64t
page-side criteria item in, 4-64
select page layout indicator item in, 4-65
PageSet syntax diagram, B-39
Parenthesized construct
See Expressionlist syntax diagram and CFE
expressions, miscellaneous
Parenthesized expression aggregate, 6-57
expression item in, 6-57
items in, 6-57

lndex-25

Parenthesized expression aggregate (Cont.)
text string item in, 6-57
Path-based layout, 4-102, 4-105
Path definition
specifying composite path in, 4-66
specifying private data for, 4-66
specifying reference number for, 4-66
Path definition aggregate, 4-66
See also DDIF$_PHD aggregate
description item in, 4-66
items in, 4-66t
number item in, 4-66
private data item in, 4-66
PathDefn syntax diagram, B-30
PathNumber syntax diagram, B-29
Pattern definition
selecting as either solid color or standard pattern,
4-68
selecting color type for, 4-68
specifying blue intensity for, 4-68
specifying color map for, 4-69
specifying green intensity for, 4-68
specifying image data unit for, 4-69
specifying private data for, 4-69
specifying red intensity for, 4-68
specifying reference number for, 4-67
specifying standard pattern number for, 4-68
Pattern definition aggregate, 4-67 to 4-69
See also DDIF$_PTD aggregate
blue intensity item in, 4-68
colors item in, 4-69
definition indicator item in,. 4-68
green intensity item in, 4-68
items in, 4-67t
number item in, 4-67
private data item in, 4-69
raster-pattern item in, 4-69
red intensity item in, 4-68
solid color indicator item in, 4-68
standard pattern number item in, 4-68
PatternDefn syntax diagram, B-32
PatternNumber syntax diagram, B-30
Payback construct
See Expressionlist syntax diagram and CFE
expressions, financial
Payment per period given present value construct
See Expressionlist syntax diagram and CFE
expressions, financial
Payment per period to achieve future value construct
See ExpressionList syntax diagram and CFE
expressions, financial
$PDL tag, defined, 4-90
Percent construct
See ExpressionList syntax diagram and CFE
expressions, arithmetic
$PERCENT editstring-name, 5-49
Perfv syntax diagram
See ExpressionList syntax diagram
Periods to achieve future value construct
See ExpressionList syntax diagram and CFE
expressions, financial
Perpmt syntax diagram
See Expressionlist syntax diagram
Perpv syntax diagram
See Expressionlist syntax diagram

lndex-26

$PHONE editstring-name, 5-49
Pl construct
See ExpressionList syntax diagram and CFE
expressions, variables
Plus-days syntax diagram
See ExpressionList syntax diagram
Plus-hours syntax diagram
See ExpressionList syntax diagram
Plus-mins syntax diagram
See ExpressionList syntax diagram
Plus-months syntax diagram
See ExpressionList syntax diagram
Plus-secs syntax diagram
See ExpressionList syntax diagram
Plus-weeks syntax diagram
See ExpressionList syntax diagram
Plus-years syntax diagram
See Expressionlist syntax diagram
Pmtfv syntax diagram
See ExpressionList syntax diagram
Pmtpv syntax diagram
See ExpressionList syntax diagram
Polarity
See Segment attributes aggregate, brightness
polarity item in
Polyline
controlling the drawing of line segments of, 4-44
controlling the rendition of, 4-43
specifying the layout of, 4-44
Polyline content aggregate, 4-43 to 4-44
See also DDIF$_LIN aggregate
draw pattern item in, 4-44
flags item in, 4-43
items in, 4-43t
line path i~dicator item, 4-44
PolyLinePath syntax diagram, B-31
Polyline syntax diagram, B-11
Position-relativelayout, 4-102, 4-1 09
Position syntax diagram, B-26
Postscript back end, 2-5 to 2-8
conversion restrictions, 2-5
data mapping in, 2-5
processing options in, 2-6
Power syntax diagram
See ExpressionList syntax diagram
-p qualifier
for the vdoc command, 2-21
Present value of an annuity construct
See ExpressionList syntax diagram and CFE
expressions, financial
Present value to achieve future value construct
See ExpressionList syntax diagram and CFE
expressions, financial
Primary aggregates, defined, 1-5
Principal construct
See ExpressionList syntax diagram and CFE
expressions,. financial
Private collating sequence, 5-49
Private content aggregate, 4-74 to 4-75
See also DDIF$_PVT aggregate
external reference index item in, 4-75
items in, 4-74t
value indicator item in, 4-75
value name item in, 4-75

Private data, 4-74
See CFE application private aggregate
See DTIF application private aggregate
See ESF application private aggregate
PrivateFuncExpr syntax diagram, D-1
Private-function construct
See ExpressionList syntax diagram and CFE
expressions, private
Processing options
attribute inheritance, 1-14
style guides, 1-15
type definitions, 1-14
type references, 1-14
discard segments, 1-17
evaluate content, 1-15
computed content, 1-16
content definitions, 1-16
content references, 1-16
for DDIF, 1-13, 8-47, 8-134
in Postscript back end, 2-6
in Text back end, 2-4
retain definitions, 1-15
PRUNE AGGREGATE routine, 8-145
PRUNE POSITION routine, 8-148
$P tag, defined, 4-91
PUT AGGREGATE routine, 8-150
PUT DOCUMENT routine, 8-153
Put routine, 9-1 O
Pva syntax diagram
See ExpressionList syntax diagram
Pvfv syntax diagram
See ExpressionList syntax diagram

R
Raise to a power construct
See ExpressionList syntax diagram and CFE
expressions, arithmetic
Random number construct
See ExpressionList syntax diagram and CFE
expressions, random number
Random-u syntax diagram
See ExpressionList syntax diagram
Range definition aggregate, 5-55 to 5-56
items in, 5-55
range name item in, 5-55
range region item in, 5-56
range type item in, 5-55
sort key item in, 5-56
RangeDefn syntax diagram, C-17
Ranges
cell ranges, 5-18
column ranges, 5-19
contiguous, 5-55
disjoint, 5-55
named ranges, 5-52
row ranges, 5-59
specifying a name for, 5-55
specifying a range region in, 5-56
specifying a sort key for, 5-56
specifying the type of, 5-55
specifying within a table window, 5-67
specifying withiri table metadata, 5-64
Range syntax diagram, C-17

Rate syntax diagram
See ExpressionList syntax diagram
Ratio syntax diagram, s:.....26
READ TEXT FILE routine, 8-156
Receiving CDA documents
on an ULTRIX system, 3-3
on a VMS system, 3-2
Record definition
specifying segments creating instances of, 4-76
specifying type identifier of, 4-76
specifying variables of, 4-76
Record definition aggregate, 4-76
See also DDIF$_RCD aggregate
contents item in, 4-76
items in, 4--76t
tag item in, 4-76
type item in, 4-76
RecordDefn syntax diagram, B-39
RecordList syntax diagram, B-38
Reference
processing external, 8-126
Reference syntax diagram, B-32
REMOVE AGGREGATE routine, 8-158
RenditionCode syntax diagram, B-8
Repeat aggregate, 7-24 to 7-26
items in, 7-24
repeat count item in, 7-24
single edit string indicator item in, 7-24
single edit string item in, 7-26
Repeat syntax diagram, E-3
Resolution
See Segment attributes aggregate, frame bounding
box items
Resolution of images, 4-41
Restricted content
external, 4-21 to 4-22
describing data value of, 4-21
identifying data type of, 4-21
indicating encoding of, 4-22
specifying encoding length of, 4-22
private
identifying value of, 4-75
indicating type of data in, 4-75
specifying external reference index for, 4-75
RestrictedContent syntax diagram, B-18
Reverse image
See Segment attributes aggregate, brightness
polarity item in
RGB syntax diagram, 8-19
RightAngle syntax diagram, 8-26
Root aggregate, 4-12
See DTIF document root aggregate
creating, 8-45
deleting, 8-60
document content item in, 4-12
document descriptor item in, 4-12
document header item in, 4-12
items in, 4-12t
Root segment, 4-78
Rotation
See Transformation; Transformation aggregate;
Path definition
Round syntax diagram
See Expressionlist syntax diagram

lndex-27

Round to the nearest whole number construct
See ExpressionList syntax diagram and CFE
expressions, conversion
Routines
Allocate/Deallocates, 9-2
cda$aggregate_type_to_ object_id, 8-3
cda$close_file, 8-6
cda$close_stream, 8-9
cda$close_text_file, 8-11
cda$convert, 8-13
cda$convert_aggregate, 8-24
cda$convert_document, 8-28
cda$convert_position, 8-31
cda$copy_aggregate, 8-33
cda$create_aggregate, 8-36
cda$create_file, 8-39
cda$create_root_aggregate, 8-45
cda$create_stream, 8-50
cda$create_text_file, 8-54
cda$delete_aggregate, 8-58
cda$delete_root_aggregate, 8-60
cda$enter_scope, 8-62
cda$erase_item, 8-76
cda$find_definition, 8-79
cda$find_transformation, 8-83
cda$flush_stream, 8-86
cda$get_aggregate, 8-88
cda$get_array_size, 8-94
cda$get_document, 8-97
cda$get_externat_encoding, 8-100
cda$get_stream_position, 8-103
cda$geUext_position, 8-106
cda$insert_aggregate, 8-108
cda$1eave_scope, 8-112
cda$1ocate_item, 8-115
cda$next_aggregate, 8-120
cda$object_id_to_aggregate_type, 8-123
cda$open_converter, 8-126
cda$open_file, 8-130
cda$open_stream, 8-138
cda$open_text_file, 8-141
cda$prune_aggregate, 8-145
cda$prune_position, 8-148
cda$put_aggregate, 8-150
cda$put_document, 8-153
cda$read_text_file, 8-156
cda$remove_aggregate, 8-158
cda$store_item, 8-160
cda$write_text_file, 8-168
close entry point, 11-3
domain$read_format, 11-1 0
domain$write _format entry point, 11-15
Flush, 9-4
Get, 9-6, 9-7
Get-Aggregate entry point, 11-5
Get-position, 9-8
Get_position, 11-8
Put routine, 9"'""1 O
RowDefn syntax diagram, C-6
Row number construct
See ExpressionList syntax diagram and CFE
expressions, variables
Row-num syntax diagram
See ExpressionList syntax diagram
RowNum syntax diagram, C-16

lndex-28

Row portion of cell name construct
See ExpressionList syntax diagram and CFE
expressions, cell-related
Row range aggregate
See CFE row range aggregate
See DTIF row range aggregate
Row range construct
See ExpressionList syntax diagram and CFE
expressions, variables
Row-range syntax diagram
See Expressionlist syntax diagram
RowRange syntax diagram, C-18
Rows
See Table rows
-r qualifier
for the dxvdoc command, 2-19
for the vdoc command, 2-21

s
Scaled integer construct
See Expressionlist syntax diagram and CFE
expressions, literals
Scaling
See Transformation; Transformation aggregate;
Legend attributes
Secondary aggregates, defined, 1-5
Segment
binding attributes to, 4-79
identifying changed attributes in, 4-153
indicating category of the content of, 4-90
listing the variables bound to, 4-91
referencing a type definition for, 4-79
root, 4-78
specifying a reference label for, 4-78
specifying available content definitions for, 4-116
specifying available font definitions for, 4-112
specifying available line style definitions for, 4-115
specifying available path definitions for, 4-114
specifying available pattern definitions for, 4-113
specifying.available type definitions for, 4-117
specifying content of, 4-80
specifying content streams for, 4-90
specifying generic layout for, 4-79
specifying language for, 4-98
specifying name for, 4-79
specifying private attributes for, 4-90
specifying processing characteristics for, 4-91
specifying specific layout for, 4-79
specifying the type of computed content in, 4-92
Segment attributes
units per measurement, 1-16
Segment attributes aggregate, 4-85 to 4-153
See also DDIF$_SGA aggregate
alternate presentation item in, 4-101
bits per component item in, 4-138
brightness polarity item in, 4-135
component space organization item in, 4-137
component wavelength indicator item in, 4-136
computed content indicator item in, 4-92
content category item in, 4-90
content definition item in, 4-116
content streams item in, 4-90
cross-reference index item in, 4-95
cross-reference segment label item in, 4-95

Segment attributes aggregate (Cont.)
cross-reference variable label item in, 4-95
data plane significance item in, 4-138
data-planes-per-pixel item in, 4-138
fixed frame position items in, 4-147
font definition item in, 4-112
frame bounding box items, 4-141 to 4-142
frame clipping path item in, 4-144
frame content transformation item in, 4-152
frame flags item in, 4-140
frame outline item in, 4-143
frame position item in, 4-146
function name item in, 4-96
function parameters item in, 4-96
galley frame items in, 4-149
galley layout item in, 4-104
grid type item in, 4-135
horizontal alignment item in, 4-107
inline frame items in, 4-148
item change list item in, 4-153
items in, 4-86t
language item in, 4-98
layout format item in, 4-106
layout indicator item, 4-103
layout path item in, 4-105
legend unit denominator item in, 4-99
legend unit name item in, 4-99
legend unit numerator item in, 4-99
line end finish item in, 4-130
line end size indicator item in, 4-130
line end start item in, 4-129
line interior pattern item in, 4-130
line joint item in, 4-130
line mask pattern item in, 4-129
line pattern size item in, 4-129
line progression item in, 4-134
line progression path aspect ratio item in, 4-134
line style definition item in, 4-115
line style item in, 4-128
line width indicator item in, 4-128
lookup table item in, 4-136
margin frame items in, 4-150 to 4-151
marker mask pattern item in, 4-132
marker size indicator item in, 4-132
marker style item in, 4-132
miter limit denominator item in, 4-130
miter limit numerator item in, 4-130
number of components item in, 4-138
path definition item in, 4-114
path orientation indicator item, 4-106
pattern definition item in, 4-113
pixel path aspect ratio item in, 4-134
pixel path item in, 4-134
private attributes item in, 4-90
private data item in, 4-134
reference index item in, 4-93
reference target item in, 4-93
relative horizontal character position item in, 4-109
relative vertical character position item in, 4-109
segment binding item in, 4-91
segment tags item in, 4-91
spectral component mapping item in, 4-135
structure attributes items in, 4-97
text character decimal alignment item in, 4-125
text direction item in, 4-124
text font item in, 4-120
text kerning item in, 4-127

Segment attributes aggregate (Cont.)
text leader attribute items in, 4-126
text mask pattern item in, 4-119
text position indicator item in, 4-111
text rendition item in, 4-122
text size attribute items in, 4-123
type definition item in, 4-117
unit name item in, 4-100
units per measurement item in, 4-100
variable item in, 4-94
vertical alignment item in, 4-108
wrap attributes item in, 4-104
SegmentAttributes syntax diagram, B-33
Segment binding
specifying computed variable items in, 4-158
specifying counter variable items for, 4-156 to
4-157
specifying list variable items in, 4-159
specifying name of variable being defined in,
4-154
specifying type of variable value in, 4-155
Segment binding aggregate, 4-154 to 4-159
See also DDIF$_SGB aggregate
computed variable items in, 4-158
counter variable items in, 4-156 to 4-157
items in, 4-154t
list variable items in, 4-159
variable name item in, 4-154
variable value indicator item in, 4-155
Segment binding attributes, 1-14
Segment definitions, 1-15
Segment initial values, 1-14
Segmentlabel syntax diagram, B-24
SegmentPrimitive syntax diagram, 8-7
Segment processing, 1-15
SegmentTag syntax diagram, 8-35
SegTypeDefn syntax diagram, B-33
Selector list aggregate, 6-61
criteria item in, 6-61
items in, 6-61
selection item in, 6-61
Sending CDA documents
on an ULTRIX system, 3-2
on a VMS system, 3-1
Sequence
removing an aggregate from, 8-158
SEQUENCE built-in constructor, defined, B-2
SEQUENCE OF built-in constructor, defined, 8-2
-s format qualifier
for the cdoc command, 2-16
SGA
See Segment attributes aggregate
Sigma construct
See Expressionlist syntax diagram and CFE
expressions, series
Sign construct
See Expressionlist syntax diagram and CFE
expressions, sign
Sine construct
See Expressionlist syntax diagram and CFE
expressions, trigonometric
Single syntax diagram, E-2
Sin syntax diagram
See Expressionlist syntax diagram

lndex-29

Size
See Measurement enumeration; Transformation;
Transformation aggregate; Legend attributes
Size syntax diagram, B-26
Soft directive, 4-81
values for, 4-34t, 4-81 t
Soft directive aggregate, 4-81
DDIF$_SFT aggregate
soft directive item in, 4-82
Soft value directive, 4-83 to 4-84
specifying escapement constant for, 4-84
specifying escapement ratio denominator for, 4-84
specifying escapement ratio numerator for, 4-84
specifying new variable value for, 4-84
specifying type of, 4-84
specifying variable to be reset by, 4-84
Soft value directive aggregate, 4-83 to 4-84
See also DDIF$_SFV aggregate
directive choice item in, 4-84
escapement constant indicator in, 4-84
escapement ratio item in, 4-84
items in, 4-83t
reset value item in, 4-84
reset variable item in, 4-84
Sort ranges, 5-56
See also Ranges
$SPANSH collating sequence, 5-49
Specific layout
specifying type of layout for, 4-50
Specific layout aggregate, 4-50 to 4-51
See also DDIF$_LS1 aggregate
items in, 4-50t
layout indicator item in, 4-50
Specificlayout syntax diagram, B-41
Sqrt syntax diagram
See Expressionlist syntax diagram
Square root construct
See Expressionlist syntax diagram and CFE
expressions, Boolean and relational
$S tag, defined, 4-91
Standard deviation construct
See Expressionlist syntax diagram and CFE
expressions, statistical
StandardPattern syntax diagram, B-32
Starts syntax diagram
See Expressionlist syntax diagram
Stdev syntax diagram
See Expressionlist syntax diagram
StorageSystemTag syntax diagram, B-36, C-3, D-2
Stored semantics file attribute, F-1
See also File tag
STORE ITEM routine, 8-160
Storing format information, 5-41
Str-char syntax diagram
See Expressionlist syntax diagram
Str-code syntax diagram
See Expressionlist syntax diagram
Str-concat syntax diagram
See Expressionlist syntax diagram
Stream
closing, 8-6, 8-9
creating, 8-39, 8-50, 8-130
flushing contents of, 8-86
opening, 8-138

lndex-30

Stream (Cont.)
retrieving position in, 8-103
retrieving size of, 8-1 03
returning position in, 8-31
returning size of, 8-31
writing a document to, 8-153
writing aggregates to, 8-150
StreamTag syntax diagram, B-36
Str-extract syntax diagram
See Expressionlist syntax diagram
Str-find syntax diagram
See Expressionlist syntax diagram
Str-fixed syntax diagram
See Expressionlist syntax diagram
Str-format syntax diagram
See Expressionlist syntax diagram
String character code construct
See Expressionlist syntax diagram and CFE
expressions, string
String character construct
See Expressionlist syntax diagram and CFE
expressions, string
String concatenate construct
See Expressionlist syntax diagram and CFE
expressions, string
StringExpression syntax diagram, B-38
String extract construct
See Expressionlist syntax diagram and CFE
expressions, string
String find substring construct
See Expressionlist syntax diagram and CFE
expressions, string
String fixed construct
See Expressionlist syntax diagram and CFE
expressions, string
String format aggregate, 6-62
edit string.item in, 6-62
items in, 6-62
value item in, 6-62
String format construct
See Expressionlist syntax diagram and CFE
expressions, string
Stringlayout syntax diagram, B-9
String length construct
See Expressionlist syntax diagram and CFE
expressions, string
String lowercase construct
See Expressionlist syntax diagram and CFE
expressions, string
String pretty aggregate, 6-63
flags item in, 6-63
items in, 6-63
string item in, 6-63
String pretty construct
See Expressionlist syntax diagram and CFE
expressions, string
String proper construct
See Expressionlist syntax diagram and CFE
expressions, string
String repeat construct
See Expressionlist syntax diagram and CFE
expressions, string

String replace construct
See Expressionlist syntax diagram and CFE
expressions, string
String reverse construct
See Expressionlist syntax diagram and CFE
expressions, string
String starts with construct
See Expressionlist syntax diagram and CFE
expressions, string
String trim construct
See Expressionlist syntax diagram and CFE
expressions, string
String uppercase construct
See Expressionlist syntax diagram and CFE
expressions, string
Str-left syntax diagram
See Expressionlist syntax diagram
Str-length syntax diagram
See Expressionlist syntax diagram
Str-lower syntax diagram
See Expressionlist syntax diagram
Str-pretty syntax diagram
See Expressionlist syntax diagram
Str-proper syntax diagram
See ExpressionList syntax diagram
Str-repeat syntax diagram
See Expressionlist syntax diagram
Str-replace syntax diagram
See Expressionlist syntax diagram
Str-reverse syntax diagram
See Expressionlist syntax diagram
Str-right syntax diagram
See Expressionlist syntax diagram
Str-trim syntax diagram
See Expressionlist syntax diagram
Structure attributes
specifying legal types of, 4-97
StructureDefinition syntax diagram, B-34
StructureElement syntax diagram, B-34
Str-upper syntax diagram
See Expressionlist syntax diagram
Style guides, 1-15
Subtraction construct
See Expressionlist syntax diagram and CFE
expressions, arithmetic
Subtract syntax diagram
See ExpressionList syntax diagram
Summation construct
See Expressionlist syntax diagram and CFE
expressions, statistical
Sum syntax diagram
See Expressionlist syntax diagram
Symbols
specifying within table metadata, 5-64
Syntax diagrams
Angle, B-25
Angle Ref, B-25
ApplPrivate, B-5, C-14, E-3
Arc, B-12
ArcPath, 8-30
ArrayDefn, C-8
ASCllString, B-25, C-15
BeginSegment, B-7

Syntax diagrams (Cont.)
Binding, B-36
8oundingBox, B-18
8reakCriteria, B-42
CategoryTag, B-35
CellCoord, C-16
CellData, C-6
CellRange, C-18
CellValue, C-7
Character-String, B-5
ColAttributes, C-9
ColNum, C-16
Color, B-19
ColRange, C-18
ComplexFloat, C-8
CompositePath, B-30
ComputeDefn, B-19
ConformanceTag, B-35
ContentDefn, B-24
ContentReference, B-18
ContentReferencePrimitive, B-18
CounterDefn, B-37
CounterStyle, 8-38
CrossRef, 8-20
CubicBezier, B-12
CubicBezierPath, B-31
Datatype, C-1 o
DateFmt, C-13
DateTime, C-14
DDIFDocument, B-5
DecimalString, D-9
Directive, B-1 O
DocumentDescriptor, 8-5, C-1
DocumentHeader, B-6, C-2
Document root segment, B-6
DTIFDocument, C-1
EditStrBuff, E-1
EditStrlndex, C-12
EditString, D-9, E-1
Escapement, B-20
EscapementDirective, B-11
Expression, B-37, D-2
Expressionlist, D-3
ExternalReference, B-20, C-2
ExternalReflndex, B-23, C-3
Field Ref, D-9
FillAreaSet, B-12
FmtFlags, C-14
FmtPrec, C-13
FontDefn, B-21
FontNumber, B-29
Format, B-21
Formatlnfo, C-10
FormattingPrimitive, B-10
FormatType, C-11
FramePar~meters, B-21
Functionlink, B-23
GalleyAttributes, B-41
GalleyFrameParams, B-22
GalleyVerticalPosition, B-22
Genericlayout, B-39
GenMeasure, B-42
GenSize, B-43
GraphicsPrimitive, B-11
lmageAttributes, B-16
lmageCodingAttrs, B-15
lmagePrimitive, B-15

lndex-31

Syntax diagrams (Cont.)
lmgCmptSpcAttrs, 8-17
lmgLutData, 8-17
lnlineFrameParams, 8-21
Label, 8-25
Label types, B-24
LangPreflndex, C-11
LangPrefTable, C-3
Languagelndex, 8-24
Latin1-String, 8-4
LayoutAttributes, B-42
LayoutGalley, 8-40
LayoutObjectType, B-37
LayoutPrimitive, B-40
LeaderStyle, 8-8
LegendUnits, 8-25
LineAttributes, 8-12
LineDefn, 8-31
LineEndNumber, 8-14
LineJoin, 8-14
LineStyleNumber, 8-14
MarginFrameParams, 8-22
MarginHorizontalPosition, B-23
MarkerAttributes, 8-15
MarkerNumber, 8-15, 8-29
Measure, 8-26
MeasurementUnits, 8-28
NamedEditString, C-4
NamedParameter, D-2
NamedRange, C-18
NamedValue, 8-28
NamedValuelist, 8-29, C-15
NamedValueTag, 8-35
NumericFmt, C-12
ObjectDescriptor, 8-4
OccurrenceDefn, 8-34
PageDescription, 8-39
PageLayout, 8-40
PageSet, 8-39
ParenthesizedExpr, D-9
PathDefn, 8-30
PathNumber, 8-29
PatternDefn, 8-32
PatternNumber, 8-30
Polyline, B-11
PolylinePath, 8-31
Position, 8-26
PrivateFuncExpr, D-1
Range, C-17
RangeDefn, C-17
Ratio, B-26
RecordDefn, 8-39
RecordList, 8-38
Reference, 8-32
RenditionCode, 8-8
Repeat, E-3
RestrictedContent, 8-18
RG8, 8-19
RightAngle, 8-26
RowDefn, C-6
RowNum, C-16
RowRange, C-18
SegmentAttributes, 8-33
SegmentPrimitive, 8-7
SegmentTag, 8-35
SegTypeDefn, 8-33
Selectorlist, D-8

lndex-32

Syntax diagrams (Cont.)
Single, E-2
Size, B-26
SpecificLayout, 8-41
StandardPattern, 8-32
StorageSystemTag, 8-36, C-3, D-2
StreamTag, 8-36
StringExpression, 8-38
StringLayout, 8-9
StructureDefinition, 8-34
StructureElement, 8-34
TableDefn, C-4
TableMD, C-5
TabStop, 8-43
TabStopList, 8-43
Tag, 8-35
Text, D-8
TextAttributes, 8-7
TextFmt, C-13
TextLayout, 8-9
TextPrimitive, 8-7
Text-String, 8-5
Transformation, 8-36
ValueData, B-28, C-15
ValueDirective, 8-1 O
VariableLabel, 8-25
VariableReset, 8-11
VaryingText, C-7, D-8
WindowDefn, C-5
WrapAttributes, 8-41
XCoordinate, 8-27
YCoordinate, 8-28

T
Table construct
See Expressionlist syntax diagram and CFE
expressions, choose and lookup
Table definition
specifying descriptive information for, 5-61
specifying number of columns for, 5-60
specifying number of rows for, 5-61
specifying private data for, 5-61
specifying the rows in, 5-61
specifying windows for, 5-61
Table definition aggregate, 5-60 to 5-61
descriptive table information item in, 5-61
items in, 5-60
number of columns item in, 5-60
number of rows item in, 5-61
private table data item in, 5-61
rows item in, 5-61
window item in, 5-61
TableDefn syntax diagram, C-4
Table discard option, 1-17
TableMd syntax diagram, C-5
Table metadata
·
specifying a table identifier for, 5-62
specifying a table name for, 5-62
specifying column attributes for, 5-63
specifying flags for, 5-63
specifying formats for, 5-63
specifying private data for, 5-62
specifying ranges for, 5-64
specifying symbols for, 5-64
specifying table descriptor for, 5-62
Table metadata aggregate, 5-62 to 5-64

Table metadata aggregate (Cont.)
column attributes item in, 5-63
flags item in, 5-63
format item in, 5-63
items in, 5-62
private table data item in, 5-62
ranges item in, 5-64
symbols item in, 5-64
table descriptor item in, 5-62
table identifier item in, 5-62
table name item in, 5-62
Table row aggregate, 5-57 to 5-58
cell item in, 5-58
flags item in, 5-58
format item in, 5-57
identifier item in, 5-57
items in, 5-57
private row data item in, 5-57
Table rows
specifying an identifier for, 5-57
specifying cells for, 5-58
specifying flags for, 5-58
specifying formats for, 5-57
specifying private data for, 5-57
Tables
See Table definition
See Table metadata
Table window aggregate, 5-66 to 5-68
active location· item in, 5-67
cardinal number item in, 5-67
flags item in, 5-67
format item in, 5-67
items in, 5-66
private window data item in, 5-66
ranges item in, 5-67
window descriptor item in, 5-67
window identifier item in, 5-66
window name item in, 5-66
Table windows
referencing from format information, 5-30
specifying a cardinal number for, 5-67
specifying a descriptor item for, 5-67
specifying a window identifier for, 5-66
specifying a window name for, 5-66
specifying flags for, 5-67
specifying formats for, 5-67
specifying private data for, 5-66
specifying ranges in, 5-67
specifying the active or current cell in, 5-67
specifying within table definition, 5-61
Tab stop
specifying horizontal position of, 4-160
specifying leader character for, 4-161
specifying type of alignment for, 4-161
Tab stop aggregate, 4-160 to 4-161
See also DDIF$_TBS aggregate
items in, 4-160t
tab stop horizontal position indicator item in, 4-160
tab stop leader item in, 4-161
tab stop type item in, 4-161
TabStoplist syntax diagram, B-43
TabStop syntax diagram, B-43
Tag
'
See File tag
Tags
See ESF edit strings

Tags (Cont.)
$AN, 4-91
content categories, 1-8
content processing characteristics, 1-8
content streams in layout, 1-9
$CRF, 4-91
$20, 4-90
$DB, 4-30, 4-90
$E, 4-91
$EN, 4-30, 4-90
$F, 4-91
$FN, 4-30,4-90,4-91
$GO, 4-91
$GRP, 4-91
$1, 4-90, 4-91
$IX, 4-30, 4-90
$L, 4-91
$LBL, 4-91
$LE, 4-91
$LIT, 4-91
$MN, 4-30, 4-90
$P, 4-91
$PDL, 4-90
$S, 4-91
See Edit string aggregate, 7-4
$T, 4-90
$TBL, 4-90
$TOC, 4-30, 4-90
$TTL, 4-91
Tag syntax diagram, B-35
Tangent construct
See Expressionlist syntax diagram and CFE
expressions, trigonometric
Tan syntax diagram
See Expressionlist syntax diagram
$TBL tag, defined, 4-90
Text
controlling kerning for, 4-127
specifying alignment characters for, 4-125
specifying amount of space used by the leader
character in, 4-126
specifying attributes for, 4-118 to 4-127
specifying format of lines wrapped by the formatter,
4-55
specifying format of lines wrapped by the user,
4-55
specifying leader alignment in, 4-126
specifying maximum consecutive hyphenated lines
of, 4-56
specifying maximum orphan size of, 4-56
specifying maximum widow size of, 4-56
specifying one or more renditions for, 4-121
specifying pattern and color of glyphs in, 4-119
specifying rules that affect hyphenation of, 4-55
specifying string used to fill leader space in, 4-126
specifying the direction of characters in, 4-124
specifying the font used for, 4-120
specifying the height of, 4-123
specifying the ratio for character widths in, 4-123
specifying type of leader to use in, 4-126
Text attribute, 4-118
TextAttributes syntax diagram, B-7
Text back end, 2-4 to 2-5
conversion restrictions, 2-4
data mapping in, 2-4
processing options in, 2-4

lndex-33

Text choice aggregate, 6-64
items in, 6-64
text type indicator item in, 6-64
Text content
general, 4-32
Latin1, 4-164
specifying general character set for, 4-32
specifying Latin1 character set for, 4-164
Text content aggregate
See also DDIF$_TXT aggregate
item in, 4-164
Text discard option, 1-17
$TEXT editstring-name, 5-49
Text file
closing, 8-11
creating, 8-54
opening, 8-141
reading a line from, 8-156
returning position in, 8-106
returning size of, 8-106
writing a line to, 8-168
TextFmt syntax diagram, C-13
Text front end, 2-2 to 2-3
conversion restrictions, 2-3
data mapping in, 2-2
document syntax errors in, 2-3
external file references in, 2-3
Text kerning, 4-127
TextLayout syntax diagram, 8-9
Text-position layout, 4-102
TextPrimitive syntax diagram, B-7
Text string aggregate, 7-27
items in, 7-27
text string item in, 7-27
Text-string construct
See Expressionlist syntax diagram and CFE
expressions, literals
Text-String defined type, defined, B-4
Text-String syntax diagram, 8-5
$TIME edit-string name, 5-49
$TOC tag, defined, 4-30, 4-90
Today construct
See Expressionlist syntax diagram and CFE
expressions, date/time literals
Tomorrow construct
See Expressionlist syntax diagram and CFE
expressions, date/time literals
Transferring CDA documents, 3-1
Transformation
returning information about, 8-83
specifying type of parameter specified for, 4-163
specifying value of the parameter for, 4-163
Transformation aggregate, 4-162 to 4-163
See also DDIF$_TRN aggregate
items in, 4-162t
transformation parameter indicator item in, 4-163
Transformation syntax diagram, 8-36
Trend construct
See Expressionlist syntax diagram and CFE
expressions, series
True construct
See Expressionlist syntax diagram and CFE
expressions, variables
Truncate construct
See Expressionlist syntax diagram and CFE
expressions, conversion

lndex-34

$T tag, defined, 4-90
$TTL tag, defined, 4-91
TXT
See Text
Type definition
specifying parent for, 4-165
specifying private data for, 4-166
specifying reference label for, 4-165
specifying segment attributes for, 4-165
Type definition aggregate, 4-165 to 4-166
See also DDIF$_TYD aggregate
attributes item in, 4-165
items in, 4-165t
label item in, 4-165
parent item in, 4-165
private data item in, 4-166
Type definitions, 1-14
Type references, 1-14

u
ULTRIX commands
cdoc, 2-16
dxvdoc, 2-18
vdoc, 2-20
Unary-plus construct
See Expressionlist syntax diagram and CFE
expressions, arithmetic
User routines
Allocate/Deallocate, 9-2
Flush, 9-4
Get, 9-6, 9-7
Get-position, 9-8

Put routine, 9-1 O

v
ValueData syntax diagram, 8-28, C-15
ValueDirective syntax diagram, 8-1 O
Variable
encoding of, 1-4
Variable computed content, 4-94
VariableLabel syntax diagram, 8-24, 8-25
VariableReset syntax diagram, B-11
Variance construct
See Expressionlist syntax diagram and CFE
expressions, statistical
Var syntax diagram
See Expressionlist syntax diagram
Varying length text construct
See Expressionlist syntax diagram and CFE
expressions, literals
Varying text aggregate
See CFE varying text aggregate
See DTIF varying text aggregate
VaryingText syntax diagram, C-7
vdoc command, 2-20 to 2-21
-f format qualifier, 2-20
-h paper-height qualifier, 2-21
-0 options qualifier, 2-21
-p qualifier, 2-21
-r qualitifer, 2-21
-w paper-width qualifier, 2-21
VIEW command, 2-13 to 2-15
/FORMAT qualifier, 2-13

VIEW command (Cont.)
/INTERFACE qualifier, 2-14
/[NO]OUTPUT qualifier, 2-14
/[NO]OVERRIDE_FORMAT qualifier, 2-14
/[NO]PAGE qualifier, 2-14
/OPTIONS qualifier, 2-14
/WIDTH qualifier, 2-14
Viewer images
linking on ULTRIX, 13-2
linking on VMS, 13-2
Vlookup construct
See Expressionlist syntax diagram and CFE
expressions, choose and lookup
VMS
support for CDA in, F-1
VMS commands
CONVERT/DOCUMENT, 2-11
VIEW, 2-13

w
/WIDTH qualifier
for the VIEW command, 2-14
WindowDefn syntax diagram, C-5
Windows
See Table windows

-w paper-width qualifier
for the dxvdoc command, 2-19
for the vdoc command, 2-21
Wrap attributes aggregate, 4-54 to 4-56
See also DDIF$_LW1 aggregate
hyphenation flags item in, 4-55
hyphenation lines item in, 4-56
items in, 4-54t
maximum orphan size item in, 4-56
maximum widow size item in, 4-56
quad format item in, 4-55
wrap format item in, 4-55
WrapAttributes syntax diagram, B-41
WRITE TEXT FILE routine, 8-168

x
XCoordinate syntax diagram, B-27
XRF
See Cross-reference computed content

y
YCoordinate syntax diagram, B-28
Yesterday construct
See Expressionlist syntax diagram and CFE
expressions, date/time literals

lndex-35

How to Order Additional Documentation

Technical Support
If you need help deciding which documentation best meets your needs, call 800-343-4040 before placing
your electronic, telephone, or direct mail order.

Electronic Orders
To place an order at the Electronic Store, dial 800-DEC-DEMO (800-332-3366) using a 1200- or 2400-baud
modem. If you need assistance using the Electronic Store, call 800-DIGITAL (800-344-4825).

Telephone and Direct Mail Orders
Your Location

Call

Contact

Continental USA,
Alaska, or Hawaii

800-DIGITAL

Digital Equipment Corporation
P.O. Box CS2008
Nashua, New Hampshire 03061

Puerto Rico

809-754-7575

Local Digital subsidiary

Canada

800-267-6215

Digital Equipment of Canada
Attn: DECdirect Operations KA02/2
P.O. Box 13000
100 Herzberg Road
Kanata, Ontario, Canada K2K 2A6

International

Local Digital subsidiary or
approved distributor

Internal 1

USASSB Order Processing - WMO/E15
or
U.S. Area Software Supply Business
Digital Equipment Corporation
Westminster, Massachusetts 01473

1For internal orders, you must submit an Internal Software Order Form (EN-01740-07).

Reader's Comments

CDA Reference Manual
Volume 2

AA-PC02A-TE

Please use this postage-paid form to comment on this manual. If you require a written reply to a software
problem and are eligible to receive one under Software Performance Report (SPR) service, submit your
comments on an SPR form.
Thank you for your assistance.

I rate this manual's:
Accuracy (software works as manual says)
Completeness (enough information)
Clarity (easy to understand)
Organization (structure of subject matter)
Figures (useful)
Examples (useful)
Index (ability to find topic)
·Page layout (easy to find information)

Excellent

Good

Fair

Poor

D
D

D
D
D
D
D
D
D
D

D
D
D
D
D
D

D
D

D
D
D
D
D

I would like to see more/less

What I like best about this manual is

What I like least about this manual is

I found the following errors in this manual:
Page

Description

Additional comments or suggestions to improve this manual:

I am using Version ___ of the software this manual describes.

Name/Title

Dept.

Company

Date

Mailing Address
Phone

Do Not Tear - Fold Here and Tape

-------------------~111r-------~~~~; ___

I
I
I
I
I

in the
United States

BUSINESS REPLY MAIL
FIRST CLASS PERMIT NO. 33 MAYNARD MASS.
POST AGE WILL BE PAID BY ADDRESSEE

DIGIT AL EQUIPMENT CORPORATION
Corporate User Publications-Spit Brook
ZK01-3/J35
110 SPIT BROOK ROAD
NASHUA, NH 03062-9987

111 ..... 11.11 .... 11 .... 1.11.1 .. 1.1 .. 1•• 1.1 ••• 1.11 .. 1
- Do Not Tear - Fold Here

I
I
I

Reader's Comments

CDA Reference Manual
Volume 2

AA-PC02A-TE

Excellent

Good

Fair

Poor

D
D
D
D

D
D

D
D
D
D
D
D
D
D

D
D
D

D
D
D
D

D
D
D
D
D
D

D
D
D
D
D

I would like to see more/less

What I like best about this manual is

What I like least about this manual is

I found the following errors in this manual:
Page

Description

Additional comments or suggestions to improve this manual:

I am using Version ___ of the software this manual describes.

Nameffitle
Company

Dept.
Date

Mailing Address
Phone

Do Not Tear - Fold Here and Tape

-------------------"lllr-------;~:~;~--11

11 Malled
in the
United States

BUSINESS REPLY MAIL
FIRST CLASS PERMIT NO. 33 MAYNARD MASS.
POST AGE WILL BE PAID BY ADDRESSEE

DIGIT AL EQUIPMENT CORPORATION
Corporate User Publications-Spit Brook
ZK01-3/J35
110 SPIT BROOK ROAD
NASHUA, NH 03062-9987

111 ..... 11.11 .... 11 .... 1.11.1 .. 1.1 .. 1•• 1.1 ••• 1.11 .. 1
-

Do Not Tear - Fold Here - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

I
I
I
I
1