[Home]
[
prev
] [
up
] [
next
] ((myalps.tex))
Contents
1
To Do
2
Preface
3
Introduction
4
Overview of the
M
y
A
l
p
s
Files
4.1
The include Subdirectory
4.2
The src Subdirectory
4.3
The test Subdirectory
5
Overview of
ALLPROSE
(Version 0.2.6)
5.1
Features of
ALLPROSE
5.2
Deficiencies of
ALLPROSE
5.3
Future of
ALLPROSE
5.4
The Main Compilation Commands
5.5
ALLPROSE
Files
6
How to Start a New Project with
ALLPROSE
7
How to Build Executables
8
How to Document the
A
l
d
o
r
Sources
9
How to Setup all Features of
ALLPROSE
9.1
Installing
GMP
9.2
Installing
E
x
t
IO
and
A
l
d
o
r
U
n
i
t
9.3
Setup
E
m
a
c
s
9.3.1
Setup
a
l
d
o
r
-
m
o
d
e
for
E
m
a
c
s
9.3.2
Setup
m
m
m
-
m
o
d
e
for
E
m
a
c
s
9.3.3
Error Search After a Failed Compilation
10
How to Upgrade
ALLPROSE
11
How to Document the
ALLPROSE
Project Itself
12
Meta-
ALLPROSE
13
License
14
L
A
T
E
X
Style Customization
14.1
Commands for Common
M
y
A
l
p
s
Names
15
User Customization of the Build Process
15.1
Information about the Project
15.2
Variants of the Libraries
15.3
Adding New Directories
16
Common
A
l
d
o
r
Include File for
M
y
A
l
p
s
16.1
Global Macros
16.2
Support for Tracing Domain Instantiations
16.3
Loading the
M
y
A
l
p
s
Library
17
MyVersionInformationType
18
MyPrimitiveType
19
MyCopyableType
20
MyAdditiveType
21
MyArithmeticType
22
MyBinaryPowering
23
TestMyBinaryPowering
24
The
ALLPROSE
L
A
T
E
X
Style File
24.1
Check for allprose.tex
24.2
Show PROJECTROOT
24.3
Packages to Load
24.3.1
The noweb Package
24.3.2
Colored Background—the
f
r
a
m
e
d
Package
24.3.3
The
a
l
d
o
r
d
o
c
Package
24.3.4
The hyperref and
r
h
x
t
e
r
m
Packages
24.3.5
The url Package
24.3.6
The verbatim Package
24.3.7
The makeidx Package
24.3.8
Mathematics Related Commands
24.3.9
The optional
s
r
c
l
t
x
Package
24.4
Header and Footer
24.5
Treatment of Source Files
24.6
Treatment of Generated Files
24.7
Shaded Code Area
24.8
Show Exports
24.9
Commands for Common Names
24.10
Miscellaneous Commands
24.10.1
Sequential Environments
24.10.2
The ToDo environment
24.10.3
The Convention environment
24.11
Include User Defined Styles
24.12
Local Modifications
24.13
Known Styles in
ALLPROSE
24.13.1
Text Styles
24.13.2
Background Colors
25
The
A
l
d
o
r
D
o
c
L
A
T
E
X
Style File
25.1
Structured
A
l
d
o
r
Documentation
25.2
User Interface
25.2.1
The
a
l
d
o
r
d
o
c
Section adusage
25.2.2
The
a
l
d
o
r
d
o
c
Section adparameters
25.2.3
The
a
l
d
o
r
d
o
c
Section addescription
25.2.4
The
a
l
d
o
r
d
o
c
Section adexceptions
25.2.5
The
a
l
d
o
r
d
o
c
Section adremarks
25.2.6
The
a
l
d
o
r
d
o
c
Section adseealso
25.2.7
The
∖
adtype command
25.2.8
The
∖
adname command
25.2.9
The
∖
adthistype and
∖
adthisname commands
25.2.10
The adsnippet environment and the
∖
adcode command
25.2.11
The Code Font
25.3
Extended User Interface
25.3.1
The
∖
addescribetype and
∖
addefinetype commands
25.3.2
The
∖
addefinename command
25.3.3
The
∖
admacro and
∖
adassertion commands
25.4
Implementation Details of
a
l
d
o
r
d
o
c
25.4.1
∖
addefinename to
∖
adinternaldefinename
25.4.2
∖
adname to
∖
adinternalusename
25.4.3
∖
adparameter to
∖
adinternalparameter
25.4.4
∖
adcode to
∖
verb
25.5
A
l
d
o
r
Pre- and Post-Description
26
Helper Script for the
A
l
d
o
r
D
o
c
L
A
T
E
X
Style File
26.1
The Special Cases
26.2
The Top-level Translation Functions
26.3
Translation of
a
l
d
o
r
d
o
c
Interface-Only Commands
26.4
Translation of
a
l
d
o
r
d
o
c
Active Commands
26.5
Split on Opening and Closing Regular Expression
26.6
Translate
∖
adname and
∖
addefinename Parameters
26.7
Escape String for Hyperref
26.8
Escape String for Makeindex
26.9
Escape String for
L
A
T
E
X
26.10
Putting Everything Together
27
Generation of HTML Code via TeX4HT
27.1
Background Colors in HTML
27.2
Crosslinks in Header and Footer
27.3
Table of Contents per Section
27.4
ProblemFix: Disabling Links and Index Generation
27.4.1
Disabling Hyperlinks Inside the Table of Contents
27.4.2
Disabling Hyperlinks in the Index
27.5
ProblemFix:
∖
xnamedef
27.6
BugFix:
srcltx.4ht
27.7
BugFix: Index
28
Top-level Makefile
28.1
Necessary Programs
28.2
Files and Directories
28.3
The Default Target
28.4
The Top-Level Targets
28.5
The Interactive Loop
28.6
Installation and Uninstallation
28.7
Generation and Inclusion of Makefile.def
28.8
Generation and Inclusion of Makefile.inc
28.9
Documentation
28.9.1
Documentation Generation
28.9.2
L
A
T
E
X
Files Generation
28.9.3
Compilation of
L
A
T
E
X
Files
28.10
Local Customization
28.10.1
Customizing Paper/Screen Sizes
28.10.2
Customizing Colors
28.10.3
Include
ALLPROSE
Documentation
28.10.4
Show the PROJECTROOT on the First Page
28.10.5
Turning Inverse Search Off
28.10.6
Customizing Code Chunks
28.10.7
Undoing Customizations
28.11
Cleaning up
28.12
Upgrading
ALLPROSE
28.13
Producing an
ALLPROSE
Release Distribution
28.13.1
Check Proper Compilation
28.13.2
Collect Distribution Files
28.13.3
Release Date
28.13.4
Build an Archive
28.14
Producing a Release Distribution of the Project Files
28.15
Debugging the
ALLPROSE
Building Process
29
Common Targets for All Makefiles
29.1
External Variables
29.2
List of Needed Programs
29.2.1
The
A
l
d
o
r
Compiler
29.2.2
N
o
w
e
b
and
P
e
r
l
29.2.3
Common UNIX Programs
29.2.4
The
L
A
T
E
X
Environment
29.3
Recursive Execution of Make
29.4
Source Code Extraction
29.5
Documentation Extraction
29.6
Undocumented Files
29.7
Building the Libraries
29.7.1
A
l
d
o
r
Compiler Flags
29.7.2
Building the Variants of the Library
29.8
Building Executables
29.8.1
A
l
d
o
r
Compiler Flags
29.8.2
Building the Variants of the Executables
30
Workaround for
N
o
w
e
b
Bug
31
Makefile for the Directory
tools
32
Makefile for the Directory
include
33
Makefile for the Directory
src
33.1
Building the Project Library Variants
33.2
Documentation Generation
33.3
Code File Generation
33.4
Interdependencies of the
A
l
d
o
r
Source Files
33.4.1
src/asfiles.list
33.4.2
src/Makefile.dep
34
TEX File Filter: Add Type Information
35
Code File Filter: Add
+++
description
36
Embelish Domain Exports with Short Descriptions
37
Generation of List of
.as
Files
38
Compute Dependencies Between
A
l
d
o
r
Source Files
38.1
Extract Constructor Definitions and Uses
38.2
Build a Dependency Graph without Extensions
38.3
Add Extensions to the Dependency Graph
38.4
Saturate Dependencies
38.5
Make Minimal Dependencies
38.6
Write Dependencies to STDOUT
39
Warn About Undocumented Files
40
Remove Non-API Text
41
Makefile for the Directory
test
41.1
Building the TestCases Library Variants
41.2
Documentation Generation
41.3
Code File Generation For Tests
41.4
Interdependencies of the
A
l
d
o
r
Source Files
41.4.1
test/tcasfiles.list
41.4.2
test/Makefile.dep
41.4.3
Dependence on Signature Files
41.5
The TestSuite Executable
42
Generate the Common Include File for the Test Cases
43
Generate The TestSuite Source File
43.1
Read Test Cases
43.2
Write TestSuite
43.3
test/TestSuite.as
[Home]
[
prev
] [
up
] [
next
] ((myalps.tex))