Class LoggerBase<T>`Abstract`

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

Type Parameters

T extends LaraJoinPoint

Hierarchy (View Summary)

LoggerBase
- Logger
- Logger

Constructors

constructor

new LoggerBase<T extends LaraJoinPoint>(
isGlobal?: boolean,
filename?: string,
): LoggerBase<T>
Type Parameters
- T extends LaraJoinPoint
Parameters
- isGlobal: boolean = false
- Optionalfilename: string
Returns LoggerBase<T>
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:23

Properties

`Protected`afterJp

afterJp: T | undefined = 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 | T, type?: number): LoggerBase<T>
** PRIVATE METHODS ***
Parameters
- message: string | T
- Optionaltype: number
Returns LoggerBase<T>
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:324

`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 }
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:437

`Protected`_getPrintableContent

_getPrintableContent(element: ElementType): string
Parameters
- element: ElementType
Returns string
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:348

`Protected`_info

_info(message: string): void
Parameters
- message: string
Returns void
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:343

_insert

_insert($jp: T, insertBefore: boolean, code: string): void
Parameters
- $jp: T
- insertBefore: boolean
- code: string
Returns void
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:110

_insertCode

_insertCode($jp: T, 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: T
- insertBefore: boolean
- code: string
Returns void
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:123

`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)
- prefix: string = "("
- suffix: string = ");"
- delimiter: string = '"'
Returns string
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:388

_validateJp

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

Requires global attribute 'ancestor'.
Parameters
- $jp: any
- functionJpName: string = "function"
Returns boolean
true if $jp is inside a function, false otherwise
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:94

`Protected`_warn

_warn(message: string): void
Parameters
- message: string
Returns void
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:339

append

append(text: string): LoggerBase<T>
Appends the given string to the current buffer.
Parameters
- text: string
  The text to append
Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:140

appendChar

appendChar(expr: string | T): LoggerBase<T>
Appends an expression that represents a char.
Parameters
- expr: string | T
  The expression to append
Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:268

appendDouble

appendDouble(expr: string | T): LoggerBase<T>
Appends an expression that represents a double.
Parameters
- expr: string | T
  The expression to append
Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:188

appendHex

appendHex(expr: string | T): LoggerBase<T>
Appends an expression that represents a hex number.
Parameters
- expr: string | T
  The expression to append
Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:288

appendInt

appendInt(expr: string | T): LoggerBase<T>
Appends an expression that represents a int.
Parameters
- expr: string | T
  The expression to append
Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:208

appendln

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

appendLong

appendLong(expr: string | T): LoggerBase<T>
Appends an expression that represents a long.
Parameters
- expr: string | T
  The expression to append
Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:228

appendOctal

appendOctal(expr: string | T): LoggerBase<T>
Appends an expression that represents an octal.
Parameters
- expr: string | T
  The expression to append
Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:308

appendString

appendString(expr: string | T): LoggerBase<T>
Appends an expression that represents a string.
Parameters
- expr: string | T
  The expression to append
Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:248

char

char(expr: string | T): LoggerBase<T>
The same as 'appendChar'.
Parameters
- expr: string | T
  The expression to append
Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:278

double

double(expr: string | T): LoggerBase<T>
The same as 'appendDouble'.
Parameters
- expr: string | T
  The expression to append
Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:198

getAfterJp

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

Returns T | undefined
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:68

hex

hex(expr: string | T): LoggerBase<T>
The same as 'appendHex'.
Parameters
- expr: string | T
  The expression to append
Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:298

int

int(expr: string | T): LoggerBase<T>
The same as 'appendInt'.
Parameters
- expr: string | T
  The expression to append
Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:218

isGlobalFn

isGlobalFn(): void
Returns void
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:60

ln

ln(): LoggerBase<T>
Appends a new line to the buffer.

Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:169

`Abstract`log

log($jp: T, insertBefore: boolean): void
Parameters
- $jp: T
- insertBefore: boolean
Returns void
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:76

logBefore

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

long

long(expr: string | T): LoggerBase<T>
The same as 'appendLong'.
Parameters
- expr: string | T
  The expression to append
Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:238

octal

octal(expr: string | T): LoggerBase<T>
The same as 'appendOctal'.
Parameters
- expr: string | T
  The expression to append
Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:318

string

string(expr: string | T): LoggerBase<T>
The same as 'appendString'.
Parameters
- expr: string | T
  The expression to append
Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:258

tab

tab(): LoggerBase<T>
Appends a tab to the buffer.

Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:178

text

text(text: string): LoggerBase<T>
The same as 'append'.
Parameters
- text: string
  the text to append
Returns LoggerBase<T>
The current logger instance
- Defined in lara-framework/Lara-JS/src-api/lara/code/LoggerBase.ts:150

Class LoggerBase<T>Abstract

Param: isGlobal

Param: filename

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns LoggerBase<T>

Properties

ProtectedafterJp

ProtectedcurrentElements

Protectedfilename

ProtectedisGlobal

printfFormat

Type

Methods

Protected_append_private

Parameters

Returns LoggerBase<T>

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

Protected_printfFormat

Parameters

Returns string

_validateJp

Parameters

Returns boolean

Protected_warn

Parameters

Returns void

append

Parameters

Returns LoggerBase<T>

appendChar

Parameters

Returns LoggerBase<T>

appendDouble

Parameters

Returns LoggerBase<T>

appendHex

Parameters

Returns LoggerBase<T>

appendInt

Parameters

Returns LoggerBase<T>

appendln

Parameters

Returns LoggerBase<T>

appendLong

Parameters

Returns LoggerBase<T>

appendOctal

Parameters

Returns LoggerBase<T>

appendString

Parameters

Returns LoggerBase<T>

char

Parameters

Returns LoggerBase<T>

double

Class LoggerBase<T>`Abstract`

`Protected`afterJp

`Protected`currentElements

`Protected`filename

`Protected`isGlobal

`Protected`_append_private

`Protected`_declareName

`Protected`_getPrintableContent

`Protected`_info

`Protected`_printfFormat

`Protected`_warn

`Abstract`log