The cl-protobufs.asdf Reference Manual

This is the cl-protobufs.asdf Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:35:29 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-protobufs.asdf

ASDF component classes for cl-protobufs.

Author

Robert Brown <>

License

MIT

Source

cl-protobufs.asdf.asd.

Child Component

asdf.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 cl-protobufs.asdf/cl-protobufs.asdf.asd

Source

cl-protobufs.asdf.asd.

Parent Component

cl-protobufs.asdf (system).

ASDF Systems

cl-protobufs.asdf.


3.1.2 cl-protobufs.asdf/asdf.lisp

Source

cl-protobufs.asdf.asd.

Parent Component

cl-protobufs.asdf (system).

Packages
Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 protobuf-config

Configuration information for PROTOBUF.

Source

asdf.lisp.

Use List

common-lisp.

Used By List

protobuf-system.

Public Interface

*protoc-relative-path* (special variable).


4.2 protobuf-system

System definitions for protocol buffer code.

Source

asdf.lisp.

Use List
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *protoc-relative-path*

Supply relative proto file paths to protoc, the protobuf compiler?

Package

protobuf-config.

Source

asdf.lisp.


5.1.2 Generic functions

Generic Reader: proto-pathname (object)
Package

protobuf-system.

Methods
Reader Method: proto-pathname ((protobuf-source-file protobuf-source-file))

Relative pathname that specifies the location of a .proto file.

Source

asdf.lisp.

Target Slot

relative-proto-pathname.

Generic Reader: search-path (object)
Package

protobuf-system.

Methods
Reader Method: search-path ((protobuf-source-file protobuf-source-file))

List containing directories where the protocol buffer compiler should search for imported protobuf files. Non-absolute pathnames are treated as relative to the directory containing the DEFSYSTEM form in which they appear.

Source

asdf.lisp.

Target Slot

search-path.


5.1.3 Standalone methods

Method: component-depends-on ((operation load-op) (proto-def-file protobuf-source-file))

Specifies the dependencies of a load OPERATION on PROTO-DEF-FILE.
Loading a protocol buffer file depends on generating Lisp source code for the protobuf, but also on loading package definitions and in-line function definitions that the machine-generated protobuf Lisp code uses.

Package

asdf/action.

Source

asdf.lisp.

Method: component-depends-on ((operation compile-op) (proto-def-file protobuf-source-file))

Specifies the dependencies of a compile OPERATION on PROTO-DEF-FILE. Compiling a protocol buffer file depends on generating Lisp source code for the protobuf, but also on loading package definitions and in-line function definitions that the machine-generated protobuf Lisp code uses.

Package

asdf/action.

Source

asdf.lisp.

Method: input-files ((operation compile-op) (c protobuf-source-file))
Package

asdf/action.

Source

asdf.lisp.

Method: input-files ((operation proto-to-lisp) (component protobuf-source-file))
Package

asdf/action.

Source

asdf.lisp.

Method: output-files ((operation proto-to-lisp) (component protobuf-source-file))

Arranges for the Lisp output file of a proto-to-lisp OPERATION on a PROTOBUF-SOURCE-FILE COMPONENT to be stored where fasl files are located.

Package

asdf/action.

Source

asdf.lisp.

Method: perform ((operation proto-to-lisp) (component protobuf-source-file))
Package

asdf/action.

Source

asdf.lisp.

Method: perform :before ((operation proto-to-lisp) (component protobuf-source-file))
Package

asdf/action.

Source

asdf.lisp.


5.1.4 Classes

Class: protobuf-source-file

A protocol buffer definition file.

Package

protobuf-system.

Source

asdf.lisp.

Direct superclasses

cl-source-file.

Direct methods
Direct slots
Slot: relative-proto-pathname

Relative pathname that specifies the location of a .proto file.

Initargs

:proto-pathname

Readers

proto-pathname.

Writers

This slot is read-only.

Slot: search-path

List containing directories where the protocol buffer compiler should search for imported protobuf files. Non-absolute pathnames are treated as relative to the directory containing the DEFSYSTEM form in which they appear.

Initargs

:proto-search-path

Readers

search-path.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Ordinary functions

Function: proto-input (protobuf-source-file)

Returns the pathname of PROTOBUF-SOURCE-FILE which must be translated into Lisp source code for this PROTO-FILE component.

Package

protobuf-system.

Source

asdf.lisp.

Function: resolve-relative-pathname (path parent-path)

When PATH doesn’t have an absolute directory component, treat it as relative to PARENT-PATH.

Package

protobuf-system.

Source

asdf.lisp.

Function: resolve-search-path (protobuf-source-file)

Resolves the search path of PROTOBUF-SOURCE-FILE.

Package

protobuf-system.

Source

asdf.lisp.


5.2.2 Standalone methods

Method: component-self-dependencies :around ((op load-op) (c protobuf-source-file))

Removes PROTO-TO-LISP operations from self dependencies. Otherwise, the Lisp output files of PROTO-TO-LISP are considered to be input files for LOAD-OP, which means ASDF loads both the .lisp file and the .fasl file.

Package

asdf/interface.

Source

asdf.lisp.


5.2.3 Conditions

Condition: protobuf-compile-failed

Condition signalled when translating a .proto file into Lisp code fails.

Package

protobuf-system.

Source

asdf.lisp.

Direct superclasses

compile-failed-error.


5.2.4 Classes

Class: proto-to-lisp

An ASDF operation that compiles a .proto file containing protocol buffer definitions into a Lisp source file.

Package

protobuf-system.

Source

asdf.lisp.

Direct superclasses
  • downward-operation.
  • selfward-operation.
Direct methods
Direct slots
Slot: selfward-operation
Package

asdf/action.

Allocation

:class

Initform

(quote asdf/lisp-action:prepare-op)


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   C   F   G   I   M   O   P   R   S  
Index Entry  Section

C
component-depends-on: Public standalone methods
component-depends-on: Public standalone methods
component-self-dependencies: Private standalone methods

F
Function, proto-input: Private ordinary functions
Function, resolve-relative-pathname: Private ordinary functions
Function, resolve-search-path: Private ordinary functions

G
Generic Function, proto-pathname: Public generic functions
Generic Function, search-path: Public generic functions

I
input-files: Public standalone methods
input-files: Public standalone methods

M
Method, component-depends-on: Public standalone methods
Method, component-depends-on: Public standalone methods
Method, component-self-dependencies: Private standalone methods
Method, input-files: Public standalone methods
Method, input-files: Public standalone methods
Method, output-files: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, proto-pathname: Public generic functions
Method, search-path: Public generic functions

O
output-files: Public standalone methods

P
perform: Public standalone methods
perform: Public standalone methods
proto-input: Private ordinary functions
proto-pathname: Public generic functions
proto-pathname: Public generic functions

R
resolve-relative-pathname: Private ordinary functions
resolve-search-path: Private ordinary functions

S
search-path: Public generic functions
search-path: Public generic functions