$ude ("compile")

Compile development objects in the Repository.

$ude("compile", ObjectType, ObjectProfile {,"", OptionList} )

Example: vResult = $ude("compile", "component", "my*")

Parameters

Parameters
Parameter Data Type Description
ObjectType String List of development object types. See Object Types.
ObjectProfile String String specifying an object name or retrieve profile for one or more objects of type ObjectType
OptionList String Associative list containing one or more options that are appropriate to the operation or the ObjectType. See Options.

Arguments can also be a field, variable, or function that evaluates to a string or list.

When using $ude to compile objects, you must specify the development objects, providing the object type and profile. Use Gold ; in specifying specific types of objects. Depending on the object type, you can also specify additional options.

The following object types are supported by $ude("compile"):

  • signature
  • component
  • {component;}form
  • {component;}report
  • {component;}dsp
  • {component;}usp or {component;}server_page
  • {component;}service
  • {component;}entity_service
  • {component;}session_service
  • application
  • dtd
  • entity
  • model (Deprecated)
  • variables
  • proc
  • message
  • device_table
  • translation_table
  • panel
  • glyph
  • format
  • menu

For variables it is not possible to specify individual variables with the ObjectProfile. The ObjectProfile is ignored, and all variables are compiled for the specified library (or for all libraries if no library was specified).

The OptionList enables you to influence how the operation works. It is an associative list containing at least one option and value. Use Gold ; in specifying multiple options.

For example, the following command compiles all menus starting with F in the MyLib library:

$result = $ude ("compile", "menu", "F*", "", "library=MyLib")
Options
Option Description
library=LibraryName Compiles the objects in the given library; supported only for global objects:

ObjectType = variables | proc | menu | panel | message |format | glyph | translation_table | device_table
language=Language Compiles language-independent objects (variables, ProcScript, tables, and panels), plus the language-dependent objects (menus, messages, glyphs, and formats) that match the specified language. Supported only for global objects:

ObjectType = menu | message | glyph | format
executeonly = True|False

If True, compile the application shell, component, or global ProcScript so that it cannot be debugged.

generatecmi=1|0 If True, generate compiled module information for the specified objects.
includenotfoundlevel = 0|1|2 Compile the specified components using the indicated severity level for the compiler message 1000 - #Include IncludeScript not found
  • 0—set the severity to info
  • 1—set the severity to warning (default)
  • 2—set the severity to error
listinglevel=0|1|2

Generates a script listing with or without precompiler directives:

  • 0—do not generate a script listing (default)
  • 1—basic script listing with no precompiler directives
  • 2—script listing that includes precompiler directives
messagelevel=0 | 1 | 2 Determines the type of compiler messages that are displayed in the Compiler Output and Message Frame.
  • 0—display Information, Warning, and Error messages
  • 1—display Warning and Error messages
  • 2—display only Error messages (default)
palettes=True | False If True, only palettes of the specified object type are compiled. This does not result in runtime objects; it only checks for ProcScript syntax errors. Supported only for main development objects.
templates=True | False If True, only templates of the specified object type are compiled. This does not result in runtime objects; it only checks for ProcScript syntax errors. Supported only for main development objects.
includeAllPurposes=True | False

If True, all development objects are compiled, regardless of their purpose (Normal, Palettes, and Templates)
symboltable = 0|1|2|3

Specify whether object references are generated during compilation, and where they are located.

  • 0—do not store object references during compilation (default)
  • 1—store object references in symbol table files in the working directory
  • 2—generate cross-reference data to the UXCROSS repository table from internal object references
  • 3—store object references to symbol table files and generate cross-reference data in the UXCROSS repository table

If ObjectType does not specify a global object, the library and language options are ignored.

The default values of an option are applicable only when no value is specified by the corresponding command line sub-switch or assignment file setting. For more information, see Configuring Compilation.

Supported Profile and Options for Global Objects
ObjectType ObjectProfile OptionList
language library
variables – – Y
proc Y – Y
device_table Y – Y
translation_table Y – Y
panel Y – Y
menu Y Y Y
message Y Y Y
glyph Y Y Y
format Y Y Y

You can use the library= and language= options to restrict compilation to a specific library or to a specific language.

Values returned by $ude and entitycopy
Value Description
>=0 Success. Number of records where an attempt was made to process them. Detailed information is returned in $procReturnContext.
<0 An error occurred. $procerror contains the exact error and $procerrorcontext provides the details.
8066 8066- Copy failed: Open error on input file/table.

This error can occur when no entity descriptors cannot be found.

Items are omitted if their value is zero or an empty string.

Items Returned by $procreturncontext
Item Description
Context = Context Context of the information. For $ude("compile"), the value is UDE Compile.
Error = Number Error number if process failed on error
InputSignatures = Number Signatures found for compilation
OutputSignatures = Number Signatures compiled
InputComponents = Number Components found for compilation
OutputComponents = Number Components compiled
InputApplications = Number Applications found for compilation
OutputApplications = Number Applications compiled
InputModels = Number Models found for compilation
OutputModels = Number Models compiled
InputDescriptors = Number Entities found for compilation
OutputDescriptors = Number Entities compiled
InputLibraryItems = Number Library items found for compilation, such as menus, glyphs, global ProcScript
OutputLibraryItems = Number Library items compiled
Infos = Number Information messages generated during compilation
Warnings = Number Warning messages generated during compilation
Errors = Number Error messages generated during compilation
Release = ReleaseNumber Number of the Uniface release of the source data.
DETAILS = String Messages, warnings, and errors encountered during processing, structured as a list.

Use

$ude("compile") requires a fully configured Repository to be available.

Note:  The $ude functions can only be used in components or applications that are run on Windows, and they rely on functionality that is provided in the ide.uar. To use $ude functions, run components and applications with ide.exe, or configure the application to include usys:ide.uar in its resources.

Allowed in all component types except self-contained Services.

Compiling Entities

The following instruction analyzes (compiles) a single entity and generates and entity descriptor file (.edc).

vResult  = $ude ("compile" ,"entity" , "Entity.Model" ,"")

The following instruction compiles all entities in MYMODEL:

vResult  = $ude ("compile" ,"entity" , "*.MYMODEL" ,"")

Compiling Components

The following instruction compiles all components beginning with my:

vResult = $ude("compile", "component", "my*, "", "messagelevel=0")

For example, this returns 0 in $result and the following in $procreturncontext:

Context=UDE Compile·;
InputComponents=4·;
OutputComponents=4·;
Infos=5·;
Warnings=19·;
Details=
 ID=1016·!·!·;
  MESSAGE=(Fields for) entity ENTITYEX not found in application model, generating now...·!·!·;
  SEVERITY=Warning·!·;
 ID=1043·!·!·;
  MESSAGE=Field CAL assumed maximum length of 40.·!·!·;
  SEVERITY=Warning·!·;
 ID=1043·!·!·;
  MESSAGE=Field SELDATE assumed maximum length of 40.·!·!·;
  SEVERITY=Warning·!·;
 ID=1016·!·!·;
  MESSAGE=(Fields for) entity BTNS not found in application model, generating now...·!·!·; 
  SEVERITY=Warning·!·;

...

Compiling Libraries and Global Objects

Libraries are typed, meaning each library can only contain one type of object. However, libraries of different types can have the same name.

Compile all French-language messages and help texts in all libraries (language=FRA): 

vResult  = $ude ("compile", "message", "", "", "language=FRA;library=MyLib")

Compile all menus in the MyLib library: 

vResult = $ude ("compile", "menu", "", "", "library=MyLib")

Compile all File menus, in all libraries:

$result = $ude ("compile", "menu", "file")

Compiling DTDs

vResult  = $ude("compile", "DTD", "myEntity", "", "model=myModel")
History
Version Change
10.3.01 Removed library as an ObjectType. It is accepted but does nothing.
9.1.01 Introduced

Related Topics