Namespace: Consultingwerk.Studio
Class 
CompilerHelper Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Studio.CompilerHelper

Inherits: Progress.Lang.Object


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
+ CompileFile (character, character) Compiles a file
+ LOGICAL CompileFiles (character, character, character, character, logical) Compiles a set of files, optionally supporting MD5 hashing them for webclient optimization
+ CHARACTER GeneratePreprocessed (character) Compiles a file to generate the preprocessed source
+ GenerateXmlXref (character, dataset) Compiles a file to generate xml xref
+ GetLastListing (dataset) Returns the Listing Dataset of the last compile run
+ GetLastXmlXref (dataset) Returns the XmlXref Dataset of the last compile run
# OnCompilingFile (CompilingFileEventArgs) Raises the CompilingFile

Top Constructor Summary
Options Name Purpose
- CompilerHelper () Disallow instance creation

Top Event Summary
Options Name Purpose
+ CompilingFile (CompilingFileEventArgs) Raised when a file is being compiled


Method Detail
Top

PUBLIC CompileFile (character, character)
Purpose: Compiles a file
Notes: Throws an CompileException in case of compile errors.
Optimization (SCL-4944): Only uses the INTO option when pcSaveInto
is not empty (""), not a single period ("."), and does not represent
the current working directory. The current working directory is
determined via FileHelper:FindFile(".") and compared to
FileHelper:FindFile(pcSaveInto) FindFile(pcSaveInto) case-insensitively. If FindFile
returns ? for either path, they are treated as not equal.

Parameters:
pcFileName CHARACTER
The file name to compile
pcSaveInto CHARACTER
The directory to compile into, optional
Top

PUBLIC LOGICAL CompileFiles (character, character, character, character, logical)
Purpose: Compiles a set of files, optionally supporting MD5 hashing them for
webclient optimization
Notes: Processes the file masks in order, so that when *.cls is passed as the
first entry, all class files are compiled before the procedures that
might be referencing them

Parameters:
pcSourcePath CHARACTER
The source file path
pcFileMask CHARACTER
A comma-delimited list of file patterns to compile (e.g. *.cls,*.w,*.p)
pcTargetPath CHARACTER
The directory to compile into
pcLogfileName CHARACTER
The name of the logfile to create
plMD5 LOGICAL
Create MD5 hash during compilation (Web Client optimization)
Returns LOGICAL
TRUE when all files compiled, FALSE in case of errors
Top

PUBLIC CHARACTER GeneratePreprocessed (character)
Purpose: Compiles a file to generate the preprocessed source
Notes: Suppresses warning messages from the compiler because they cannot be
distinguished from error messages

Parameters:
pcFileName CHARACTER
The file name to compile
Returns CHARACTER
The file name of the preprocessed source
Top

PUBLIC GenerateXmlXref (character, dataset)
Purpose: Compiles a file to generate xml xref
Notes: Suppresses warning messages from the compiler because they cannot be
distinguished from error messages

Parameters:
pcFileName CHARACTER
The file name to compile
dsXmlXref DATASET dsXmlXref
The dsXmlXref dataset to load the XML XREF into. Should be called BY-REFERENCE
Top

PUBLIC GetLastListing (dataset)
Purpose: Returns the Listing Dataset of the last compile run
Notes:

Parameters:
dsListing DATASET dsListing
OUTPUT DATASET from Consultingwerk/Studio/Listing/dsListing.i
Top

PUBLIC GetLastXmlXref (dataset)
Purpose: Returns the XmlXref Dataset of the last compile run
Notes:

Parameters:
dsXmlXref DATASET dsXmlXref
OUTPUT DATASET from Consultingwerk/Studio/Xref/dsXmlXref.i
Top

PROTECTED OnCompilingFile (CompilingFileEventArgs)
Purpose: Raises the CompilingFile
Notes:

Parameters:
e Consultingwerk.Studio.CompilingFileEventArgs
The eventargs with the data for the event


Constructor Detail
Top

PRIVATE CompilerHelper ()
Purpose: Disallow instance creation
Notes:



Event Detail
Top

PUBLIC CompilingFile (CompilingFileEventArgs)
Purpose: Raised when a file is being compiled
Notes:

Parameters:
e Consultingwerk.Studio.CompilingFileEventArgs
The CompilingFileEventArgs with the data for the event


ProDataset Detail

ProDataset dsListing

Member tables: eBlockInfo, eListing

ProDataset dsXmlXref

Member tables: eSource, eReference, eClassRef, eParameterRef


Temp-Table Detail

Temp-Table eBlockInfo

Defined in:

Temp-Table eClassRef

Defined in:

Temp-Table eListing

Defined in:

Temp-Table eParameterRef

Defined in:

Temp-Table eReference

Defined in:

Temp-Table eSource

Defined in:


©2006-2025 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       24.10.2025 08:56:01