The cl-weather-jp Reference Manual

This is the cl-weather-jp Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:32:17 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-weather-jp

Get weather in Japan

Author

Eitaro Fukamachi

License

BSD 2-Clause

Long Description

# cl-weather-jp

[![Build Status](https://travis-ci.org/fukamachi/cl-weather-jp.svg?branch=master)](https://travis-ci.org/fukamachi/cl-weather-jp) [![Coverage Status](https://coveralls.io/repos/fukamachi/cl-weather-jp/badge.svg?branch=master)](https://coveralls.io/r/fukamachi/cl-weather-jp) [![Quicklisp dist](http://quickdocs.org/badge/cl-weather-jp.svg)](http://quickdocs.org/cl-weather-jp/)

cl-weather-jp allows you to retrieve the weather in Japan via [Livedoor Weather](http://weather.livedoor.com).

## Usage

“‘common-lisp
(use-package :cl-weather-jp)

(city-forecasts "東京")
;=> ((("image" ("height" . 31) ("title" . "晴時々曇")
; ("url" . "http://weather.livedoor.com/img/icon/2.gif") ("width" . 50))
; ("temperature" ("max" ("fahrenheit" . "60.8") ("celsius" . "16")) ("min"))
; ("date" . "2015-12-25") ("telop" . "晴時々曇") ("dateLabel" . "今日"))
; (("image" ("height" . 31) ("title" . "晴れ")
; ("url" . "http://weather.livedoor.com/img/icon/1.gif") ("width" . 50))
; ("temperature" ("max" ("fahrenheit" . "57.2") ("celsius" . "14"))
; ("min" ("fahrenheit" . "41.0") ("celsius" . "5")))
; ("date" . "2015-12-26") ("telop" . "晴れ") ("dateLabel" . "明日"))
; (("image" ("height" . 31) ("title" . "晴時々曇")
; ("url" . "http://weather.livedoor.com/img/icon/2.gif") ("width" . 50))
; ("temperature" ("max") ("min")) ("date" . "2015-12-27") ("telop" . "晴時々曇")
; ("dateLabel" . "明後日")))
“‘

## Installation

“‘
$ cd ~/common-lisp
$ git clone https://github.com/fukamachi/cl-weather-jp
“‘

“‘common-lisp
(ql:quickload :cl-weather-jp)
“‘

## Author

* Eitaro Fukamachi (e.arrows@gmail.com)

## Copyright

Copyright (c) 2015 Eitaro Fukamachi (e.arrows@gmail.com)

## License

Licensed under the BSD 2-Clause License.

Version

0.1

Dependencies
  • dexador (system).
  • plump (system).
  • clss (system).
  • jonathan (system).
  • function-cache (system).
Source

cl-weather-jp.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 cl-weather-jp/src

Source

cl-weather-jp.asd.

Parent Component

cl-weather-jp (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 cl-weather-jp/cl-weather-jp.asd

Source

cl-weather-jp.asd.

Parent Component

cl-weather-jp (system).

ASDF Systems

cl-weather-jp.

Packages

cl-weather-jp-asd.


4.1.2 cl-weather-jp/src/cl-weather-jp.lisp

Dependencies
Source

cl-weather-jp.asd.

Parent Component

src (module).

Packages

cl-weather-jp.

Public Interface

4.1.3 cl-weather-jp/src/location.lisp

Dependencies
Source

cl-weather-jp.asd.

Parent Component

src (module).

Packages

cl-weather-jp.location.

Public Interface
Internals

4.1.4 cl-weather-jp/src/http.lisp

Source

cl-weather-jp.asd.

Parent Component

src (module).

Packages

cl-weather-jp.http.

Public Interface

http-get (function).

Internals

*default-user-agent* (special variable).


4.1.5 cl-weather-jp/src/error.lisp

Source

cl-weather-jp.asd.

Parent Component

src (module).

Packages

cl-weather-jp.error.

Public Interface

unknown-location (condition).


4.1.6 cl-weather-jp/src/util.lisp

Source

cl-weather-jp.asd.

Parent Component

src (module).

Packages

cl-weather-jp.util.

Public Interface

5 Packages

Packages are listed by definition order.


5.1 cl-weather-jp.util

Source

util.lisp.

Use List

common-lisp.

Used By List
Public Interface

5.2 cl-weather-jp.error

Source

error.lisp.

Use List

common-lisp.

Used By List
Public Interface

unknown-location (condition).


5.3 cl-weather-jp.location

Source

location.lisp.

Use List
Used By List

cl-weather-jp.

Public Interface
Internals

5.4 cl-weather-jp

Source

cl-weather-jp.lisp.

Use List
Public Interface

5.5 cl-weather-jp-asd

Source

cl-weather-jp.asd.

Use List
  • asdf/interface.
  • common-lisp.

5.6 cl-weather-jp.http

Source

http.lisp.

Use List

common-lisp.

Used By List

cl-weather-jp.location.

Public Interface

http-get (function).

Internals

*default-user-agent* (special variable).


6 Definitions

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


6.1 Public Interface


6.1.1 Ordinary functions

Function: aget (alist key &key test)
Package

cl-weather-jp.util.

Source

util.lisp.

Function: (setf aget) (alist key &key test)
Package

cl-weather-jp.util.

Source

util.lisp.

Function: city-forecast-detail-url (city)
Package

cl-weather-jp.

Source

cl-weather-jp.lisp.

Function: city-forecasts (city)
Package

cl-weather-jp.

Source

cl-weather-jp.lisp.

Function: http-get (url)
Package

cl-weather-jp.http.

Source

http.lisp.

Function: retrieve-city-id (city)
Package

cl-weather-jp.location.

Source

location.lisp.

Function: retrieve-city-weather (city)
Package

cl-weather-jp.location.

Source

location.lisp.


6.1.2 Conditions

Condition: unknown-location
Package

cl-weather-jp.error.

Source

error.lisp.

Direct superclasses

error.

Direct slots
Slot: location
Initargs

:location


6.2 Internals


6.2.1 Special variables

Special Variable: *area-info-cache*
Package

cl-weather-jp.location.

Source

location.lisp.

Special Variable: *default-user-agent*
Package

cl-weather-jp.http.

Source

http.lisp.


6.2.2 Ordinary functions

Function: area-info ()
Package

cl-weather-jp.location.

Source

location.lisp.


Appendix A Indexes


A.1 Concepts


A.4 Data types

Jump to:   C   E   F   H   L   M   P   S   U  
Index Entry  Section

C
cl-weather-jp: The cl-weather-jp system
cl-weather-jp: The cl-weather-jp package
cl-weather-jp-asd: The cl-weather-jp-asd package
cl-weather-jp.asd: The cl-weather-jp/cl-weather-jp․asd file
cl-weather-jp.error: The cl-weather-jp․error package
cl-weather-jp.http: The cl-weather-jp․http package
cl-weather-jp.lisp: The cl-weather-jp/src/cl-weather-jp․lisp file
cl-weather-jp.location: The cl-weather-jp․location package
cl-weather-jp.util: The cl-weather-jp․util package
Condition, unknown-location: Public conditions

E
error.lisp: The cl-weather-jp/src/error․lisp file

F
File, cl-weather-jp.asd: The cl-weather-jp/cl-weather-jp․asd file
File, cl-weather-jp.lisp: The cl-weather-jp/src/cl-weather-jp․lisp file
File, error.lisp: The cl-weather-jp/src/error․lisp file
File, http.lisp: The cl-weather-jp/src/http․lisp file
File, location.lisp: The cl-weather-jp/src/location․lisp file
File, util.lisp: The cl-weather-jp/src/util․lisp file

H
http.lisp: The cl-weather-jp/src/http․lisp file

L
location.lisp: The cl-weather-jp/src/location․lisp file

M
Module, src: The cl-weather-jp/src module

P
Package, cl-weather-jp: The cl-weather-jp package
Package, cl-weather-jp-asd: The cl-weather-jp-asd package
Package, cl-weather-jp.error: The cl-weather-jp․error package
Package, cl-weather-jp.http: The cl-weather-jp․http package
Package, cl-weather-jp.location: The cl-weather-jp․location package
Package, cl-weather-jp.util: The cl-weather-jp․util package

S
src: The cl-weather-jp/src module
System, cl-weather-jp: The cl-weather-jp system

U
unknown-location: Public conditions
util.lisp: The cl-weather-jp/src/util․lisp file