The osmpbf Reference Manual

This is the osmpbf Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 05:48:00 2022 GMT+0.

1 Introduction
2 Systems
- 2.1 osmpbf
3 Files
- 3.1 Lisp
4 Packages
- 4.1 osmpbf
- 4.2 osmpbf/protobuf-inner
5 Definitions
- 5.1 Public Interface
- 5.2 Internals
Appendix A Indexes

1 Introduction

`osmpbf`, the Lisp OSM PBF format reader

What is this?

This library lets you read OpenStreetMap map data encoded in PBF format in the Common Lisp programming language, for whatever mapping-related needs you might have.

Implementation status

Basic support for reading nodes, ways, and relations is currently there (and it might even be somewhat performant; who knows!). Node metadata information is, however, not decoded yet.

How to use

Installation instructions

Download the library, and put it somewhere ASDF can find it. (For example, git clone-ing the repo into ~/common-lisp/ should do the trick.)
Install the dependencies com.google.base, protobuf, chipz, nibbles and flexi-streams. (If Quicklisp is installed, running (ql:quickload :osmpbf) should do this, and load the library as well!)
If you didn't do it with Quicklisp above, run (asdf:load-system :osmpbf) and watch the compiler output scroll by.
???
Profit!

Basic usage

Basically, you open your PBF file, specifying something like :direction :input :element-type (unsigned-byte 8), and pass the resulting stream to get-next-primitive-groups, repeating until you hit the end of the file.

CL-USER> (with-open-file (file "sample.pbf"
                               :direction :input
                               :element-type '(unsigned-byte 8))
           (osmpbf:get-next-primitive-groups file))
(#<OSMPBF:PRIMITIVE-GROUP nodes: (#<NODE #653970877 (51.7636027d0, -0.22875700000000002d0) tags: NIL>
                                  #<NODE #647105170 (51.76359050000001d0, -0.23446450000000002d0) tags: NIL>
                                  #<NODE #672663476 (51.7657492d0, -0.2290703d0) tags: NIL>
                                  #<NODE #241806356 (51.7689451d0, -0.23266170000000003d0) tags: NIL>
                                  ... snip ...)

The :element-type bit is important; if you leave it out, it'll yell at you. To figure out how to actually get useful things from the data returned, have a look at the goodies in the osmtypes.lisp file, and their associated documentation.

On that note...

Documentation

Is currently in the form of docstrings. Use the Source, Luke!

License

MIT

2 Systems

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

osmpbf

2.1 `osmpbf`

Library to read OpenStreetMap PBF-encoded files.

Author

eta

License

MIT

Version

0.0.1

Dependencies

com.google.base (system).
protobuf (system).
chipz (system).
flexi-streams (system).
nibbles (system).

Source

osmpbf.asd.

Child Components

packages.lisp (file).
fileformat.lisp (file).
osmformat.lisp (file).
osmtypes.lisp (file).
tag-translation.lisp (file).
osmpbf.lisp (file).

3 Files

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

Lisp

3.1.1 `osmpbf/osmpbf.asd`

Source: osmpbf.asd.
Parent Component: osmpbf (system).
ASDF Systems: osmpbf.

3.1.2 `osmpbf/packages.lisp`

Source

osmpbf.asd.

Parent Component

osmpbf (system).

Packages

osmpbf.
osmpbf/protobuf-inner.

3.1.3 `osmpbf/fileformat.lisp`

Dependency

packages.lisp (file).

Source

osmpbf.asd.

Parent Component

osmpbf (system).

Public Interface

blob (class).
blob-header (class).
clear (method).
clear (method).
clear-datasize (generic function).
clear-indexdata (generic function).
clear-lzma-data (generic function).
clear-obsolete-bzip2-data (generic function).
clear-raw (generic function).
clear-raw-size (generic function).
clear-type (generic function).
clear-zlib-data (generic function).
datasize (reader method).
(setf datasize) (writer method).
(setf datasize) (method).
has-datasize (generic function).
has-indexdata (generic function).
has-lzma-data (generic function).
has-obsolete-bzip2-data (generic function).
has-raw (generic function).
has-raw-size (generic function).
has-type (generic function).
has-zlib-data (generic function).
indexdata (reader method).
(setf indexdata) (writer method).
(setf indexdata) (method).
is-initialized (method).
is-initialized (method).
lzma-data (reader method).
(setf lzma-data) (writer method).
(setf lzma-data) (method).
merge-from-array (method).
merge-from-array (method).
merge-from-message (method).
merge-from-message (method).
obsolete-bzip2-data (reader method).
(setf obsolete-bzip2-data) (writer method).
(setf obsolete-bzip2-data) (method).
octet-size (method).
octet-size (method).
print-object (method).
print-object (method).
raw (reader method).
(setf raw) (writer method).
(setf raw) (method).
raw-size (reader method).
(setf raw-size) (writer method).
(setf raw-size) (method).
serialize (method).
serialize (method).
type (reader method).
(setf type) (writer method).
(setf type) (method).
zlib-data (reader method).
(setf zlib-data) (writer method).
(setf zlib-data) (method).

Internals

%has-bits% (reader method).
%has-bits% (reader method).
(setf %has-bits%) (writer method).
(setf %has-bits%) (writer method).

3.1.4 `osmpbf/osmformat.lisp`

Dependency

fileformat.lisp (file).

Source

osmpbf.asd.

Parent Component

osmpbf (system).

Public Interface

+maximum-relation-member-type+ (constant).
+minimum-relation-member-type+ (constant).
+relation-member-type-node+ (constant).
+relation-member-type-relation+ (constant).
+relation-member-type-way+ (constant).
bbox (generic function).
(setf bbox) (writer method).
(setf bbox) (method).
bottom (reader method).
(setf bottom) (writer method).
(setf bottom) (method).
change-set (class).
changeset (reader method).
changeset (reader method).
(setf changeset) (writer method).
(setf changeset) (writer method).
(setf changeset) (method).
changesets (reader method).
(setf changesets) (writer method).
clear (method).
clear (method).
clear (method).
clear (method).
clear (method).
clear (method).
clear (method).
clear (method).
clear (method).
clear (method).
clear (method).
clear (method).
clear-bbox (generic function).
clear-bottom (generic function).
clear-changeset (generic function).
clear-changesets (generic function).
clear-date-granularity (generic function).
clear-dense (generic function).
clear-denseinfo (generic function).
clear-granularity (generic function).
clear-id (generic function).
clear-info (generic function).
clear-keys (generic function).
clear-keys-vals (generic function).
clear-lat (generic function).
clear-lat-offset (generic function).
clear-left (generic function).
clear-lon (generic function).
clear-lon-offset (generic function).
clear-memids (generic function).
clear-nodes (generic function).
clear-optional-features (generic function).
clear-osmosis-replication-base-url (generic function).
clear-osmosis-replication-sequence-number (generic function).
clear-osmosis-replication-timestamp (generic function).
clear-primitivegroup (generic function).
clear-refs (generic function).
clear-relations (generic function).
clear-required-features (generic function).
clear-right (generic function).
clear-roles-sid (generic function).
clear-s (generic function).
clear-source (generic function).
clear-stringtable (generic function).
clear-timestamp (generic function).
clear-top (generic function).
clear-types (generic function).
clear-uid (generic function).
clear-user-sid (generic function).
clear-vals (generic function).
clear-version (generic function).
clear-visible (generic function).
clear-ways (generic function).
clear-writingprogram (generic function).
date-granularity (reader method).
(setf date-granularity) (writer method).
(setf date-granularity) (method).
dense (generic function).
(setf dense) (writer method).
(setf dense) (method).
dense-info (class).
dense-nodes (class).
denseinfo (generic function).
(setf denseinfo) (writer method).
(setf denseinfo) (method).
granularity (reader method).
(setf granularity) (writer method).
(setf granularity) (method).
has-bbox (generic function).
has-bottom (generic function).
has-changeset (generic function).
has-date-granularity (generic function).
has-dense (generic function).
has-denseinfo (generic function).
has-granularity (generic function).
has-id (generic function).
has-info (generic function).
has-lat (generic function).
has-lat-offset (generic function).
has-left (generic function).
has-lon (generic function).
has-lon-offset (generic function).
has-osmosis-replication-base-url (generic function).
has-osmosis-replication-sequence-number (generic function).
has-osmosis-replication-timestamp (generic function).
has-right (generic function).
has-source (generic function).
has-stringtable (generic function).
has-timestamp (generic function).
has-top (generic function).
has-uid (generic function).
has-user-sid (generic function).
has-version (generic function).
has-visible (generic function).
has-writingprogram (generic function).
header-b-box (class).
header-block (class).
id (reader method).
id (reader method).
id (reader method).
id (reader method).
id (reader method).
(setf id) (writer method).
(setf id) (method).
(setf id) (writer method).
(setf id) (method).
(setf id) (writer method).
(setf id) (writer method).
(setf id) (method).
(setf id) (writer method).
(setf id) (method).
info (generic function).
(setf info) (writer method).
(setf info) (method).
(setf info) (writer method).
(setf info) (method).
(setf info) (writer method).
(setf info) (method).
info (class).
is-initialized (method).
is-initialized (method).
is-initialized (method).
is-initialized (method).
is-initialized (method).
is-initialized (method).
is-initialized (method).
is-initialized (method).
is-initialized (method).
is-initialized (method).
is-initialized (method).
is-initialized (method).
keys (reader method).
keys (reader method).
keys (reader method).
(setf keys) (writer method).
(setf keys) (writer method).
(setf keys) (writer method).
keys-vals (reader method).
(setf keys-vals) (writer method).
lat (reader method).
lat (reader method).
(setf lat) (writer method).
(setf lat) (writer method).
(setf lat) (method).
lat-offset (reader method).
(setf lat-offset) (writer method).
(setf lat-offset) (method).
left (reader method).
(setf left) (writer method).
(setf left) (method).
lon (reader method).
lon (reader method).
(setf lon) (writer method).
(setf lon) (writer method).
(setf lon) (method).
lon-offset (reader method).
(setf lon-offset) (writer method).
(setf lon-offset) (method).
memids (reader method).
(setf memids) (writer method).
merge-from-array (method).
merge-from-array (method).
merge-from-array (method).
merge-from-array (method).
merge-from-array (method).
merge-from-array (method).
merge-from-array (method).
merge-from-array (method).
merge-from-array (method).
merge-from-array (method).
merge-from-array (method).
merge-from-array (method).
merge-from-message (method).
merge-from-message (method).
merge-from-message (method).
merge-from-message (method).
merge-from-message (method).
merge-from-message (method).
merge-from-message (method).
merge-from-message (method).
merge-from-message (method).
merge-from-message (method).
merge-from-message (method).
merge-from-message (method).
node (class).
nodes (reader method).
(setf nodes) (writer method).
octet-size (method).
octet-size (method).
octet-size (method).
octet-size (method).
octet-size (method).
octet-size (method).
octet-size (method).
octet-size (method).
octet-size (method).
octet-size (method).
octet-size (method).
octet-size (method).
optional-features (reader method).
(setf optional-features) (writer method).
osmosis-replication-base-url (reader method).
(setf osmosis-replication-base-url) (writer method).
(setf osmosis-replication-base-url) (method).
osmosis-replication-sequence-number (reader method).
(setf osmosis-replication-sequence-number) (writer method).
(setf osmosis-replication-sequence-number) (method).
osmosis-replication-timestamp (reader method).
(setf osmosis-replication-timestamp) (writer method).
(setf osmosis-replication-timestamp) (method).
primitive-block (class).
primitive-group (class).
primitivegroup (reader method).
(setf primitivegroup) (writer method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
refs (reader method).
(setf refs) (writer method).
relation (class).
relation-member-type (type).
relations (reader method).
(setf relations) (writer method).
required-features (reader method).
(setf required-features) (writer method).
right (reader method).
(setf right) (writer method).
(setf right) (method).
roles-sid (reader method).
(setf roles-sid) (writer method).
s (reader method).
(setf s) (writer method).
serialize (method).
serialize (method).
serialize (method).
serialize (method).
serialize (method).
serialize (method).
serialize (method).
serialize (method).
serialize (method).
serialize (method).
serialize (method).
serialize (method).
source (reader method).
(setf source) (writer method).
(setf source) (method).
string-table (class).
stringtable (generic function).
(setf stringtable) (writer method).
(setf stringtable) (method).
timestamp (reader method).
timestamp (reader method).
(setf timestamp) (writer method).
(setf timestamp) (writer method).
(setf timestamp) (method).
top (reader method).
(setf top) (writer method).
(setf top) (method).
types (reader method).
(setf types) (writer method).
uid (reader method).
uid (reader method).
(setf uid) (writer method).
(setf uid) (writer method).
(setf uid) (method).
user-sid (reader method).
user-sid (reader method).
(setf user-sid) (writer method).
(setf user-sid) (writer method).
(setf user-sid) (method).
vals (reader method).
vals (reader method).
vals (reader method).
(setf vals) (writer method).
(setf vals) (writer method).
(setf vals) (writer method).
version (reader method).
version (reader method).
(setf version) (writer method).
(setf version) (writer method).
(setf version) (method).
visible (reader method).
visible (reader method).
(setf visible) (writer method).
(setf visible) (writer method).
(setf visible) (method).
way (class).
ways (reader method).
(setf ways) (writer method).
writingprogram (reader method).
(setf writingprogram) (writer method).
(setf writingprogram) (method).

Internals

(setf %changeset-cached-size%) (writer method).
%changeset-cached-size% (reader method).
%has-bits% (reader method).
%has-bits% (reader method).
%has-bits% (reader method).
%has-bits% (reader method).
%has-bits% (reader method).
%has-bits% (reader method).
%has-bits% (reader method).
%has-bits% (reader method).
%has-bits% (reader method).
%has-bits% (reader method).
%has-bits% (reader method).
%has-bits% (reader method).
(setf %has-bits%) (writer method).
(setf %has-bits%) (writer method).
(setf %has-bits%) (writer method).
(setf %has-bits%) (writer method).
(setf %has-bits%) (writer method).
(setf %has-bits%) (writer method).
(setf %has-bits%) (writer method).
(setf %has-bits%) (writer method).
(setf %has-bits%) (writer method).
(setf %has-bits%) (writer method).
(setf %has-bits%) (writer method).
(setf %has-bits%) (writer method).
(setf %id-cached-size%) (writer method).
%id-cached-size% (reader method).
(setf %keys-cached-size%) (writer method).
%keys-cached-size% (reader method).
(setf %keys-cached-size%) (writer method).
%keys-cached-size% (reader method).
(setf %keys-cached-size%) (writer method).
%keys-cached-size% (reader method).
(setf %keys-vals-cached-size%) (writer method).
%keys-vals-cached-size% (reader method).
(setf %lat-cached-size%) (writer method).
%lat-cached-size% (reader method).
(setf %lon-cached-size%) (writer method).
%lon-cached-size% (reader method).
(setf %memids-cached-size%) (writer method).
%memids-cached-size% (reader method).
(setf %refs-cached-size%) (writer method).
%refs-cached-size% (reader method).
(setf %roles-sid-cached-size%) (writer method).
%roles-sid-cached-size% (reader method).
(setf %timestamp-cached-size%) (writer method).
%timestamp-cached-size% (reader method).
(setf %types-cached-size%) (writer method).
%types-cached-size% (reader method).
(setf %uid-cached-size%) (writer method).
%uid-cached-size% (reader method).
(setf %user-sid-cached-size%) (writer method).
%user-sid-cached-size% (reader method).
(setf %vals-cached-size%) (writer method).
%vals-cached-size% (reader method).
(setf %vals-cached-size%) (writer method).
%vals-cached-size% (reader method).
(setf %vals-cached-size%) (writer method).
%vals-cached-size% (reader method).
(setf %version-cached-size%) (writer method).
%version-cached-size% (reader method).
(setf %visible-cached-size%) (writer method).
%visible-cached-size% (reader method).

3.1.5 `osmpbf/osmtypes.lisp`

Dependency

osmformat.lisp (file).

Source

osmpbf.asd.

Parent Component

osmpbf (system).

Public Interface

group-nodes (reader method).
(setf group-nodes) (writer method).
group-relations (reader method).
(setf group-relations) (writer method).
group-ways (reader method).
(setf group-ways) (writer method).
node (class).
node-lat (reader method).
(setf node-lat) (writer method).
node-lon (reader method).
(setf node-lon) (writer method).
osm-obj-id (reader method).
osm-obj-id (reader method).
osm-obj-id (reader method).
(setf osm-obj-id) (writer method).
(setf osm-obj-id) (writer method).
(setf osm-obj-id) (writer method).
osm-obj-tags (reader method).
osm-obj-tags (reader method).
osm-obj-tags (reader method).
(setf osm-obj-tags) (writer method).
(setf osm-obj-tags) (writer method).
(setf osm-obj-tags) (writer method).
primitive-group (class).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
relation (class).
relation-members (reader method).
(setf relation-members) (writer method).
way (class).
way-refs (reader method).
(setf way-refs) (writer method).

3.1.6 `osmpbf/tag-translation.lisp`

Dependency

osmtypes.lisp (file).

Source

osmpbf.asd.

Parent Component

osmpbf (system).

Public Interface

*osm-symbols-package* (special variable).
*perform-tag-name-translation* (special variable).
*tag-value-translation-names* (special variable).
tag-name-to-symbol (function).

Internals

make-tag-cons (function).

3.1.7 `osmpbf/osmpbf.lisp`

Dependency

tag-translation.lisp (file).

Source

osmpbf.asd.

Parent Component

osmpbf (system).

Public Interface

*current-granularity* (special variable).
*current-lat-offset* (special variable).
*current-lon-offset* (special variable).
*current-string-table* (special variable).
get-next-primitive-groups (function).
invalid-osm-fileblock (condition).
parse-primitive-block (function).
read-fileblock (function).

Internals

delta-decode (function).
invalid-osm-fileblock-name (reader method).
(setf invalid-osm-fileblock-name) (writer method).
keys-vals-to-alist (function).
make-node (function).
octet (type).
packed-keys-vals-to-alists (function).
parse-dense-nodes (function).
parse-node (function).
parse-pb-object (function).
parse-relation (function).
parse-relation-member-type (function).
parse-relation-members (function).
parse-string-table (function).
parse-way (function).
read-blob-and-return-data (function).
read-blob-header (function).
read-buffer-of-length (function).
read-header-length (function).
read-pb-object (function).
transform-coordinate (function).

4 Packages

Packages are listed by definition order.

osmpbf
osmpbf/protobuf-inner

4.1 `osmpbf`

Source

packages.lisp.

Use List

common-lisp.

Public Interface

*current-granularity* (special variable).
*current-lat-offset* (special variable).
*current-lon-offset* (special variable).
*current-string-table* (special variable).
*osm-symbols-package* (special variable).
*perform-tag-name-translation* (special variable).
*tag-value-translation-names* (special variable).
get-next-primitive-groups (function).
group-nodes (generic reader).
(setf group-nodes) (generic writer).
group-relations (generic reader).
(setf group-relations) (generic writer).
group-ways (generic reader).
(setf group-ways) (generic writer).
invalid-osm-fileblock (condition).
node (class).
node-lat (generic reader).
(setf node-lat) (generic writer).
node-lon (generic reader).
(setf node-lon) (generic writer).
osm-obj-id (generic reader).
(setf osm-obj-id) (generic writer).
osm-obj-tags (generic reader).
(setf osm-obj-tags) (generic writer).
parse-primitive-block (function).
primitive-group (class).
read-fileblock (function).
relation (class).
relation-members (generic reader).
(setf relation-members) (generic writer).
tag-name-to-symbol (function).
way (class).
way-refs (generic reader).
(setf way-refs) (generic writer).

Internals

delta-decode (function).
invalid-osm-fileblock-name (generic reader).
(setf invalid-osm-fileblock-name) (generic writer).
keys-vals-to-alist (function).
make-node (function).
make-tag-cons (function).
octet (type).
packed-keys-vals-to-alists (function).
parse-dense-nodes (function).
parse-node (function).
parse-pb-object (function).
parse-relation (function).
parse-relation-member-type (function).
parse-relation-members (function).
parse-string-table (function).
parse-way (function).
read-blob-and-return-data (function).
read-blob-header (function).
read-buffer-of-length (function).
read-header-length (function).
read-pb-object (function).
transform-coordinate (function).

4.2 `osmpbf/protobuf-inner`

Source

packages.lisp.

Nickname

opb

Public Interface

+maximum-relation-member-type+ (constant).
+minimum-relation-member-type+ (constant).
+relation-member-type-node+ (constant).
+relation-member-type-relation+ (constant).
+relation-member-type-way+ (constant).
bbox (generic function).
(setf bbox) (generic function).
blob (class).
blob-header (class).
bottom (generic reader).
(setf bottom) (generic function).
change-set (class).
changeset (generic reader).
(setf changeset) (generic function).
changesets (generic reader).
(setf changesets) (generic writer).
clear-bbox (generic function).
clear-bottom (generic function).
clear-changeset (generic function).
clear-changesets (generic function).
clear-datasize (generic function).
clear-date-granularity (generic function).
clear-dense (generic function).
clear-denseinfo (generic function).
clear-granularity (generic function).
clear-id (generic function).
clear-indexdata (generic function).
clear-info (generic function).
clear-keys (generic function).
clear-keys-vals (generic function).
clear-lat (generic function).
clear-lat-offset (generic function).
clear-left (generic function).
clear-lon (generic function).
clear-lon-offset (generic function).
clear-lzma-data (generic function).
clear-memids (generic function).
clear-nodes (generic function).
clear-obsolete-bzip2-data (generic function).
clear-optional-features (generic function).
clear-osmosis-replication-base-url (generic function).
clear-osmosis-replication-sequence-number (generic function).
clear-osmosis-replication-timestamp (generic function).
clear-primitivegroup (generic function).
clear-raw (generic function).
clear-raw-size (generic function).
clear-refs (generic function).
clear-relations (generic function).
clear-required-features (generic function).
clear-right (generic function).
clear-roles-sid (generic function).
clear-s (generic function).
clear-source (generic function).
clear-stringtable (generic function).
clear-timestamp (generic function).
clear-top (generic function).
clear-type (generic function).
clear-types (generic function).
clear-uid (generic function).
clear-user-sid (generic function).
clear-vals (generic function).
clear-version (generic function).
clear-visible (generic function).
clear-ways (generic function).
clear-writingprogram (generic function).
clear-zlib-data (generic function).
datasize (generic reader).
(setf datasize) (generic function).
date-granularity (generic reader).
(setf date-granularity) (generic function).
dense (generic function).
(setf dense) (generic function).
dense-info (class).
dense-nodes (class).
denseinfo (generic function).
(setf denseinfo) (generic function).
granularity (generic reader).
(setf granularity) (generic function).
has-bbox (generic function).
has-bottom (generic function).
has-changeset (generic function).
has-datasize (generic function).
has-date-granularity (generic function).
has-dense (generic function).
has-denseinfo (generic function).
has-granularity (generic function).
has-id (generic function).
has-indexdata (generic function).
has-info (generic function).
has-lat (generic function).
has-lat-offset (generic function).
has-left (generic function).
has-lon (generic function).
has-lon-offset (generic function).
has-lzma-data (generic function).
has-obsolete-bzip2-data (generic function).
has-osmosis-replication-base-url (generic function).
has-osmosis-replication-sequence-number (generic function).
has-osmosis-replication-timestamp (generic function).
has-raw (generic function).
has-raw-size (generic function).
has-right (generic function).
has-source (generic function).
has-stringtable (generic function).
has-timestamp (generic function).
has-top (generic function).
has-type (generic function).
has-uid (generic function).
has-user-sid (generic function).
has-version (generic function).
has-visible (generic function).
has-writingprogram (generic function).
has-zlib-data (generic function).
header-b-box (class).
header-block (class).
id (generic reader).
(setf id) (generic function).
indexdata (generic reader).
(setf indexdata) (generic function).
info (generic function).
(setf info) (generic function).
info (class).
keys (generic reader).
(setf keys) (generic writer).
keys-vals (generic reader).
(setf keys-vals) (generic writer).
lat (generic reader).
(setf lat) (generic function).
lat-offset (generic reader).
(setf lat-offset) (generic function).
left (generic reader).
(setf left) (generic function).
lon (generic reader).
(setf lon) (generic function).
lon-offset (generic reader).
(setf lon-offset) (generic function).
lzma-data (generic reader).
(setf lzma-data) (generic function).
memids (generic reader).
(setf memids) (generic writer).
node (class).
nodes (generic reader).
(setf nodes) (generic writer).
obsolete-bzip2-data (generic reader).
(setf obsolete-bzip2-data) (generic function).
optional-features (generic reader).
(setf optional-features) (generic writer).
osmosis-replication-base-url (generic reader).
(setf osmosis-replication-base-url) (generic function).
osmosis-replication-sequence-number (generic reader).
(setf osmosis-replication-sequence-number) (generic function).
osmosis-replication-timestamp (generic reader).
(setf osmosis-replication-timestamp) (generic function).
primitive-block (class).
primitive-group (class).
primitivegroup (generic reader).
(setf primitivegroup) (generic writer).
raw (generic reader).
(setf raw) (generic function).
raw-size (generic reader).
(setf raw-size) (generic function).
refs (generic reader).
(setf refs) (generic writer).
relation (class).
relation-member-type (type).
relations (generic reader).
(setf relations) (generic writer).
required-features (generic reader).
(setf required-features) (generic writer).
right (generic reader).
(setf right) (generic function).
roles-sid (generic reader).
(setf roles-sid) (generic writer).
s (generic reader).
(setf s) (generic writer).
source (generic reader).
(setf source) (generic function).
string-table (class).
stringtable (generic function).
(setf stringtable) (generic function).
timestamp (generic reader).
(setf timestamp) (generic function).
top (generic reader).
(setf top) (generic function).
type (generic reader).
(setf type) (generic function).
types (generic reader).
(setf types) (generic writer).
uid (generic reader).
(setf uid) (generic function).
user-sid (generic reader).
(setf user-sid) (generic function).
vals (generic reader).
(setf vals) (generic writer).
version (generic reader).
(setf version) (generic function).
visible (generic reader).
(setf visible) (generic function).
way (class).
ways (generic reader).
(setf ways) (generic writer).
writingprogram (generic reader).
(setf writingprogram) (generic function).
zlib-data (generic reader).
(setf zlib-data) (generic function).

Internals

%has-bits% (generic reader).
(setf %has-bits%) (generic writer).

5 Definitions

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

Public Interface
Internals

5.1 Public Interface

Constants
Special variables
Ordinary functions
Generic functions
Standalone methods
Conditions
Classes
Types

5.1.1 Constants

Constant: +maximum-relation-member-type+ ¶

Package: osmpbf/protobuf-inner.
Source: osmformat.lisp.

Constant: +minimum-relation-member-type+ ¶

Package: osmpbf/protobuf-inner.
Source: osmformat.lisp.

Constant: +relation-member-type-node+ ¶

Package: osmpbf/protobuf-inner.
Source: osmformat.lisp.

Constant: +relation-member-type-relation+ ¶

Package: osmpbf/protobuf-inner.
Source: osmformat.lisp.

Constant: +relation-member-type-way+ ¶

Package: osmpbf/protobuf-inner.
Source: osmformat.lisp.

5.1.2 Special variables

Special Variable: *current-granularity* ¶

Package: osmpbf.
Source: osmpbf.lisp.

Special Variable: *current-lat-offset* ¶

Package: osmpbf.
Source: osmpbf.lisp.

Special Variable: *current-lon-offset* ¶

Package: osmpbf.
Source: osmpbf.lisp.

Special Variable: *current-string-table* ¶

Package: osmpbf.
Source: osmpbf.lisp.

Special Variable: *osm-symbols-package* ¶

The package where OSM tag names are interned. Defaults to ‘keyword’; use ‘nil‘ for the current package.

Package: osmpbf.
Source: tag-translation.lisp.

Special Variable: *perform-tag-name-translation* ¶

Whether or not to translate OSM tag names to symbols. Defaults to ‘t’.

Package: osmpbf.
Source: tag-translation.lisp.

Special Variable: *tag-value-translation-names* ¶

Tag names where the tag *values* should also be translated to symbols. Defaults to ‘nil’.

Package: osmpbf.
Source: tag-translation.lisp.

5.1.3 Ordinary functions

Function: get-next-primitive-groups (stream &key eof-error-p) ¶

Get the next batch of PRIMITIVE-GROUP objects from the PBF octet stream STREAM. STREAM must have element type (UNSIGNED-BYTE 8), otherwise an error will be signalled.

If EOF-ERROR-P is false, returns NIL if an end-of-file condition is reached.

Package: osmpbf.
Source: osmpbf.lisp.

Function: parse-primitive-block (primblock) ¶

Package: osmpbf.
Source: osmpbf.lisp.

Function: read-fileblock (stream) ¶

Reads an OSM fileblock, of any type, from STREAM, and returns it. May signal an END-OF-FILE condition.

Package: osmpbf.
Source: osmpbf.lisp.

Function: tag-name-to-symbol (tag-name) ¶

Translates an OSM tag name to a Lisp symbol, interning it in *OSM-SYMBOLS-PACKAGE*.

Package: osmpbf.
Source: tag-translation.lisp.

5.1.4 Generic functions

Generic Function: bbox (proto) ¶

Package

	Index Entry	Section

%
	`%cached-size%`:	Public classes
	`%cached-size%`:	Public classes
	`%cached-size%`:	Public classes
	`%cached-size%`:	Public classes
	`%cached-size%`:	Public classes
	`%cached-size%`:	Public classes
	`%cached-size%`:	Public classes
	`%cached-size%`:	Public classes
	`%cached-size%`:	Public classes
	`%cached-size%`:	Public classes
	`%cached-size%`:	Public classes
	`%cached-size%`:	Public classes
	`%cached-size%`:	Public classes
	`%cached-size%`:	Public classes
	`%changeset-cached-size%`:	Public classes
	`%has-bits%`:	Public classes
	`%has-bits%`:	Public classes
	`%has-bits%`:	Public classes
	`%has-bits%`:	Public classes
	`%has-bits%`:	Public classes
	`%has-bits%`:	Public classes
	`%has-bits%`:	Public classes
	`%has-bits%`

The osmpbf Reference Manual

The osmpbf Reference Manual

Table of Contents

1 Introduction

osmpbf, the Lisp OSM PBF format reader

What is this?

Implementation status

How to use

Installation instructions

Basic usage

Documentation

License

2 Systems

2.1 osmpbf

3 Files

3.1 Lisp

3.1.1 osmpbf/osmpbf.asd

3.1.2 osmpbf/packages.lisp

3.1.3 osmpbf/fileformat.lisp

3.1.4 osmpbf/osmformat.lisp

3.1.5 osmpbf/osmtypes.lisp

3.1.6 osmpbf/tag-translation.lisp

3.1.7 osmpbf/osmpbf.lisp

4 Packages

4.1 osmpbf

4.2 osmpbf/protobuf-inner

5 Definitions

5.1 Public Interface

5.1.1 Constants

5.1.2 Special variables

5.1.3 Ordinary functions

5.1.4 Generic functions

5.1.5 Standalone methods

5.1.6 Conditions

5.1.7 Classes

5.1.8 Types

5.2 Internals

5.2.1 Ordinary functions

5.2.2 Generic functions

5.2.3 Standalone methods

5.2.4 Types

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

`osmpbf`, the Lisp OSM PBF format reader

2.1 `osmpbf`

3.1.1 `osmpbf/osmpbf.asd`

3.1.2 `osmpbf/packages.lisp`

3.1.3 `osmpbf/fileformat.lisp`

3.1.4 `osmpbf/osmformat.lisp`

3.1.5 `osmpbf/osmtypes.lisp`

3.1.6 `osmpbf/tag-translation.lisp`

3.1.7 `osmpbf/osmpbf.lisp`

4.1 `osmpbf`

4.2 `osmpbf/protobuf-inner`