Class Logger

Logger object, for inserting code that prints/saves information to files.

Param: isGlobal

Not implemented, please ignore

Param: filename

If set, instead of printing, will insert code for writing output to this file

Hierarchy (View Summary)

LoggerBase<Joinpoint>
- Logger

Constructors

constructor

new Logger(isGlobal?: boolean, filename?: string): Logger
Parameters
- isGlobal: boolean = false
- Optionalfilename: string
Returns Logger
Overrides LoggerBase.constructor
- Defined in kadabra/Kadabra-JS/src-api/lara/code/Logger.ts:6

Properties

`Protected`afterJp

afterJp: Joinpoint | undefined

`Protected`currentElements

currentElements: ElementType[]

`Protected`filename

filename: string | undefined

`Protected`isGlobal

isGlobal: boolean

printfFormat

printfFormat: Record<number, string | undefined>

Used for both C and Java printf functions

Type

Type: Map<string, number>

Methods

`Protected`_append_private

_append_private(message: string | Joinpoint, type?: number): this
** PRIVATE METHODS ***
Parameters
- message: string | Joinpoint
- Optionaltype: number
Returns this
Inherited from LoggerBase._append_private
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:185

`Protected`_declareName

_declareName(
functionId: string,
nameGenerator: () => string,
): { alreadyDeclared: boolean; name: string }
Parameters
- functionId: string
- nameGenerator: () => string
  Function that receives no arguments and generates a new name
Returns { alreadyDeclared: boolean; name: string }
Inherited from LoggerBase._declareName
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:201

`Protected`_getPrintableContent

_getPrintableContent(element: ElementType): string
Parameters
- element: ElementType
Returns string
Inherited from LoggerBase._getPrintableContent
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:188

`Protected`_info

_info(message: string): void
Parameters
- message: string
Returns void
Inherited from LoggerBase._info
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:187

_insert

_insert($jp: Joinpoint, insertBefore: boolean, code: string): void
Parameters
- $jp: Joinpoint
- insertBefore: boolean
- code: string
Returns void
Inherited from LoggerBase._insert
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:46

_insertCode

_insertCode($jp: Joinpoint, insertBefore: boolean, code: string): void
Inserts the given code before/after the given join point.

Override this method if you need to specialize the insertion.
Parameters
- $jp: Joinpoint
- insertBefore: boolean
- code: string
Returns void
Inherited from LoggerBase._insertCode
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:52

_log_code

_log_code(): string
Returns string
- Defined in kadabra/Kadabra-JS/src-api/lara/code/Logger.ts:41

_log_code_console

_log_code_console(): string
Returns string
- Defined in kadabra/Kadabra-JS/src-api/lara/code/Logger.ts:49

_log_code_file

_log_code_file(): string
Returns string
- Defined in kadabra/Kadabra-JS/src-api/lara/code/Logger.ts:59

`Protected`_printfFormat

_printfFormat(
    printFunctionName: string,
    prefix?: string,
    suffix?: string,
    delimiter?: string,
): string
Generates printf like code for c and java
Parameters
- printFunctionName: string
  The name of the function to use (printf for C, System.out.println for Java)
- Optionalprefix: string
- Optionalsuffix: string
- Optionaldelimiter: string
Returns string
Inherited from LoggerBase._printfFormat
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:194

_validateJp

_validateJp($jp: any, functionJpName?: string): boolean
Verifies that the given $jp is inside a function.

Requires global attribute 'ancestor'.
Parameters
- $jp: any
- OptionalfunctionJpName: string
Returns boolean
true if $jp is inside a function, false otherwise
Inherited from LoggerBase._validateJp
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:45

`Protected`_warn

_warn(message: string): void
Parameters
- message: string
Returns void
Inherited from LoggerBase._warn
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:186

append

append(text: string): this
Appends the given string to the current buffer.
Parameters
- text: string
  The text to append
Returns this
The current logger instance
Inherited from LoggerBase.append
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:59

appendChar

appendChar(expr: string | Joinpoint): this
Appends an expression that represents a char.
Parameters
- expr: string | Joinpoint
  The expression to append
Returns this
The current logger instance
Inherited from LoggerBase.appendChar
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:148

appendDouble

appendDouble(expr: string | Joinpoint): this
Appends an expression that represents a double.
Parameters
- expr: string | Joinpoint
  The expression to append
Returns this
The current logger instance
Inherited from LoggerBase.appendDouble
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:92

appendHex

appendHex(expr: string | Joinpoint): this
Appends an expression that represents a hex number.
Parameters
- expr: string | Joinpoint
  The expression to append
Returns this
The current logger instance
Inherited from LoggerBase.appendHex
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:162

appendInt

appendInt(expr: string | Joinpoint): this
Appends an expression that represents a int.
Parameters
- expr: string | Joinpoint
  The expression to append
Returns this
The current logger instance
Inherited from LoggerBase.appendInt
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:106

appendln

appendln(text: string): this
The same as 'append', but adds a new line at the end of the buffer.
Parameters
- text: string
  the text to append
Returns this
The current logger instance
Inherited from LoggerBase.appendln
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:73

appendLong

appendLong(expr: string | Joinpoint): this
Appends an expression that represents a long.
Parameters
- expr: string | Joinpoint
  The expression to append
Returns this
The current logger instance
Inherited from LoggerBase.appendLong
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:120

appendOctal

appendOctal(expr: string | Joinpoint): this
Appends an expression that represents an octal.
Parameters
- expr: string | Joinpoint
  The expression to append
Returns this
The current logger instance
Inherited from LoggerBase.appendOctal
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:176

appendString

appendString(expr: string | Joinpoint): this
Appends an expression that represents a string.
Parameters
- expr: string | Joinpoint
  The expression to append
Returns this
The current logger instance
Inherited from LoggerBase.appendString
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:134

char

char(expr: string | Joinpoint): this
The same as 'appendChar'.
Parameters
- expr: string | Joinpoint
  The expression to append
Returns this
The current logger instance
Inherited from LoggerBase.char
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:155

double

double(expr: string | Joinpoint): this
The same as 'appendDouble'.
Parameters
- expr: string | Joinpoint
  The expression to append
Returns this
The current logger instance
Inherited from LoggerBase.double
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:99

getAfterJp

getAfterJp(): Joinpoint | undefined
The 'last' join point after .log() is called.

Returns Joinpoint | undefined
Inherited from LoggerBase.getAfterJp
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:30

hex

hex(expr: string | Joinpoint): this
The same as 'appendHex'.
Parameters
- expr: string | Joinpoint
  The expression to append
Returns this
The current logger instance
Inherited from LoggerBase.hex
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:169

int

int(expr: string | Joinpoint): this
The same as 'appendInt'.
Parameters
- expr: string | Joinpoint
  The expression to append
Returns this
The current logger instance
Inherited from LoggerBase.int
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:113

isGlobalFn

isGlobalFn(): void
Returns void
Inherited from LoggerBase.isGlobalFn
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:25

ln

ln(): this
Appends a new line to the buffer.

Returns this
The current logger instance
Inherited from LoggerBase.ln
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:79

log

log($jp: Joinpoint, insertBefore?: boolean): Logger | undefined
Adds code that prints the message built up to that point with the append() functions.

TODO: Improve this comment, add JSDoc tags
Parameters
- $jp: Joinpoint
- insertBefore: boolean = false
Returns Logger | undefined
Overrides LoggerBase.log
- Defined in kadabra/Kadabra-JS/src-api/lara/code/Logger.ts:25

logBefore

logBefore($jp: Joinpoint): void
Helper method which call 'log' with 'insertBefore' set to true
Parameters
- $jp: Joinpoint
Returns void
Inherited from LoggerBase.logBefore
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:37

long

long(expr: string | Joinpoint): this
The same as 'appendLong'.
Parameters
- expr: string | Joinpoint
  The expression to append
Returns this
The current logger instance
Inherited from LoggerBase.long
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:127

octal

octal(expr: string | Joinpoint): this
The same as 'appendOctal'.
Parameters
- expr: string | Joinpoint
  The expression to append
Returns this
The current logger instance
Inherited from LoggerBase.octal
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:183

string

string(expr: string | Joinpoint): this
The same as 'appendString'.
Parameters
- expr: string | Joinpoint
  The expression to append
Returns this
The current logger instance
Inherited from LoggerBase.string
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:141

tab

tab(): this
Appends a tab to the buffer.

Returns this
The current logger instance
Inherited from LoggerBase.tab
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:85

text

text(text: string): this
The same as 'append'.
Parameters
- text: string
  the text to append
Returns this
The current logger instance
Inherited from LoggerBase.text
- Defined in lara-framework/Lara-JS/api/lara/code/LoggerBase.d.ts:66

Class Logger

Param: isGlobal

Param: filename

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Logger

Properties

ProtectedafterJp

ProtectedcurrentElements

Protectedfilename

ProtectedisGlobal

printfFormat

Type

Methods

Protected_append_private

Parameters

Returns this

Protected_declareName

Parameters

Returns { alreadyDeclared: boolean; name: string }

Protected_getPrintableContent

Parameters

Returns string

Protected_info

Parameters

Returns void

_insert

Parameters

Returns void

_insertCode

Parameters

Returns void

_log_code

Returns string

_log_code_console

Returns string

_log_code_file

Returns string

Protected_printfFormat

Parameters

Returns string

_validateJp

Parameters

Returns boolean

Protected_warn

Parameters

Returns void

append

Parameters

Returns this

appendChar

Parameters

Returns this

appendDouble

Parameters

Returns this

appendHex

Parameters

Returns this

appendInt

Parameters

Returns this

appendln

Parameters

Returns this

appendLong

Parameters

Returns this

appendOctal

Parameters

Returns this

appendString

Parameters

Returns this

`Protected`afterJp

`Protected`currentElements

`Protected`filename

`Protected`isGlobal

`Protected`_append_private

`Protected`_declareName

`Protected`_getPrintableContent

`Protected`_info

`Protected`_printfFormat

`Protected`_warn