The quickapp Reference Manual

Table of Contents

The quickapp Reference Manual

This is the quickapp Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 05:55:39 2022 GMT+0.

1 Introduction

quickapp

A common lisp project for generating template projects that use sbcl and buildapp

See https://github.com/triclops200/quickapp-cli for the command line standalone utility.

Example usage

(ql:quickload :quickapp)
(quickapp:quickapp
          "src/lisp/test-project"
          :project-name "test-project" 
          :executable-name "test.out" 
          :project-description "This is a sample test project" 
          :project-author "YOUR NAME HERE" 
          :dependencies '(:sdl2 :cl-openal))

This creates the needed files and Makefile as well as a template project.

For easy interactive development in slime, just do (assuming one is in their generated project directory):

(load "slime.lisp")
(in-package :<YOUR PACKAGE NAME>)

Arg parsing utilities

This library also contains two functions for dealing with argument handling for the generated application: (quickapp:parse-args) and (quickapp:generate-flag-string).

An example usage is shown below

(defun -main (&optional args)
  "Entry point"
  (let* ((arg-defs '(("h" "help" "Display this help menu")
	          ("d" "dependencies" "(:dep1 [:dep2 ...])" "The dependencies")
	          ("p" "project-name" "NAME" "The project name")
	          ("a" "project-author" "NAME" "The name of the author")
	          ("s" "project-description" "DESCRIPTION" "The project description")
	          ("e" "executable-name" "NAME" "The executable name")))
         (parsed-args (quickapp:parse-args arg-defs (cdr args))))
	  (if (or (/= (length (first parsed-args)) 1)
	          (assoc "help" (second parsed-args) :test #'string=))
		  (progn (format t "Usage: ~a PROJECT-PATH [OPTIONS]~%OPTIONS:~%~a~%~a~%~a~a~%~a~%~a~%"
			       (first args)
			       (quickapp:generate-flag-string arg-defs)
			       "Example Usage: " (first args) " test-project \\"
			       "  -d\"(:sdl2 :cl-opengl)\" \\"
			       "  --project-author=cluser"))
		  (format t "~a~%" parsed-args))))

Running that application with the --help flag results in:

Usage: ./quickapp PROJECT-PATH [OPTIONS]
OPTIONS:
  -h  --help                              Display this help menu
  -d  --dependencies=(:dep1 [:dep2 ...])  The dependencies
  -p  --project-name=NAME                 The project name
  -a  --project-author=NAME               The name of the author
  -s  --project-description=DESCRIPTION   The project description
  -e  --executable-name=NAME              The executable name

Example Usage: 
./quickapp test-project \
  -d"(:sdl2 :cl-opengl)" \
  --project-author=cluser

Running this command: ./quickapp test-project -d"(:sdl2 :cl-opengl)" --project-author=cluser results in this list returned as parsed-args

(("test-project")
 (("project-author" . "cluser") ("dependencies" . "(:sdl2 :cl-opengl)")))

#License Licensed under Modified BSD License.

See License.txt for more details.

2 Systems

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

2.1 quickapp

Author

Bryan Hoyle

License

Modified BSD License

Description

A utility library to automate much of the app creation process

Source

quickapp.asd (file)

Components

• package.lisp (file)
• quickapp.lisp (file)
• argument-parsing.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 quickapp.asd

Location

quickapp.asd

Systems

quickapp (system)

3.1.2 quickapp/package.lisp

Parent

quickapp (system)

Location

package.lisp

Packages

quickapp

3.1.3 quickapp/quickapp.lisp

Dependency

package.lisp (file)

Parent

quickapp (system)

Location

quickapp.lisp

Exported Definitions

• get-dependencies (function)
• get-executable (function)
• get-project (function)
• get-project-author (function)
• get-project-description (function)
• get-utils (function)
• quickapp (function)

Internal Definitions

• *executable-name* (special variable)
• *my-directory* (special variable)
• *project-author* (special variable)
• *project-dependencies* (special variable)
• *project-description* (special variable)
• *project-name* (special variable)
• dispatch-stream-rewrite (function)
• do-template (function)
• do-templates (function)
• eval-template-file (function)
• eval-template-string (function)
• from-my-path (function)
• slurp-file (function)
• spit-file (function)

3.1.4 quickapp/argument-parsing.lisp

Dependency

quickapp.lisp (file)

Parent

quickapp (system)

Location

argument-parsing.lisp

Exported Definitions

• generate-flag-string (function)
• parse-args (function)

Internal Definitions

• fill-string (function)
• fix-argdef (function)
• fix-named-arg (function)
• fix-named-args (function)
• loop-rec (macro)
• parse-arg (function)
• parse-unfixed-args (function)
• reduce-full (function)
• split-string (function)
• split-string-first (function)
• subseq-rel (function)
• with-string-stream (macro)

4 Packages

Packages are listed by definition order.

4.1 quickapp

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• generate-flag-string (function)
• get-dependencies (function)
• get-executable (function)
• get-project (function)
• get-project-author (function)
• get-project-description (function)
• get-utils (function)
• parse-args (function)
• quickapp (function)

Internal Definitions

• *executable-name* (special variable)
• *my-directory* (special variable)
• *project-author* (special variable)
• *project-dependencies* (special variable)
• *project-description* (special variable)
• *project-name* (special variable)
• dispatch-stream-rewrite (function)
• do-template (function)
• do-templates (function)
• eval-template-file (function)
• eval-template-string (function)
• fill-string (function)
• fix-argdef (function)
• fix-named-arg (function)
• fix-named-args (function)
• from-my-path (function)
• loop-rec (macro)
• parse-arg (function)
• parse-unfixed-args (function)
• reduce-full (function)
• slurp-file (function)
• spit-file (function)
• split-string (function)
• split-string-first (function)
• subseq-rel (function)
• with-string-stream (macro)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: generate-flag-string ARG-DEFS

Generate the part of the help string that documents the options from the arg definition

Package

quickapp

Source

argument-parsing.lisp (file)

Function: get-dependencies ()

Package

quickapp

Source

quickapp.lisp (file)

Function: get-executable ()

Package

quickapp

Source

quickapp.lisp (file)

Function: get-project ()

Package

quickapp

Source

quickapp.lisp (file)

Function: get-project-author ()

Package

quickapp

Source

quickapp.lisp (file)

Function: get-project-description ()

Package

quickapp

Source

quickapp.lisp (file)

Function: get-utils ()

Package

quickapp

Source

quickapp.lisp (file)

Function: parse-args ARG-DEFS ARGS

Actually calls all the functions to parse the args into the correct form.

Package

quickapp

Source

argument-parsing.lisp (file)

Function: quickapp PROJECT-PATH &key PROJECT-NAME EXECUTABLE-NAME PROJECT-DESCRIPTION PROJECT-AUTHOR DEPENDENCIES

Create the project from the templates

Package

quickapp

Source

quickapp.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *executable-name*

Package

quickapp

Source

quickapp.lisp (file)

Special Variable: *my-directory*

Package

quickapp

Source

quickapp.lisp (file)

Special Variable: *project-author*

Package

quickapp

Source

quickapp.lisp (file)

Special Variable: *project-dependencies*

Package

quickapp

Source

quickapp.lisp (file)

Special Variable: *project-description*

Package

quickapp

Source

quickapp.lisp (file)

Special Variable: *project-name*

Package

quickapp

Source

quickapp.lisp (file)

5.2.2 Macros

Macro: loop-rec BINDINGS &body BODY

Similar to the clojure loop macro

Package

quickapp

Source

argument-parsing.lisp (file)

Macro: with-string-stream STREAM &body BODY

A macro to allow one to write to a variable string stream and get the body result out

Package

quickapp

Source

argument-parsing.lisp (file)

5.2.3 Functions

Function: dispatch-stream-rewrite C1 C2 INPUT-STRING DISPATCH-FUNCTION

Package

quickapp

Source

quickapp.lisp (file)

Function: do-template PROJECT-PATH FILE &optional NAME

Package

quickapp

Source

quickapp.lisp (file)

Function: do-templates PROJECT-PATH TEMPLATES

Package

quickapp

Source

quickapp.lisp (file)

Function: eval-template-file FILE

Package

quickapp

Source

quickapp.lisp (file)

Function: eval-template-string STRING

Package

quickapp

Source

quickapp.lisp (file)

Function: fill-string STR FILL-CHAR N

Fill a string with a character until it is at least as long as n specifies

Package

quickapp

Source

argument-parsing.lisp (file)

Function: fix-argdef ARGDEF

This is a formatter for an argdef to display properly

Package

quickapp

Source

argument-parsing.lisp (file)

Function: fix-named-arg ARG-NAMES ARG

This unifies the named arguments to use the long form.

Package

quickapp

Source

argument-parsing.lisp (file)

Function: fix-named-args ARG-NAMES ARGS

Fix all of the named args to use the long form

Package

quickapp

Source

argument-parsing.lisp (file)

Function: from-my-path FILENAME

Package

quickapp

Source

quickapp.lisp (file)

Function: parse-arg ACC ARG-LIST

Parses one argument/argument pair into the named/unnamed lists appropriately

Package

quickapp

Source

argument-parsing.lisp (file)

Function: parse-unfixed-args ARGS

Parse an argument list into the appropriate list

Package

quickapp

Source

argument-parsing.lisp (file)

Function: reduce-full F &rest ARGS

A reducer that allows f to control the iteration as well as the accumulator

Package

quickapp

Source

argument-parsing.lisp (file)

Function: slurp-file FILENAME

Package

quickapp

Source

quickapp.lisp (file)

Function: spit-file FILENAME STRING

Package

quickapp

Source

quickapp.lisp (file)

Function: split-string SEPERATOR STR

Fully split a string by seperator.

Package

quickapp

Source

argument-parsing.lisp (file)

Function: split-string-first SEPERATOR STR &optional DEFAULT-VALUE

Returns a value pair representing the first split in the string matching the seperator string

Package

quickapp

Source

argument-parsing.lisp (file)

Function: subseq-rel SEQ FST &optional L

A relative subsequence function

Package

quickapp

Source

argument-parsing.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types