aboutsummaryrefslogtreecommitdiff
path: root/src/algebra/system.spad.pamphlet
blob: e2ba788de4f7afac6c9b546f879e0eef5e7dde48 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
\documentclass{article}
\usepackage{open-axiom}

\title{\$SPAD/src/algebra system.spad}
\author{Gabriel Dos~Reis \and Timothy Daly}

\begin{document}
\maketitle

\begin{abstract}
\end{abstract}
\tableofcontents
\eject

\section{package SYSTEM System}
<<package SYSTEM System>>=
)abbrev package SYSTEM System
++ Author: Gabriel Dos Reis
++ Date Created: April 2, 2008.
++ Date Last Modified: February 6, 2009.
++ Related Constructors:
++ Description:
++   The package \spadtype{System} provides information about 
++   the runtime system and its characteristics.
System(): Public == Private where
  Public == Type with
    rootDirectory: () -> String
      ++ rootDirectory() returns the pathname of the root directory
      ++ for the running OpenAxiom system.
    hostPlatform: String
      ++ \spad{hostPlatform} is a string `triplet' description 
      ++ of the platform hosting the running OpenAxiom system.
    hostByteOrder: ByteOrder
      ++ \sapd{hostByteOrder}
    nativeModuleExtension: String
      ++ \spad{nativeModuleExtension} is a string representation
      ++ of a filename extension for native modules.
    loadNativeModule: String -> Void
      ++ loadNativeModule(path) loads the native modile designated
      ++ by \spadvar{path}.

  Private == add
    rootDirectory() ==
      systemRootDirectory()$Lisp

    hostPlatform ==
      _$hostPlatform$Lisp

    hostByteOrder == %hostByteOrder()$Lisp

    nativeModuleExtension ==
      _$NativeModuleExt$Lisp

    loadNativeModule(path) ==
      loadNativeModule(path)$Lisp
      
@

\section{package MSYSCMD MoreSystemCommands}

<<package MSYSCMD MoreSystemCommands>>=
import Void
import String
)abbrev package MSYSCMD MoreSystemCommands
++ Author:
++ Date Created:
++ Change History:
++ Basic Operations: systemCommand
++ Related Constructors:
++ Also See:
++ AMS Classification:
++ Keywords: command
++ Description:
++   \spadtype{MoreSystemCommands} implements an interface with the
++   system command facility. These are the commands that are issued
++   from source files or the system interpreter and they start with
++   a close parenthesis, e.g., \spadsyscom{what} commands.
 
MoreSystemCommands: public == private where
 
  public == with
 
    systemCommand: String -> Void
      ++ systemCommand(cmd) takes the string \spadvar{cmd} and passes
      ++ it to the runtime environment for execution as a system
      ++ command. Although various things may be printed, no usable
      ++ value is returned.
 
  private == add
 
    systemCommand cmd == doSystemCommand(cmd)$Lisp

@

\section{License}

<<license>>=
--Copyright (c) 1991-2002, The Numerical ALgorithms Group Ltd.
--All rights reserved.
--
--Redistribution and use in source and binary forms, with or without
--modification, are permitted provided that the following conditions are
--met:
--
--    - Redistributions of source code must retain the above copyright
--      notice, this list of conditions and the following disclaimer.
--
--    - Redistributions in binary form must reproduce the above copyright
--      notice, this list of conditions and the following disclaimer in
--      the documentation and/or other materials provided with the
--      distribution.
--
--    - Neither the name of The Numerical ALgorithms Group Ltd. nor the
--      names of its contributors may be used to endorse or promote products
--      derived from this software without specific prior written permission.
--
--THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
--IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
--TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
--PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
--OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
--EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
--PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
--PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
--LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
--NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
--SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@
<<*>>=
<<license>>
 
<<package MSYSCMD MoreSystemCommands>>
@
\eject
\begin{thebibliography}{99}
\bibitem{1} nothing
\end{thebibliography}
\end{document}