library.nbk
Home
A growing number of optional extensions to Toka are provided in the Library. This guide will attempt to document the stable libraries and show examples of their use.
- License
- Building and Installation
- AssociativeArrayLibrary
- BubbleSortLibrary
- CaseLibrary
- CGILibrary
- ConditionalsLibrary
- ConsoleLibrary
- CTypeLibrary
- EnumLibrary
- FloatsLibrary
- HelpDBLibrary
- MathLibrary
- QuotesLibrary
- ReadlineLibrary
- RegexLibrary
- SDLLibrary
- ShellLibrary
- SocketsLibrary
- StringsLibrary
- TextEditLibrary
AssociativeArrayLibrary
To include: needs asarray
This library provides support for associative arrays (where the index is a string) to Toka.
Provides:
is-asarray ( n"- ) Allocate space for the array (n bytes),
parsing for the name to use.
asarray.get ( ia-n ) Fetch value 'n' from array 'a' at index 'i'
asarray.put ( nia- ) Put value 'n' into array 'a' at index 'i'
BubbleSortLibrary
To include: needs bsort
This library provides the bubble sort algorithim for sorting the content of arrays.
Provides:
bsort ( an- ) Sort the first 'n' elements of array 'a'
Building and Installation
To build the library, you will need:
- GCC (4.x recommended, 2.9x or 3.x should also work)
- Make (GNU Make is recommended)
Optionally:
- libSDL
- GNU Readline
Building, installation, and removal of the library is done via a single Makefile. Run make with one of the following targets:
make install Build and install all libraries to /usr/share/toka/library
make remove Remove all libraries installed to /usr/share/toka/library
make clean Cleanup temporary files created during editing or build process.
CaseLibrary
To include: needs case
This library provides basic functionality for a switch/case style construct for both numbers and strings.
Provides:
<default> ( -n ) Data element, flag to determine whether or not to
invoke the default case.
<cond> ( -n ) Data element, stores the value to check against
switch ( n- ) Store the value to check into <cond>
string-case ( $q- ) Compare string '$' to string in <cond>; invoke
quote 'q' if they are identical.
case ( nq- ) If 'n' matches the value in <cond>, invoke quote 'q'
default ( q- ) If no matching 'case' contains a 'break', invoke
quote 'q'
break ( - ) Flag <default> to indicate that a match was found
Example:
needs case [ switch 1 [ ." One!\n" ] case 2 [ ." Two!\n" ] case 3 [ ." Three!\n" ] case 4 [ ." Four!\n" ] case 5 [ ." Five!\n" ] case ] is try ." Inputs are: 1 3 5 2 5 4\n" 1 try 3 try 5 try 2 try 5 try 4 try
CGILibrary
To include: needs cgi
This library provides support for writing CGI applications in Toka.
Provides:
cgiSetHeader ( ab-n ) Set additional HTTP header lines to be sent
with cgiHeader. 'a' = name, 'b' = value
cgiSetType ( $-n ) Set the result type for HTTP. $ = type.
cgiHeader ( -n ) Print a valid CGI header for HTTP
cgiInit ( -n ) Read in all variables set via POST or stdin and
any HTTP cookies. Returns an s_cgi
structure.
cgiGetValue ( sn-a ) Return the value of a specified variable or
NULL if it doesn't exist. 's' is an s_cgi
struct, and 'n' is the name of the variable.
cgiGetVariables ( s-n ) Return the names of all variables
cgiRedirect ( $-n ) Provide a valid redirect for web pages. $ = url
cgiGetCookie ( sn-a ) Get the cookie specified or NULL if it
doesn't exist.
cgiGetCookies ( s-n ) Get the names of all cookies.
cgiFreeList ( x-n ) Free the lists returned by cgiGetVariables
and cgiGetCookies
cgiFree ( s-n ) Free the s_cgi structure.
This library is released under the GPL Version 2. The copyright block follows:
Copyright (c) 1996-9 Martin Schulze <joey@infodrom.north.de>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
ConditionalsLibrary
To include: needs conditionals
This library provides additional conditionals to help with comparisions.
>= ( xy-f ) Return TRUE if x greater than or equal to y. FALSE otherwise. <= ( xy-f ) Return TRUE if x less than or equal to y. FALSE otherwise. >!= ( xy-f ) Return TRUE if x greater than or not equal to y. FALSE otherwise. <!= ( xy-f ) Return TRUE if x less than or not equal to y. FALSE otherwise.
ConsoleLibrary
To include: needs console
The console library provides a number of functions to make developing ANSI/VT100 compatible console applications easier.
console_init ( -n ) Initialize the console subsystem to key breaking mode
console_cleanup ( -n ) Reset the console subsystem to the OS default
getkey ( -n ) Read a key and return a single key value code
getchar ( -n ) Read a single character from the keyboard;
special keys may return multiple character
codes.
console_dimensions ( -xy ) Return the number of rows and columns in
the console or console emulator.
xy ( xy- ) Set the cursor to x, y
home ( - ) Reset the cursor to the top left corner
Onscreen colors can be set using the following functions:
normal ( - ) VT100: Set the colors back to the default bold ( - ) VT100: Set the bold attribute for the foreground color black ( - ) VT100: Set the foreground color to black red ( - ) VT100: Set the foreground color to red green ( - ) VT100: Set the foreground color to green yellow ( - ) VT100: Set the foreground color to yellow blue ( - ) VT100: Set the foreground color to blue magenta ( - ) VT100: Set the foreground color to magenta cyan ( - ) VT100: Set the foreground color to cyan white ( - ) VT100: Set the foreground color to white onBlack ( - ) VT100: Set the background color to black onRed ( - ) VT100: Set the background color to red onGreen ( - ) VT100: Set the background color to green onYellow ( - ) VT100: Set the background color to yellow onBlue ( - ) VT100: Set the background color to blue onMagenta( - ) VT100: Set the background color to magenta onCyan ( - ) VT100: Set the background color to cyan onWhite ( - ) VT100: Set the background color to white
Some keys have special constants (these should be self documenting:
K_ESC K_BS K_UP K_DOWN K_LEFT K_RIGHT K_HOME K_INS K_DEL K_PGUP K_PGDN K_F1 K_F2 K_F3 K_F4 K_F5 K_F6 K_F7 K_F9 K_F10 K_F11 K_F12
CTypeLibrary
To include: needs ctype
This library provides functionality from ctype.h in C.
isalnum ( a-b ) alphanumeric character test isalpha ( a-b ) alphabetic character test isascii ( a-b ) test for ASCII character iscntrl ( a-b ) control character test isdigit ( a-b ) decimal-digit character test isgraph ( a-b ) printing character test (space character exclusive) islower ( a-b ) lower-case character test isprint ( a-b ) printing character test (space character inclusive) ispunct ( a-b ) punctuation character test isspace ( a-b ) white-space character test isupper ( a-b ) upper-case character test isxdigit ( a-b ) hexadecimal-digit character test toascii ( a-b ) convert a byte to 7-bit ASCII tolower ( a-b ) upper case to lower case letter conversion toupper ( a-b ) lower case to upper case letter conversion
EnumLibrary
To include: needs enum
This library adds basic support for enumerated constants to Toka.
enum ( n"- ) Parse ahead and create constants, starting with a
value of 'n' and increasing by one for each new
constant created.
An example:
1 enum| a b c d | a . b . c . d .
FloatsLibrary
To include: needs floats
This library adds support for floating point numbers and math. As with many Forth implementations, it provides a separate stack for floating point numbers, and alternative versions of the main stack and math words.
float: ( "-n ) Parse ahead for a new floating point
number
fvariable ( "- ) Create a new floating-point variable
f@ ( a-n ) Fetch the value in memory location 'a'
f! ( na- ) Store 'n' to memory location 'a'
fdup ( n-nn ) Duplicate the TOS
fdrop ( n- ) Drop the TOS
fswap ( ab-ba ) Exchange the TOS and NOS
fdepth ( -n ) Return the number of items on the stack
fnip ( xy-y ) Remove the second item on the stack
frot ( abc-bca ) Rotate top three values on stack
f-rot ( abc-acb ) Rotate top three values on stack twice
fover ( xy-xyx ) Put a copy of NOS above the TOS
ftuck ( xy-yxy ) Put a copy of TOS under NOS
f2dup ( xy-xyxy ) Duplicate the top two items on the stack
f2drop ( xy- ) Drop TOS and NOS
freset ( *- ) Drop all items on the stack
f+ ( ab-c ) Add TOS and NOS
f- ( ab-c ) Subtract TOS from NOS
f* ( ab-c ) Multiply TOS by NOS
f/ ( ab-c ) Divide and get remainder
:fstack ( - ) Display all items on the float stack
f. ( n- ) Display the top item on the float stack
f= ( ab-f ) Compare two floats
f< ( ab-f ) Compare two floats
f> ( ab-f ) Compare two floats
f<> ( ab-f ) Compare two floats
>float ( data:n -- float:n ) Convert number 'n' to a float
float> ( float:n -- data:n ) Convert float 'n' to a normal integer
fvalue ( "- ) Create a new "value"
fto ( - ) Toggle values to set their value
Example
needs floats float: 100 float: 200.12 f+ f. fvalue kilometer 1.609344 fto kilometer kilometer f.
GPL Version 2
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.
HelpDBLibrary
To include: needs helpdb
This library adds the core support for a basic help database.
It is intended to be used as part of larger applications and not by itself.
document: ( $"- ) Add documentation ($) for a key (")
:getHelp ( $-$ ) Get documentation string for a key.
:dumpAllHelp ( - ) Display all keys and their docstrings.
Example
" This does nothing" document: foo " foo" :getHelp type cr
Index
- AssociativeArrayLibrary (09/15/2007 17:23:38)
- BubbleSortLibrary (09/16/2007 15:00:37)
- Building and Installation (09/07/2007 10:30:47)
- CaseLibrary (09/07/2007 10:41:38)
- CGILibrary (09/14/2007 08:30:47)
- ConditionalsLibrary (09/07/2007 10:25:29)
- ConsoleLibrary (09/07/2007 10:23:25)
- CTypeLibrary (09/11/2007 12:28:07)
- EnumLibrary (09/13/2007 16:55:26)
- FloatsLibrary (09/07/2007 10:07:35)
- GPL Version 2 (09/14/2007 08:30:26)
- HelpDBLibrary (09/07/2007 10:28:40)
- Home (09/16/2007 14:59:03)
- Index (07/13/2002 14:58:54)
- License (09/14/2007 08:30:16)
- MathLibrary (09/07/2007 10:44:25)
- QuotesLibrary (09/07/2007 10:09:21)
- ReadlineLibrary (09/07/2007 10:45:52)
- Recent Changes (07/13/2002 14:41:15)
- RegexLibrary (09/07/2007 10:48:19)
- SDLLibrary (09/07/2007 10:59:32)
- Search (03/29/2007 21:18:59)
- ShellLibrary (09/07/2007 10:33:23)
- SocketsLibrary (09/07/2007 22:52:56)
- StringsLibrary (09/16/2007 15:09:33)
- TextEditLibrary (09/07/2007 10:36:21)
- User Code (09/07/2007 22:52:36)
27 Pages
License
Most of the libraries included are under the following license:
Copyright (c) 2006, 2007, Charles R. Childers <charles.childers@gmail.com> Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Some are under other licenses. These are marked in the source and documentation for the specific libraries.
MathLibrary
To include: needs math
This library extends the core math functionality of Toka in minor ways.
The provided API follows:
abs ( n-n ) Returns the absolute value of 'n' random ( -n ) Returns a random number srandom ( s-x ) Set a new seed for the random number generator ^ ( xy-z ) Returns x^y power sqrt ( x-y ) Returns the square root of x
QuotesLibrary
To include: needs quotes
This library provides a set of words for using quotes in new ways.
apply ( ab-... ) Evaluate quote 'a' and apply quote 'b' to each item left on the stack by 'a'. '...' is the result. fix? ( ...-... ) Use this with apply to keep the stack balanced as necessary. [[ ( - ) Turn the compiler off, but does not close the current quote. ]] ( - ) Turn the compiler back on; does not start a new quote. within ( abc-f ) Check to see if 'c' is between 'a' and 'b' in size range ( ab-... ) Generate a sequence of numbers starting with 'a' and ending with 'b'
Examples:
1 7 range [ fix? + ] apply .
ReadlineLibrary
To include: needs readline
This library provides basic access to the GNU readline library.
readline ( -$ ) Read a line of text into a dynamically allocated
buffer.
Recent Changes
- StringsLibrary (09/16/2007 15:09:33)
- BubbleSortLibrary (09/16/2007 15:00:37)
- Home (09/16/2007 14:59:03)
- AssociativeArrayLibrary (09/15/2007 17:23:38)
- CGILibrary (09/14/2007 08:30:47)
- GPL Version 2 (09/14/2007 08:30:26)
- License (09/14/2007 08:30:16)
- EnumLibrary (09/13/2007 16:55:26)
- CTypeLibrary (09/11/2007 12:28:07)
- SocketsLibrary (09/07/2007 22:52:56)
- User Code (09/07/2007 22:52:36)
- SDLLibrary (09/07/2007 10:59:32)
- RegexLibrary (09/07/2007 10:48:19)
- ReadlineLibrary (09/07/2007 10:45:52)
- MathLibrary (09/07/2007 10:44:25)
- CaseLibrary (09/07/2007 10:41:38)
- TextEditLibrary (09/07/2007 10:36:21)
- ShellLibrary (09/07/2007 10:33:23)
- Building and Installation (09/07/2007 10:30:47)
- HelpDBLibrary (09/07/2007 10:28:40)
- ConditionalsLibrary (09/07/2007 10:25:29)
- ConsoleLibrary (09/07/2007 10:23:25)
- QuotesLibrary (09/07/2007 10:09:21)
- FloatsLibrary (09/07/2007 10:07:35)
- Search (03/29/2007 21:18:59)
- Index (07/13/2002 14:58:54)
- Recent Changes (07/13/2002 14:41:15)
27 Pages
RegexLibrary
To include: needs regex
This library provides support for traditional POSIX-style regular expression matching.
Imports from the standard C library:
- regcomp
- regexec
- regerror
- regfree
Wrapper functions:
regex: ( $"- ) Create a regular expression from string ($), assign a
name (") from the input stream.
try-regex ( r$na-f ) Run an expression (named 'r') against a string
($), with a maximum of 'n' matches, storing
results in array 'a'. Returns a flag.
Example:
needs regex 2 cells is-array pmatch " This is a test: Hello, World!" is-data test1 " This is a test: Goodbye, World!" is-data test2 " [Hh]ello" regex: preg ." Test 1: Search for [Hh]ello in: " test1 type cr preg test1 2 pmatch try-regex [ 0 pmatch array.get test1 + type cr ] [ ." No match found\n" ] ifTrueFalse ." Test 2: Search for [Hh]ello in: " test2 type cr preg test2 2 pmatch try-regex [ 0 pmatch array.get test2 + type cr ] [ ." No match found\n" ] ifTrueFalse
SDLLibrary
To include: needs sdl
Toka has a wrapper over the raw SDL library that allows for use of SDL drawing and events.
Primitive SDL functions:
SDL_Quit ( -n ) SDL_Delay ( n-n ) SDL_GetTicks ( -n ) SDL_PollEvent ( e-n ) SDL_WaitEvent ( e-n )
Higher-level wrappers:
sdl_setup ( hw- ) Create a new surface and open a drawing window
for it.
sdl_render ( - ) Render the scene to the drawing surface.
sdl_surface_size ( -n ) Return the size of the drawing surface.
sdl_event_size ( -n ) Return the size of an event structure.
<b>malloc</b> this and assign a name to
create an event structure for
<b>SDL_PollEvent</b> or <b>SDL_WaitEvent</b>.
sdl_event_type ( e-t ) Return a value corresponding to the type of
event which happened.
putpixel ( xyc- ) Draw a single pixel on the screen.
circle ( xyrc- ) Draw a hollow circle on the screen.
aline ( xyadc- ) Draw a line starting at x,y and extending
out 'd' distance at a specified angle 'a'.
hline ( xylc- ) Draw a horizontal line starting at x,y and
extending 'l' length.
vline ( xylc- ) Draw a vertical line starting at x,y and
extending 'l' length.
line ( x1 y1 x2 y2 color -- )
Draw a line starting at x1,y1 and ending at x2,y2
box ( x1 y2 x2 y2 color -- )
Draw a hollow rectangle.
get-mouse-coords ( e-xy ) Get the x,y coordinates of the mouse (for
mouse events)
get-keysym ( e-k ) Get the value of the key that was pressed
(for keyboard events)
rgb: ( $-v ) Parse ahead and build a color code from
the RRGGBB hex string that follows.
Search
- AssociativeArrayLibrary (09/15/2007 17:23:38)
- BubbleSortLibrary (09/16/2007 15:00:37)
- Building and Installation (09/07/2007 10:30:47)
- CaseLibrary (09/07/2007 10:41:38)
- CGILibrary (09/14/2007 08:30:47)
- ConditionalsLibrary (09/07/2007 10:25:29)
- ConsoleLibrary (09/07/2007 10:23:25)
- CTypeLibrary (09/11/2007 12:28:07)
- EnumLibrary (09/13/2007 16:55:26)
- FloatsLibrary (09/07/2007 10:07:35)
- GPL Version 2 (09/14/2007 08:30:26)
- HelpDBLibrary (09/07/2007 10:28:40)
- Home (09/16/2007 14:59:03)
- Index (07/13/2002 14:58:54)
- License (09/14/2007 08:30:16)
- MathLibrary (09/07/2007 10:44:25)
- QuotesLibrary (09/07/2007 10:09:21)
- ReadlineLibrary (09/07/2007 10:45:52)
- Recent Changes (07/13/2002 14:41:15)
- RegexLibrary (09/07/2007 10:48:19)
- SDLLibrary (09/07/2007 10:59:32)
- Search (03/29/2007 21:18:59)
- ShellLibrary (09/07/2007 10:33:23)
- SocketsLibrary (09/07/2007 22:52:56)
- StringsLibrary (09/16/2007 15:09:33)
- TextEditLibrary (09/07/2007 10:36:21)
- User Code (09/07/2007 22:52:36)
27 Pages
ShellLibrary
To include: needs shell
This library provides the fundamental support for calling external files and doing actions normally done at the shell.
The provided API follows:
remove ( $-n ) Delete file '$'
system ( $-n ) Run string '$' as a shell command
getpid ( -n ) Return the current process ID
fork ( -f ) Fork the current process.
basename ( $-$ ) Return the base name (name+extension), of a file.
Strips any directories from the filename.
mkdir ( $m-n ) Create a directory named "$" with a mode of "m".
fnmatch ( ab-f ) Returns TRUE if filename "a" matches the pattern in "b".
Returns FALSE otherwise.
SocketsLibrary
To include: needs sockets
The socket library is a hybrid library. It provides both a C library module and a set of Toka bindings. The functionality is dependent on both.
The provided API is as follows:
pBind
( n-x )
Bind to a specific port
pConnect
( $n-s )
Connect to host (string '$') at port 'n'. Returns a socket.
pAccept
( n-x )
Accept a new connection upon a socket. Return the new client.
pRead
( sbl-n )
Attempt to read 'l' chars from socket 's' into buffer 'b'. Returns
the number of bytes read.
pWrite
( sbl-n )
Attempt to write 'l' bytes from buffer 'b' to socket 's'. Returns
the number of bytes written.
pClose
( s-x )
Attempt to close socket 's'.
This API, while minimalistic, is sufficient to allow development of both client and server applications. It has been used in conjunction with the ShellLibrary to implement a working HTTP server.
StringsLibrary
To include: needs strings
This library expands on the string support in Toka.
Provides:
string.findChar ( ab-$ ) Search for character 'b' in string 'a'.
Return a new string starting at
character 'c'.
string.findSubstring ( ab-$ ) Search for string 'b' within string
'a'. Return a new string starting with
string 'b'.
string.findToken ( ab-$ ) Search for string 'b' within string
'a'. Return a new string starting with
'a' and ending at the first
occurance of 'b'.
TextEditLibrary
To include: needs textedit
Toka has a hybrid library that provides a Pico/Nano style text editor. This is based on a simple text editor originally developed by Tom Novelli.
edit.load ( $- ) Load a file ($ = filename) into the editor buffer. edit.save ( $- ) Save the editor buffer to a file ($ = filename) edit.start ( - ) Begin editing the file in the file buffer edit.redraw ( - ) Redraw the editor screen
User Code
# Enter new commands here
Notebook exported on Sunday, 16 September 2007, 15:57:12 PM EDT