Namespace: Consultingwerk.BusinessEntityDesigner.Generator
Class 
GeneratedFileRenameRefactorer Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.BusinessEntityDesigner.Generator.GeneratedFileRenameRefactorer

Inherits: Progress.Lang.Object


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



Top Method Summary
Options Name Purpose
AddIdentifierRename (character, character) Registers the rename of an ABL identifier (a temp-table or before-table name)
AddIncludeFileRename (character, character) Registers the rename or move of an include file
AddRename (character, character, character) Registers a rename of the given type
LOGICAL ApplyToFile (character) Applies the registered renames to the given source file
INTEGER ApplyToFiles (character) Applies the registered renames to the given source files
LONGCHAR ApplyToSource (longchar) Applies the registered renames to the given source code
CHARACTER GetTokenAfterKeyword (longchar, character) Returns the identifier that follows the given keyword in the source code
CHARACTER GetTokensAfterKeyword (longchar, character) Returns all identifiers that follow the given keyword in the source code
LOGICAL HasRenames () Returns TRUE when at least one rename has been registered
LOGICAL IsIdentifierCharacter (character) Returns TRUE when the given character is part of an ABL identifier
INTEGER MatchByFieldNames (character, character) Returns the index of the candidate whose field names match the given field names best
CHARACTER ParseDatasetIncludeFile (character) Returns the name of the ProDataset defined in the given dataset include file
CHARACTER ParseTempTableFieldNames (character) Returns the names of the fields defined in the given temp-table include file
LOGICAL ParseTempTableIncludeFile (character, character, character) Returns the name of the temp-table and of its before-table defined in the given temp-table include file
LONGCHAR ReplaceIdentifier (longchar, character, character) Replaces all occurrences of the given identifier in the source code, but only where the identifier appears as a whole token
LONGCHAR ReplaceIncludeFileReference (longchar, character, character) Replaces all references to the given include file in the source code

Top Property Summary
Options Name Purpose
CHARACTER IDENTIFIER_CHARACTERS
INTEGER UpdatedFileCount


Method Detail
Top

AddIdentifierRename (character, character)
Purpose: Registers the rename of an ABL identifier (a temp-table or
before-table name)
Notes: References are only replaced when the identifier appears as a
whole token

Parameters:
pcOldName CHARACTER
The previous name of the identifier
pcNewName CHARACTER
The new name of the identifier
Top

AddIncludeFileRename (character, character)
Purpose: Registers the rename or move of an include file
Notes: The references are matched independently of the directory
separator used in the source file

Parameters:
pcOldReference CHARACTER
The previous include file reference relative to the include base folder, e.g. Sports2000/Order/eOrder.i
pcNewReference CHARACTER
The new include file reference relative to the include base folder
Top

AddRename (character, character, character)
Purpose: Registers a rename of the given type
Notes:

Parameters:
pcRenameType CHARACTER
The type of the rename (Identifier or IncludeFile)
pcOldValue CHARACTER
The previous value
pcNewValue CHARACTER
The new value
Top

LOGICAL ApplyToFile (character)
Purpose: Applies the registered renames to the given source file
Notes: The file is only rewritten when at least one reference was
actually replaced. The write is announced through the WriteFile
and AfterWriteFile events of the Business Entity Generator, so
that plugins and the stale file check (SCL-5615) treat the file
as part of the current generation run

Parameters:
pcFileName CHARACTER
The name of the source file to update
Returns LOGICAL
TRUE when the source file was updated
Top

INTEGER ApplyToFiles (character)
Purpose: Applies the registered renames to the given source files
Notes: Reports the progress through the IStatusManager

Parameters:
pcFileNames CHARACTER
CHR(1) delimited list of the source files to update
Returns INTEGER
The number of source files that were updated
Top

LONGCHAR ApplyToSource (longchar)
Purpose: Applies the registered renames to the given source code
Notes:

Parameters:
plcSource LONGCHAR
The source code to update
Returns LONGCHAR
The updated source code
Top

CHARACTER GetTokenAfterKeyword (longchar, character)
Purpose: Returns the identifier that follows the given keyword in the
source code
Notes: The keyword is matched as a whole token and case insensitive.
A preprocessor reference following the identifier (e.g. the
~{&SUFFIX} of the generated temp-table definitions) is not part
of the returned identifier

Parameters:
plcSource LONGCHAR
The source code to inspect
pcKeyword CHARACTER
The keyword to search for, e.g. temp-table
Returns CHARACTER
The identifier following the keyword or "" when the keyword was not found
Top

CHARACTER GetTokensAfterKeyword (longchar, character)
Purpose: Returns all identifiers that follow the given keyword in the
source code
Notes: The keyword is matched as a whole token and case insensitive

Parameters:
plcSource LONGCHAR
The source code to inspect
pcKeyword CHARACTER
The keyword to search for, e.g. field
Returns CHARACTER
Comma delimited list of the identifiers following the keyword
Top

LOGICAL HasRenames ()
Purpose: Returns TRUE when at least one rename has been registered
Notes:

Returns LOGICAL
TRUE when at least one rename has been registered
Top

LOGICAL IsIdentifierCharacter (character)
Purpose: Returns TRUE when the given character is part of an ABL
identifier
Notes: Used to verify that a match is a whole identifier token and not
part of a longer identifier

Parameters:
pcChar CHARACTER
The character to test
Returns LOGICAL
TRUE when the character is part of an ABL identifier
Top

INTEGER MatchByFieldNames (character, character)
Purpose: Returns the index of the candidate whose field names match the
given field names best
Notes: Used to assign a renamed temp-table to its previous include file
when several temp-tables were renamed in the same generation
run. Returns 0 when no candidate is similar enough or when the
best match is not unique - the caller then leaves the references
untouched rather than applying a wrong rename

Parameters:
pcFieldNames CHARACTER
Comma delimited list of the field names of the current temp-table
pcCandidateFieldNames CHARACTER
CHR(1) delimited list of the comma delimited field names of the candidates
Returns INTEGER
The 1 based index of the best matching candidate or 0
Top

CHARACTER ParseDatasetIncludeFile (character)
Purpose: Returns the name of the ProDataset defined in the given dataset
include file
Notes: Returns "" when the file does not exist or does not contain a
dataset definition

Parameters:
pcFileName CHARACTER
The name of the dataset include file
Returns CHARACTER
The name of the ProDataset defined in the include file
Top

CHARACTER ParseTempTableFieldNames (character)
Purpose: Returns the names of the fields defined in the given temp-table
include file
Notes: Used to assign a renamed temp-table to its previous include file
by comparing the field names

Parameters:
pcFileName CHARACTER
The name of the temp-table include file
Returns CHARACTER
Comma delimited list of the field names defined in the include file
Top

LOGICAL ParseTempTableIncludeFile (character, character, character)
Purpose: Returns the name of the temp-table and of its before-table
defined in the given temp-table include file
Notes: Returns FALSE when the file does not exist or does not contain
a temp-table definition

Parameters:
pcFileName CHARACTER
The name of the temp-table include file
pcTableName CHARACTER
OUTPUT The name of the temp-table defined in the include file
pcBeforeTableName CHARACTER
OUTPUT The name of the before-table defined in the include file
Returns LOGICAL
TRUE when a temp-table definition was found
Top

LONGCHAR ReplaceIdentifier (longchar, character, character)
Purpose: Replaces all occurrences of the given identifier in the source
code, but only where the identifier appears as a whole token
Notes: Comparison is case insensitive (as in ABL), the replacement is
written in the casing of the new name. Occurrences within
string literals are replaced as well - the generated code
references the temp-table names in string literals (e.g. the
ATTACH-DATA-SOURCE arguments and the SourceColumn case branches)

Parameters:
plcSource LONGCHAR
The source code to update
pcOldName CHARACTER
The previous name of the identifier
pcNewName CHARACTER
The new name of the identifier
Returns LONGCHAR
The updated source code
Top

LONGCHAR ReplaceIncludeFileReference (longchar, character, character)
Purpose: Replaces all references to the given include file in the source
code
Notes: The reference is matched independently of the directory
separator used in the source file (forward slash or backslash)

Parameters:
plcSource LONGCHAR
The source code to update
pcOldReference CHARACTER
The previous include file reference, e.g. Sports2000/Order/eOrder.i
pcNewReference CHARACTER
The new include file reference
Returns LONGCHAR
The updated source code


Property Detail
Top

CHARACTER IDENTIFIER_CHARACTERS

Returns CHARACTER
Top

INTEGER UpdatedFileCount

Returns INTEGER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       24.08.2026 05:56:10