Library: BSXparsingUtils

Created Nov 2022 by Devin Olson/USA/PNPHCL
	BaliSX Script Reading / Parsing Utilities

Script Creator	Devin Olson
Uses Library	BSXdocumentationUtils

BSXscriptNode	Represents a block of script code.
BSXscriptParser	Utilitiy class for parsing BSX script source content
ScriptLine	Represents a Line of Script Code
ScriptLineQueue	Queue implementation for ScriptLines
ScriptLinesCarrier	Carrier class for ScriptLines

`getBeginIndices(source As String, substring As String, maxindex As Integer) As IntegerQueue`
`mergeScriptSource(source As StringQueue, projectname As String, filepath As String, instance_code As Integer, unmerged As StringQueue, duplicateoutput As Boolean, writeJSON As Boolean) As StringQueue`
`spawnScriptNodeFromFile(projectname As String, filepath As String, instance_code As Integer, duplicateoutput As Boolean, writeJSON As Boolean) As BSXscriptNode`

Public Function getBeginIndices(source As String, substring As String, maxindex As Integer) As IntegerQueue
Returns an array of Integers containing the beginning index positions of all instances of a substring within a source string.
idx	Argument	Data Type	Attributes	Comments
1	source	String		String to search
2	substring	String		Substring to search for for instances within source
3	maxindex	Integer		The maximum index number allowed to be returned.

Public Function mergeScriptSource(source As StringQueue, projectname As String, filepath As String, instance_code As Integer, unmerged As StringQueue, duplicateoutput As Boolean, writeJSON As Boolean) As StringQueue
Merges source script script object with existing content.
idx	Argument	Data Type	Attributes	Comments
1	source	StringQueue		Source Script object
2	projectname	String		Name of the Project
3	filepath	String		Filepath of the existing source script file
4	instance_code	Integer		Integer code indicating the type of code block this object (Library, Function, Class, etc) represents.
5	unmerged	StringQueue		StringQueue containing unmerged script (code that could not be matched)
6	duplicateoutput	Boolean		Flag indicating if the existing source script file should be duplicated (extension "output.vss" will be added)
7	writeJSON	Boolean		Flag indicating if the JSON generated from the source script should be written to a file (extension ".json" will be added)

Throws Exceptions
Message	Error Code	Comments
MSG_PARAMETER_BLANK	1199	if project is Nothing.
MSG_PARAMETER_BLANK	1199	if source is Nothing.

Public Function spawnScriptNodeFromFile(projectname As String, filepath As String, instance_code As Integer, duplicateoutput As Boolean, writeJSON As Boolean) As BSXscriptNode
Loads a script source library file into a new BSXscriptNode
idx	Argument	Data Type	Attributes	Comments
1	projectname	String		Name of the Project
2	filepath	String		Filepath of the existing source script file
3	instance_code	Integer		Integer code indicating the type of code block this object (Library, Function, Class, etc) represents.
4	duplicateoutput	Boolean		Flag indicating if the existing source script file should be duplicated (extension "output.vss" will be added)
5	writeJSON	Boolean		Flag indicating if the JSON generated from the source script should be written to a file (extension ".json" will be added)

Throws Exceptions
Message	Error Code	Comments
MSG_PARAMETER_BLANK	1199	if source is Nothing.

Library BSXparsingUtils