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 full)

Constructors

constructor

Properties

afterJp currentElements filename isGlobal printfFormat Type

Methods

_append_private _clava_logger_filename_declaration _clava_logger_filename_declaration_cpp _declareName _getPrintableContent _info _insert _insertCode _log_c _log_c_console _log_c_file _log_c_file_setup _log_cxx _log_cxx_specslogger _log_cxx_stdcpp _logSetup _printfFormat _setup_cxx_specslogger _setup_cxx_stdcpp_console _setup_cxx_stdcpp_file _validateJp _warn append appendChar appendDouble appendHex appendInt appendln appendLong appendLongLong appendOctal appendString char double getAfterJp hex int isGlobalFn ln log logBefore long longLong octal string tab text

Constructors

constructor

Properties

ProtectedafterJp

afterJp: undefined | Joinpoint

ProtectedcurrentElements

currentElements: ElementType[]

Protectedfilename

filename: undefined | string

ProtectedisGlobal

isGlobal: boolean

printfFormat

printfFormat: Record<number, undefined | string>

Used for both C and Java printf functions

Type

Type: Map<string, number>

Methods

Protected_append_private

  • _append_private(message, type?): this

  • ** PRIVATE METHODS ***

    Parameters

    • message: string | Joinpoint
    • Optionaltype: number

    Returns this

_clava_logger_filename_declaration

_clava_logger_filename_declaration_cpp

Protected_declareName

  • _declareName(functionId, nameGenerator): {
        alreadyDeclared: boolean;
        name: string;
    }

  • Parameters

    • functionId: string
    • nameGenerator: (() => string)

      Function that receives no arguments and generates a new name

        • (): string

        • Returns string

    Returns {
        alreadyDeclared: boolean;
        name: string;
    }

    • alreadyDeclared: boolean
    • name: string

Protected_getPrintableContent

  • _getPrintableContent(element): string

  • Parameters

    • element: ElementType

    Returns string

Protected_info

  • _info(message): void

  • Parameters

    • message: string

    Returns void

_insert

  • _insert($jp, insertBefore, code): void

  • Parameters

    • $jp: Joinpoint
    • insertBefore: boolean
    • code: string

    Returns void

_insertCode

_log_c

_log_c_console

_log_c_file

_log_c_file_setup

_log_cxx

_log_cxx_specslogger

_log_cxx_stdcpp

_logSetup

  • _logSetup($jp, insertBefore?): undefined | FunctionJp

  • Checks the initial constrains before executing the actual log (ancestor function, minimum of elements to log, defines the value of insertBefore) Should be called on the beggining of each implementation of log

    Parameters

    Returns undefined | FunctionJp

    Undefined on failure and a $function instance if successful

Protected_printfFormat

  • _printfFormat(printFunctionName, prefix?, suffix?, delimiter?): 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

_setup_cxx_specslogger

_setup_cxx_stdcpp_console

_setup_cxx_stdcpp_file

_validateJp

  • _validateJp($jp, functionJpName?): 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

Protected_warn

  • _warn(message): void

  • Parameters

    • message: string

    Returns void

append

  • append(text): this

  • Appends the given string to the current buffer.

    Parameters

    • text: string

      The text to append

    Returns this

    The current logger instance

appendChar

  • appendChar(expr): this

  • Appends an expression that represents a char.

    Parameters

    • expr: string | Joinpoint

      The expression to append

    Returns this

    The current logger instance

appendDouble

  • appendDouble(expr): this

  • Appends an expression that represents a double.

    Parameters

    • expr: string | Joinpoint

      The expression to append

    Returns this

    The current logger instance

appendHex

  • appendHex(expr): this

  • Appends an expression that represents a hex number.

    Parameters

    • expr: string | Joinpoint

      The expression to append

    Returns this

    The current logger instance

appendInt

  • appendInt(expr): this

  • Appends an expression that represents a int.

    Parameters

    • expr: string | Joinpoint

      The expression to append

    Returns this

    The current logger instance

appendln

  • appendln(text): 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

appendLong

  • appendLong(expr): this

  • Appends an expression that represents a long.

    Parameters

    • expr: string | Joinpoint

      The expression to append

    Returns this

    The current logger instance

appendLongLong

appendOctal

  • appendOctal(expr): this

  • Appends an expression that represents an octal.

    Parameters

    • expr: string | Joinpoint

      The expression to append

    Returns this

    The current logger instance

appendString

  • appendString(expr): this

  • Appends an expression that represents a string.

    Parameters

    • expr: string | Joinpoint

      The expression to append

    Returns this

    The current logger instance

char

  • char(expr): this

  • The same as 'appendChar'.

    Parameters

    • expr: string | Joinpoint

      The expression to append

    Returns this

    The current logger instance

double

  • double(expr): this

  • The same as 'appendDouble'.

    Parameters

    • expr: string | Joinpoint

      The expression to append

    Returns this

    The current logger instance

getAfterJp

  • getAfterJp(): undefined | Joinpoint

  • The 'last' join point after .log() is called.

    Returns undefined | Joinpoint

hex

  • hex(expr): this

  • The same as 'appendHex'.

    Parameters

    • expr: string | Joinpoint

      The expression to append

    Returns this

    The current logger instance

int

  • int(expr): this

  • The same as 'appendInt'.

    Parameters

    • expr: string | Joinpoint

      The expression to append

    Returns this

    The current logger instance

isGlobalFn

  • isGlobalFn(): void

  • Returns void

ln

  • ln(): this

  • Appends a new line to the buffer.

    Returns this

    The current logger instance

log

logBefore

  • logBefore($jp): void

  • Helper method which call 'log' with 'insertBefore' set to true

    Parameters

    Returns void

long

  • long(expr): this

  • The same as 'appendLong'.

    Parameters

    • expr: string | Joinpoint

      The expression to append

    Returns this

    The current logger instance

longLong

octal

  • octal(expr): this

  • The same as 'appendOctal'.

    Parameters

    • expr: string | Joinpoint

      The expression to append

    Returns this

    The current logger instance

string

  • string(expr): this

  • The same as 'appendString'.

    Parameters

    • expr: string | Joinpoint

      The expression to append

    Returns this

    The current logger instance

tab

  • tab(): this

  • Appends a tab to the buffer.

    Returns this

    The current logger instance

text

  • text(text): this

  • The same as 'append'.

    Parameters

    • text: string

      the text to append

    Returns this

    The current logger instance

Settings

Member Visibility

On This Page

Constructors
Properties
Methods