The gtirb-functions Reference Manual

Table of Contents

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

The gtirb-functions Reference Manual

This is the gtirb-functions Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 11:12:19 2020 GMT+0.


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

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.


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

2 Systems

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


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

2.1 gtirb-functions

Author

GrammaTech

License

MIT

Description

Function objects over GTIRB

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

Dependency

gtirb-functions/gtirb-functions (system)

Source

gtirb-functions.asd (file)


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

2.2 gtirb-functions/gtirb-functions

Author

GrammaTech

License

MIT

Dependencies
Source

gtirb-functions.asd (file)

Component

lisp.lisp (file)


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

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


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 gtirb-functions.asd

Location

gtirb-functions.asd

Systems

Previous: , Up: Lisp files   [Contents][Index]

3.1.2 gtirb-functions/gtirb-functions/lisp.lisp

Parent

gtirb-functions/gtirb-functions (system)

Location

gtirb-functions.lisp

Packages

gtirb-functions/gtirb-functions

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 gtirb-functions/gtirb-functions

Source

lisp.lisp (file)

Nickname

gtirb-functions

Use List
Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Generic functions

Generic Function: entries OBJECT
Generic Function: (setf entries) NEW-VALUE OBJECT
Package

gtirb-functions/gtirb-functions

Methods
Method: entries (FUNC func)
Method: (setf entries) NEW-VALUE (FUNC func)

Blocks serving as entry points to the function.

Source

lisp.lisp (file)

Generic Function: exits OBJECT

Return the blocks that exit OBJECT.

Package

gtirb-functions/gtirb-functions

Source

lisp.lisp (file)

Methods
Method: exits (OBJ func)
Generic Function: functions OBJECT

Return all functions in OBJECT.

Package

gtirb-functions/gtirb-functions

Source

lisp.lisp (file)

Methods
Method: functions (OBJ gtirb)
Method: functions (OBJ module) &aux RESULTS
Generic Function: returns OBJECT

Return the blocks that return from OBJECT.

Package

gtirb-functions/gtirb-functions

Source

lisp.lisp (file)

Methods
Method: returns (OBJ func)

Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Classes

Class: func ()

A function in a GTIRB instance.

Package

gtirb-functions/gtirb-functions

Source

lisp.lisp (file)

Direct superclasses

gtirb-node (class)

Direct methods
  • returns (method)
  • exits (method)
  • ir (method)
  • print-object (method)
  • entries (method)
  • entries (method)
  • blocks (method)
  • blocks (method)
  • name (method)
  • name (method)
  • module (method)
  • module (method)
Direct slots
Slot: module

Module containing the function.

Type

gtirb/gtirb:module

Initargs

:module

Readers

module (generic function)

Writers

(setf module) (generic function)

Slot: name

Name of the function, if present.

Type

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

Initargs

:name

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: blocks

Blocks in the function.

Type

(quote (list (or gtirb/gtirb:code-block gtirb-functions/gtirb-functions::proxy-block)))

Initargs

:blocks

Readers

blocks (generic function)

Writers

(setf blocks) (generic function)

Slot: entries

Blocks serving as entry points to the function.

Type

(quote (list (or gtirb/gtirb:code-block gtirb-functions/gtirb-functions::proxy-block)))

Initargs

:entries

Readers

entries (generic function)

Writers

(setf entries) (generic function)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *base-dir*
Package

gtirb-functions/gtirb-functions

Source

lisp.lisp (file)

Special Variable: *hello*
Package

gtirb-functions/gtirb-functions

Source

lisp.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: functions-are-returned ()
Package

gtirb-functions/gtirb-functions

Source

lisp.lisp (file)

Function: hello &optional PHASE2
Package

gtirb-functions/gtirb-functions

Source

lisp.lisp (file)

Function: test ()
Package

gtirb-functions/gtirb-functions

Source

lisp.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   G   L  
Index Entry  Section

F
File, Lisp, gtirb-functions.asd: The gtirb-functions․asd file
File, Lisp, gtirb-functions/gtirb-functions/lisp.lisp: The gtirb-functions/gtirb-functions/lisp․lisp file

G
gtirb-functions.asd: The gtirb-functions․asd file
gtirb-functions/gtirb-functions/lisp.lisp: The gtirb-functions/gtirb-functions/lisp․lisp file

L
Lisp File, gtirb-functions.asd: The gtirb-functions․asd file
Lisp File, gtirb-functions/gtirb-functions/lisp.lisp: The gtirb-functions/gtirb-functions/lisp․lisp file

Jump to:   F   G   L  

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

A.2 Functions

Jump to:   (  
E   F   G   H   M   R   T  
Index Entry  Section

(
(setf entries): Exported generic functions
(setf entries): Exported generic functions

E
entries: Exported generic functions
entries: Exported generic functions
exits: Exported generic functions
exits: Exported generic functions

F
Function, functions-are-returned: Internal functions
Function, hello: Internal functions
Function, test: Internal functions
functions: Exported generic functions
functions: Exported generic functions
functions: Exported generic functions
functions-are-returned: Internal functions

G
Generic Function, (setf entries): Exported generic functions
Generic Function, entries: Exported generic functions
Generic Function, exits: Exported generic functions
Generic Function, functions: Exported generic functions
Generic Function, returns: Exported generic functions

H
hello: Internal functions

M
Method, (setf entries): Exported generic functions
Method, entries: Exported generic functions
Method, exits: Exported generic functions
Method, functions: Exported generic functions
Method, functions: Exported generic functions
Method, returns: Exported generic functions

R
returns: Exported generic functions
returns: Exported generic functions

T
test: Internal functions

Jump to:   (  
E   F   G   H   M   R   T  

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

A.3 Variables

Jump to:   *  
B   E   M   N   S  
Index Entry  Section

*
*base-dir*: Internal special variables
*hello*: Internal special variables

B
blocks: Exported classes

E
entries: Exported classes

M
module: Exported classes

N
name: Exported classes

S
Slot, blocks: Exported classes
Slot, entries: Exported classes
Slot, module: Exported classes
Slot, name: Exported classes
Special Variable, *base-dir*: Internal special variables
Special Variable, *hello*: Internal special variables

Jump to:   *  
B   E   M   N   S  

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

A.4 Data types

Jump to:   C   F   G   P   S  
Index Entry  Section

C
Class, func: Exported classes

F
func: Exported classes

G
gtirb-functions: The gtirb-functions system
gtirb-functions/gtirb-functions: The gtirb-functions/gtirb-functions system
gtirb-functions/gtirb-functions: The gtirb-functions/gtirb-functions package

P
Package, gtirb-functions/gtirb-functions: The gtirb-functions/gtirb-functions package

S
System, gtirb-functions: The gtirb-functions system
System, gtirb-functions/gtirb-functions: The gtirb-functions/gtirb-functions system

Jump to:   C   F   G   P   S