diff --git a/.circleci/config.yml b/.circleci/config.yml new file mode 100644 index 000000000..1ad1612af --- /dev/null +++ b/.circleci/config.yml @@ -0,0 +1,165 @@ +version: 2 + +references: + setup-tex: &setup-tex + run: + name: Setup TeX + command: |- + sudo apt-get update + sudo apt-get install -qq -y texlive-latex-base ptex-bin latex2html nkf poppler-utils + setup-eus: &setup-eus + run: + name: Setup EusLisp + command: |- + sudo apt-get install -qq -y git make gcc g++ libjpeg-dev libxext-dev libx11-dev libgl1-mesa-dev libglu1-mesa-dev libpq-dev libpng-dev xfonts-100dpi xfonts-75dpi + echo 'export EUSDIR=`pwd`' >> $BASH_ENV + echo 'export ARCHDIR=Linux64' >> $BASH_ENV + echo 'export PATH=${PATH}:${EUSDIR}/${ARCHDIR}/bin' >> $BASH_ENV + echo 'export LD_LIBRARY_PATH=${EUSDIR}/${ARCHDIR}/lib' >> $BASH_ENV + cat $BASH_ENV + compile-eus: &compile-eus + run: + name: Compile EusLisp + command: cd lisp; ln -sf Makefile.Linux64 Makefile; make + +jobs: + html: + machine: true + steps: + - checkout + - *setup-tex + - run: + name: Cleanup HTML + command: cd doc/html && rm *manual*.html *manual*.png + - run: + name: Compile HTML + command: cd doc/latex && make html + - run: + name: Compile jHTML + command: cd doc/jlatex && make html + - run: + command: | + mkdir -p /tmp/html + cp doc/html/*manual*.html /tmp/html + cp doc/html/*manual*.png /tmp/html + - store_artifacts: + path: /tmp/html + - persist_to_workspace: + root: doc + paths: + - html/manual*.html + - html/jmanual*.html + - html/manual*.png + - html/jmanual*.png + + latex: + machine: true + steps: + - checkout + - *setup-tex + - *setup-eus + - *compile-eus + - run: + name: Cleanup LaTeX + command: cd doc/latex && make distclean + - run: + name: Compile LaTeX + command: | + cd doc/latex && make + - store_artifacts: + path: doc/latex/manual.pdf + destination: manual.pdf + - persist_to_workspace: + root: doc/latex + paths: manual.pdf + jlatex: + machine: true + steps: + - checkout + - *setup-tex + - *setup-eus + - *compile-eus + - run: + name: Cleanup jLaTeX + command: cd doc/jlatex && make distclean + - run: + name: Compile jLaTeX + command: | + cd doc/jlatex && make + - store_artifacts: + path: doc/jlatex/jmanual.pdf + destination: jmanual.pdf + - persist_to_workspace: + root: doc/jlatex/ + paths: jmanual.pdf + rst: + machine: true + steps: + - checkout + - *setup-tex + - run: + name: Install Python3 + command: pyenv global system 3.5.2 + - run: + name: Install Pandoc + command: sudo apt-get install -y -qq pandoc + - run: + name: Compile reStructuredText(reST) + command: cd doc/latex && make rst + - run: + command: | + mkdir -p /tmp/rst/fig + cp doc/latex/*.rst /tmp/rst + cp doc/latex/fig/*.png /tmp/rst/fig + cp doc/latex/conf.py /tmp/rst + - run: + name: Install Sphinx + command: | + pip3 install --user sphinx + pip3 install --user sphinx_rtd_theme + - run: + name: Build reStructuredText(reST) + command: cd /tmp/rst && ~/.local/bin/sphinx-build . html + - store_artifacts: + path: /tmp/rst + - persist_to_workspace: + root: /tmp + paths: rst + + artifacts: + docker: + - image: circleci/node:8.10.0 + steps: + - checkout + - attach_workspace: + at: artifacts + - store_artifacts: + path: artifacts + - run: + command: | + echo "Check is PR commit : CIRCLE_BRANCH = $CIRCLE_BRANCH" + if [ "${CIRCLE_BRANCH}" == master ]; then exit 0; fi + echo "Check if there is commit in doc directory" + git diff origin/master --name-only --relative doc + if [ "`git diff origin/master --name-only --relative doc`" == "" ]; then echo "No update in doc directory found, exitting... "; circleci step halt; fi + echo "Found new commit on doc directory" + - run: cd .circleci/ && git clone https://github.com/themadcreator/circle-github-bot.git + - run: cd .circleci/circle-github-bot && npm install + - run: cd .circleci/circle-github-bot && npm run build + - run: .circleci/github-pr-update.js + +workflows: + version: 2 + build: + jobs: + - latex + - jlatex + - html + - rst + - artifacts: + requires: + - latex + - jlatex + - html + - rst + diff --git a/.circleci/github-pr-update.js b/.circleci/github-pr-update.js new file mode 100755 index 000000000..753ca2753 --- /dev/null +++ b/.circleci/github-pr-update.js @@ -0,0 +1,14 @@ +#!/usr/bin/env node + +const bot = require("./circle-github-bot/").create(); + +bot.comment(process.env.GH_AUTH_TOKEN, ` +Thank you for contributing EusLisp documentation
+Please check latest documents before merging
+ +PDF version of English manual: ${bot.artifactLink('artifacts/manual.pdf', 'manual.pdf')} +PDF version of Japanese jmanual: ${bot.artifactLink('artifacts/jmanual.pdf', 'jmanual.pdf')} +HTML version of English manual: ${bot.artifactLink('artifacts/html/manual.html', 'manual.html')} +HTML version of Japanese manual: ${bot.artifactLink('artifacts/html/jmanual.html', 'jmanual.html')} +Sphinx (ReST) version of English manual: ${bot.artifactLink('artifacts/rst/html/manual.html', 'manual.rst')} +`); diff --git a/.travis.sh b/.travis.sh index cffda89cb..fadb9aa86 100755 --- a/.travis.sh +++ b/.travis.sh @@ -28,7 +28,7 @@ if [ "$TRAVIS_OS_NAME" == "linux" ]; then travis_time_end travis_time_start setup.apt-get_install - ret=1; while [ $ret != 0 ]; do sudo apt-get install -qq -y git make gcc g++ libjpeg-dev libxext-dev libx11-dev libgl1-mesa-dev libglu1-mesa-dev libpq-dev libpng-dev xfonts-100dpi xfonts-75dpi && ret=0 || echo "failed, retry"; done # msttcorefonts could not install on 14.04 travis + ret=1; while [ $ret != 0 ]; do sudo apt-get install -qq -y git make gcc g++ libjpeg-dev libxext-dev libx11-dev libgl1-mesa-dev libglu1-mesa-dev libpq-dev libpng-dev xfonts-100dpi xfonts-75dpi pkg-config libbullet-dev && ret=0 || echo "failed, retry"; done # msttcorefonts could not install on 14.04 travis if [ "`uname -m`" == "x86_64" ] ; then sudo apt-get install -qq -y texlive-latex-base ptex-bin latex2html nkf poppler-utils || echo "ok"; fi # 16.04 does ont have ptex bin travis_time_end @@ -38,9 +38,11 @@ if [ "$TRAVIS_OS_NAME" == "osx" ]; then # skip if already installed # https://discourse.brew.sh/t/skip-ignore-brew-install-if-package-is-already-installed/633/2 # brew install jpeg libpng mesalib-glw; - brew list jpeg &>/dev/null || brew install jpeg - brew list libpng &>/dev/null || brew install libpng - brew list mesalib-glw &>/dev/null || brew install mesalib-glw + # use HOMEBREW_NO_AUT_UPDATE to fix unexpected keyword error https://travis-ci.community/t/syntax-error-unexpected-keyword-rescue-expecting-keyword-end-in-homebrew/5623 + brew list jpeg &>/dev/null || HOMEBREW_NO_AUTO_UPDATE=1 brew install jpeg + brew list libpng &>/dev/null || HOMEBREW_NO_AUTO_UPDATE=1 brew install libpng + brew list mesalib-glw &>/dev/null || HOMEBREW_NO_AUTO_UPDATE=1 brew install mesalib-glw + brew list bullet &>/dev/null || HOMEBREW_NO_AUTO_UPDATE=1 brew install bullet travis_time_end fi @@ -171,6 +173,9 @@ fi for test_l in irteus/test/*.l; do [[ ("`uname -m`" == "arm"* || "`uname -m`" == "aarch"*) && $test_l =~ geo.l|mathtest.l|interpolator.l|test-irt-motion.l|test-pointcloud.l|irteus-demo.l ]] && continue; + # skip collision test because bullet of 2.83 or later version is not released in trusty and jessie. + # https://github.com/euslisp/jskeus/blob/6cb08aa6c66fa8759591de25b7da68baf76d5f09/irteus/Makefile#L37 + [[ ( "$DOCKER_IMAGE" == *"trusty"* || "$DOCKER_IMAGE" == *"jessie"* ) && $test_l =~ test-collision.l ]] && continue; travis_time_start irteus.${test_l##*/}.test diff --git a/.travis.yml b/.travis.yml index 243a8536e..5af69c6a9 100644 --- a/.travis.yml +++ b/.travis.yml @@ -86,7 +86,7 @@ install: script: - echo "Testing branch $TRAVIS_BRANCH of $REPOSITORY_NAME" - if [ "$TRAVIS_OS_NAME" == "linux" ]; then docker run --rm -i -v $HOME:$HOME -e "TRAVIS_OS_NAME=$TRAVIS_OS_NAME" -e "CI_SOURCE_PATH=$CI_SOURCE_PATH" -e "HOME=$HOME" -e "MAKEFLAGS=$MAKEFLAGS" -e "DOCKER_IMAGE=$DOCKER_IMAGE" -t $DOCKER_IMAGE sh -c "cd $CI_SOURCE_PATH; ./.travis.sh"; fi - - if [ "$TRAVIS_OS_NAME" == "osx" ]; then source ./.travis.sh; fi + - if [ "$TRAVIS_OS_NAME" == "osx" ]; then ./.travis.sh; fi after_failure: - echo "failure" after_success: diff --git a/doc/jlatex/jgenerals.tex b/doc/jlatex/jgenerals.tex index e311f1fde..80fc52598 100644 --- a/doc/jlatex/jgenerals.tex +++ b/doc/jlatex/jgenerals.tex @@ -384,7 +384,7 @@ \subsection{型指定} あるいは{\bf :fixnum}が整数型を表現するために使用され、 {\bf :float}あるいは{\bf float}が実数型を表現するために使用される。 {\bf make-array}の{\em element-type}引数においては、文字列を作るために -{\bf :character}, {\bf character}, {\bf :byte}や{\bfx byte}を +{\bf :character}, {\bf character}, {\bf :byte}や\bfx{byte}を 認識する。 {\bf defcstruct}, {\bf sys:peek}や{\bf sys:poke}のような低レベルの関数も、 バイト毎にアクセスするために diff --git a/doc/jlatex/jgeometry.tex b/doc/jlatex/jgeometry.tex index d76479870..fce474e21 100644 --- a/doc/jlatex/jgeometry.tex +++ b/doc/jlatex/jgeometry.tex @@ -1,7 +1,7 @@ \section{\label{Geometry}幾何学モデリング} \markright{\arabic{section}. 幾何学モデリング} -Euslispは、３次元の幾何学モデルの内部表現として{\emx Brep}（境界表現）を採用している。 +Euslispは、３次元の幾何学モデルの内部表現として\emx{Brep}（境界表現）を採用している。 Brep内の要素は{\bf edge, plane, polygon, face, hole,}や{\bf body}クラスによって 表現される。 基本bodyの作成関数とbodyの合成関数は、これらのクラスの新しい @@ -746,8 +746,8 @@ \subsection{\label{primitive-body-creation}基本bodyの作成関数} もし，頂点のリストなら，順番を慎重にしなさい。 %%% change 2004.12.14 \verb+ (make-cone \#f(0 0 10) (list \#f(10 0 0) \#f(0 10 0) \#f(-10 0 0) %%% change 2004.12.14 \#f(0 -10 0)))+ は，正方形の底面を持つ四角錐を作る。} -\verb~ (make-cone \#f(0 0 10) (list \#f(10 0 0) \#f(0 10 0) \#f(-10 0 0) -\#f(0 -10 0)))~ は，正方形の底面を持つ四角錐を作る。} +\verb~ (make-cone \#f(0 0 10) (list \#f(10 0 0) \#f(0 10 0) \#f(-10 0 0) \#f(0 -10 0)))~ +は，正方形の底面を持つ四角錐を作る。} \funcdesc{make-solid-of-revolution}{points \&key (segments 16) name color}{ {\em points}は，z軸まわりの時計方向に回転される。 diff --git a/doc/jlatex/jintro.tex b/doc/jlatex/jintro.tex index a9d893e73..8a18322f9 100644 --- a/doc/jlatex/jintro.tex +++ b/doc/jlatex/jintro.tex @@ -233,7 +233,7 @@ \subsection{インストール} その他は、付属ライブラリ・デモプログラム・ユーザーからの寄贈品である。 \begin{table} -\caption{\label{Directories}{\tt *eusdir*}のディレクトリ} +\caption{{\tt *eusdir*}のディレクトリ\label{Directories}} \begin{center} {\footnotesize \begin{tabular}{|l | l|}\hline diff --git a/doc/jlatex/jmthread.tex b/doc/jlatex/jmthread.tex index 35c8ff2ea..70f23e1c3 100644 --- a/doc/jlatex/jmthread.tex +++ b/doc/jlatex/jmthread.tex @@ -393,8 +393,8 @@ \subsection{同期} {\em sem}に信号が来るまで待つ。} \classdesc{sys:barrier-synch}{propertied-object}{ -threads n-threads count barrier-cond threads-lock count-lock} -{同期障壁のための構造を表現する。 +threads n-threads count barrier-cond threads-lock count-lock}{ +同期障壁のための構造を表現する。 同期を待っているスレッドは、{\em thread-lock}によって 相互に排除される{\em thread}に置かれる。 {\bf barrier-synch}オブジェクトが生成されたとき、 diff --git a/doc/jlatex/jobjects.tex b/doc/jlatex/jobjects.tex index a66928fe4..6bfd8ed5b 100644 --- a/doc/jlatex/jobjects.tex +++ b/doc/jlatex/jobjects.tex @@ -297,8 +297,8 @@ \subsection{基本クラス} {\bf metaclass}は、複数クラスを定義する。独自のクラス変数を持つ複数クラスは、 それらのスーパークラスとして{\bf metaclass}を定義しなければならない。} -\methoddesc{:new}{} -{このクラスのインスタンスを生成し、全てのスロットをNILにした後、 +\methoddesc{:new}{}{ +このクラスのインスタンスを生成し、全てのスロットをNILにした後、 それを返す。} \methoddesc{:super}{}{ diff --git a/doc/jlatex/jsymbols.tex b/doc/jlatex/jsymbols.tex index 41702567e..72f87f344 100644 --- a/doc/jlatex/jsymbols.tex +++ b/doc/jlatex/jsymbols.tex @@ -169,7 +169,7 @@ \subsection{パッケージ} symbolをexportあるいはimportするとき、あらゆるパッケージ内の 全てのsymbolが独自の print-nameを持つ必要があるため、symbol名の重複を発見することができる。 -{\bfx shadow}は、パッケージからsymbolを仮想的に削除することにより、 +\bfx{shadow}は、パッケージからsymbolを仮想的に削除することにより、 存在するsymbolと同じ名前のsymbolを作成することができる。 Euslispは次の8つのパッケージを定義する。 diff --git a/doc/latex/Makefile b/doc/latex/Makefile index 5e463e14c..1cf10adb3 100644 --- a/doc/latex/Makefile +++ b/doc/latex/Makefile @@ -27,3 +27,35 @@ html: rm -f ../html/manual*.{old,html,png,pl} ../html/manual-images.* TRANSPARENT_COLOR="#ffffff" latex2html -dir ../html/ -transparent -local_icons -split +3 -auto_prefix -iso_language JP -address "This document was generated using the LaTeX2HTML translator on `date` from EusLisp version `git log -1 --oneline`" -html_version="4.0,unicode" manual (cd ../html; for imgfile in manual-img*.png; do pngtopnm $$imgfile > /tmp/$$imgfile.pnm; pnmtopng -transparent white /tmp/$$imgfile.pnm > $$imgfile; done) + +latex.py: + wget https://raw.githubusercontent.com/jobh/latex.py/master/latex.py + +# +TEXFILES=$(filter-out manual.tex, $(wildcard *.tex)) +RSTFILES=$(TEXFILES:%.tex=%.rst) +%.rst : %.tex + python3 latex.py -2 -L preamble.tex $< > /tmp/tmp_$^ + pandoc /tmp/tmp_$^ -o $@ -V documentclass=ltjarticle --latex-engine=lualatex + sed -i 's@.. figure:: \(.*\).ps@.. figure:: \1.png@g' $@ # use png for figures + +PSFILES=$(wildcard fig/*.ps) +PNGFILES=$(PSFILES:%.ps=%.png) +%.png : %.ps + #ps2png $^ $@ + pstopnm -stdout $^ | pnmflip -rotate270 | pnmtopng - > $@ + + +rst: manual.rst +manual.rst: latex.py $(RSTFILES) $(PNGFILES) + cp manual.tex /tmp/manual.tex + sed -i 's@\\input{\(.*\)}@..include:: \1\n@g' /tmp/manual.tex # convert \input in tex to bypass pandoc + sed -i 's@\\part{\(.*\)}@.. toctree:: \1@' /tmp/manual.tex # convert \part in tex to bypass pandoc + sed -i ':a;/^[^%].*\\\\$$/{N;s/\\\\\n//;ba}' /tmp/manual.tex # concatinate title/author multi lines + sed -i '/^\\vspace{10mm}$$/d' /tmp/manual.tex # remove vspace{10mm} within title to pass pandoc + pandoc --no-wrap -s /tmp/manual.tex -o manual.rst -V documentclass=ltjarticle --latex-engine=lualatex + sed -i 's@..include:: \(.*\)@ \1@' manual.rst # restore ..include for rst + sed -i 's@.. toctree:: \(.*\)@.. toctree::\n :maxdepth: 1\n :caption: \1@' manual.rst # restore ..toctree for rst + sed -i 's@** Featuring@**\nFeaturing@' manual.rst # add newline before Featuring in title + sed -i -ne '3!{p;d;};h;n;:1;4!{N;b1};G;h;n;p;g;p' manual.rst; head manual.rst + diff --git a/doc/latex/conf.py b/doc/latex/conf.py new file mode 100644 index 000000000..6c9e2e89a --- /dev/null +++ b/doc/latex/conf.py @@ -0,0 +1,191 @@ +# -*- coding: utf-8 -*- +# +# EusLisp documentation build configuration file, created by +# sphinx-quickstart on Mon Jun 10 14:01:34 2019. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + +import subprocess, os, sys +def sh(command): + print("+ {}".format(command)) + print(subprocess.check_output(command, shell=True)) + +on_rtd = os.environ.get('READTHEDOCS') == 'True' +if on_rtd: + # run make rst + sh("make rst") + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'manual' + +# General information about the project. +project = u'EusLisp' +copyright = u'1984-2001, National Institute of Advanced Industrial Science and Technology (AIST)' +author = u'Toshihiro Matsui' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'9.26' +# The full version, including alpha/beta/rc tags. +release = u'9.26' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + ] +} + +import sphinx_rtd_theme +if on_rtd: + # The theme to use for HTML and HTML Help pages. See the documentation for + # a list of builtin themes. + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + sh("sed -i 's@set suffix@set suffix_bak@' {}/sphinx_rtd_theme/breadcrumbs.html".format(html_theme_path[0])) + + # Add Edit on GitHub link + html_context = { + 'suffix': '.tex', + } + + sh("mkdir -p _build/html") + sh("cd _build/html; ln -sf manual.html index.html; ls -al") + + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'EusLispdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'EusLisp.tex', u'EusLisp Documentation', + u'Toshihiro Matsui', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'euslisp', u'EusLisp Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'EusLisp', u'EusLisp Documentation', + author, 'EusLisp', 'EusLisp is an integrated programming system for the research on intelligent robots based on Common Lisp and Object-Oriented programming.', + 'Miscellaneous'), +] + diff --git a/doc/latex/database.tex b/doc/latex/database.tex index 50eb349db..61e809c60 100644 --- a/doc/latex/database.tex +++ b/doc/latex/database.tex @@ -77,7 +77,7 @@ \subsection{PostgreSQL} \begin{refdesc} -\classdesc{pgsql}{propertied-object}{...} +\classdesc{pgsql}{propertied-object}{...}{}{} \methoddesc{:init}{key host port dbname user password}{ connects to a database designated by host, port and dbname. @@ -124,8 +124,8 @@ \subsection{PostgreSQL} For example, (delimit-list '(a b c) 'or) returns "a or b or c". This function is useful to compose SQL commands.} -\funcdesc{pq:select}{db fields table \&key where limit limit-offset order-by} -{ sends an SQL command composed by the argument, and retrieves the +\funcdesc{pq:select}{db fields table \&key where limit limit-offset order-by}{ + sends an SQL command composed by the argument, and retrieves the result in the synchronous manner. The following example gives a list of id, name and email selected from the address\_book table diff --git a/doc/latex/datetime.tex b/doc/latex/datetime.tex index dfebfe4bb..451dfb3cc 100644 --- a/doc/latex/datetime.tex +++ b/doc/latex/datetime.tex @@ -4,8 +4,8 @@ \section{Date and Time} \begin{refdesc} -\classdesc{time}{propertied-object} -{(micro second minute hour day month weekday year \\ +\classdesc{time}{propertied-object}{ +(micro second minute hour day month weekday year \\ \> timezone dst seconds)}{ defines time objects. } diff --git a/doc/latex/evaluation.tex b/doc/latex/evaluation.tex index ce8969dfe..24ea6f9af 100644 --- a/doc/latex/evaluation.tex +++ b/doc/latex/evaluation.tex @@ -111,8 +111,8 @@ \subsection{Evaluators} \begin{description} \item {special} declares special variables \item {type} declares the type of variables; {\tt (type integer count)}; -valid type specifiers are {\emx integer}, {\emx :integer} {\emx fixnum}, -{\emx :float} and {\emx float}. The {\bf type} keyword may be omitted +valid type specifiers are \emx{integer}, \emx{:integer} \emx{fixnum}, +\emx{:float} and \emx{float}. The {\bf type} keyword may be omitted if type specifier is either one listed here. So {\tt (integer count)} is a correct declaration. Other types (classes) such as {\em float-vector}, {\em integer-vector}, etc. need to be preceded by {\bf type}, as diff --git a/doc/latex/generals.tex b/doc/latex/generals.tex index a5d3f54d9..a2dc2e9b3 100644 --- a/doc/latex/generals.tex +++ b/doc/latex/generals.tex @@ -383,7 +383,7 @@ \subsection{Class Hierarchy} \> handle \> ;file handle returned by ''dlopen''} \subsection{Type Specifier} -Though EusLisp does not have the {\bfx deftype} special form, +Though EusLisp does not have the \bfx{deftype} special form, type names are used in declarations and functions requesting to specify the type of results or contents, as in {\bf coerce, map, concatenate, make-array}, etc. @@ -393,16 +393,16 @@ \subsection{Type Specifier} As EusLisp does not have classes to represent numbers, types for numbers need to be given by keywords. -{\bfx :integer}, {\bfx integer}, {\bfx :int}, {\bfx fixnum}, -or {\bfx :fixnum} is used to represent the integer type, -{\bfx :float} or {\bfx float}, the floating point number type. -As the {\emx element-type} argument of {\bfx make-array}, -{\bfx :character}, {\bfx character}, {\bfx :byte}, and {\bfx byte} +\bfx{:integer}, \bfx{integer}, \bfx{:int}, \bfx{fixnum}, +or \bfx{:fixnum} is used to represent the integer type, +\bfx{:float} or \bfx{float}, the floating point number type. +As the \emx{element-type} argument of \bfx{make-array}, +\bfx{:character}, \bfx{character}, \bfx{:byte}, and \bfx{byte} are recognized to make strings. -Low level functions such as {\bfx defcstruct}, {\bfx sys:peek}, -and {\bfx sys:poke}, also recognize -{\bfx :character}, {\bfx character}, {\bfx :byte}, or {\bfx byte} -for the byte access, and {\bfx :short} or {\bfx short} for short word access. +Low level functions such as \bfx{defcstruct}, \bfx{sys:peek}, +and \bfx{sys:poke}, also recognize +\bfx{:character}, \bfx{character}, \bfx{:byte}, or \bfx{byte} +for the byte access, and \bfx{:short} or \bfx{short} for short word access. In any cases, keywords are preferable to lisp package symbols with the same pname. diff --git a/doc/latex/geometry.tex b/doc/latex/geometry.tex index 4641b6302..110ab8679 100644 --- a/doc/latex/geometry.tex +++ b/doc/latex/geometry.tex @@ -2,7 +2,7 @@ \section{\label{Geometry}Geometric Modeling} \markright{\arabic{section}. Geometric Modeling} -EusLisp adopts {\emx Brep} (Boundary Representation) as the internal +EusLisp adopts \emx{Brep} (Boundary Representation) as the internal representation of 3D geometric models. Components in Breps are represented by classes {\bf edge, plane, polygon, face, hole,} and {\bf body}. @@ -788,9 +788,8 @@ \subsection{\label{primitive-body-creation}Primitive Body Creation} {\em Top} is a 3D float-vector. {\em Bottom} is either a list of vertices of the bottom face or a radius (scalar). If it is the vertices list, it is order sensitive. -\verb~ (make-cone \#f(0 0 10) (list \#f(10 0 0) \#f(0 10 0) \#f(-10 0 0) -\#f(0 -10 0)))~ makes a cone of a square bottom.} - +\verb~ (make-cone \#f(0 0 10) (list \#f(10 0 0) \#f(0 10 0) \#f(-10 0 0) \#f(0 -10 0)))~ + makes a cone of a square bottom.} \funcdesc{make-solid-of-revolution}{points \&key (segments 16) name color}{ {\em Points} are revolted along z-axis in the clock wise direction. diff --git a/doc/latex/http.tex b/doc/latex/http.tex index c2c85f63b..3029b22d3 100644 --- a/doc/latex/http.tex +++ b/doc/latex/http.tex @@ -25,8 +25,8 @@ \subsection{HTTP Client} \funcdesc{unescaped-url-string-from-namestring}{url-string \&optional (queryp t)}{ returns result of {\tt unescape-url} as string.} -\funcdesc{read-http}{url \&key (timeout 10) (retry 5)} -{makes a socket connection to the designated url, and +\funcdesc{read-http}{url \&key (timeout 10) (retry 5)}{ +makes a socket connection to the designated url, and read the html document. The result is a list of tags and plain strings. HTML tags are converted as lists consisting of the tag-name @@ -134,7 +134,7 @@ \subsection{HTTP CGI Programming} from the QUERY\_STRING environment variable or from the standard input. Anyways, the result is returned in one string.} -\funcdesc{parse-http-query}{query-string} +\funcdesc{parse-http-query}{query-string}{} \funcdesc{html-header}{}{generates the html header, usually a simple string of two lines, diff --git a/doc/latex/io.tex b/doc/latex/io.tex index 3f3236249..88e9a16ac 100644 --- a/doc/latex/io.tex +++ b/doc/latex/io.tex @@ -17,7 +17,7 @@ \subsection{Streams} \begin{refdesc} \funcdesc{streamp}{object}{ -Any object created from {\bfx stream}, {\bfx io-stream}, +Any object created from \bfx{stream}, \bfx{io-stream}, or their subclasses returns T.} \funcdesc{input-stream-p}{object}{ @@ -256,7 +256,7 @@ \subsection{Reader} Only the first s-expression can be read. If successive read operations need to be performed on a string containing more than one expression, -use string-stream made by {\bfx make-string-input-stream}.} +use string-stream made by \bfx{make-string-input-stream}.} \funcdesc{unread-char}{char \&optional stream}{ puts the {\em char} back to the {\em stream}. @@ -483,7 +483,7 @@ \subsubsection{Shared Memory} maps the file named {\em filename} to memory space. {\em Filename} can be either of a local file, an NFS-mounted remote file, or a memory device in {\tt /dev}. -A {\bfx foreign-string}, whose elements can be accessed by {\bf aref}, +A \bfx{foreign-string}, whose elements can be accessed by {\bf aref}, is returned. Writing data into a foreign-string mapped by {\tt map-file} with {\em direction=:input} will result a segmentation fault.} diff --git a/doc/latex/loadforeign.tex b/doc/latex/loadforeign.tex index 8b748f938..f14796d56 100644 --- a/doc/latex/loadforeign.tex +++ b/doc/latex/loadforeign.tex @@ -1,5 +1,5 @@ -\macrodesc{load-foreign}{objfile \&key symbol-input symbol-output (symbol-file objfile) ld-option)} -{loads an object module written other than EusLisp. +\macrodesc{load-foreign}{objfile \&key symbol-input symbol-output (symbol-file objfile) ld-option)}{ +loads an object module written other than EusLisp. A compiled code object is returned. This result is necessary to make function entries in the module by {\bf defforeign}. diff --git a/doc/latex/manual.pdf b/doc/latex/manual.pdf new file mode 100644 index 000000000..e69de29bb diff --git a/doc/latex/mars-pre.tex b/doc/latex/mars-pre.tex index 496252766..89b66f6e7 100644 --- a/doc/latex/mars-pre.tex +++ b/doc/latex/mars-pre.tex @@ -55,7 +55,7 @@ \subsection{System Overview} %\begin{tabular}{c@\extracolsep{1em}c} \begin{tabular}{c c} \includegraphics[height=10cm]{fig/mars.ps} -%\epsfile{file=fig/mars.eps,scale=0.3} & % ɽƱѹơ +%\epsfile{file=fig/mars.eps,scale=0.3} & % 表紙と同じ絵に変更して。 %\mbox{ %\epsfsize=10cm %\epsfbox{file=fig/mars.eps} diff --git a/doc/latex/matrix.tex b/doc/latex/matrix.tex index 4c80b6e1e..e1d3c70d4 100644 --- a/doc/latex/matrix.tex +++ b/doc/latex/matrix.tex @@ -482,7 +482,7 @@ \subsection{CascadedCoords} \classdesc{cascaded-coords}{coordinates}{(parent descendants worldcoords manager changed)}{ defines a linked coordinates. {\bf Cascaded-coords} is often abbreviated -as {\bfx cascoords}.} +as \bfx{cascoords}.} \methoddesc{:inheritance}{}{ returns the inheritance tree list describing all the descendants of the diff --git a/doc/latex/mthread.tex b/doc/latex/mthread.tex index 26c57f608..ad85972b3 100644 --- a/doc/latex/mthread.tex +++ b/doc/latex/mthread.tex @@ -414,8 +414,8 @@ \subsection{Synchronization} waits for the {\em sem} semaphore to be posted.} \classdesc{sys:barrier-synch}{propertied-object}{ -threads n-threads count barrier-cond threads-lock count-lock} -{represents a structure for barrier-synchronization. Threads waiting +threads n-threads count barrier-cond threads-lock count-lock}{ +represents a structure for barrier-synchronization. Threads waiting for the synchronization are put in {\em threads} which is mutually excluded by {\em threads-lock}. When a {\bf barrier-synch} object is created, diff --git a/doc/latex/objects.tex b/doc/latex/objects.tex index d44fdf98b..782585bf9 100644 --- a/doc/latex/objects.tex +++ b/doc/latex/objects.tex @@ -294,8 +294,8 @@ \subsection{Basic Classes} Metaclass defines classes. Classes that have own class variables should be defined with {\bf metaclass} as their superclass.} -\methoddesc{:new}{} -{creates an instance of this class and returns it +\methoddesc{:new}{}{ +creates an instance of this class and returns it after filling all the slots with NIL.} \methoddesc{:super}{}{ diff --git a/doc/latex/opengl.tex b/doc/latex/opengl.tex index d9c89c3aa..ef2363beb 100644 --- a/doc/latex/opengl.tex +++ b/doc/latex/opengl.tex @@ -28,7 +28,7 @@ \subsection{OpenGL Extensions} Drawing requests to a viewer are interpreted to OpenGL requests. } -\methoddesc{:create}{}{ \&key (x 0) (y 0) (size 256) (w size) (h size) +\methoddesc{:create}{ \&key (x 0) (y 0) (size 256) (w size) (h size) (title (string (gensym "GL"))) (displaymode (logior gl:AUX\_DOUBLE gl:AUX\_RGB gl:AUX\_DEPTH)) \&allow-other-keys}{ @@ -41,110 +41,110 @@ \subsection{OpenGL Extensions} changes the current color.} \methoddesc{:3d-mode}{}{ -ͱѴƩˡͱƥ⡼ɤˤǥץ饤ƥ󥰤򥤥֥͡뤹 -롣ǥ먡Ŭ⡼ɤˤ롣 +射影変換を透視法射影モードにし、デプス検査、ライティングをイネーブルす +る。３次元モデル──シーンの描画に適したモードにする。 } \methoddesc{:2d-mode}{}{ -ͱѴͱƤˤǥץ饤ƥ󥰤ǥ֥뤹롣 -ǤŬ⡼ɤˤ롣 +射影変換を正射影にし、デプス検査、ライティングをディスエーブルする。 +２次元の描画要素の描画に適したモードにする。 } \methoddesc{:clear}{mask \&key color}{ -{\relax mask} ǻꤵ롢ե졼ХåեƤõ롣 -{\relax color} ϻ꤬СõѤ뿧ꤷľ +{\relax mask} で指定される、フレームバッファの内容を消去する。 +{\relax color} は指定があれば、消去時に用いられる色を設定し直す。 } \methoddesc{:init}{\&key \&allow-other-keys}{ -᥽åɡ +初期化メソッド。 } \methoddesc{:point}{x y}{ -⡼ɤǡ +２次元モードで、点を描く。 } \methoddesc{:line}{x1 y1 x2 y2}{ -⡼ɤǡľ +２次元モードで、直線を描く。 } \methoddesc{:3d-point}{pos}{ -⡼ɤ +３次元モードで点を描く。 } \methoddesc{:3d-line}{start end}{ -⡼ɤľ +３次元モードで直線を描く。 } \methoddesc{:draw-faces}{faces}{ -⡼ɤ̡ʥݥꥴˤ +３次元モードで面（ポリゴン）を描く。 } \methoddesc{:rectangle}{x y w h}{ -⡼ɤǶ +２次元モードで矩形を描く。 } \methoddesc{:draw-point}{p}{ -⡼ɤǡ +２次元モードで、点を描く。 } \methoddesc{:draw-line}{from to}{ -⡼ɤǡľ +２次元モードで、直線を描く。 } \methoddesc{:draw-rectangle}{}{ -⡼ɤǶ +２次元モードで矩形を描く。 } \classdesc{colormaterial}{object}{}{ -ǥΥޥƥꥢѤǡ¤ +モデルのマテリアル指定に用いるデータ構造。 } \funcdesc{gl:draw-face}{face}{ -ݥꥴñ̡̤ǥۡΤʤݥꥴ glVertex3fv\(\) -ơΤޤ롣ǤʤΤ GLU 饤֥ tesselation -ǽѤ롣 +ポリゴンの描画単位。凸でホールのない、ポリゴンは glVertex3fv\(\) を用 +いて、そのまま描かれる。そうでないものは GLU ライブラリの tesselation +機能を用いて描かれる。 } \funcdesc{gl:draw-body}{abody}{ -{\relax body} ñ̡\\ +{\relax body} の描画単位。\\ -{\relax body} ϰ١׵Ȥơ {\relax -body} 礬 OpenGL Display List Ȥ졢ºݤ -θ塢 Display List ƤӽФȤˤ褬Ԥʤ롣\\ +{\relax body} の描画手順は一度、各面毎の描画要求の列として、その {\relax +body} を描く手順が OpenGL の Display List として定義され、実際の描画は +その後、その Display List を呼び出すことにより描画が行なわれる。\\ -Display List εϿ {\relax body} plist attribute {\relax -:GL-DISPLAYLIST-ID} put 롣 +Display List の記録は {\relax body} の plist に attribute {\relax +:GL-DISPLAYLIST-ID} で put される。 } \classdesc{linecolor}{object}{}{ -ľοѤǡ¤ +点、直線の色指定に用いるデータ構造。 } \funcdesc{cls}{}{ -̤򥯥ꥢ롣 +画面をクリアする。 } \funcdesc{swapb}{}{ -֥Хåե⡼ɤΤȤΥХåեåפԤʤ +ダブルバッファ・モードのときのバッファ・スワップを行なう。 } \funcdesc{resetperspective}{}{ -ߤ{\relax \*viewing\*} ֤ФGL Υƥ -ȤȿǤ롣 +現在の{\relax \*viewing\*} から視点、注視点位置を取り出し、GL のコンテキ +ストに反映させる。 } \funcdesc{gldraw}{\&rest things}{ -κ {\relax (resetperspective)} -ե졼ХåեΥꥢ {\relax (cls)} - {\relax (apply \#'draw things)} -֥Хåեθ {\relax (swapb)} -˹ԤʤԤʤ\\ +視点の再設定 {\relax (resetperspective)}、 +フレームバッファのクリア {\relax (cls)}、 +描画 {\relax (apply \#'draw things)}、 +ダブルバッファの交換 {\relax (swapb)} +を順に行ない、シーンの描画を行なう。\\ -things Ϻ鱦˽˽졢Ǥ饹 colormaterial -linecolor Υ󥹥󥹤λϡGL ΥȥƥȤοѹ -롣ʤ(gldraw *color1* *obj1* *color2* *obj2*) Ǥϡ -*obj1* *color1* 졢*obj2* *color2* 롣 +things は左から右に順に処理され、その要素が、クラス colormaterial、 +linecolor のインスタンスの時は、GL のカレントコンテキストの色が変更さ +れる。すなわち、(gldraw *color1* *obj1* *color2* *obj2*) では、 +*obj1* が *color1* で描かれ、*obj2* が *color2* で描かれる。 } -\subsection{ưˡ} -eusgl OpenGL 饤֥ auxglx ѤΤᡢĶѿ -DISPLAYLD\_LIBRARY\_PATH Ŭͤ˥åȤƤɬפ롣aux -饤֥ irix5 ǤϥǥեȤǥ󥹥ȡ뤵Ƥʤ -/usr/share/src/OpenGL ˥ɤۤ -http://www.sgi.com/Technology/openGL/opengl.html ޤ -ftp://sgigate.sgi.com/pub/opengl/ Ǥ롣\\ +\subsection{起動方法} +eusgl は OpenGL の補助ライブラリ aux、glx を用いるのため、環境変数 +DISPLAY、LD\_LIBRARY\_PATH が適当な値にセットされている必要がある。aux +ライブラリは irix5 ではデフォルトでインストールされていないが、 +/usr/share/src/OpenGL 下にソースコードがあるほか、 +http://www.sgi.com/Technology/openGL/opengl.html または +ftp://sgigate.sgi.com/pub/opengl/ 等から取得できる。\\ -Mesa GL 饤֥ѤϡLD\_LIBRARY\_PATH ѹΤ -ǡؤǤ롣ܺ٤ /usr/local/eus/gl/src/README.Mesa 򻲾ȤΤ -ȡMesa GL ϡhttp://www.ssec.wisc.edu/\~brianp/Mesa.html ޤ -ftp://iris.ssec.wisc.edu/pub/Mesa/ Ǥ롣\\ +Mesa GL ライブラリを用いる場合は、LD\_LIBRARY\_PATH の変更のみ +で、切替ができる。詳細は /usr/local/eus/gl/src/README.Mesa を参照のこ +と。Mesa GL は、http://www.ssec.wisc.edu/\~brianp/Mesa.html または +ftp://iris.ssec.wisc.edu/pub/Mesa/ 等から入手できる。\\ -ץ̾ eusgl ȤƵư뤳ȤǡOpenGL ĥǽĤ Euslisp -Ω夬롣\\ +プログラム名 eusgl として起動することで、OpenGL 拡張機能つきの Euslisp +が立ち上がる。\\ -eta3 ޥ˥ԥ졼ץ /usr/local/eus/gl/src/Sample.l -ѰդƤꡢ +eta3 マニピュレータを描くサンプル /usr/local/eus/gl/src/Sample.l が +用意してあり、 \begin{verbatim} eusgl$ (load "/usr/local/eus/gl/src/Sample.l") @@ -152,5 +152,5 @@ \subsection{OpenGL Extensions} eusgl$ (gldraw *scene*) \end{verbatim} -ȤȳɽǤ롣 +等とすると絵が表示できる。 diff --git a/doc/latex/preamble.tex b/doc/latex/preamble.tex new file mode 100644 index 000000000..b21da130f --- /dev/null +++ b/doc/latex/preamble.tex @@ -0,0 +1,67 @@ +\newcommand{\desclist}[1]{ +\begin{list}{ }{\setlength{\rightmargin}{0mm}\topsep=0mm\partopsep=0mm} +\item #1 +\end{list} +\vspace{3mm}} + +\newcommand{\functiondescription}[4]{ +\index{#1} +\textbf{#1} \em #2 \rm \hfill [#3] +%\if#4 \vspace{3mm} \\ \else \desclist{#4} \fi +%\ifx#4 \vspace{3mm} \\ \else \desclist{#4} \fi + \desclist{\hspace{0mm}#4} +} + +\newcommand{\bfx}[1]{\index{#1}{\bf #1}} +\newcommand{\emx}[1]{\index{#1}{\em #1}} + +\newcommand{\longdescription}[4]{ +\index{#2} +\begin{tabbing} +{\bf #2} \rm \hspace{3mm} \= \`[#1] \\ +\> \it #3 +\end{tabbing} +\rm +\desclist{#4} +} + +\newcommand{\funcdesc}[3]{\functiondescription{#1}{#2}{function}{#3}} +\newcommand{\macrodesc}[3]{\functiondescription{#1}{#2}{macro}{#3}} +\newcommand{\specialdesc}[3]{\functiondescription{#1}{#2}{special}{#3}} +\newcommand{\methoddesc}[3]{\functiondescription{#1}{#2}{method}{#3}} +\newcommand{\vardesc}[2]{\functiondescription{#1}{}{variable}{#2}} + +%\newcommand{\fundesc}[2]{\functiondescription{#1}{#2}{function}{ +%}} +%\newcommand{\macdesc}[2]{\functiondescription{#1}{#2}{macro}{ +%}} +%\newcommand{\spedesc}[2]{\functiondescription{#1}{#2}{special}{ +%}} +%\newcommand{\metdesc}[2]{\functiondescription{#1}{#2}{method}{ +%}} +\newcommand{\fundesc}[2]{\functiondescription{#1}{#2}{function}{\hspace{0mm}}} +\newcommand{\macdesc}[2]{\functiondescription{#1}{#2}{macro}{\hspace{0mm}}} +\newcommand{\spedesc}[2]{\functiondescription{#1}{#2}{special}{\hspace{0mm}}} +\newcommand{\metdesc}[2]{\functiondescription{#1}{#2}{method}{\hspace{0mm}}} + +\newcommand{\constdesc}[2]{\functiondescription{#1}{}{constant}{#2}} + +\newcommand{\classdesc}[4]{ %class, super slots description +\vspace{2mm} +\index{#1} +\textbf{\large #1 } \hfill [class] %super +\begin{tabbing} +\hspace{30mm} :super \hspace{5mm} \= \textbf{\ #2} \\ +\hspace{30mm} :slots \> #3 +\end{tabbing} +\vspace{4mm} +\desclist{#4}} + +\newenvironment{refdesc}{ + \vspace{5mm} \parindent=0mm \topsep=0mm \parskip=0mm \leftmargin=10mm}{ + \parindent=10mm \topsep=3mm \parskip=1mm \leftmargin=0mm } + + +%% fix for readthedocs +\renewcommand{\label}[1]{} %% label is not supported on rtd + diff --git a/doc/latex/sequences.tex b/doc/latex/sequences.tex index 38de02b03..bba998b4a 100644 --- a/doc/latex/sequences.tex +++ b/doc/latex/sequences.tex @@ -26,7 +26,7 @@ \subsection{General Sequences} For vectors, {\bf length} finishes in constant time, but time proportional to the length is required for a list. {\bf Length} never terminates if {\em sequence} is a circular list. -Use {\bfx list-length}, instead. +Use \bfx{list-length}, instead. If {\em sequence} is an array with a fill-pointer, {\bf length} returns the fill-pointer, not the entire size of the array entity. Use {\bf array-total-size} to know the entire size of those arrays.} @@ -263,7 +263,7 @@ \subsection{Lists} \funcdesc{first}{list}{ retrieves the first element in {\em list}. -{\bfx second, third, fourth, fifth, sixth, seventh, eighth} are also +\bfx{second, third, fourth, fifth, sixth, seventh, eighth} are als available.} \funcdesc{nth}{count list}{ diff --git a/doc/latex/symbols.tex b/doc/latex/symbols.tex index 17b2a2bdf..98699df6c 100644 --- a/doc/latex/symbols.tex +++ b/doc/latex/symbols.tex @@ -175,13 +175,13 @@ \subsection{Packages} packages are referenced by prefixing the package name and a single colon, as {\tt x:*display*}, while referencing internal symbols in other packages requires double colons, as {\tt sys::free-threads}. -In order to omit this package prefixing, a package may {\bfx import} symbols +In order to omit this package prefixing, a package may \bfx{import} symbols from other packages. -Moreover, {\bfx use-package} allows importing all external symbols +Moreover, \bfx{use-package} allows importing all external symbols from another package at once. When symbols are exported or imported, symbol name conflicts can be detected, since every symbol in any packages must have the unique print name. -{\bfx Shadow} allows creating a symbol with the same print name as the +\bfx{Shadow} allows creating a symbol with the same print name as the existing symbol in a package by virtually removing the old symbol from the package. @@ -205,7 +205,7 @@ \subsection{Packages} and a list of other packages that the package is using. {\bf *Package*} is a special variable that holds the current package for read and print. -If {\bfx *package*} is not {\tt user:}, +If \bfx{*package*} is not {\tt user:}, top-level prompt changes to indicate the current package, like {\tt mypkg:eus}\$. diff --git a/doc/latex/sysfunc.tex b/doc/latex/sysfunc.tex index 0bed56bb8..4e0085e42 100644 --- a/doc/latex/sysfunc.tex +++ b/doc/latex/sysfunc.tex @@ -1151,7 +1151,7 @@ \subsection{Foreign Language Interface} The function defined by {\bf defun-c-callable} can be called from Lisp expressions, too. {\bf Defun-c-callable} returns {\em funcname}. -It looks like a symbol, but it is not, but an instance of {\bfx foreign-pod} +It looks like a symbol, but it is not, but an instance of \bfx{foreign-pod} which is a subclass of symbol.} diff --git a/doc/latex/xwindow.tex b/doc/latex/xwindow.tex index 88a4583b0..f6435b604 100644 --- a/doc/latex/xwindow.tex +++ b/doc/latex/xwindow.tex @@ -387,7 +387,7 @@ \subsection{Xwindow} %%%%%% X W I N D O W \classdesc{Xwindow}{Xdrawable}{(parent subwindows backing-pixmap event-forward)}{ {\bf Xwindow} defines visible rectangular regions of the screen. -It is inherited not only by {\bfx text-window} and {\bf canvas} where +It is inherited not only by \bfx{text-window} and {\bf canvas} where any graphics objects can be drawn, but also by many {\bf panel-items} and {\bf scroll-bars}, which look like graphics objects rather than windows.} @@ -433,7 +433,7 @@ \subsection{Xwindow} :FocusChange, :PropertyChange, :ColormapChange} and {\tt :OwnerGrabButton}. {\tt :Key} enables both {\tt :keyPress} and {\tt :KeyRelease}, and {\tt :button} enables both {\tt :ButtonPress} and {\tt :ButtonRelease}. -When an event is sent from the server, {\bfx window-main-loop} analyzes +When an event is sent from the server, \bfx{window-main-loop} analyzes the event structure and send the {\tt :KeyPress, :KeyRelease, :buttonPress, :ButtonRelease, :EnterNotify, :LeaveNotify, :MotionNotify, :ConfigureNotify} message to the window where the event occurred.} diff --git a/lib/llib/unittest.l b/lib/llib/unittest.l index 28531c06e..e862755df 100644 --- a/lib/llib/unittest.l +++ b/lib/llib/unittest.l @@ -232,19 +232,17 @@ (trace ,name)))) (defmacro assert (pred &optional (message "") &rest args) - (let - ((ret (gensym))) - `(let* (failure (ret ,pred)) - ;; lisp::step could not work with macros.. - ;; (if (and (listp ',pred) (functionp (car ',pred))) - ;; (setq ret (lisp::step ,pred)) - ;; (setq ret ,pred)) - ;; - (if (not ret) - ;; escape <> for xml - (send *unit-test* :increment-failure ',pred (format nil ,message ,@args) - (escape-xml-string (subseq (send *error-output* :buffer) 0 (or (position 0 (send *error-output* :buffer)) (length (send *error-output* :buffer))))))) - ))) + `(let (failure (ret ,pred)) + ;; lisp::step could not work with macros.. + ;; (if (and (listp ',pred) (functionp (car ',pred))) + ;; (setq ret (lisp::step ,pred)) + ;; (setq ret ,pred)) + ;; + (if (not ret) + ;; escape <> for xml + (send *unit-test* :increment-failure ',pred (format nil ,message ,@args) + (escape-xml-string (subseq (send *error-output* :buffer) 0 (or (position 0 (send *error-output* :buffer)) (length (send *error-output* :buffer))))))) + )) t)) diff --git a/lisp/c/lispio.c b/lisp/c/lispio.c index 211bd150a..91d87f793 100644 --- a/lisp/c/lispio.c +++ b/lisp/c/lispio.c @@ -491,10 +491,11 @@ pointer argv[]; if (islower(cch)) cch=toupper(cch);} switch(cch) { case 'A': /*Ascii*/ + a=nextfarg(); osf=ctx->slashflag; ctx->slashflag=1; written_count[thr_self()]=0; - prinx(ctx,(pointer)nextfarg(),dest); + prinx(ctx,a,dest); while (param[0]>written_count[thr_self()]) writech(dest,' '); ctx->slashflag=osf; break; diff --git a/lisp/l/eusstart.l b/lisp/l/eusstart.l index b5a746b1e..05db22c1d 100644 --- a/lisp/l/eusstart.l +++ b/lisp/l/eusstart.l @@ -35,7 +35,7 @@ ;; LEO (export '(self class)) ;; classnames, variable names are exported by 'basicclass' - (export '(string float-vector interger-vector bit-vector)) + (export '(string float-vector integer-vector bit-vector)) ;; feature constants (export '(vax sun apollo mips sun3 sun4 news sanyo bsd4_2 sunos4 sunos4.1 system5 coff alpha thread)) diff --git a/lisp/l/exports.l b/lisp/l/exports.l index e2c01de3d..85ca4fbb3 100644 --- a/lisp/l/exports.l +++ b/lisp/l/exports.l @@ -32,7 +32,7 @@ ;; LEO (export '(self class)) ;; classnames, variable names are exported by 'basicclass' - (export '(string float-vector interger-vector bit-vector)) + (export '(string float-vector integer-vector bit-vector)) ;; feature constants (export '(vax sun apollo mips sun3 sun4 news sanyo bsd4_2 sunos4 sunos4.1 system5 coff alpha thread)) diff --git a/test/print-length.l b/test/print-length.l new file mode 100644 index 000000000..cf3dcd6d5 --- /dev/null +++ b/test/print-length.l @@ -0,0 +1,164 @@ +(require :unittest "lib/llib/unittest.l") + +(init-unit-test) + +;; extended from `ansi-test' example +;; https://gitlab.common-lisp.net/ansi-test/ansi-test + +(defmacro print-test (form result &rest bindings) + `(let ,bindings + (assert + (string= + (prin1-to-string ,form) + ,result)))) + + +;; LISTS + +(deftest print-length-list.1 () + (let ((x '(|A| |B| |C| |D| |E| |F|)) + (res (list + "(...)" + "(A ...)" + "(A B ...)" + "(A B C ...)" + "(A B C D ...)" + "(A B C D E ...)" + "(A B C D E F)" + "(A B C D E F)" + "(A B C D E F)"))) + (let ((*print-case* :upcase) + (*print-length* nil)) + (dotimes (i 9) + (print-test x (pop res) (*print-length* i)))))) + +(deftest print-length-list.2 () + (let ((seq (make-list 100000 :initial-element 0)) + (*print-length* nil)) + (assert + (equal seq (read-from-string (prin1-to-string seq)))))) + +(deftest print-length-list.3 () + (print-test '(1) "(1)" (*print-length* nil))) + +(deftest print-length-list.4 () + (print-test '(1 . 2) "(1 . 2)" (*print-length* 1))) + +(deftest print-length-list.5 () + (print-test '(1) "(1)" (*print-length* (1+ most-positive-fixnum)))) + + +;; VECTORS + +(deftest print-length-vector.1 () + (let ((x #(|A| |B| |C| |D| |E| |F|)) + (res (list + "#(...)" + "#(A ...)" + "#(A B ...)" + "#(A B C ...)" + "#(A B C D ...)" + "#(A B C D E ...)" + "#(A B C D E F)" + "#(A B C D E F)" + "#(A B C D E F)"))) + (let ((*print-case* :upcase) + (*print-length* nil)) + (dotimes (i 9) + (print-test x (pop res) (*print-length* i)))))) + +(deftest print-length-vector.2 () + (let ((seq (make-array 100000 :initial-element 0)) + (*print-length* nil)) + (assert + (equal seq (read-from-string (prin1-to-string seq)))))) + + +;; FLOAT VECTORS + +(deftest print-length-float-vector.1 () + (let ((x #f(1 2 3 4 5 6)) + (res (list + "#f(...)" + "#f(1.0 ...)" + "#f(1.0 2.0 ...)" + "#f(1.0 2.0 3.0 ...)" + "#f(1.0 2.0 3.0 4.0 ...)" + "#f(1.0 2.0 3.0 4.0 5.0 ...)" + "#f(1.0 2.0 3.0 4.0 5.0 6.0)" + "#f(1.0 2.0 3.0 4.0 5.0 6.0)" + "#f(1.0 2.0 3.0 4.0 5.0 6.0)"))) + (let (*print-length*) + (dotimes (i 9) + (print-test x (pop res) (*print-length* i)))))) + +(deftest print-length-float-vector.2 () + (let ((seq (make-array 100000 :element-type float-vector)) + (*print-length* nil)) + (assert + (equal seq (read-from-string (prin1-to-string seq)))))) + + +;; INTEGER VECTORS + +(deftest print-length-integer-vector.1 () + (let ((x #i(1 2 3 4 5 6)) + (res (list + "#i(...)" + "#i(1 ...)" + "#i(1 2 ...)" + "#i(1 2 3 ...)" + "#i(1 2 3 4 ...)" + "#i(1 2 3 4 5 ...)" + "#i(1 2 3 4 5 6)" + "#i(1 2 3 4 5 6)" + "#i(1 2 3 4 5 6)"))) + (let (*print-length*) + (dotimes (i 9) + (print-test x (pop res) (*print-length* i)))))) + +(deftest print-length-integer-vector.2 () + (let ((seq (make-array 100000 :element-type integer-vector)) + (*print-length* nil)) + (assert + (equal seq (read-from-string (prin1-to-string seq)))))) + + +;; BIT VECTORS +(deftest print-length-bitvector.1 () + (print-test #*00110101100011 "#*00110101100011" (*print-length* 0))) + + +;; STRUCTURES + +(defstruct print-length-struct foo) + +(deftest print-length-structure.1 + (let ((*print-case* :upcase) + (*print-structure* t) + (s (instantiate print-length-struct)) + acc) + (send s :set-val 'foo 17) + (dotimes (i 5) + (let ((*print-length* i)) + (push (prin1-to-string s) acc))) + (assert + (member (nreverse acc) + '(("#s(...)" + "#s(PRINT-LENGTH-STRUCT ...)" + "#s(PRINT-LENGTH-STRUCT FOO ...)" + "#s(PRINT-LENGTH-STRUCT FOO 17)" + "#s(PRINT-LENGTH-STRUCT FOO 17)") + ("#s(PRINT-LENGTH-STRUCT ...)" + "#s(PRINT-LENGTH-STRUCT FOO 17)" + "#s(PRINT-LENGTH-STRUCT FOO 17)" + "#s(PRINT-LENGTH-STRUCT FOO 17)" + "#s(PRINT-LENGTH-STRUCT FOO 17)")) + :test 'equal)))) + + +;; RUN TESTS + +(eval-when (load eval) + (run-all-tests) + (exit))