C Include Code

The function Generate C Include Code generates a record buffer for use in C programs based on a Predict file object.

In addition, an Adabas format buffer can also be generated if required for files of the following types:

• Adabas file (file type A) with parameter Adabas SQL usage = N

• Adabas userview (file type U)

This document covers the following topics:

• Calling the Function

• Parameters

• Generate C Include Code in Batch Mode

• Names in C Include Code

• Field Format and C Include Code

• Sample Output

Calling the Function

The Generate C Copy Code screen is displayed with function code G and object code CC in a Predict main menu, or with the command GENERATE LANG-C.

10:00:41             *****  P R E D I C T  *****             2007-05-31
Plan   0                  - Generate C Copy Code -

File ID ...................*

Save as member .............              Save in library .... CCCLIB
Overwrite option ........... Y  (Y,N)     Op. system member ..
Punch / output ............* N

List generated code ........ Y  (Y,N)     List offsets ......* N
Generate format buffer ....* N            Adabas version ....* I7
Check field name ..........* A

Shift increment ............ 3  (0-9)     Field name prefix ..
Nr. of abstract lines ...... 3  (0-16)    Field name suffix ..
Storage class .............* A            Validate ........... _
Upper or lower case .......* L            Truncation ........* R
Record buffer name .........
Format buffer name .........

Command ===>
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
      Help  Next  Stop  Last  LnkEl Flip  Print Impl  AdmFi SelFi Prof  Main

Parameters

Values for fields which have been locked by your data dictionary administrator cannot be overwritten. These fields are skipped when positioning the cursor with the TAB key. See Generation Defaults.

Generate C Include Code in Batch Mode

Command: GENERATE LANG-C

Enter parameters on next line in positional or keyword form. File ID is obligatory, all other parameters are optional.

If a parameter is not specified, the default value is taken.

Parameters NP-LIB, NP-SUBLIB and NP-MEMTYPE must be specified if the generated code is written to workfile 1 (Punch/output=Y) and Library system=3.

Names in C Include Code

The following rules apply to the generation of names for C include code.

• Field names are derived from the name of the corresponding Predict field object if no C field name synonym has been specified.

• The case of alpha characters in field and file names is determined by the parameter Upper or lower case.

• The parameters Field name prefix, Field name suffix, Validate and Truncate apply to the generation of field names (see description of parameters above).

• If supplementary fields have to be generated the names of these extra fields are derived from the Predict field names by generating prefixes. The rules for generating names for extra fields are described in the sections below.

• If a generated field name or type name is not unique, an error message may be displayed if Check field name is either set to A or Y.

C Names for Redefinition Fields - RE

When a field is redefined, a data type with structure union is generated. The name of the data type is tu_fieldname. The name of the corresponding variable is u_fieldname. The union consists of

• the redefined field

• one type tn for each redefinition with corresponding variable rn_fieldname.

C Names for Counter Fields (MC or PC)

When generating C fields for Predict fields of type MC or PC, a counter field will automatically be generated in the copy code. The name of this field is derived from the ID of the MC or PC field by adding the prefix C-.

With the following parameter settings

• Field name prefix = Adabas

• Field name suffix = *PERSONNELOFFICE

• Validate = _

• Truncation = R

• Max. name length = 30

the following field names are generated in C include code for field HOURS_DAY of type MC:

ADABAS_C_HOURS_DAY_PERSONNELOF
ADABAS_HOURS_DAY_PERSONNELOFFI  

C Names for Additionally Generated Indicator Fields

An additional indicator field prefixed with s_ is generated in the following cases:

• a field is defined with Suppression option set to U (null allowed)

• a field of a file of type A or U is defined with Suppression option set to R (not null)

• I3 or above

• U1 or above

• V4 or above.

Field Format and C Include Code

Fields in the C include code have a C clause determined by the length and format of the corresponding Predict field object, as shown in the table below:

varchar struct
{
short Fieldname_len;
char Fieldname_txt [n];
} Fieldname;

varchar struct
{
short Fieldname_len;
char Fieldname_txt [n];
} Fieldname;

varbyte struct
{
short Fieldname_len;
char Fieldname_txt [n];
} Fieldname;

struct t_Fieldname
{
short int Fieldname_len;
unsigned char Fieldname_txt [n];
} Fieldname;

struct t_Fieldname
{
short int Fieldname_len;
unsigned char Fieldname_txt [n];
} Fieldname;

struct t_Fieldname
{
i2form Fieldname_len;
unsigned char Fieldname_txt [n];
} Fieldname;

An automatically generated counter field has the same clause as an I2 field. A numeric or binary format field with a length not included in the table above is treated in C include code as an alphanumeric format field. A warning message is given.

Sample Output

File ID .. GENERATION-EXAMPLE

/********************************************************************/
/*     THIS RECORD-BUFFER LAYOUT WAS GENERATED BY PREDICT           */
/*          FOR FILE: GENERATION-EXAMPLE                            */
/*                ON: 2007-05-31 STARTING AT 13:27:28               */
/*     FILE-COMMENTS: Example file for the                          */
/*                    PREDICT generation subsystem                  */
/*                    ..                                            */
/********************************************************************/
struct t_generation_example
   {
   struct t_group_1
      {
      unsigned char ele_n_9v5[14];
/*      * >>> DIC1818 WARNING: FORMAT(S) CHANGED ( ' N ' --> ' A ')   */
      struct t_gr_in_group
         {
         long ele_b_4;
         unsigned char ele_ps_5v2[4];
/*      * >>> DIC1818 WARNING: FORMAT(S) CHANGED ( ' PS ' --> ' A ')  */
         union tu_mu_b_4
            {
            long mu_b_4[5];
            struct t1_mu_b_4
               {
               unsigned char mu_red_b_7[7];
/*      * >>> DIC1818 WARNING: FORMAT(S) CHANGED ( ' B ' --> ' A ')   */
               unsigned char mu_red_us_13[13];
/*      * >>> DIC1818 WARNING: FORMAT(S) CHANGED ( ' NS ' --> ' A ')  */
               } r1_mu_b_4;
            struct t2_mu_b_4
               {
               unsigned char mu_red_b_8[8];
/*      * >>> DIC1818 WARNING: FORMAT(S) CHANGED ( ' B ' --> ' A ')   */
               } r2_mu_b_4;
            } u_mu_b_4;
         } gr_in_group;
      unsigned char ele_a_42[42];
      double ele_f_8;
      unsigned char ele_b_3[3];

File ID .. GENERATION-EXAMPLE

/*      * >>> DIC1818 WARNING: FORMAT(S) CHANGED ( ' B ' --> ' A ')   */
      } group_1;
   short c_pc_occ_7;
   struct t_pc_occ_7
      {
      unsigned char pc_ele_de_ns_7v3[10];
/*      * >>> DIC1818 WARNING: FORMAT(S) CHANGED ( ' NS ' --> ' A ')  */
      short c_pc_mc_ps_6v1;
      unsigned char pc_mc_ps_6v1[11] [4];
/*      * >>> DIC1818 WARNING: FORMAT(S) CHANGED ( ' PS ' --> ' A ')  */
      struct t_pc_gr
         {
         short pc_ele_i_2;
         unsigned char pc_ps_20v7[14];
/*      * >>> DIC1818 WARNING: FORMAT(S) CHANGED ( ' PS ' --> ' A ')  */
         } pc_gr;
      float pc_ele_f_4;
      } pc_occ_7[7];
    unsigned char ele_d[4];
 /*      * >>> DIC1818 WARNING: FORMAT(S) CHANGED ( ' D ' --> ' A ')   */
    unsigned char ele_t[7];
 /*      * >>> DIC1818 WARNING: FORMAT(S) CHANGED ( ' T ' --> ' A ')   */
    unsigned char ele_l;
    } generation_example;
 /**********************************************************************/
 /*       THIS FORMAT-BUFFER WAS GENERATED BY PREDICT                  */
 /*            FOR FILE: GENERATION-EXAMPLE                            */
 /*                  ON: 2007-05-31 STARTING AT 13:27:28               */
 /**********************************************************************/
 unsigned char f_generation_example [ 293 ] =
                   "AB,2X,AD,AE,AF1-5,AG,2X,AH,AI,1X,ALC,2,AM1,AN1C,2,AN"
                   "1(1-11),AO1,2X,AR1,2X,AM2,AN2C,2,AN2(1-11),AO2,2X,AR"
                   "2,2X,AM3,AN3C,2,AN3(1-11),AO3,2X,AR3,2X,AM4,AN4C,2,A"
                   "N4(1-11),AO4,2X,AR4,2X,AM5,AN5C,2,AN5(1-11),AO5,2X,A"
                   "R5,2X,AM6,AN6C,2,AN6(1-11),AO6,2X,AR6,2X,AM7,AN7C,2,"
                   "AN7(1-11),AO7,2X,AR7,2X,AS,AT,AU."
/**********************************************************************/

DIC1800 SUMMARY:    25 FIELD(S) PROCESSED
DIC1818 WARNING:    11 FORMAT(S) CHANGED
DIC1819 MESSAGE:    33 SLACK BYTE(S) GENERATED
DIC1847 MESSAGE:     3 FIELD(S) SKIPPED FOR RECORDBUFFER STRUCTURE