The gtirb-functions Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The gtirb-functions Reference Manual

This is the gtirb-functions Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:44:08 2022 GMT+0.

Table of Contents


1 Introduction

GTIRB-Functions

Function objects over GTIRB

Abstract

This repository provides simple function objects easing working with functions on top of GTIRB instances. Functions are not first-class in GTIRB and are not supported by the GTIRB API. Instead three sanctioned AuxData tables are used to persist hold function information in GTIRB instances. This repository mediates access to these tables through first-class function objects.

Copyright and Acknowledgments

Copyright (C) 2020 GrammaTech, Inc.

This code is licensed under the MIT license. See the LICENSE file in the project root for license terms.

This project is sponsored by the Office of Naval Research, One Liberty Center, 875 N. Randolph Street, Arlington, VA 22203 under contract # N68335-17-C-0700. The content of the information does not necessarily reflect the position or policy of the Government and no official endorsement should be inferred.


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 gtirb-functions

Function objects over GTIRB

Author

GrammaTech

License

MIT

Long Description

This repository provides simple function
objects easing working with functions on top of GTIRB instances. Functions are not first-class in GTIRB and are not supported by the GTIRB API. Instead three sanctioned AuxData tables are used to persist hold function information in GTIRB instances. This repository mediates access to these tables through first-class function objects.

Defsystem Dependency

asdf-package-system (system).

Dependency

gtirb-functions/gtirb-functions (system).

Source

gtirb-functions.asd.


Previous: , Up: Systems   [Contents][Index]

2.2 gtirb-functions/gtirb-functions

Author

GrammaTech

License

MIT

Dependencies
  • gt (system).
  • gtirb (system).
  • graph (system).
  • stefil (system).
Source

gtirb-functions.asd.


3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


3.1.1 gtirb-functions/gtirb-functions.asd

Source

gtirb-functions.asd.

Parent Component

gtirb-functions (system).

ASDF Systems

3.1.2 gtirb-functions/gtirb-functions/file-type.lisp

Source

gtirb-functions.asd.

Parent Component

gtirb-functions/gtirb-functions (system).

Packages

gtirb-functions/gtirb-functions.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 gtirb-functions/gtirb-functions

Source

file-type.lisp.

Nickname

gtirb-functions

Use List
  • graph/graph.
  • gt.
  • gtirb/gtirb.
  • stefil.
Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


5.1.1 Generic functions

Generic Reader: entries (object)
Generic Writer: (setf entries) (object)
Package

gtirb-functions/gtirb-functions.

Methods
Reader Method: entries ((func func))
Writer Method: (setf entries) ((func func))

Blocks serving as entry points to the function.

Source

file-type.lisp.

Target Slot

entries.

Generic Function: exits (object)

Return the blocks that exit OBJECT.

Package

gtirb-functions/gtirb-functions.

Source

file-type.lisp.

Methods
Method: exits ((obj func))
Generic Function: functions (object)

Return all functions in OBJECT.

Package

gtirb-functions/gtirb-functions.

Source

file-type.lisp.

Methods
Method: functions ((obj gtirb))
Method: functions ((obj module))
Generic Function: returns (object)

Return the blocks that return from OBJECT.

Package

gtirb-functions/gtirb-functions.

Source

file-type.lisp.

Methods
Method: returns ((obj func))
Generic Function: tail-calls (object)

Return the blocks that tail-call out of OBJECT.

Package

gtirb-functions/gtirb-functions.

Source

file-type.lisp.

Methods
Method: tail-calls ((obj func))

5.1.2 Standalone methods

Writer Method: (setf blocks) ((func func))

Blocks in the function.

Package

gtirb/gtirb.

Source

file-type.lisp.

Target Slot

blocks.

Reader Method: blocks ((func func))

Blocks in the function.

Package

gtirb/gtirb.

Source

file-type.lisp.

Target Slot

blocks.

Method: ir ((func func))
Package

gtirb/gtirb.

Source

file-type.lisp.

Writer Method: (setf module) ((func func))

Module containing the function.

Package

gtirb/gtirb.

Source

file-type.lisp.

Target Slot

module.

Reader Method: module ((func func))

Module containing the function.

Package

gtirb/gtirb.

Source

file-type.lisp.

Target Slot

module.

Writer Method: (setf name) ((func func))

Name of the function, if present.

Package

gtirb/gtirb.

Source

file-type.lisp.

Target Slot

name.

Reader Method: name ((func func))

Name of the function, if present.

Package

gtirb/gtirb.

Source

file-type.lisp.

Target Slot

name.

Method: print-object ((obj func) stream)
Source

file-type.lisp.


5.1.3 Classes

Class: func

A function in a GTIRB instance.

Package

gtirb-functions/gtirb-functions.

Source

file-type.lisp.

Direct superclasses

gtirb-node.

Direct methods
Direct slots
Slot: module

Module containing the function.

Package

gtirb/gtirb.

Type

gtirb/gtirb:module

Initargs

:module

Readers

module.

Writers

(setf module).

Slot: name

Name of the function, if present.

Package

gtirb/gtirb.

Type

(or null gtirb-functions/gtirb-functions::symbol)

Initargs

:name

Readers

name.

Writers

(setf name).

Slot: blocks

Blocks in the function.

Package

gtirb/gtirb.

Type

list

Initargs

:blocks

Readers

blocks.

Writers

(setf blocks).

Slot: entries

Blocks serving as entry points to the function.

Type

list

Initargs

:entries

Readers

entries.

Writers

(setf entries).


5.2 Internals


Next: , Previous: , Up: Internals   [Contents][Index]

5.2.1 Special variables

Special Variable: *base-dir*
Package

gtirb-functions/gtirb-functions.

Source

file-type.lisp.

Special Variable: *hello*
Package

gtirb-functions/gtirb-functions.

Source

file-type.lisp.


5.2.2 Ordinary functions

Function: functions-are-returned ()
Package

gtirb-functions/gtirb-functions.

Source

file-type.lisp.

Function: hello (&optional phase2)
Package

gtirb-functions/gtirb-functions.

Source

file-type.lisp.

Function: test ()
Package

gtirb-functions/gtirb-functions.

Source

file-type.lisp.


5.2.3 Generic functions

Generic Function: instructions (func)
Package

gtirb-functions/gtirb-functions.

Methods
Method: instructions ((func func))
Source

file-type.lisp.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
B   E   F   G   H   I   M   N   P   R   T  
Index Entry  Section

(
(setf blocks): Public standalone methods
(setf entries): Public generic functions
(setf entries): Public generic functions
(setf module): Public standalone methods
(setf name): Public standalone methods

B
blocks: Public standalone methods

E
entries: Public generic functions
entries: Public generic functions
exits: Public generic functions
exits: Public generic functions

F
Function, functions-are-returned: Private ordinary functions
Function, hello: Private ordinary functions
Function, test: Private ordinary functions
functions: Public generic functions
functions: Public generic functions
functions: Public generic functions
functions-are-returned: Private ordinary functions

G
Generic Function, (setf entries): Public generic functions
Generic Function, entries: Public generic functions
Generic Function, exits: Public generic functions
Generic Function, functions: Public generic functions
Generic Function, instructions: Private generic functions
Generic Function, returns: Public generic functions
Generic Function, tail-calls: Public generic functions

H
hello: Private ordinary functions

I
instructions: Private generic functions
instructions: Private generic functions
ir: Public standalone methods

M
Method, (setf blocks): Public standalone methods
Method, (setf entries): Public generic functions
Method, (setf module): Public standalone methods
Method, (setf name): Public standalone methods
Method, blocks: Public standalone methods
Method, entries: Public generic functions
Method, exits: Public generic functions
Method, functions: Public generic functions
Method, functions: Public generic functions
Method, instructions: Private generic functions
Method, ir: Public standalone methods
Method, module: Public standalone methods
Method, name: Public standalone methods
Method, print-object: Public standalone methods
Method, returns: Public generic functions
Method, tail-calls: Public generic functions
module: Public standalone methods

N
name: Public standalone methods

P
print-object: Public standalone methods

R
returns: Public generic functions
returns: Public generic functions

T
tail-calls: Public generic functions
tail-calls: Public generic functions
test: Private ordinary functions

Jump to:   (  
B   E   F   G   H   I   M   N   P   R   T