Class default

This class provides a parser for callgrind files. It can be used to extract profile information from the callgrind file. Specification of callgrind type files can be found in valgrind website.

Hierarchy

default

Index

Constructors

constructor

new default(file): default
Creates an instance of CallGrind.
Parameters
- file: string | Readable
  
  The file parameter is either a string representing the path to a file or a Readable stream for the callgrind file to be parsed.
Returns default
- Defined in callgrind.ts:99

Properties

`Private` HEADER_REGEX

HEADER_REGEX: RegExp = ...

The regular expression for matching header lines.

`Private` REGEXLIST

REGEXLIST: {
    cfi: RegExp;
    cfl: RegExp;
    cfn: RegExp;
    fl: RegExp;
    fn: RegExp;
} = ...

The regular expression list for matching different types of lines.

Type declaration

cfi: RegExp
cfl: RegExp
cfn: RegExp
fl: RegExp
fn: RegExp

errorLines

errorLines: string[] = []

The list of error lines encountered during parsing.

`Private` eventList

eventList: string[] = []

The list of events specified in the callgrind file.

`Private` fileList

fileList: {
[fkey: string]: string;
} = {}

The list of files specified in the callgrind file.

Type declaration

[fkey: string]: string

`Private` fstream

fstream: Interface

The readline.Interface instance that is used to read the file.

`Private` functionList

functionList: {
[fkey: string]: string;
} = {}

The list of functions specified in the callgrind file.

Type declaration

[fkey: string]: string

header

header: {
[key: string]: any;
} = {}

The header section of the callgrind file.

Type declaration

[key: string]: any

`Private` profiledb

profiledb: ProfileDatabase = {}

The profile database that stores the extracted profile information.

`Private` scope

scope: {
    parameters?: {
        [field: string]: string;
    };
    section: string;
} = ...

The current scope of the parser.

Type declaration

Optional parameters?: {
[field: string]: string;
}
- [field: string]: string
section: string

Methods

`Private` getCallerScope

getCallerScope(): {
    file: {
        id: string;
        name: string;
    };
    function: {
        id: string;
        name: string;
    };
}
Private
Returns the current scope of the caller function in the parser.

Returns
The current scope of the caller function in the parser.

Returns {
    file: {
        id: string;
        name: string;
    };
    function: {
        id: string;
        name: string;
    };
}
- file: {
  id: string;
  name: string;
  }
  - id: string
  - name: string
- function: {
  id: string;
  name: string;
  }
  - id: string
  - name: string
- Defined in callgrind.ts:163

`Private` getScope

getScope(): {
    file: {
        id: string;
        name: string;
    };
    function: {
        id: string;
        name: string;
    };
}
Private
Returns the current scope of the parser.

Returns
The current scope of the parser.

Returns {
    file: {
        id: string;
        name: string;
    };
    function: {
        id: string;
        name: string;
    };
}
- file: {
  id: string;
  name: string;
  }
  - id: string
  - name: string
- function: {
  id: string;
  name: string;
  }
  - id: string
  - name: string
- Defined in callgrind.ts:144

`Private` isCommentLine

isCommentLine(line): boolean
Private
Checks if a line is a comment line.

Returns
true if the line is a comment line, false otherwise.
Parameters
- line: string
  
  The line to be checked.
Returns boolean
- Defined in callgrind.ts:134

parse

parse(): Promise<CallGrindParseOutput>
Parses the callgrind file and returns the extracted profile information.

Returns
A promise that resolves to the extracted profile information.

Returns Promise<CallGrindParseOutput>
- Defined in callgrind.ts:111

`Private` parseLine

parseLine(line): void
Parses a single line of a Callgrind file asynchronously, updating the internal states of the CallGrind object.

Returns
A Promise that resolves to void.
Parameters
- line: string
  
  A single line from a Callgrind file.
Returns void
- Defined in callgrind.ts:183

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

file: string | Readable

Returns default

Properties

Private HEADER_REGEX

Private REGEXLIST

Type declaration

cfi: RegExp

cfl: RegExp

cfn: RegExp

fl: RegExp

fn: RegExp

errorLines

Private eventList

Private fileList

Type declaration

[fkey: string]: string

Private fstream

Private functionList

Type declaration

[fkey: string]: string

header

Type declaration

[key: string]: any

Private profiledb

Private scope

Type declaration

Optional parameters?: { [field: string]: string; }

[field: string]: string

section: string

Methods

Private getCallerScope

Returns

Returns { file: { id: string; name: string; }; function: { id: string; name: string; }; }

file: { id: string; name: string; }

id: string

name: string

function: { id: string; name: string; }

id: string

name: string

Private getScope

Returns

Returns { file: { id: string; name: string; }; function: { id: string; name: string; }; }

file: { id: string; name: string; }

id: string

name: string

function: { id: string; name: string; }

id: string

name: string

Private isCommentLine

Returns

Parameters

line: string

Returns boolean

parse

Returns

Returns Promise<CallGrindParseOutput>

Private parseLine

Returns

Parameters

line: string

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` HEADER_REGEX

`Private` REGEXLIST

`Private` eventList

`Private` fileList

`Private` fstream

`Private` functionList

`Private` profiledb

`Private` scope

`Optional` parameters?: {
[field: string]: string;
}

`Private` getCallerScope

Returns {
file: {
id: string;
name: string;
};
function: {
id: string;
name: string;
};
}

file: {
id: string;
name: string;
}

function: {
id: string;
name: string;
}

`Private` getScope

Returns {
file: {
id: string;
name: string;
};
function: {
id: string;
name: string;
};
}

file: {
id: string;
name: string;
}

function: {
id: string;
name: string;
}

`Private` isCommentLine

`Private` parseLine