From 1e5b73f1387e2b238e15238604b20a21f4e109ef Mon Sep 17 00:00:00 2001 From: "Paul C. Buetow (mars.fritz.box)" Date: Sun, 22 Jun 2014 11:53:34 +0200 Subject: add README.pod --- docs/pod/fype.1.gz | Bin 6545 -> 6523 bytes docs/pod/fype.html | 145 ++++++++++++++---------------------- docs/pod/fype.man | 211 ++++++++++++++++++++--------------------------------- docs/pod/fype.txt | 6 +- 4 files changed, 135 insertions(+), 227 deletions(-) (limited to 'docs/pod') diff --git a/docs/pod/fype.1.gz b/docs/pod/fype.1.gz index 164c95c..916f836 100644 Binary files a/docs/pod/fype.1.gz and b/docs/pod/fype.1.gz differ diff --git a/docs/pod/fype.html b/docs/pod/fype.html index 0a709bb..121cbea 100644 --- a/docs/pod/fype.html +++ b/docs/pod/fype.html @@ -4,13 +4,15 @@ NAME - + -

+ +

NAME

@@ -78,9 +82,9 @@

SYNOPSES

fype [-[hsvTV]] file.fy +
fype [-[hsvTV]] file.fy
fype -e ``fype code string;'' +
fype -e "fype code string;"

@@ -91,7 +95,7 @@ TODO file of the source distribution of Fype!

Fype is a 32 bit scripting language created for fun. You can use it and comment on it if you like. You could also write patches and mail them to fype at dev dot buetow dot org! Or go visit the IRC channel #coding at irc.german-elite.net and ask rantanplan.

Fype is developed under the BSD license. See the COPYING file which is included in the source tree.

Fype should be ``at least as good as AWK''. This does not mean it will be a replacement for AWK but it should support functions, loops and arrays like AWK does but with a different syntax. It should also get extension support like AWK has. I am not talking about GNU AWK but about New AWK, which is included in the *BSD distributions! Fype already has a few features which are not available in AWK. However, AWK has still many features which are not available in Fype as well ;)

Fype should be "at least as good as AWK". This does not mean it will be a replacement for AWK but it should support functions, loops and arrays like AWK does but with a different syntax. It should also get extension support like AWK has. I am not talking about GNU AWK but about New AWK, which is included in the *BSD distributions! Fype already has a few features which are not available in AWK. However, AWK has still many features which are not available in Fype as well ;)

Fancy stuff like OOP or unicode or threading is not yet planed. But fancy stuff like function pointers and closures may be considered for one of the first releases of Fype :)

@@ -139,71 +143,61 @@ TODO file of the source distribution of Fype!

The basic data types

integer +
integer: Specifies an integer number
double +
double: Specifies a double number
string +
string: Specifies a string
number +
number: May be an integer or a double number
any +
any: May be of any type above
void +
void: No type
identifier +
identifier: It's a variable name or a procedure name or a function name

Explicit type conversions

(integer) integer any +
(integer) integer any: Converts any type to an integer
(double) double any +
(double) double any: Converts any type to a double
(string) string any +
(string) string any: Converts any type to a string

@@ -259,30 +253,26 @@ TODO file of the source distribution of Fype!

Control statements

Fype knows the following control statements:

if <expression> { <statements> } +
if <expression> { <statements> }: Runs the statements if the expression evaluates to a true value.
ifnot <expression> { <statements> } +
ifnot <expression> { <statements> }: Runs the statements if the expression evaluates to a false value.
while <expression> { <statements> } +
while <expression> { <statements> }: Runs the statements as long as the the expression evaluates to a true value.
until <expression> { <statements> } +
until <expression> { <statements> }: Runs the statements as long as the the expression evaluates to a false value.

@@ -356,153 +346,132 @@ not.

Math

(any) any + any +
(any) any + any: Special string behavior: A string will get auto convertet into an integer.
(any) any - any +
(any) any - any: Special string behavior: A string will get auto convertet into an integer.
(any) any * any +
(any) any * any: Special string behavior: A string will get auto convertet into an integer.
(any) any / any +
(any) any / any: Special string behavior: A string will get auto convertet into an integer.

Definedness

(integer) defined identifier +
(integer) defined identifier: Returns 1 if identifier has been defined. Returns 0 else.
(integer) undef identifier +
(integer) undef identifier: Tries to undefine/delete the identifier. Returns 1 if success, otherwise 0 is returned.

Bitwise

(integer) any :< any +
(integer) any :< any
(integer) any :> any +
(integer) any :> any
(integer) any and any +
(integer) any and any
(integer) any or any +
(integer) any or any
(integer) any xor any +
(integer) any xor any

Numeric

(number) neg number +

(number) neg number

This function returns the negative value of any

(integer) no [integer] +

(integer) no [integer]

This function returns 1 if the argument is 0, otherwise it will return 0! If no argument is given, then 0 is returned!

(integer) yes [integer] +

(integer) yes [integer]

This function always returns 1. The parameter is optional. -

This function always returns 1. The parameter is optional.

 
         # Prints out 1, because foo is not defined
         if yes { say no defined foo; }

System

(void) end +

(void) end

Exits the program with the exit status of 0

(void) exit integer +

(void) exit integer

Exits the program with the specified exit status

(integer) fork +

(integer) fork

Fork forks a subprocess. It returns 0 for the child process and the pid of the child process otherwise! Example:

         my pid = fork;

         if pid {
                 put "I am the parent process; child has the pid ";
                 say pid;

         } ifnot pid {
                 say "I am the child process";
         }

(integer) gc +

(integer) gc

Executes the garbage collector and returns the number of items freed! You may @@ -510,30 +479,26 @@ wonder why most of the time it will return a value of 0! Fype tries to free not needed memory asap. This may change in future versions in order to gain faster execution of scripts!

I/O

(any) put any +
(any) put any: Prints out the argument
(any) say any +
(any) say any: Same as put, but also includes an ending newline
(void) ln +
(void) ln: Just prints a newline

@@ -620,9 +585,7 @@ keyword in order to check if a procedure has been defined or not.

diff --git a/docs/pod/fype.man b/docs/pod/fype.man index e9b95a7..ed963a7 100644 --- a/docs/pod/fype.man +++ b/docs/pod/fype.man @@ -1,15 +1,7 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== -.de Sh \" Subsection heading -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp @@ -25,11 +17,11 @@ .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. | will give a -.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to -.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' -.\" expand to `' in nroff, nothing in troff, for use with C<>. -.tr \(*W-|\(bv\*(Tr +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- @@ -48,22 +40,25 @@ . ds R" '' 'br\} .\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.if \nF \{\ +.ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} -.\" -.\" For nroff, turn off justification. Always turn off hyphenation; it makes -.\" way too many mistakes in technical documents. -.hy 0 -.if n .na +.el \{\ +. de IX +.. +.\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,13 +124,17 @@ .\" ======================================================================== .\" .IX Title "FYPE 1" -.TH FYPE 1 "2008-10-26" "Fype v0.1-devel Build 9276" "The Fype Users Manual Page" +.TH FYPE 1 "2014-06-22" "Fype Superalpha Build 9666" "The Fype Users Manual Page" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh .SH "NAME" -\&\fBFype\fR is \fBF\fRor \fBY\fRour \fBP\fRrogram \fBE\fRxecution +Fype is For Your Program Execution .PP -\&\fBFype\fR is \fBF\fRree \fBY\fRak \fBP\fRrogramed for \fBE\fRLF +Fype is Free Yak Programed for ELF .PP -It's not a hype \- it's \fBFype\fR! +It's not a hype \- it's Fype! .SH "SYNOPSES" .IX Header "SYNOPSES" .IP "\fBfype\fR [\-[hsvTV]] file.fy" 4 @@ -156,10 +155,10 @@ Fype is developed under the \s-1BSD\s0 license. See the \s-1COPYING\s0 file whic .PP Fype should be \*(L"at least as good as \s-1AWK\s0\*(R". This does not mean it will be a replacement for \s-1AWK\s0 but it should support functions, loops and arrays like \s-1AWK\s0 does but with a different syntax. It should also get extension support like \s-1AWK\s0 has. I am not talking about \s-1GNU\s0 \s-1AWK\s0 but about New \s-1AWK\s0, which is included in the *BSD distributions! Fype already has a few features which are not available in \s-1AWK\s0. However, \s-1AWK\s0 has still many features which are not available in Fype as well ;) .PP -Fancy stuff like \s-1OOP\s0 or unicode or threading is not yet planed. But fancy stuff like function pointers and closures may be considered for one of the first releases of Fype :) +Fancy stuff like \s-1OOP\s0 or unicode or threading is not yet planed. But fancy stuff like function pointers and closures may be considered for one of the first releases of Fype :) .SH "PARSING / CODE GENERATION" .IX Header "PARSING / CODE GENERATION" -The Fype syntax is very simple and is using a maximum look ahead of 1 and a very easy top down parsing. Fype is parsing and interpreting its code simultaneous. This means, that syntax errors are only detected during program runtime. +The Fype syntax is very simple and is using a maximum look ahead of 1 and a very easy top down parsing. Fype is parsing and interpreting its code simultaneous. This means, that syntax errors are only detected during program runtime. .SH "REQUIREMENTS" .IX Header "REQUIREMENTS" Fype only has been tested on FreeBSD 7.0. Linux may work too. Windows support is not planned. But may work using Cygwin or \s-1SFU\s0. Linux users have to install pmake before compiling Fype! @@ -204,7 +203,7 @@ See the ./examples subdir of the Fype source distribution for examples! See also .SH "DATA TYPES" .IX Header "DATA TYPES" Fype uses auto type conversion. However, if you want to know what's going on you may take a look at the provided basic datatypes. -.Sh "The basic data types" +.SS "The basic data types" .IX Subsection "The basic data types" .IP "\fIinteger\fR" 4 .IX Item "integer" @@ -227,7 +226,7 @@ No type .IP "\fIidentifier\fR" 4 .IX Item "identifier" It's a variable name or a procedure name or a function name -.Sh "Explicit type conversions" +.SS "Explicit type conversions" .IX Subsection "Explicit type conversions" .IP "(\fIinteger\fR) \fBinteger\fR \fIany\fR" 4 .IX Item "(integer) integer any" @@ -240,64 +239,52 @@ Converts any type to a double Converts any type to a string .SH "SYNTAX" .IX Header "SYNTAX" -.Sh "Comments" +.SS "Comments" .IX Subsection "Comments" Text from a \fB#\fR character until the end of the current line is considered being a comment. Multi line comments may start with an \fB#*\fR and and with an \fB*#\fR anywhere. Exceptions are if those signs are inside of strings. -.Sh "Statements" +.SS "Statements" .IX Subsection "Statements" A Fype program is a list of statements. Each keyword, expression or function call is part of a statement. Each statement is ended with a semicolon. Example: .PP .Vb 3 \& my bar = 3, foo = 1 + 2; \& say foo; -\& exit foo - bar; +\& exit foo \- bar; .Ve -.Sh "Paranthesis" +.SS "Paranthesis" .IX Subsection "Paranthesis" All paranthesis of function calls are optional. They help to make the code better readable. They also help to force precedences of expressions. -.Sh "Scopeing" +.SS "Scopeing" .IX Subsection "Scopeing" -A new scope starts with an { and ends with an }. An exception is a procedure, which does not use its own scope (see later in this manual). Control statements and functions support scopeings. The \fBscope\fR function will print out all available symbols at the current position. Here is a small example of how to use scopes: +A new scope starts with an { and ends with an }. An exception is a procedure, which does not use its own scope (see later in this manual). Control statements and functions support scopeings. The \fBscope\fR function will print out all available symbols at the current position. Here is a small example of how to use scopes: .PP .Vb 1 \& my foo = 1; -.Ve -.PP -.Vb 5 +\& \& { \& # Prints out 1 \& put defined foo; \& { \& my bar = 2; -.Ve -.PP -.Vb 2 +\& \& # Prints out 1 \& put defined bar; -.Ve -.PP -.Vb 4 +\& \& # Prints out all available symbols at this \& # point to stdout. Those are: bar and foo \& scope; \& } -.Ve -.PP -.Vb 2 +\& \& # Prints out 0 \& put defined bar; -.Ve -.PP -.Vb 2 +\& \& my baz = 3; \& } -.Ve -.PP -.Vb 2 +\& \& # Prints out 0 \& say defined bar; .Ve -.Sh "Control statements" +.SS "Control statements" .IX Subsection "Control statements" Fype knows the following control statements: .IP "if \fI { \fI }" 4 @@ -318,16 +305,12 @@ Variables can be defined with the \fBmy\fR keyword. If you don't assign a value .PP .Vb 2 \& my foo = 1 + 2; -\& say foo; -.Ve -.PP -.Vb 3 +\& say foo; +\& \& my bar = 12, baz = foo; \& say 1 + bar; \& say bar; -.Ve -.PP -.Vb 2 +\& \& my baz; \& say baz; # Will print out 0 .Ve @@ -339,13 +322,9 @@ not. \& ifnot defined foo { \& say "No foo yet defined"; \& } -.Ve -.PP -.Vb 1 +\& \& my foo = 1; -.Ve -.PP -.Vb 4 +\& \& if defined foo { \& put "foo is defined and has the value "; \& say foo; @@ -359,9 +338,7 @@ Each variable can have as many synonyms as wished. A synonym is another name to \& my foo = "foo"; \& my bar = \efoo; \& foo = "bar"; -.Ve -.PP -.Vb 2 +\& \& # The synonym variable should now also set to "bar" \& assert "bar" == bar; .Ve @@ -371,18 +348,12 @@ Synonyms can be used for all kind of identifiers. It's not limited to normal var .Vb 2 \& # Create a new procedure baz \& proc baz { say "I am baz"; } -.Ve -.PP -.Vb 2 +\& \& # Make a synonym baz, and undefine baz \& my bay = \ebaz; -.Ve -.PP -.Vb 1 +\& \& undef baz; -.Ve -.PP -.Vb 2 +\& \& # bay still has a reference of the original procedure baz \& bay; # this prints aut "I am baz" .Ve @@ -392,22 +363,18 @@ The \fBsyms\fR keyword gives you the total number of synonyms pointing to a spec .Vb 2 \& my foo = 1; \& say syms foo; # Prints 1 -.Ve -.PP -.Vb 3 +\& \& my baz = \efoo; \& say syms foo; # Prints 2 \& say syms baz; # Prints 2 -.Ve -.PP -.Vb 2 +\& \& undef baz; \& say syms foo; # Prints 1 .Ve .SH "BUILT IN FUNCTIONS" .IX Header "BUILT IN FUNCTIONS" In Fype, operators are built in functions as well. The difference is, that they may be written in infix notation instead in front of the arguments. The types inside the () specify the return types. -.Sh "Math" +.SS "Math" .IX Subsection "Math" .IP "(\fIany\fR) \fIany\fR \fB+\fR \fIany\fR" 4 .IX Item "(any) any + any" @@ -421,7 +388,7 @@ Special string behavior: A string will get auto convertet into an \fIinteger\fR. .IP "(\fIany\fR) \fIany\fR \fB/\fR \fIany\fR" 4 .IX Item "(any) any / any" Special string behavior: A string will get auto convertet into an \fIinteger\fR. -.Sh "Conditional" +.SS "Conditional" .IX Subsection "Conditional" .IP "(\fIinteger\fR) \fIany\fR \fB==\fR \fIany\fR" 4 .IX Item "(integer) any == any" @@ -439,7 +406,7 @@ Special string behavior: A string will get auto convertet into an \fIinteger\fR. .IP "(\fIinteger\fR) \fBnot\fR \fIany\fR" 4 .IX Item "(integer) not any" .PD -.Sh "Definedness" +.SS "Definedness" .IX Subsection "Definedness" .IP "(\fIinteger\fR) \fBdefined\fR \fIidentifier\fR" 4 .IX Item "(integer) defined identifier" @@ -447,7 +414,7 @@ Returns 1 if \fIidentifier\fR has been defined. Returns 0 else. .IP "(\fIinteger\fR) \fBundef\fR \fIidentifier\fR" 4 .IX Item "(integer) undef identifier" Tries to undefine/delete the \fIidentifier\fR. Returns 1 if success, otherwise 0 is returned. -.Sh "Bitwise" +.SS "Bitwise" .IX Subsection "Bitwise" .IP "(\fIinteger\fR) \fIany\fR \fB:<\fR \fIany\fR" 4 .IX Item "(integer) any :< any" @@ -461,7 +428,7 @@ Tries to undefine/delete the \fIidentifier\fR. Returns 1 if success, otherwise 0 .IP "(\fIinteger\fR) \fIany\fR \fBxor\fR \fIany\fR" 4 .IX Item "(integer) any xor any" .PD -.Sh "Numeric" +.SS "Numeric" .IX Subsection "Numeric" .IP "(\fInumber\fR) \fBneg\fR \fInumber\fR" 4 .IX Item "(number) neg number" @@ -472,13 +439,13 @@ This function returns 1 if the argument is 0, otherwise it will return 0! If no argument is given, then 0 is returned! .IP "(\fIinteger\fR) \fByes\fR [\fIinteger\fR]" 4 .IX Item "(integer) yes [integer]" -This function always returns 1. The parameter is optional. +This function always returns 1. The parameter is optional. .Sp .Vb 2 \& # Prints out 1, because foo is not defined \& if yes { say no defined foo; } .Ve -.Sh "System" +.SS "System" .IX Subsection "System" .IP "(\fIvoid\fR) \fBend\fR" 4 .IX Item "(void) end" @@ -493,15 +460,11 @@ child process otherwise! Example: .Sp .Vb 1 \& my pid = fork; -.Ve -.Sp -.Vb 3 +\& \& if pid { \& put "I am the parent process; child has the pid "; \& say pid; -.Ve -.Sp -.Vb 3 +\& \& } ifnot pid { \& say "I am the child process"; \& } @@ -512,20 +475,20 @@ Executes the garbage collector and returns the number of items freed! You may wonder why most of the time it will return a value of 0! Fype tries to free not needed memory asap. This may change in future versions in order to gain faster execution of scripts! -.Sh "I/O" +.SS "I/O" .IX Subsection "I/O" .IP "(\fIany\fR) \fBput\fR \fIany\fR" 4 .IX Item "(any) put any" Prints out the argument .IP "(\fIany\fR) \fBsay\fR \fIany\fR" 4 .IX Item "(any) say any" -Same as put, but also includes an ending newline +Same as put, but also includes an ending newline .IP "(\fIvoid\fR) \fBln\fR" 4 .IX Item "(void) ln" Just prints a newline .SH "SELF DEFINING PROCEDURES AND FUNCTIONS" .IX Header "SELF DEFINING PROCEDURES AND FUNCTIONS" -.Sh "Procedures" +.SS "Procedures" .IX Subsection "Procedures" A procedure can be defined with the \fBproc\fR keyword and deleted with the \fBundef\fR keyword. A procedure does not return any value and does not support parameter passing. It's using already defined variables (e.g. global variables). A procedure does not have its own namespace. It's using the calling namespace. It is possible to define new variabes inside of a procedure in the current namespace. .PP @@ -534,17 +497,13 @@ A procedure can be defined with the \fBproc\fR keyword and deleted with the \fBu \& say 1 + a * 3 + b; \& my c = 6; \& } -.Ve -.PP -.Vb 1 +\& \& my a = 2, b = 4; -.Ve -.PP -.Vb 2 +\& \& foo; # Run the procedure. Print out "11\en" \& say c; # Print out "6\en"; .Ve -.Sh "Nested procedures" +.SS "Nested procedures" .IX Subsection "Nested procedures" It's possible to define procedures inside of procedures. Since procedures don't have its own scope, nested procedures will be available to the current scope as @@ -554,47 +513,37 @@ keyword in order to check if a procedure has been defined or not. .Vb 2 \& proc foo { \& say "I am foo"; -.Ve -.PP -.Vb 5 +\& \& undef bar; \& proc bar { \& say "I am bar"; \& } \& } -.Ve -.PP -.Vb 3 +\& \& # Here bar would produce an error because \& # the proc is not yet defined! -\& # bar; -.Ve -.PP -.Vb 3 +\& # bar; +\& \& foo; # Here the procedure foo will define the procedure bar! \& bar; # Now the procedure bar is defined! \& foo; # Here the procedure foo will redefine bar again! .Ve -.Sh "Functions" +.SS "Functions" .IX Subsection "Functions" -A function should be defined with the \fBfunc\fR keyword and deleted with the \fBundef\fR keyword. Function not yet return values (will be changed in future versions) and supports not yet parameter passing (will be changed in future versions). It's using local (lexical scoped) variables. If a certain variable does not exist It's using already defined variables (e.g. one scope above). +A function should be defined with the \fBfunc\fR keyword and deleted with the \fBundef\fR keyword. Function not yet return values (will be changed in future versions) and supports not yet parameter passing (will be changed in future versions). It's using local (lexical scoped) variables. If a certain variable does not exist It's using already defined variables (e.g. one scope above). .PP .Vb 4 \& func foo { \& say 1 + a * 3 + b; \& my c = 6; \& } -.Ve -.PP -.Vb 1 +\& \& my a = 2, b = 4; -.Ve -.PP -.Vb 2 +\& \& foo; # Run the procedure. Print out "11\en" \& say c; # Will produce an error, because c is out of scoped! .Ve -.Sh "Nested functions" +.SS "Nested functions" .IX Subsection "Nested functions" Nested functions work the same way the nested procedures work, with the exception that nested functions will not be available any more after the function has been left! .PP @@ -603,14 +552,10 @@ Nested functions work the same way the nested procedures work, with the exceptio \& func bar { \& say "Hello i am nested"; \& } -.Ve -.PP -.Vb 2 +\& \& bar; # Calling nested \& } -.Ve -.PP -.Vb 2 +\& \& foo; \& bar; # Will produce an error, because bar is out of scope! .Ve diff --git a/docs/pod/fype.txt b/docs/pod/fype.txt index a6be7b8..8513538 100644 --- a/docs/pod/fype.txt +++ b/docs/pod/fype.txt @@ -47,7 +47,7 @@ REQUIREMENTS You will need: GNU GCC C Compiler (gcc.gnu.org) - NetBSD Make aka pmake (GNU Make will not work) + NetBSD Make aka pmake (GNU Make will not work) NetBSD Make is included in any *BSD and can be run with just make. @@ -235,7 +235,7 @@ SYNONYMS undef baz; # bay still has a reference of the original procedure baz - bay; # this prints aut "I am baz" + bay; # this prints aut "I am baz" The syms keyword gives you the total number of synonyms pointing to a specific value: @@ -308,7 +308,7 @@ BUILT IN FUNCTIONS This function always returns 1. The parameter is optional. # Prints out 1, because foo is not defined - if yes { say no defined foo; } + if yes { say no defined foo; } System (*void*) end -- cgit v1.2.3