Merge branch 'master' of git://factorcode.org/git/factor
Daniel Ehrenberg
commit
ccfd9f9c52
|
|
@ -93,7 +93,7 @@ HELP: Viamax
|
|||
|
||||
HELP: Vamax
|
||||
{ $values { "x" blas-vector-base } { "max" number } }
|
||||
{ $description "Return the value of the element in " { $snippet "x" } " with the largest norm-1. If more than one element has the same norm-1, returns the first element. Corresponds to the IxAMAX routines in BLAS." } ;
|
||||
{ $description "Return the value of the element in " { $snippet "x" } " with the largest norm-1. If more than one element has the same norm-1, returns the element closest to the beginning. Corresponds to the IxAMAX routines in BLAS." } ;
|
||||
|
||||
{ Viamax Vamax } related-words
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,42 @@
|
|||
USING: accessors arrays combinators definitions generalizations
|
||||
help help.markup help.topics kernel sequences sorting vocabs
|
||||
words ;
|
||||
IN: annotations
|
||||
|
||||
<PRIVATE
|
||||
: comment-word ( base -- word ) "!" prepend "annotations" lookup ;
|
||||
: comment-usage-word ( base -- word ) "s" append "annotations" lookup ;
|
||||
: comment-usage.-word ( base -- word ) "s." append "annotations" lookup ;
|
||||
PRIVATE>
|
||||
|
||||
"Code annotations"
|
||||
{
|
||||
"The " { $vocab-link "annotations" } " vocabulary provides syntax for comment-like annotations that can be looked up with Factor's " { $link usage } " mechanism."
|
||||
}
|
||||
annotation-tags natural-sort
|
||||
[
|
||||
[ \ $subsection swap comment-word 2array ] map append
|
||||
"To look up annotations:" suffix
|
||||
] [
|
||||
[ \ $subsection swap comment-usage.-word 2array ] map append
|
||||
] bi
|
||||
<article> "annotations" add-article
|
||||
|
||||
"annotations" vocab "annotations" >>help drop
|
||||
|
||||
annotation-tags [
|
||||
{
|
||||
[ [ \ $syntax ] dip "!" " your comment here" surround 2array ]
|
||||
[ [ \ $description "Treats the rest of the line after the exclamation point as a code annotation that can be looked up with the " \ $link ] dip comment-usage.-word 2array " word." 4array ]
|
||||
[ [ \ $unchecked-example ] dip ": foo ( x y z -- w )\n !" " --w-ó()ò-w-- kilroy was here\n + * ;" surround 2array 3array ]
|
||||
[ comment-word set-word-help ]
|
||||
|
||||
[ [ \ $description "Displays a list of words, help articles, and vocabularies that contain " \ $link ] dip comment-word 2array " annotations." 4array 1array ]
|
||||
[ comment-usage.-word set-word-help ]
|
||||
|
||||
[ [ { $values { "usages" sequence } } \ $description "Returns a list of words, help articles, and vocabularies that contain " \ $link ] dip [ comment-word 2array " annotations. For a more user-friendly display, use the " \ $link ] [ comment-usage.-word 2array " word." 6 narray 2array ] bi ]
|
||||
[ comment-usage-word set-word-help ]
|
||||
|
||||
[ [ comment-word ] [ comment-usage-word ] [ comment-usage.-word ] tri 3array related-words ]
|
||||
} cleave
|
||||
] each
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
USING: accessors annotations combinators.short-circuit
|
||||
io.pathnames kernel math sequences sorting tools.test ;
|
||||
IN: annotations.tests
|
||||
|
||||
!NOTE testing toplevel form
|
||||
|
||||
: three ( -- x )
|
||||
!BROKEN english plz
|
||||
"þrij" ;
|
||||
|
||||
: four ( -- x )
|
||||
!BROKEN this code is broken
|
||||
2 2 + 1+ ;
|
||||
|
||||
: five ( -- x )
|
||||
!TODO return 5
|
||||
f ;
|
||||
|
||||
[ t ] [
|
||||
NOTEs {
|
||||
[ length 1 = ]
|
||||
[ first string>> file-name "annotations-tests.factor" = ]
|
||||
} 1&&
|
||||
] unit-test
|
||||
|
||||
[ { four three } ] [ BROKENs natural-sort ] unit-test
|
||||
[ { five } ] [ TODOs ] unit-test
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
! (c)2009 Joe Groff, Doug Coleman. see BSD license
|
||||
USING: accessors combinators.short-circuit definitions functors
|
||||
kernel lexer namespaces parser prettyprint sequences words ;
|
||||
IN: annotations
|
||||
|
||||
<<
|
||||
|
||||
: (parse-annotation) ( accum -- accum )
|
||||
lexer get [ line-text>> parsed ] [ next-line ] bi ;
|
||||
|
||||
: (non-annotation-usage) ( word -- usages )
|
||||
smart-usage
|
||||
[ { [ word? ] [ vocabulary>> "annotations" = ] } 1&& not ]
|
||||
filter ;
|
||||
|
||||
FUNCTOR: define-annotation ( NAME -- )
|
||||
|
||||
(NAME) DEFINES (${NAME})
|
||||
!NAME DEFINES !${NAME}
|
||||
NAMEs DEFINES ${NAME}s
|
||||
NAMEs. DEFINES ${NAME}s.
|
||||
|
||||
WHERE
|
||||
|
||||
: (NAME) ( str -- ) drop ; inline
|
||||
: !NAME (parse-annotation) \ (NAME) parsed ; parsing
|
||||
|
||||
: NAMEs ( -- usages )
|
||||
\ (NAME) (non-annotation-usage) ;
|
||||
: NAMEs. ( -- )
|
||||
NAMEs sorted-definitions. ;
|
||||
|
||||
;FUNCTOR
|
||||
|
||||
CONSTANT: annotation-tags {
|
||||
"XXX" "TODO" "FIXME" "BUG" "REVIEW" "LICENSE"
|
||||
"AUTHOR" "BROKEN" "HACK" "LOL" "NOTE"
|
||||
}
|
||||
|
||||
annotation-tags [ define-annotation ] each
|
||||
|
||||
>>
|
||||
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
Joe Groff
|
||||
Doug Coleman
|
||||
|
|
@ -0,0 +1 @@
|
|||
Code annotation comment syntax
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
comments
|
||||
annotation
|
||||
|
|
@ -1,3 +1,5 @@
|
|||
! Copyright (C) 2009 Philipp Brüschweiler
|
||||
! See http://factorcode.org/license.txt for BSD license.
|
||||
IN: infix.ast
|
||||
|
||||
TUPLE: ast-number value ;
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
Philipp Brüschweiler
|
||||
|
|
@ -1,4 +1,6 @@
|
|||
USING: help.syntax help.markup prettyprint locals ;
|
||||
! Copyright (C) 2009 Philipp Brüschweiler
|
||||
! See http://factorcode.org/license.txt for BSD license.
|
||||
USING: help.syntax help.markup math prettyprint locals sequences ;
|
||||
IN: infix
|
||||
|
||||
HELP: [infix
|
||||
|
|
@ -36,3 +38,54 @@ HELP: [infix|
|
|||
} ;
|
||||
|
||||
{ POSTPONE: [infix POSTPONE: [infix| } related-words
|
||||
|
||||
ARTICLE: "infix" "Infix notation"
|
||||
"The " { $vocab-link "infix" } " vocabulary implements support for infix notation in Factor source code."
|
||||
{ $subsection POSTPONE: [infix }
|
||||
{ $subsection POSTPONE: [infix| }
|
||||
$nl
|
||||
"The usual infix math operators are supported:"
|
||||
{ $list
|
||||
{ $link + }
|
||||
{ $link - }
|
||||
{ $link * }
|
||||
{ $link / }
|
||||
{ { $snippet "%" } ", which is the infix operator for " { $link mod } "." }
|
||||
}
|
||||
"The standard precedence rules apply: Grouping with parentheses before " { $snippet "*" } ", " { $snippet "/" } "and " { $snippet "%" } " before " { $snippet "+" } " and " { $snippet "-" } "."
|
||||
{ $example
|
||||
"USING: infix prettyprint ;"
|
||||
"[infix 5-40/10*2 infix] ."
|
||||
"-3"
|
||||
}
|
||||
$nl
|
||||
"You can call Factor words in infix expressions just as you would in C. There are some restrictions on which words are legal to use though:"
|
||||
{ $list
|
||||
"The word must return exactly one value."
|
||||
"The word name must consist of the letters a-z, A-Z, _ or 0-9, and the first character can't be a number."
|
||||
}
|
||||
{ $example
|
||||
"USING: infix locals math math.functions prettyprint ;"
|
||||
":: binary_entropy ( p -- h )"
|
||||
" [infix -(p*log(p) + (1-p)*log(1-p)) / log(2) infix] ;"
|
||||
"[infix binary_entropy( sqrt(0.25) ) infix] ."
|
||||
"1.0"
|
||||
}
|
||||
$nl
|
||||
"You can access " { $vocab-link "sequences" } " inside infix expressions with the familiar " { $snippet "arr[index]" } " notation."
|
||||
{ $example
|
||||
"USING: arrays infix prettyprint ;"
|
||||
"[infix| myarr [ { 1 2 3 4 } ] | myarr[4/2]*3 infix] ."
|
||||
"9"
|
||||
}
|
||||
"Please note: in Factor " { $emphasis "fixnums are sequences too." } " If you are not careful with sequence accesses you may introduce subtle bugs:"
|
||||
{ $example
|
||||
"USING: arrays infix locals prettyprint ;"
|
||||
":: add-2nd-element ( x y -- res )"
|
||||
" [infix x[1] + y[1] infix] ;"
|
||||
"{ 1 2 3 } 5 add-2nd-element ."
|
||||
"3"
|
||||
}
|
||||
;
|
||||
|
||||
ABOUT: "infix"
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
! Copyright (C) 2009 Philipp Brüschweiler
|
||||
! See http://factorcode.org/license.txt for BSD license.
|
||||
USING: infix infix.private kernel locals math math.functions
|
||||
tools.test ;
|
||||
IN: infix.tests
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
! Copyright (C) 2009 Philipp Brüschweiler
|
||||
! See http://factorcode.org/license.txt for BSD license.
|
||||
USING: accessors assocs combinators combinators.short-circuit
|
||||
effects fry infix.parser infix.ast kernel locals.parser
|
||||
locals.types math multiline namespaces parser quotations
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
! Copyright (C) 2009 Philipp Brüschweiler
|
||||
! See http://factorcode.org/license.txt for BSD license.
|
||||
USING: infix.ast infix.parser infix.tokenizer tools.test ;
|
||||
IN: infix.parser.tests
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
! Copyright (C) 2009 Philipp Brüschweiler
|
||||
! See http://factorcode.org/license.txt for BSD license.
|
||||
USING: infix.ast infix.tokenizer kernel math peg.ebnf sequences
|
||||
strings vectors ;
|
||||
IN: infix.parser
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
Support for infix notation in Factor programs
|
||||
|
|
@ -0,0 +1 @@
|
|||
extensions
|
||||
|
|
@ -1,3 +1,5 @@
|
|||
! Copyright (C) 2009 Philipp Brüschweiler
|
||||
! See http://factorcode.org/license.txt for BSD license.
|
||||
USING: infix.ast infix.tokenizer tools.test ;
|
||||
IN: infix.tokenizer.tests
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
! Copyright (C) 2009 Philipp Brüschweiler
|
||||
! See http://factorcode.org/license.txt for BSD license.
|
||||
USING: infix.ast kernel peg peg.ebnf math.parser sequences
|
||||
strings ;
|
||||
IN: infix.tokenizer
|
||||
|
|
|
|||
Loading…
Reference in New Issue