Objeck Documentation

All Bundles

Analysis

Analysis results

Operations

CodeAction
CodeRename
Completion
FindDeclaration
FindDefinition
FindReferences
GetDiagnostics
GetSymbols
HasUses
Hover
IsParsed
Release
SignatureHelp

CodeAction

Get signature definitions

method : public : CodeAction(uri:String, start_range_line:Int, start_range_char:Int, var_name:String) ~ Result

Parameters

Name	Type	Description
uri	String	file uri
start_range_line	Int	line of symbol
start_range_char	Int	character position of symbol
var_name	String	variable string name

Return

Type	Description
Result	symbol references, Nil of none found

CodeRename

Renames a variable or method/function

method : public : CodeRename(uri:String, line:Int, pos:Int, sys_path:String) ~ Result[]

Parameters

Name	Type	Description
uri	String	file uri
line	Int	line of symbol
pos	Int	character position of symbol
sys_path	String	system library path

Return

Type	Description
Result	symbol references, Nil of none found

Completion

Get completion options

method : public : Completion(uri:String, line:Int, pos:Int, var_str:String, mthd_str:String, sys_path:String) ~ Result

Parameters

Name	Type	Description
uri	String	file uri
line	Int	line of symbol
pos	Int	character position of symbol
var_str	String	variable string name
mthd_str	String	method string name
sys_path	String	system library path

Return

Type	Description
Result	symbol references, Nil of none found

FindDeclaration

Finds symbol deceleration

method : public : FindDeclaration(uri:String, line:Int, pos:Int, sys_path:String) ~ Result

Parameters

Name	Type	Description
uri	String	file uri
line	Int	line of symbol
pos	Int	character position of symbol
sys_path	String	system library path

Return

Type	Description
Result	symbol deceleration, Nil of none found

FindDefinition

Finds symbol definition

method : public : FindDefinition(uri:String, line:Int, pos:Int, sys_path:String) ~ Result

Parameters

Name	Type	Description
uri	String	file uri
line	Int	line of symbol
pos	Int	character position of symbol
sys_path	String	system library path

Return

Type	Description
Result	symbol deceleration, Nil of none found

FindReferences

Get references specified symbol

method : public : FindReferences(uri:String, line:Int, pos:Int, sys_path:String) ~ Result[]

Parameters

Name	Type	Description
uri	String	file uri
line	Int	line of symbol
pos	Int	character position of symbol
sys_path	String	system library path

Return

Type	Description
Result	symbol references, Nil of none found

GetDiagnostics

Get parse and analysis errors

method : public : GetDiagnostics(was_analyzed:BoolRef, uri:String, sys_path:String) ~ Result[]

Parameters

Name	Type	Description
was_analyzed	BoolRef	set true if code was successfully analyzed, false otherwise
uri	String	file uri
sys_path	String	system library path

Return

Type	Description
Result	analysis errors, Nil of no errors

GetSymbols

Get source code analysis symbols

method : public : GetSymbols(uri:String, sys_path:String) ~ Result

Parameters

Name	Type	Description
uri	String	file uri
sys_path	String	system library path

Return

Type	Description
Result	analysis symbols

HasUses

Check to see if user 'use' statement are present

method : public : HasUses() ~ Bool

Return

Type	Description
Bool	true if user 'use' statement are present, false otherwise

Hover

Gets hover signatures

method : public : Hover(uri:String, line:Int, pos:Int, var_str:String, mthd_str:String, sys_path:String) ~ Result

Parameters

Name	Type	Description
uri	String	file uri
line	Int	line of symbol
pos	Int	character position of symbol
var_str	String	variable string name
mthd_str	String	method string name
sys_path	String	system library path

Return

Type	Description
Result	hover references, Nil of none found

IsParsed

Check to see if source was parsed

method : public : IsParsed() ~ Bool

Return

Type	Description
Bool	true if parsed, false otherwise

Release

Release native resources, required for clean up.

method : public : Release() ~ Nil

SignatureHelp

Get signature definitions

method : public : SignatureHelp(uri:String, line:Int, pos:Int, var_str:String, mthd_str:String, sys_path:String) ~ Result

Parameters

Name	Type	Description
uri	String	file uri
line	Int	line of symbol
pos	Int	character position of symbol
var_str	String	variable string name
mthd_str	String	method string name
sys_path	String	system library path

Return

Type	Description
Result	symbol references, Nil of none found