File:  [gforth] / gforth / prim
Revision 1.209: download - view: text, annotated - select for diffs
Sat Mar 31 19:43:54 2007 UTC (12 years, 6 months ago) by anton
Branches: MAIN
CVS tags: HEAD
documented FORM and reorganized related documentation

    1: \ Gforth primitives
    2: 
    3: \ Copyright (C) 1995,1996,1997,1998,2000,2003,2004,2005,2006 Free Software Foundation, Inc.
    4: 
    5: \ This file is part of Gforth.
    6: 
    7: \ Gforth is free software; you can redistribute it and/or
    8: \ modify it under the terms of the GNU General Public License
    9: \ as published by the Free Software Foundation; either version 2
   10: \ of the License, or (at your option) any later version.
   11: 
   12: \ This program is distributed in the hope that it will be useful,
   13: \ but WITHOUT ANY WARRANTY; without even the implied warranty of
   14: \ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   15: \ GNU General Public License for more details.
   16: 
   17: \ You should have received a copy of the GNU General Public License
   18: \ along with this program; if not, write to the Free Software
   19: \ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
   20: 
   21: 
   22: \ WARNING: This file is processed by m4. Make sure your identifiers
   23: \ don't collide with m4's (e.g. by undefining them).
   24: \ 
   25: \ 
   26: \ 
   27: \ This file contains primitive specifications in the following format:
   28: \ 
   29: \ forth name	( stack effect )	category	[pronunciation]
   30: \ [""glossary entry""]
   31: \ C code
   32: \ [:
   33: \ Forth code]
   34: \ 
   35: \ Note: Fields in brackets are optional.  Word specifications have to
   36: \ be separated by at least one empty line
   37: \
   38: \ Both pronounciation and stack items (in the stack effect) must
   39: \ conform to the C identifier syntax or the C compiler will complain.
   40: \ If you don't have a pronounciation field, the Forth name is used,
   41: \ and has to conform to the C identifier syntax.
   42: \ 
   43: \ These specifications are automatically translated into C-code for the
   44: \ interpreter and into some other files. I hope that your C compiler has
   45: \ decent optimization, otherwise the automatically generated code will
   46: \ be somewhat slow. The Forth version of the code is included for manual
   47: \ compilers, so they will need to compile only the important words.
   48: \ 
   49: \ Note that stack pointer adjustment is performed according to stack
   50: \ effect by automatically generated code and NEXT is automatically
   51: \ appended to the C code. Also, you can use the names in the stack
   52: \ effect in the C code. Stack access is automatic. One exception: if
   53: \ your code does not fall through, the results are not stored into the
   54: \ stack. Use different names on both sides of the '--', if you change a
   55: \ value (some stores to the stack are optimized away).
   56: \
   57: \ For superinstructions the syntax is:
   58: \
   59: \ forth-name [/ c-name] = forth-name forth-name ...
   60: \
   61: \ 
   62: \ The stack variables have the following types:
   63: \ 
   64: \ name matches	type
   65: \ f.*		Bool
   66: \ c.*		Char
   67: \ [nw].*	Cell
   68: \ u.*		UCell
   69: \ d.*		DCell
   70: \ ud.*		UDCell
   71: \ r.*		Float
   72: \ a_.*		Cell *
   73: \ c_.*		Char *
   74: \ f_.*		Float *
   75: \ df_.*		DFloat *
   76: \ sf_.*		SFloat *
   77: \ xt.*		XT
   78: \ f83name.*	F83Name *
   79: 
   80: \E stack data-stack   sp Cell
   81: \E stack fp-stack     fp Float
   82: \E stack return-stack rp Cell
   83: \E
   84: \E get-current prefixes set-current
   85: \E 
   86: \E s" Bool"		single data-stack type-prefix f
   87: \E s" Char"		single data-stack type-prefix c
   88: \E s" Cell"		single data-stack type-prefix n
   89: \E s" Cell"		single data-stack type-prefix w
   90: \E s" UCell"		single data-stack type-prefix u
   91: \E s" DCell"		double data-stack type-prefix d
   92: \E s" UDCell"		double data-stack type-prefix ud
   93: \E s" Float"		single fp-stack   type-prefix r
   94: \E s" Cell *"		single data-stack type-prefix a_
   95: \E s" Char *"		single data-stack type-prefix c_
   96: \E s" Float *"		single data-stack type-prefix f_
   97: \E s" DFloat *"		single data-stack type-prefix df_
   98: \E s" SFloat *"		single data-stack type-prefix sf_
   99: \E s" Xt"		single data-stack type-prefix xt
  100: \E s" struct F83Name *"	single data-stack type-prefix f83name
  101: \E s" struct Longname *" single data-stack type-prefix longname
  102: \E 
  103: \E data-stack   stack-prefix S:
  104: \E fp-stack     stack-prefix F:
  105: \E return-stack stack-prefix R:
  106: \E inst-stream  stack-prefix #
  107: \E 
  108: \E set-current
  109: \E store-optimization on
  110: \E ' noop tail-nextp2 ! \ now INST_TAIL just stores, but does not jump
  111: \E
  112: \E include-skipped-insts on \ static superinsts include cells for components
  113: \E                          \ useful for dynamic programming and
  114: \E                          \ superinsts across entry points
  115: 
  116: \ 
  117: \ 
  118: \ 
  119: \ In addition the following names can be used:
  120: \ ip	the instruction pointer
  121: \ sp	the data stack pointer
  122: \ rp	the parameter stack pointer
  123: \ lp	the locals stack pointer
  124: \ NEXT	executes NEXT
  125: \ cfa	
  126: \ NEXT1	executes NEXT1
  127: \ FLAG(x)	makes a Forth flag from a C flag
  128: \ 
  129: \ 
  130: \ 
  131: \ Percentages in comments are from Koopmans book: average/maximum use
  132: \ (taken from four, not very representative benchmarks)
  133: \ 
  134: \ 
  135: \ 
  136: \ To do:
  137: \ 
  138: \ throw execute, cfa and NEXT1 out?
  139: \ macroize *ip, ip++, *ip++ (pipelining)?
  140: 
  141: \ Stack caching setup
  142: 
  143: ifdef(`STACK_CACHE_FILE', `include(STACK_CACHE_FILE)', `include(cache0.vmg)')
  144: 
  145: \ these m4 macros would collide with identifiers
  146: undefine(`index')
  147: undefine(`shift')
  148: undefine(`symbols')
  149: 
  150: \F 0 [if]
  151: 
  152: \ run-time routines for non-primitives.  They are defined as
  153: \ primitives, because that simplifies things.
  154: 
  155: (docol)	( -- R:a_retaddr )	gforth-internal	paren_docol
  156: ""run-time routine for colon definitions""
  157: #ifdef NO_IP
  158: a_retaddr = next_code;
  159: INST_TAIL;
  160: goto **(Label *)PFA(CFA);
  161: #else /* !defined(NO_IP) */
  162: a_retaddr = (Cell *)IP;
  163: SET_IP((Xt *)PFA(CFA));
  164: #endif /* !defined(NO_IP) */
  165: 
  166: (docon) ( -- w )	gforth-internal	paren_docon
  167: ""run-time routine for constants""
  168: w = *(Cell *)PFA(CFA);
  169: #ifdef NO_IP
  170: INST_TAIL;
  171: goto *next_code;
  172: #endif /* defined(NO_IP) */
  173: 
  174: (dovar) ( -- a_body )	gforth-internal	paren_dovar
  175: ""run-time routine for variables and CREATEd words""
  176: a_body = PFA(CFA);
  177: #ifdef NO_IP
  178: INST_TAIL;
  179: goto *next_code;
  180: #endif /* defined(NO_IP) */
  181: 
  182: (douser) ( -- a_user )	gforth-internal	paren_douser
  183: ""run-time routine for constants""
  184: a_user = (Cell *)(up+*(Cell *)PFA(CFA));
  185: #ifdef NO_IP
  186: INST_TAIL;
  187: goto *next_code;
  188: #endif /* defined(NO_IP) */
  189: 
  190: (dodefer) ( -- )	gforth-internal	paren_dodefer
  191: ""run-time routine for deferred words""
  192: #ifndef NO_IP
  193: ip=IP; /* undo any ip updating that may have been performed by NEXT_P0 */
  194: #endif /* !defined(NO_IP) */
  195: SUPER_END; /* !! probably unnecessary and may lead to measurement errors */
  196: VM_JUMP(EXEC1(*(Xt *)PFA(CFA)));
  197: 
  198: (dofield) ( n1 -- n2 )	gforth-internal	paren_field
  199: ""run-time routine for fields""
  200: n2 = n1 + *(Cell *)PFA(CFA);
  201: #ifdef NO_IP
  202: INST_TAIL;
  203: goto *next_code;
  204: #endif /* defined(NO_IP) */
  205: 
  206: (dodoes) ( -- a_body R:a_retaddr )	gforth-internal	paren_dodoes
  207: ""run-time routine for @code{does>}-defined words""
  208: #ifdef NO_IP
  209: a_retaddr = next_code;
  210: a_body = PFA(CFA);
  211: INST_TAIL;
  212: goto **(Label *)DOES_CODE1(CFA);
  213: #else /* !defined(NO_IP) */
  214: a_retaddr = (Cell *)IP;
  215: a_body = PFA(CFA);
  216: SET_IP(DOES_CODE1(CFA));
  217: #endif /* !defined(NO_IP) */
  218: 
  219: (does-handler) ( -- )	gforth-internal	paren_does_handler
  220: ""just a slot to have an encoding for the DOESJUMP, 
  221: which is no longer used anyway (!! eliminate this)""
  222: 
  223: \F [endif]
  224: 
  225: \g control
  226: 
  227: noop	( -- )		gforth
  228: :
  229:  ;
  230: 
  231: call	( #a_callee -- R:a_retaddr )	new
  232: ""Call callee (a variant of docol with inline argument).""
  233: #ifdef NO_IP
  234: assert(0);
  235: INST_TAIL;
  236: JUMP(a_callee);
  237: #else
  238: #ifdef DEBUG
  239:     {
  240:       CFA_TO_NAME((((Cell *)a_callee)-2));
  241:       fprintf(stderr,"%08lx: call %08lx %.*s\n",(Cell)ip,(Cell)a_callee,
  242: 	      len,name);
  243:     }
  244: #endif
  245: a_retaddr = (Cell *)IP;
  246: SET_IP((Xt *)a_callee);
  247: #endif
  248: 
  249: execute	( xt -- )		core
  250: ""Perform the semantics represented by the execution token, @i{xt}.""
  251: #ifndef NO_IP
  252: ip=IP;
  253: #endif
  254: SUPER_END;
  255: VM_JUMP(EXEC1(xt));
  256: 
  257: perform	( a_addr -- )	gforth
  258: ""@code{@@ execute}.""
  259: /* and pfe */
  260: #ifndef NO_IP
  261: ip=IP;
  262: #endif
  263: SUPER_END;
  264: VM_JUMP(EXEC1(*(Xt *)a_addr));
  265: :
  266:  @ execute ;
  267: 
  268: ;s	( R:w -- )		gforth	semis
  269: ""The primitive compiled by @code{EXIT}.""
  270: #ifdef NO_IP
  271: INST_TAIL;
  272: goto *(void *)w;
  273: #else
  274: SET_IP((Xt *)w);
  275: #endif
  276: 
  277: unloop	( R:w1 R:w2 -- )	core
  278: /* !! alias for 2rdrop */
  279: :
  280:  r> rdrop rdrop >r ;
  281: 
  282: lit-perform	( #a_addr -- )	new	lit_perform
  283: #ifndef NO_IP
  284: ip=IP;
  285: #endif
  286: SUPER_END;
  287: VM_JUMP(EXEC1(*(Xt *)a_addr));
  288: 
  289: does-exec ( #a_cfa -- R:nest a_pfa )	new	does_exec
  290: #ifdef NO_IP
  291: /* compiled to LIT CALL by compile_prim */
  292: assert(0);
  293: #else
  294: a_pfa = PFA(a_cfa);
  295: nest = (Cell)IP;
  296: #ifdef DEBUG
  297:     {
  298:       CFA_TO_NAME(a_cfa);
  299:       fprintf(stderr,"%08lx: does %08lx %.*s\n",
  300: 	      (Cell)ip,(Cell)a_cfa,len,name);
  301:     }
  302: #endif
  303: SET_IP(DOES_CODE1(a_cfa));
  304: #endif
  305: 
  306: \+glocals
  307: 
  308: branch-lp+!# ( #a_target #nlocals -- )	gforth	branch_lp_plus_store_number
  309: /* this will probably not be used */
  310: lp += nlocals;
  311: #ifdef NO_IP
  312: INST_TAIL;
  313: JUMP(a_target);
  314: #else
  315: SET_IP((Xt *)a_target);
  316: #endif
  317: 
  318: \+
  319: 
  320: branch	( #a_target -- )	gforth
  321: #ifdef NO_IP
  322: INST_TAIL;
  323: JUMP(a_target);
  324: #else
  325: SET_IP((Xt *)a_target);
  326: #endif
  327: :
  328:  r> @ >r ;
  329: 
  330: \ condbranch(forthname,stackeffect,restline,code1,code2,forthcode)
  331: \ this is non-syntactical: code must open a brace that is closed by the macro
  332: \ condbranch(forthname,stackeffect,restline,code1,code2,forthcode)
  333: \ this is non-syntactical: code must open a brace that is closed by the macro
  334: define(condbranch,
  335: $1 ( `#'a_target $2 ) $3
  336: $4	#ifdef NO_IP
  337: INST_TAIL;
  338: #endif
  339: $5	#ifdef NO_IP
  340: JUMP(a_target);
  341: #else
  342: SET_IP((Xt *)a_target);
  343: #endif
  344: }
  345: $6
  346: 
  347: \+glocals
  348: 
  349: $1-lp+!`#' ( `#'a_target `#'nlocals $2 ) $3_lp_plus_store_number
  350: $4	#ifdef NO_IP
  351: INST_TAIL;
  352: #endif
  353: $5	lp += nlocals;
  354: #ifdef NO_IP
  355: JUMP(a_target);
  356: #else
  357: SET_IP((Xt *)a_target);
  358: #endif
  359: }
  360: 
  361: \+
  362: )
  363: 
  364: \ version that generates two jumps (not good for PR 15242 workaround)
  365: define(condbranch_twojump,
  366: $1 ( `#'a_target $2 ) $3
  367: $4	#ifdef NO_IP
  368: INST_TAIL;
  369: #endif
  370: $5	#ifdef NO_IP
  371: JUMP(a_target);
  372: #else
  373: SET_IP((Xt *)a_target);
  374: INST_TAIL; NEXT_P2;
  375: #endif
  376: }
  377: SUPER_CONTINUE;
  378: $6
  379: 
  380: \+glocals
  381: 
  382: $1-lp+!`#' ( `#'a_target `#'nlocals $2 ) $3_lp_plus_store_number
  383: $4	#ifdef NO_IP
  384: INST_TAIL;
  385: #endif
  386: $5	lp += nlocals;
  387: #ifdef NO_IP
  388: JUMP(a_target);
  389: #else
  390: SET_IP((Xt *)a_target);
  391: INST_TAIL; NEXT_P2;
  392: #endif
  393: }
  394: SUPER_CONTINUE;
  395: 
  396: \+
  397: )
  398: 
  399: condbranch(?branch,f --,f83	question_branch,
  400: ,if (f==0) {
  401: ,:
  402:  0= dup 0=          \ !f f
  403:  r> tuck cell+      \ !f branchoffset f IP+
  404:  and -rot @ and or  \ f&IP+|!f&branch
  405:  >r ;)
  406: 
  407: \ we don't need an lp_plus_store version of the ?dup-stuff, because it
  408: \ is only used in if's (yet)
  409: 
  410: \+xconds
  411: 
  412: ?dup-?branch	( #a_target f -- S:... )	new	question_dupe_question_branch
  413: ""The run-time procedure compiled by @code{?DUP-IF}.""
  414: if (f==0) {
  415: #ifdef NO_IP
  416: INST_TAIL;
  417: JUMP(a_target);
  418: #else
  419: SET_IP((Xt *)a_target);
  420: #endif
  421: } else {
  422: sp--;
  423: sp[0]=f;
  424: }
  425: 
  426: ?dup-0=-?branch ( #a_target f -- S:... ) new	question_dupe_zero_equals_question_branch
  427: ""The run-time procedure compiled by @code{?DUP-0=-IF}.""
  428: if (f!=0) {
  429:   sp--;
  430:   sp[0]=f;
  431: #ifdef NO_IP
  432:   JUMP(a_target);
  433: #else
  434:   SET_IP((Xt *)a_target);
  435: #endif
  436: }
  437: 
  438: \+
  439: \fhas? skiploopprims 0= [IF]
  440: 
  441: condbranch((next),R:n1 -- R:n2,cmFORTH	paren_next,
  442: n2=n1-1;
  443: ,if (n1) {
  444: ,:
  445:  r> r> dup 1- >r
  446:  IF @ >r ELSE cell+ >r THEN ;)
  447: 
  448: condbranch((loop),R:nlimit R:n1 -- R:nlimit R:n2,gforth	paren_loop,
  449: n2=n1+1;
  450: ,if (n2 != nlimit) {
  451: ,:
  452:  r> r> 1+ r> 2dup =
  453:  IF >r 1- >r cell+ >r
  454:  ELSE >r >r @ >r THEN ;)
  455: 
  456: condbranch((+loop),n R:nlimit R:n1 -- R:nlimit R:n2,gforth paren_plus_loop,
  457: /* !! check this thoroughly */
  458: /* sign bit manipulation and test: (x^y)<0 is equivalent to (x<0) != (y<0) */
  459: /* dependent upon two's complement arithmetic */
  460: Cell olddiff = n1-nlimit;
  461: n2=n1+n;	
  462: ,if (((olddiff^(olddiff+n))    /* the limit is not crossed */
  463:      &(olddiff^n))	       /* OR it is a wrap-around effect */
  464:     >=0) { /* & is used to avoid having two branches for gforth-native */
  465: ,:
  466:  r> swap
  467:  r> r> 2dup - >r
  468:  2 pick r@ + r@ xor 0< 0=
  469:  3 pick r> xor 0< 0= or
  470:  IF    >r + >r @ >r
  471:  ELSE  >r >r drop cell+ >r THEN ;)
  472: 
  473: \+xconds
  474: 
  475: condbranch((-loop),u R:nlimit R:n1 -- R:nlimit R:n2,gforth paren_minus_loop,
  476: UCell olddiff = n1-nlimit;
  477: n2=n1-u;
  478: ,if (olddiff>u) {
  479: ,)
  480: 
  481: condbranch((s+loop),n R:nlimit R:n1 -- R:nlimit R:n2,gforth	paren_symmetric_plus_loop,
  482: ""The run-time procedure compiled by S+LOOP. It loops until the index
  483: crosses the boundary between limit and limit-sign(n). I.e. a symmetric
  484: version of (+LOOP).""
  485: /* !! check this thoroughly */
  486: Cell diff = n1-nlimit;
  487: Cell newdiff = diff+n;
  488: if (n<0) {
  489:     diff = -diff;
  490:     newdiff = -newdiff;
  491: }
  492: n2=n1+n;
  493: ,if (((~diff)|newdiff)<0) { /* use | to avoid two branches for gforth-native */
  494: ,)
  495: 
  496: \+
  497: 
  498: (for)   ( ncount -- R:nlimit R:ncount )         cmFORTH         paren_for
  499: /* or (for) = >r -- collides with unloop! */
  500: nlimit=0;
  501: :
  502:  r> swap 0 >r >r >r ;
  503: 
  504: (do)    ( nlimit nstart -- R:nlimit R:nstart )  gforth          paren_do
  505: :
  506:  r> swap rot >r >r >r ;
  507: 
  508: (?do) ( #a_target nlimit nstart -- R:nlimit R:nstart ) gforth	paren_question_do
  509: #ifdef NO_IP
  510:     INST_TAIL;
  511: #endif
  512: if (nstart == nlimit) {
  513: #ifdef NO_IP
  514:     JUMP(a_target);
  515: #else
  516:     SET_IP((Xt *)a_target);
  517: #endif
  518: }
  519: :
  520:   2dup =
  521:   IF   r> swap rot >r >r
  522:        @ >r
  523:   ELSE r> swap rot >r >r
  524:        cell+ >r
  525:   THEN ;				\ --> CORE-EXT
  526: 
  527: \+xconds
  528: 
  529: (+do)	( #a_target nlimit nstart -- R:nlimit R:nstart ) gforth	paren_plus_do
  530: #ifdef NO_IP
  531:     INST_TAIL;
  532: #endif
  533: if (nstart >= nlimit) {
  534: #ifdef NO_IP
  535:     JUMP(a_target);
  536: #else
  537:     SET_IP((Xt *)a_target);
  538: #endif
  539: }
  540: :
  541:  swap 2dup
  542:  r> swap >r swap >r
  543:  >=
  544:  IF
  545:      @
  546:  ELSE
  547:      cell+
  548:  THEN  >r ;
  549: 
  550: (u+do)	( #a_target ulimit ustart -- R:ulimit R:ustart ) gforth	paren_u_plus_do
  551: #ifdef NO_IP
  552:     INST_TAIL;
  553: #endif
  554: if (ustart >= ulimit) {
  555: #ifdef NO_IP
  556: JUMP(a_target);
  557: #else
  558: SET_IP((Xt *)a_target);
  559: #endif
  560: }
  561: :
  562:  swap 2dup
  563:  r> swap >r swap >r
  564:  u>=
  565:  IF
  566:      @
  567:  ELSE
  568:      cell+
  569:  THEN  >r ;
  570: 
  571: (-do)	( #a_target nlimit nstart -- R:nlimit R:nstart ) gforth	paren_minus_do
  572: #ifdef NO_IP
  573:     INST_TAIL;
  574: #endif
  575: if (nstart <= nlimit) {
  576: #ifdef NO_IP
  577: JUMP(a_target);
  578: #else
  579: SET_IP((Xt *)a_target);
  580: #endif
  581: }
  582: :
  583:  swap 2dup
  584:  r> swap >r swap >r
  585:  <=
  586:  IF
  587:      @
  588:  ELSE
  589:      cell+
  590:  THEN  >r ;
  591: 
  592: (u-do)	( #a_target ulimit ustart -- R:ulimit R:ustart ) gforth	paren_u_minus_do
  593: #ifdef NO_IP
  594:     INST_TAIL;
  595: #endif
  596: if (ustart <= ulimit) {
  597: #ifdef NO_IP
  598: JUMP(a_target);
  599: #else
  600: SET_IP((Xt *)a_target);
  601: #endif
  602: }
  603: :
  604:  swap 2dup
  605:  r> swap >r swap >r
  606:  u<=
  607:  IF
  608:      @
  609:  ELSE
  610:      cell+
  611:  THEN  >r ;
  612: 
  613: \+
  614: 
  615: \ don't make any assumptions where the return stack is!!
  616: \ implement this in machine code if it should run quickly!
  617: 
  618: i	( R:n -- R:n n )		core
  619: :
  620: \ rp@ cell+ @ ;
  621:   r> r> tuck >r >r ;
  622: 
  623: i'	( R:w R:w2 -- R:w R:w2 w )		gforth		i_tick
  624: :
  625: \ rp@ cell+ cell+ @ ;
  626:   r> r> r> dup itmp ! >r >r >r itmp @ ;
  627: variable itmp
  628: 
  629: j	( R:n R:d1 -- n R:n R:d1 )		core
  630: :
  631: \ rp@ cell+ cell+ cell+ @ ;
  632:   r> r> r> r> dup itmp ! >r >r >r >r itmp @ ;
  633: [IFUNDEF] itmp variable itmp [THEN]
  634: 
  635: k	( R:n R:d1 R:d2 -- n R:n R:d1 R:d2 )		gforth
  636: :
  637: \ rp@ [ 5 cells ] Literal + @ ;
  638:   r> r> r> r> r> r> dup itmp ! >r >r >r >r >r >r itmp @ ;
  639: [IFUNDEF] itmp variable itmp [THEN]
  640: 
  641: \f[THEN]
  642: 
  643: \ digit is high-level: 0/0%
  644: 
  645: \g strings
  646: 
  647: move	( c_from c_to ucount -- )		core
  648: ""Copy the contents of @i{ucount} aus at @i{c-from} to
  649: @i{c-to}. @code{move} works correctly even if the two areas overlap.""
  650: /* !! note that the standard specifies addr, not c-addr */
  651: memmove(c_to,c_from,ucount);
  652: /* make an Ifdef for bsd and others? */
  653: :
  654:  >r 2dup u< IF r> cmove> ELSE r> cmove THEN ;
  655: 
  656: cmove	( c_from c_to u -- )	string	c_move
  657: ""Copy the contents of @i{ucount} characters from data space at
  658: @i{c-from} to @i{c-to}. The copy proceeds @code{char}-by-@code{char}
  659: from low address to high address; i.e., for overlapping areas it is
  660: safe if @i{c-to}=<@i{c-from}.""
  661: cmove(c_from,c_to,u);
  662: :
  663:  bounds ?DO  dup c@ I c! 1+  LOOP  drop ;
  664: 
  665: cmove>	( c_from c_to u -- )	string	c_move_up
  666: ""Copy the contents of @i{ucount} characters from data space at
  667: @i{c-from} to @i{c-to}. The copy proceeds @code{char}-by-@code{char}
  668: from high address to low address; i.e., for overlapping areas it is
  669: safe if @i{c-to}>=@i{c-from}.""
  670: cmove_up(c_from,c_to,u);
  671: :
  672:  dup 0= IF  drop 2drop exit  THEN
  673:  rot over + -rot bounds swap 1-
  674:  DO  1- dup c@ I c!  -1 +LOOP  drop ;
  675: 
  676: fill	( c_addr u c -- )	core
  677: ""Store @i{c} in @i{u} chars starting at @i{c-addr}.""
  678: memset(c_addr,c,u);
  679: :
  680:  -rot bounds
  681:  ?DO  dup I c!  LOOP  drop ;
  682: 
  683: compare	( c_addr1 u1 c_addr2 u2 -- n )	string
  684: ""Compare two strings lexicographically. If they are equal, @i{n} is 0; if
  685: the first string is smaller, @i{n} is -1; if the first string is larger, @i{n}
  686: is 1. Currently this is based on the machine's character
  687: comparison. In the future, this may change to consider the current
  688: locale and its collation order.""
  689: /* close ' to keep fontify happy */ 
  690: n = compare(c_addr1, u1, c_addr2, u2);
  691: :
  692:  rot 2dup swap - >r min swap -text dup
  693:  IF  rdrop  ELSE  drop r> sgn  THEN ;
  694: : -text ( c_addr1 u c_addr2 -- n )
  695:  swap bounds
  696:  ?DO  dup c@ I c@ = WHILE  1+  LOOP  drop 0
  697:  ELSE  c@ I c@ - unloop  THEN  sgn ;
  698: : sgn ( n -- -1/0/1 )
  699:  dup 0= IF EXIT THEN  0< 2* 1+ ;
  700: 
  701: \ -text is only used by replaced primitives now; move it elsewhere
  702: \ -text	( c_addr1 u c_addr2 -- n )	new	dash_text
  703: \ n = memcmp(c_addr1, c_addr2, u);
  704: \ if (n<0)
  705: \   n = -1;
  706: \ else if (n>0)
  707: \   n = 1;
  708: \ :
  709: \  swap bounds
  710: \  ?DO  dup c@ I c@ = WHILE  1+  LOOP  drop 0
  711: \  ELSE  c@ I c@ - unloop  THEN  sgn ;
  712: \ : sgn ( n -- -1/0/1 )
  713: \  dup 0= IF EXIT THEN  0< 2* 1+ ;
  714: 
  715: toupper	( c1 -- c2 )	gforth
  716: ""If @i{c1} is a lower-case character (in the current locale), @i{c2}
  717: is the equivalent upper-case character. All other characters are unchanged.""
  718: c2 = toupper(c1);
  719: :
  720:  dup [char] a - [ char z char a - 1 + ] Literal u<  bl and - ;
  721: 
  722: capscompare	( c_addr1 u1 c_addr2 u2 -- n )	string
  723: ""Compare two strings lexicographically. If they are equal, @i{n} is 0; if
  724: the first string is smaller, @i{n} is -1; if the first string is larger, @i{n}
  725: is 1. Currently this is based on the machine's character
  726: comparison. In the future, this may change to consider the current
  727: locale and its collation order.""
  728: /* close ' to keep fontify happy */ 
  729: n = capscompare(c_addr1, u1, c_addr2, u2);
  730: 
  731: /string	( c_addr1 u1 n -- c_addr2 u2 )	string	slash_string
  732: ""Adjust the string specified by @i{c-addr1, u1} to remove @i{n}
  733: characters from the start of the string.""
  734: c_addr2 = c_addr1+n;
  735: u2 = u1-n;
  736: :
  737:  tuck - >r + r> dup 0< IF  - 0  THEN ;
  738: 
  739: \g arith
  740: 
  741: lit	( #w -- w )		gforth
  742: :
  743:  r> dup @ swap cell+ >r ;
  744: 
  745: +	( n1 n2 -- n )		core	plus
  746: n = n1+n2;
  747: 
  748: \ lit+ / lit_plus = lit +
  749: 
  750: lit+	( n1 #n2 -- n )		new	lit_plus
  751: n=n1+n2;
  752: 
  753: \ PFE-0.9.14 has it differently, but the next release will have it as follows
  754: under+	( n1 n2 n3 -- n n2 )	gforth	under_plus
  755: ""add @i{n3} to @i{n1} (giving @i{n})""
  756: n = n1+n3;
  757: :
  758:  rot + swap ;
  759: 
  760: -	( n1 n2 -- n )		core	minus
  761: n = n1-n2;
  762: :
  763:  negate + ;
  764: 
  765: negate	( n1 -- n2 )		core
  766: /* use minus as alias */
  767: n2 = -n1;
  768: :
  769:  invert 1+ ;
  770: 
  771: 1+	( n1 -- n2 )		core		one_plus
  772: n2 = n1+1;
  773: :
  774:  1 + ;
  775: 
  776: 1-	( n1 -- n2 )		core		one_minus
  777: n2 = n1-1;
  778: :
  779:  1 - ;
  780: 
  781: max	( n1 n2 -- n )	core
  782: if (n1<n2)
  783:   n = n2;
  784: else
  785:   n = n1;
  786: :
  787:  2dup < IF swap THEN drop ;
  788: 
  789: min	( n1 n2 -- n )	core
  790: if (n1<n2)
  791:   n = n1;
  792: else
  793:   n = n2;
  794: :
  795:  2dup > IF swap THEN drop ;
  796: 
  797: abs	( n -- u )	core
  798: if (n<0)
  799:   u = -n;
  800: else
  801:   u = n;
  802: :
  803:  dup 0< IF negate THEN ;
  804: 
  805: *	( n1 n2 -- n )		core	star
  806: n = n1*n2;
  807: :
  808:  um* drop ;
  809: 
  810: /	( n1 n2 -- n )		core	slash
  811: n = n1/n2;
  812: if (CHECK_DIVISION_SW && n2 == 0)
  813:   throw(BALL_DIVZERO);
  814: if (CHECK_DIVISION_SW && n2 == -1 && n1 == CELL_MIN)
  815:   throw(BALL_RESULTRANGE);
  816: if (FLOORED_DIV && ((n1^n2) < 0) && (n1%n2 != 0))
  817:   n--;
  818: :
  819:  /mod nip ;
  820: 
  821: mod	( n1 n2 -- n )		core
  822: n = n1%n2;
  823: if (CHECK_DIVISION_SW && n2 == 0)
  824:   throw(BALL_DIVZERO);
  825: if (CHECK_DIVISION_SW && n2 == -1 && n1 == CELL_MIN)
  826:   throw(BALL_RESULTRANGE);
  827: if(FLOORED_DIV && ((n1^n2) < 0) && n!=0) n += n2;
  828: :
  829:  /mod drop ;
  830: 
  831: /mod	( n1 n2 -- n3 n4 )		core		slash_mod
  832: n4 = n1/n2;
  833: n3 = n1%n2; /* !! is this correct? look into C standard! */
  834: if (CHECK_DIVISION_SW && n2 == 0)
  835:   throw(BALL_DIVZERO);
  836: if (CHECK_DIVISION_SW && n2 == -1 && n1 == CELL_MIN)
  837:   throw(BALL_RESULTRANGE);
  838: if (FLOORED_DIV && ((n1^n2) < 0) && n3!=0) {
  839:   n4--;
  840:   n3+=n2;
  841: }
  842: :
  843:  >r s>d r> fm/mod ;
  844: 
  845: */mod	( n1 n2 n3 -- n4 n5 )	core	star_slash_mod
  846: ""n1*n2=n3*n5+n4, with the intermediate result (n1*n2) being double.""
  847: #ifdef BUGGY_LL_MUL
  848: DCell d = mmul(n1,n2);
  849: #else
  850: DCell d = (DCell)n1 * (DCell)n2;
  851: #endif
  852: #ifdef ASM_SM_SLASH_REM
  853: ASM_SM_SLASH_REM(DLO(d), DHI(d), n3, n4, n5);
  854: if (FLOORED_DIV && ((DHI(d)^n3)<0) && n4!=0) {
  855:   if (CHECK_DIVISION && n5 == CELL_MIN)
  856:     throw(BALL_RESULTRANGE);
  857:   n5--;
  858:   n4+=n3;
  859: }
  860: #else
  861: DCell r = FLOORED_DIV ? fmdiv(d,n3) : smdiv(d,n3);
  862: n4=DHI(r);
  863: n5=DLO(r);
  864: #endif
  865: :
  866:  >r m* r> fm/mod ;
  867: 
  868: */	( n1 n2 n3 -- n4 )	core	star_slash
  869: ""n4=(n1*n2)/n3, with the intermediate result being double.""
  870: #ifdef BUGGY_LL_MUL
  871: DCell d = mmul(n1,n2);
  872: #else
  873: DCell d = (DCell)n1 * (DCell)n2;
  874: #endif
  875: #ifdef ASM_SM_SLASH_REM
  876: Cell remainder;
  877: ASM_SM_SLASH_REM(DLO(d), DHI(d), n3, remainder, n4);
  878: if (FLOORED_DIV && ((DHI(d)^n3)<0) && remainder!=0) {
  879:   if (CHECK_DIVISION && n4 == CELL_MIN)
  880:     throw(BALL_RESULTRANGE);
  881:   n4--;
  882: }
  883: #else
  884: DCell r = FLOORED_DIV ? fmdiv(d,n3) : smdiv(d,n3);
  885: n4=DLO(r);
  886: #endif
  887: :
  888:  */mod nip ;
  889: 
  890: 2*	( n1 -- n2 )		core		two_star
  891: ""Shift left by 1; also works on unsigned numbers""
  892: n2 = 2*n1;
  893: :
  894:  dup + ;
  895: 
  896: 2/	( n1 -- n2 )		core		two_slash
  897: ""Arithmetic shift right by 1.  For signed numbers this is a floored
  898: division by 2 (note that @code{/} not necessarily floors).""
  899: n2 = n1>>1;
  900: :
  901:  dup MINI and IF 1 ELSE 0 THEN
  902:  [ bits/char cell * 1- ] literal 
  903:  0 DO 2* swap dup 2* >r MINI and 
  904:      IF 1 ELSE 0 THEN or r> swap
  905:  LOOP nip ;
  906: 
  907: fm/mod	( d1 n1 -- n2 n3 )		core		f_m_slash_mod
  908: ""Floored division: @i{d1} = @i{n3}*@i{n1}+@i{n2}, @i{n1}>@i{n2}>=0 or 0>=@i{n2}>@i{n1}.""
  909: #ifdef ASM_SM_SLASH_REM
  910: ASM_SM_SLASH_REM(DLO(d1), DHI(d1), n1, n2, n3);
  911: if (((DHI(d1)^n1)<0) && n2!=0) {
  912:   if (CHECK_DIVISION && n3 == CELL_MIN)
  913:     throw(BALL_RESULTRANGE);
  914:   n3--;
  915:   n2+=n1;
  916: }
  917: #else /* !defined(ASM_SM_SLASH_REM) */
  918: DCell r = fmdiv(d1,n1);
  919: n2=DHI(r);
  920: n3=DLO(r);
  921: #endif /* !defined(ASM_SM_SLASH_REM) */
  922: :
  923:  dup >r dup 0< IF  negate >r dnegate r>  THEN
  924:  over       0< IF  tuck + swap  THEN
  925:  um/mod
  926:  r> 0< IF  swap negate swap  THEN ;
  927: 
  928: sm/rem	( d1 n1 -- n2 n3 )		core		s_m_slash_rem
  929: ""Symmetric division: @i{d1} = @i{n3}*@i{n1}+@i{n2}, sign(@i{n2})=sign(@i{d1}) or 0.""
  930: #ifdef ASM_SM_SLASH_REM
  931: ASM_SM_SLASH_REM(DLO(d1), DHI(d1), n1, n2, n3);
  932: #else /* !defined(ASM_SM_SLASH_REM) */
  933: DCell r = smdiv(d1,n1);
  934: n2=DHI(r);
  935: n3=DLO(r);
  936: #endif /* !defined(ASM_SM_SLASH_REM) */
  937: :
  938:  over >r dup >r abs -rot
  939:  dabs rot um/mod
  940:  r> r@ xor 0< IF       negate       THEN
  941:  r>        0< IF  swap negate swap  THEN ;
  942: 
  943: m*	( n1 n2 -- d )		core	m_star
  944: #ifdef BUGGY_LL_MUL
  945: d = mmul(n1,n2);
  946: #else
  947: d = (DCell)n1 * (DCell)n2;
  948: #endif
  949: :
  950:  2dup      0< and >r
  951:  2dup swap 0< and >r
  952:  um* r> - r> - ;
  953: 
  954: um*	( u1 u2 -- ud )		core	u_m_star
  955: /* use u* as alias */
  956: #ifdef BUGGY_LL_MUL
  957: ud = ummul(u1,u2);
  958: #else
  959: ud = (UDCell)u1 * (UDCell)u2;
  960: #endif
  961: :
  962:    0 -rot dup [ 8 cells ] literal -
  963:    DO
  964: 	dup 0< I' and d2*+ drop
  965:    LOOP ;
  966: : d2*+ ( ud n -- ud+n c )
  967:    over MINI
  968:    and >r >r 2dup d+ swap r> + swap r> ;
  969: 
  970: um/mod	( ud u1 -- u2 u3 )		core	u_m_slash_mod
  971: ""ud=u3*u1+u2, u1>u2>=0""
  972: #ifdef ASM_UM_SLASH_MOD
  973: ASM_UM_SLASH_MOD(DLO(ud), DHI(ud), u1, u2, u3);
  974: #else /* !defined(ASM_UM_SLASH_MOD) */
  975: UDCell r = umdiv(ud,u1);
  976: u2=DHI(r);
  977: u3=DLO(r);
  978: #endif /* !defined(ASM_UM_SLASH_MOD) */
  979: :
  980:    0 swap [ 8 cells 1 + ] literal 0
  981:    ?DO /modstep
  982:    LOOP drop swap 1 rshift or swap ;
  983: : /modstep ( ud c R: u -- ud-?u c R: u )
  984:    >r over r@ u< 0= or IF r@ - 1 ELSE 0 THEN  d2*+ r> ;
  985: : d2*+ ( ud n -- ud+n c )
  986:    over MINI
  987:    and >r >r 2dup d+ swap r> + swap r> ;
  988: 
  989: m+	( d1 n -- d2 )		double		m_plus
  990: #ifdef BUGGY_LL_ADD
  991: DLO_IS(d2, DLO(d1)+n);
  992: DHI_IS(d2, DHI(d1) - (n<0) + (DLO(d2)<DLO(d1)));
  993: #else
  994: d2 = d1+n;
  995: #endif
  996: :
  997:  s>d d+ ;
  998: 
  999: d+	( d1 d2 -- d )		double	d_plus
 1000: #ifdef BUGGY_LL_ADD
 1001: DLO_IS(d, DLO(d1) + DLO(d2));
 1002: DHI_IS(d, DHI(d1) + DHI(d2) + (d.lo<DLO(d1)));
 1003: #else
 1004: d = d1+d2;
 1005: #endif
 1006: :
 1007:  rot + >r tuck + swap over u> r> swap - ;
 1008: 
 1009: d-	( d1 d2 -- d )		double		d_minus
 1010: #ifdef BUGGY_LL_ADD
 1011: DLO_IS(d, DLO(d1) - DLO(d2));
 1012: DHI_IS(d, DHI(d1)-DHI(d2)-(DLO(d1)<DLO(d2)));
 1013: #else
 1014: d = d1-d2;
 1015: #endif
 1016: :
 1017:  dnegate d+ ;
 1018: 
 1019: dnegate	( d1 -- d2 )		double	d_negate
 1020: /* use dminus as alias */
 1021: #ifdef BUGGY_LL_ADD
 1022: d2 = dnegate(d1);
 1023: #else
 1024: d2 = -d1;
 1025: #endif
 1026: :
 1027:  invert swap negate tuck 0= - ;
 1028: 
 1029: d2*	( d1 -- d2 )		double		d_two_star
 1030: ""Shift left by 1; also works on unsigned numbers""
 1031: d2 = DLSHIFT(d1,1);
 1032: :
 1033:  2dup d+ ;
 1034: 
 1035: d2/	( d1 -- d2 )		double		d_two_slash
 1036: ""Arithmetic shift right by 1.  For signed numbers this is a floored
 1037: division by 2.""
 1038: #ifdef BUGGY_LL_SHIFT
 1039: DHI_IS(d2, DHI(d1)>>1);
 1040: DLO_IS(d2, (DLO(d1)>>1) | (DHI(d1)<<(CELL_BITS-1)));
 1041: #else
 1042: d2 = d1>>1;
 1043: #endif
 1044: :
 1045:  dup 1 and >r 2/ swap 2/ [ 1 8 cells 1- lshift 1- ] Literal and
 1046:  r> IF  [ 1 8 cells 1- lshift ] Literal + THEN  swap ;
 1047: 
 1048: and	( w1 w2 -- w )		core
 1049: w = w1&w2;
 1050: 
 1051: or	( w1 w2 -- w )		core
 1052: w = w1|w2;
 1053: :
 1054:  invert swap invert and invert ;
 1055: 
 1056: xor	( w1 w2 -- w )		core	x_or
 1057: w = w1^w2;
 1058: 
 1059: invert	( w1 -- w2 )		core
 1060: w2 = ~w1;
 1061: :
 1062:  MAXU xor ;
 1063: 
 1064: rshift	( u1 n -- u2 )		core	r_shift
 1065: ""Logical shift right by @i{n} bits.""
 1066: #ifdef BROKEN_SHIFT
 1067:   u2 = rshift(u1, n);
 1068: #else
 1069:   u2 = u1 >> n;
 1070: #endif
 1071: :
 1072:     0 ?DO 2/ MAXI and LOOP ;
 1073: 
 1074: lshift	( u1 n -- u2 )		core	l_shift
 1075: #ifdef BROKEN_SHIFT
 1076:   u2 = lshift(u1, n);
 1077: #else
 1078:   u2 = u1 << n;
 1079: #endif
 1080: :
 1081:     0 ?DO 2* LOOP ;
 1082: 
 1083: \g compare
 1084: 
 1085: \ comparisons(prefix, args, prefix, arg1, arg2, wordsets...)
 1086: define(comparisons,
 1087: $1=	( $2 -- f )		$6	$3equals
 1088: f = FLAG($4==$5);
 1089: :
 1090:     [ char $1x char 0 = [IF]
 1091: 	] IF false ELSE true THEN [
 1092:     [ELSE]
 1093: 	] xor 0= [
 1094:     [THEN] ] ;
 1095: 
 1096: $1<>	( $2 -- f )		$7	$3not_equals
 1097: f = FLAG($4!=$5);
 1098: :
 1099:     [ char $1x char 0 = [IF]
 1100: 	] IF true ELSE false THEN [
 1101:     [ELSE]
 1102: 	] xor 0<> [
 1103:     [THEN] ] ;
 1104: 
 1105: $1<	( $2 -- f )		$8	$3less_than
 1106: f = FLAG($4<$5);
 1107: :
 1108:     [ char $1x char 0 = [IF]
 1109: 	] MINI and 0<> [
 1110:     [ELSE] char $1x char u = [IF]
 1111: 	]   2dup xor 0<  IF nip ELSE - THEN 0<  [
 1112: 	[ELSE]
 1113: 	    ] MINI xor >r MINI xor r> u< [
 1114: 	[THEN]
 1115:     [THEN] ] ;
 1116: 
 1117: $1>	( $2 -- f )		$9	$3greater_than
 1118: f = FLAG($4>$5);
 1119: :
 1120:     [ char $1x char 0 = [IF] ] negate [ [ELSE] ] swap [ [THEN] ]
 1121:     $1< ;
 1122: 
 1123: $1<=	( $2 -- f )		gforth	$3less_or_equal
 1124: f = FLAG($4<=$5);
 1125: :
 1126:     $1> 0= ;
 1127: 
 1128: $1>=	( $2 -- f )		gforth	$3greater_or_equal
 1129: f = FLAG($4>=$5);
 1130: :
 1131:     [ char $1x char 0 = [IF] ] negate [ [ELSE] ] swap [ [THEN] ]
 1132:     $1<= ;
 1133: 
 1134: )
 1135: 
 1136: comparisons(0, n, zero_, n, 0, core, core-ext, core, core-ext)
 1137: comparisons(, n1 n2, , n1, n2, core, core-ext, core, core)
 1138: comparisons(u, u1 u2, u_, u1, u2, gforth, gforth, core, core-ext)
 1139: 
 1140: \ dcomparisons(prefix, args, prefix, arg1, arg2, wordsets...)
 1141: define(dcomparisons,
 1142: $1=	( $2 -- f )		$6	$3equals
 1143: #ifdef BUGGY_LL_CMP
 1144: f = FLAG($4.lo==$5.lo && $4.hi==$5.hi);
 1145: #else
 1146: f = FLAG($4==$5);
 1147: #endif
 1148: 
 1149: $1<>	( $2 -- f )		$7	$3not_equals
 1150: #ifdef BUGGY_LL_CMP
 1151: f = FLAG($4.lo!=$5.lo || $4.hi!=$5.hi);
 1152: #else
 1153: f = FLAG($4!=$5);
 1154: #endif
 1155: 
 1156: $1<	( $2 -- f )		$8	$3less_than
 1157: #ifdef BUGGY_LL_CMP
 1158: f = FLAG($4.hi==$5.hi ? $4.lo<$5.lo : $4.hi<$5.hi);
 1159: #else
 1160: f = FLAG($4<$5);
 1161: #endif
 1162: 
 1163: $1>	( $2 -- f )		$9	$3greater_than
 1164: #ifdef BUGGY_LL_CMP
 1165: f = FLAG($4.hi==$5.hi ? $4.lo>$5.lo : $4.hi>$5.hi);
 1166: #else
 1167: f = FLAG($4>$5);
 1168: #endif
 1169: 
 1170: $1<=	( $2 -- f )		gforth	$3less_or_equal
 1171: #ifdef BUGGY_LL_CMP
 1172: f = FLAG($4.hi==$5.hi ? $4.lo<=$5.lo : $4.hi<=$5.hi);
 1173: #else
 1174: f = FLAG($4<=$5);
 1175: #endif
 1176: 
 1177: $1>=	( $2 -- f )		gforth	$3greater_or_equal
 1178: #ifdef BUGGY_LL_CMP
 1179: f = FLAG($4.hi==$5.hi ? $4.lo>=$5.lo : $4.hi>=$5.hi);
 1180: #else
 1181: f = FLAG($4>=$5);
 1182: #endif
 1183: 
 1184: )
 1185: 
 1186: \+dcomps
 1187: 
 1188: dcomparisons(d, d1 d2, d_, d1, d2, double, gforth, double, gforth)
 1189: dcomparisons(d0, d, d_zero_, d, DZERO, double, gforth, double, gforth)
 1190: dcomparisons(du, ud1 ud2, d_u_, ud1, ud2, gforth, gforth, double-ext, gforth)
 1191: 
 1192: \+
 1193: 
 1194: within	( u1 u2 u3 -- f )		core-ext
 1195: ""u2=<u1<u3 or: u3=<u2 and u1 is not in [u3,u2).  This works for
 1196: unsigned and signed numbers (but not a mixture).  Another way to think
 1197: about this word is to consider the numbers as a circle (wrapping
 1198: around from @code{max-u} to 0 for unsigned, and from @code{max-n} to
 1199: min-n for signed numbers); now consider the range from u2 towards
 1200: increasing numbers up to and excluding u3 (giving an empty range if
 1201: u2=u3); if u1 is in this range, @code{within} returns true.""
 1202: f = FLAG(u1-u2 < u3-u2);
 1203: :
 1204:  over - >r - r> u< ;
 1205: 
 1206: \g stack
 1207: 
 1208: useraddr	( #u -- a_addr )	new
 1209: a_addr = (Cell *)(up+u);
 1210: 
 1211: up!	( a_addr -- )	gforth	up_store
 1212: gforth_UP=up=(Address)a_addr;
 1213: :
 1214:  up ! ;
 1215: Variable UP
 1216: 
 1217: sp@	( S:... -- a_addr )		gforth		sp_fetch
 1218: a_addr = sp;
 1219: 
 1220: sp!	( a_addr -- S:... )		gforth		sp_store
 1221: sp = a_addr;
 1222: 
 1223: rp@	( -- a_addr )		gforth		rp_fetch
 1224: a_addr = rp;
 1225: 
 1226: rp!	( a_addr -- )		gforth		rp_store
 1227: rp = a_addr;
 1228: 
 1229: \+floating
 1230: 
 1231: fp@	( f:... -- f_addr )	gforth	fp_fetch
 1232: f_addr = fp;
 1233: 
 1234: fp!	( f_addr -- f:... )	gforth	fp_store
 1235: fp = f_addr;
 1236: 
 1237: \+
 1238: 
 1239: >r	( w -- R:w )		core	to_r
 1240: :
 1241:  (>r) ;
 1242: : (>r)  rp@ cell+ @ rp@ ! rp@ cell+ ! ;
 1243: 
 1244: r>	( R:w -- w )		core	r_from
 1245: :
 1246:  rp@ cell+ @ rp@ @ rp@ cell+ ! (rdrop) rp@ ! ;
 1247: Create (rdrop) ' ;s A,
 1248: 
 1249: rdrop	( R:w -- )		gforth
 1250: :
 1251:  r> r> drop >r ;
 1252: 
 1253: 2>r	( d -- R:d )	core-ext	two_to_r
 1254: :
 1255:  swap r> swap >r swap >r >r ;
 1256: 
 1257: 2r>	( R:d -- d )	core-ext	two_r_from
 1258: :
 1259:  r> r> swap r> swap >r swap ;
 1260: 
 1261: 2r@	( R:d -- R:d d )	core-ext	two_r_fetch
 1262: :
 1263:  i' j ;
 1264: 
 1265: 2rdrop	( R:d -- )		gforth	two_r_drop
 1266: :
 1267:  r> r> drop r> drop >r ;
 1268: 
 1269: over	( w1 w2 -- w1 w2 w1 )		core
 1270: :
 1271:  sp@ cell+ @ ;
 1272: 
 1273: drop	( w -- )		core
 1274: :
 1275:  IF THEN ;
 1276: 
 1277: swap	( w1 w2 -- w2 w1 )		core
 1278: :
 1279:  >r (swap) ! r> (swap) @ ;
 1280: Variable (swap)
 1281: 
 1282: dup	( w -- w w )		core	dupe
 1283: :
 1284:  sp@ @ ;
 1285: 
 1286: rot	( w1 w2 w3 -- w2 w3 w1 )	core	rote
 1287: :
 1288: [ defined? (swap) [IF] ]
 1289:     (swap) ! (rot) ! >r (rot) @ (swap) @ r> ;
 1290: Variable (rot)
 1291: [ELSE] ]
 1292:     >r swap r> swap ;
 1293: [THEN]
 1294: 
 1295: -rot	( w1 w2 w3 -- w3 w1 w2 )	gforth	not_rote
 1296: :
 1297:  rot rot ;
 1298: 
 1299: nip	( w1 w2 -- w2 )		core-ext
 1300: :
 1301:  swap drop ;
 1302: 
 1303: tuck	( w1 w2 -- w2 w1 w2 )	core-ext
 1304: :
 1305:  swap over ;
 1306: 
 1307: ?dup	( w -- S:... w )	core	question_dupe
 1308: ""Actually the stack effect is: @code{( w -- 0 | w w )}.  It performs a
 1309: @code{dup} if w is nonzero.""
 1310: if (w!=0) {
 1311:   *--sp = w;
 1312: }
 1313: :
 1314:  dup IF dup THEN ;
 1315: 
 1316: pick	( S:... u -- S:... w )		core-ext
 1317: ""Actually the stack effect is @code{ x0 ... xu u -- x0 ... xu x0 }.""
 1318: w = sp[u];
 1319: :
 1320:  1+ cells sp@ + @ ;
 1321: 
 1322: 2drop	( w1 w2 -- )		core	two_drop
 1323: :
 1324:  drop drop ;
 1325: 
 1326: 2dup	( w1 w2 -- w1 w2 w1 w2 )	core	two_dupe
 1327: :
 1328:  over over ;
 1329: 
 1330: 2over	( w1 w2 w3 w4 -- w1 w2 w3 w4 w1 w2 )	core	two_over
 1331: :
 1332:  3 pick 3 pick ;
 1333: 
 1334: 2swap	( w1 w2 w3 w4 -- w3 w4 w1 w2 )	core	two_swap
 1335: :
 1336:  rot >r rot r> ;
 1337: 
 1338: 2rot	( w1 w2 w3 w4 w5 w6 -- w3 w4 w5 w6 w1 w2 )	double-ext	two_rote
 1339: :
 1340:  >r >r 2swap r> r> 2swap ;
 1341: 
 1342: 2nip	( w1 w2 w3 w4 -- w3 w4 )	gforth	two_nip
 1343: :
 1344:  2swap 2drop ;
 1345: 
 1346: 2tuck	( w1 w2 w3 w4 -- w3 w4 w1 w2 w3 w4 )	gforth	two_tuck
 1347: :
 1348:  2swap 2over ;
 1349: 
 1350: \ toggle is high-level: 0.11/0.42%
 1351: 
 1352: \g memory
 1353: 
 1354: @	( a_addr -- w )		core	fetch
 1355: ""@i{w} is the cell stored at @i{a_addr}.""
 1356: w = *a_addr;
 1357: 
 1358: \ lit@ / lit_fetch = lit @
 1359: 
 1360: lit@		( #a_addr -- w ) new	lit_fetch
 1361: w = *a_addr;
 1362: 
 1363: !	( w a_addr -- )		core	store
 1364: ""Store @i{w} into the cell at @i{a-addr}.""
 1365: *a_addr = w;
 1366: 
 1367: +!	( n a_addr -- )		core	plus_store
 1368: ""Add @i{n} to the cell at @i{a-addr}.""
 1369: *a_addr += n;
 1370: :
 1371:  tuck @ + swap ! ;
 1372: 
 1373: c@	( c_addr -- c )		core	c_fetch
 1374: ""@i{c} is the char stored at @i{c_addr}.""
 1375: c = *c_addr;
 1376: :
 1377: [ bigendian [IF] ]
 1378:     [ cell>bit 4 = [IF] ]
 1379: 	dup [ 0 cell - ] Literal and @ swap 1 and
 1380: 	IF  $FF and  ELSE  8>>  THEN  ;
 1381:     [ [ELSE] ]
 1382: 	dup [ cell 1- ] literal and
 1383: 	tuck - @ swap [ cell 1- ] literal xor
 1384:  	0 ?DO 8>> LOOP $FF and
 1385:     [ [THEN] ]
 1386: [ [ELSE] ]
 1387:     [ cell>bit 4 = [IF] ]
 1388: 	dup [ 0 cell - ] Literal and @ swap 1 and
 1389: 	IF  8>>  ELSE  $FF and  THEN
 1390:     [ [ELSE] ]
 1391: 	dup [ cell  1- ] literal and 
 1392: 	tuck - @ swap
 1393: 	0 ?DO 8>> LOOP 255 and
 1394:     [ [THEN] ]
 1395: [ [THEN] ]
 1396: ;
 1397: : 8>> 2/ 2/ 2/ 2/  2/ 2/ 2/ 2/ ;
 1398: 
 1399: c!	( c c_addr -- )		core	c_store
 1400: ""Store @i{c} into the char at @i{c-addr}.""
 1401: *c_addr = c;
 1402: :
 1403: [ bigendian [IF] ]
 1404:     [ cell>bit 4 = [IF] ]
 1405: 	tuck 1 and IF  $FF and  ELSE  8<<  THEN >r
 1406: 	dup -2 and @ over 1 and cells masks + @ and
 1407: 	r> or swap -2 and ! ;
 1408: 	Create masks $00FF , $FF00 ,
 1409:     [ELSE] ]
 1410: 	dup [ cell 1- ] literal and dup 
 1411: 	[ cell 1- ] literal xor >r
 1412: 	- dup @ $FF r@ 0 ?DO 8<< LOOP invert and
 1413: 	rot $FF and r> 0 ?DO 8<< LOOP or swap ! ;
 1414:     [THEN]
 1415: [ELSE] ]
 1416:     [ cell>bit 4 = [IF] ]
 1417: 	tuck 1 and IF  8<<  ELSE  $FF and  THEN >r
 1418: 	dup -2 and @ over 1 and cells masks + @ and
 1419: 	r> or swap -2 and ! ;
 1420: 	Create masks $FF00 , $00FF ,
 1421:     [ELSE] ]
 1422: 	dup [ cell 1- ] literal and dup >r
 1423: 	- dup @ $FF r@ 0 ?DO 8<< LOOP invert and
 1424: 	rot $FF and r> 0 ?DO 8<< LOOP or swap ! ;
 1425:     [THEN]
 1426: [THEN]
 1427: : 8<< 2* 2* 2* 2*  2* 2* 2* 2* ;
 1428: 
 1429: 2!	( w1 w2 a_addr -- )		core	two_store
 1430: ""Store @i{w2} into the cell at @i{c-addr} and @i{w1} into the next cell.""
 1431: a_addr[0] = w2;
 1432: a_addr[1] = w1;
 1433: :
 1434:  tuck ! cell+ ! ;
 1435: 
 1436: 2@	( a_addr -- w1 w2 )		core	two_fetch
 1437: ""@i{w2} is the content of the cell stored at @i{a-addr}, @i{w1} is
 1438: the content of the next cell.""
 1439: w2 = a_addr[0];
 1440: w1 = a_addr[1];
 1441: :
 1442:  dup cell+ @ swap @ ;
 1443: 
 1444: cell+	( a_addr1 -- a_addr2 )	core	cell_plus
 1445: ""@code{1 cells +}""
 1446: a_addr2 = a_addr1+1;
 1447: :
 1448:  cell + ;
 1449: 
 1450: cells	( n1 -- n2 )		core
 1451: "" @i{n2} is the number of address units of @i{n1} cells.""
 1452: n2 = n1 * sizeof(Cell);
 1453: :
 1454:  [ cell
 1455:  2/ dup [IF] ] 2* [ [THEN]
 1456:  2/ dup [IF] ] 2* [ [THEN]
 1457:  2/ dup [IF] ] 2* [ [THEN]
 1458:  2/ dup [IF] ] 2* [ [THEN]
 1459:  drop ] ;
 1460: 
 1461: char+	( c_addr1 -- c_addr2 )	core	char_plus
 1462: ""@code{1 chars +}.""
 1463: c_addr2 = c_addr1 + 1;
 1464: :
 1465:  1+ ;
 1466: 
 1467: (chars)	( n1 -- n2 )	gforth	paren_chars
 1468: n2 = n1 * sizeof(Char);
 1469: :
 1470:  ;
 1471: 
 1472: count	( c_addr1 -- c_addr2 u )	core
 1473: ""@i{c-addr2} is the first character and @i{u} the length of the
 1474: counted string at @i{c-addr1}.""
 1475: u = *c_addr1;
 1476: c_addr2 = c_addr1+1;
 1477: :
 1478:  dup 1+ swap c@ ;
 1479: 
 1480: \g compiler
 1481: 
 1482: \+f83headerstring
 1483: 
 1484: (f83find)	( c_addr u f83name1 -- f83name2 )	new	paren_f83find
 1485: for (; f83name1 != NULL; f83name1 = (struct F83Name *)(f83name1->next))
 1486:   if ((UCell)F83NAME_COUNT(f83name1)==u &&
 1487:       memcasecmp(c_addr, f83name1->name, u)== 0 /* or inline? */)
 1488:     break;
 1489: f83name2=f83name1;
 1490: :
 1491:     BEGIN  dup WHILE  (find-samelen)  dup  WHILE
 1492: 	>r 2dup r@ cell+ char+ capscomp  0=
 1493: 	IF  2drop r>  EXIT  THEN
 1494: 	r> @
 1495:     REPEAT  THEN  nip nip ;
 1496: : (find-samelen) ( u f83name1 -- u f83name2/0 )
 1497:     BEGIN  2dup cell+ c@ $1F and <> WHILE  @  dup 0= UNTIL  THEN ;
 1498: : capscomp ( c_addr1 u c_addr2 -- n )
 1499:  swap bounds
 1500:  ?DO  dup c@ I c@ <>
 1501:      IF  dup c@ toupper I c@ toupper =
 1502:      ELSE  true  THEN  WHILE  1+  LOOP  drop 0
 1503:  ELSE  c@ toupper I c@ toupper - unloop  THEN  sgn ;
 1504: : sgn ( n -- -1/0/1 )
 1505:  dup 0= IF EXIT THEN  0< 2* 1+ ;
 1506: 
 1507: \-
 1508: 
 1509: (listlfind)	( c_addr u longname1 -- longname2 )	new	paren_listlfind
 1510: longname2=listlfind(c_addr, u, longname1);
 1511: :
 1512:     BEGIN  dup WHILE  (findl-samelen)  dup  WHILE
 1513: 	>r 2dup r@ cell+ cell+ capscomp  0=
 1514: 	IF  2drop r>  EXIT  THEN
 1515: 	r> @
 1516:     REPEAT  THEN  nip nip ;
 1517: : (findl-samelen) ( u longname1 -- u longname2/0 )
 1518:     BEGIN  2dup cell+ @ lcount-mask and <> WHILE  @  dup 0= UNTIL  THEN ;
 1519: : capscomp ( c_addr1 u c_addr2 -- n )
 1520:  swap bounds
 1521:  ?DO  dup c@ I c@ <>
 1522:      IF  dup c@ toupper I c@ toupper =
 1523:      ELSE  true  THEN  WHILE  1+  LOOP  drop 0
 1524:  ELSE  c@ toupper I c@ toupper - unloop  THEN  sgn ;
 1525: : sgn ( n -- -1/0/1 )
 1526:  dup 0= IF EXIT THEN  0< 2* 1+ ;
 1527: 
 1528: \+hash
 1529: 
 1530: (hashlfind)	( c_addr u a_addr -- longname2 )	new	paren_hashlfind
 1531: longname2 = hashlfind(c_addr, u, a_addr);
 1532: :
 1533:  BEGIN  dup  WHILE
 1534:         2@ >r >r dup r@ cell+ @ lcount-mask and =
 1535:         IF  2dup r@ cell+ cell+ capscomp 0=
 1536: 	    IF  2drop r> rdrop  EXIT  THEN  THEN
 1537: 	rdrop r>
 1538:  REPEAT nip nip ;
 1539: 
 1540: (tablelfind)	( c_addr u a_addr -- longname2 )	new	paren_tablelfind
 1541: ""A case-sensitive variant of @code{(hashfind)}""
 1542: longname2 = tablelfind(c_addr, u, a_addr);
 1543: :
 1544:  BEGIN  dup  WHILE
 1545:         2@ >r >r dup r@ cell+ @ lcount-mask and =
 1546:         IF  2dup r@ cell+ cell+ -text 0=
 1547: 	    IF  2drop r> rdrop  EXIT  THEN  THEN
 1548: 	rdrop r>
 1549:  REPEAT nip nip ;
 1550: : -text ( c_addr1 u c_addr2 -- n )
 1551:  swap bounds
 1552:  ?DO  dup c@ I c@ = WHILE  1+  LOOP  drop 0
 1553:  ELSE  c@ I c@ - unloop  THEN  sgn ;
 1554: : sgn ( n -- -1/0/1 )
 1555:  dup 0= IF EXIT THEN  0< 2* 1+ ;
 1556: 
 1557: (hashkey1)	( c_addr u ubits -- ukey )		gforth	paren_hashkey1
 1558: ""ukey is the hash key for the string c_addr u fitting in ubits bits""
 1559: ukey = hashkey1(c_addr, u, ubits);
 1560: :
 1561:  dup rot-values + c@ over 1 swap lshift 1- >r
 1562:  tuck - 2swap r> 0 2swap bounds
 1563:  ?DO  dup 4 pick lshift swap 3 pick rshift or
 1564:       I c@ toupper xor
 1565:       over and  LOOP
 1566:  nip nip nip ;
 1567: Create rot-values
 1568:   5 c, 0 c, 1 c, 2 c, 3 c,  4 c, 5 c, 5 c, 5 c, 5 c,
 1569:   3 c, 5 c, 5 c, 5 c, 5 c,  7 c, 5 c, 5 c, 5 c, 5 c,
 1570:   7 c, 5 c, 5 c, 5 c, 5 c,  6 c, 5 c, 5 c, 5 c, 5 c,
 1571:   7 c, 5 c, 5 c,
 1572: 
 1573: \+
 1574: 
 1575: \+
 1576: 
 1577: (parse-white)	( c_addr1 u1 -- c_addr2 u2 )	gforth	paren_parse_white
 1578: struct Cellpair r=parse_white(c_addr1, u1);
 1579: c_addr2 = (Char *)(r.n1);
 1580: u2 = r.n2;
 1581: :
 1582:  BEGIN  dup  WHILE  over c@ bl <=  WHILE  1 /string
 1583:  REPEAT  THEN  2dup
 1584:  BEGIN  dup  WHILE  over c@ bl >   WHILE  1 /string
 1585:  REPEAT  THEN  nip - ;
 1586: 
 1587: aligned	( c_addr -- a_addr )	core
 1588: "" @i{a-addr} is the first aligned address greater than or equal to @i{c-addr}.""
 1589: a_addr = (Cell *)((((Cell)c_addr)+(sizeof(Cell)-1))&(-sizeof(Cell)));
 1590: :
 1591:  [ cell 1- ] Literal + [ -1 cells ] Literal and ;
 1592: 
 1593: faligned	( c_addr -- f_addr )	float	f_aligned
 1594: "" @i{f-addr} is the first float-aligned address greater than or equal to @i{c-addr}.""
 1595: f_addr = (Float *)((((Cell)c_addr)+(sizeof(Float)-1))&(-sizeof(Float)));
 1596: :
 1597:  [ 1 floats 1- ] Literal + [ -1 floats ] Literal and ;
 1598: 
 1599: \ threading stuff is currently only interesting if we have a compiler
 1600: \fhas? standardthreading has? compiler and [IF]
 1601: threading-method	( -- n )	gforth	threading_method
 1602: ""0 if the engine is direct threaded. Note that this may change during
 1603: the lifetime of an image.""
 1604: #if defined(DOUBLY_INDIRECT)
 1605: n=2;
 1606: #else
 1607: # if defined(DIRECT_THREADED)
 1608: n=0;
 1609: # else
 1610: n=1;
 1611: # endif
 1612: #endif
 1613: :
 1614:  1 ;
 1615: 
 1616: \f[THEN]
 1617: 
 1618: \g hostos
 1619: 
 1620: key-file	( wfileid -- c )		gforth	paren_key_file
 1621: ""Read one character @i{c} from @i{wfileid}.  This word disables
 1622: buffering for @i{wfileid}.  If you want to read characters from a
 1623: terminal in non-canonical (raw) mode, you have to put the terminal in
 1624: non-canonical mode yourself (using the C interface); the exception is
 1625: @code{stdin}: Gforth automatically puts it into non-canonical mode.""
 1626: #ifdef HAS_FILE
 1627: fflush(stdout);
 1628: c = key((FILE*)wfileid);
 1629: #else
 1630: c = key(stdin);
 1631: #endif
 1632: 
 1633: key?-file	( wfileid -- f )	        gforth	key_q_file
 1634: ""@i{f} is true if at least one character can be read from @i{wfileid}
 1635: without blocking.  If you also want to use @code{read-file} or
 1636: @code{read-line} on the file, you have to call @code{key?-file} or
 1637: @code{key-file} first (these two words disable buffering).""
 1638: #ifdef HAS_FILE
 1639: fflush(stdout);
 1640: f = key_query((FILE*)wfileid);
 1641: #else
 1642: f = key_query(stdin);
 1643: #endif
 1644: 
 1645: stdin	( -- wfileid )	gforth
 1646: ""The standard input file of the Gforth process.""
 1647: wfileid = (Cell)stdin;
 1648: 
 1649: stdout	( -- wfileid )	gforth
 1650: ""The standard output file of the Gforth process.""
 1651: wfileid = (Cell)stdout;
 1652: 
 1653: stderr	( -- wfileid )	gforth
 1654: ""The standard error output file of the Gforth process.""
 1655: wfileid = (Cell)stderr;
 1656: 
 1657: \+os
 1658: 
 1659: form	( -- urows ucols )	gforth
 1660: ""The number of lines and columns in the terminal. These numbers may
 1661: change with the window size.  Note that it depends on the OS whether
 1662: this reflects the actual size and changes with the window size
 1663: (currently only on Unix-like OSs).  On other OSs you just get a
 1664: default, and can tell Gforth the terminal size by setting the
 1665: environment variables @code{COLUMNS} and @code{LINES} before starting
 1666: Gforth.""
 1667: /* we could block SIGWINCH here to get a consistent size, but I don't
 1668:  think this is necessary or always beneficial */
 1669: urows=rows;
 1670: ucols=cols;
 1671: 
 1672: wcwidth	( u -- n )	gforth
 1673: ""The number of fixed-width characters per unicode character u""
 1674: n = wcwidth(u);
 1675: 
 1676: flush-icache	( c_addr u -- )	gforth	flush_icache
 1677: ""Make sure that the instruction cache of the processor (if there is
 1678: one) does not contain stale data at @i{c-addr} and @i{u} bytes
 1679: afterwards. @code{END-CODE} performs a @code{flush-icache}
 1680: automatically. Caveat: @code{flush-icache} might not work on your
 1681: installation; this is usually the case if direct threading is not
 1682: supported on your machine (take a look at your @file{machine.h}) and
 1683: your machine has a separate instruction cache. In such cases,
 1684: @code{flush-icache} does nothing instead of flushing the instruction
 1685: cache.""
 1686: FLUSH_ICACHE(c_addr,u);
 1687: 
 1688: (bye)	( n -- )	gforth	paren_bye
 1689: SUPER_END;
 1690: return (Label *)n;
 1691: 
 1692: (system)	( c_addr u -- wretval wior )	gforth	paren_system
 1693: wretval = gforth_system(c_addr, u);  
 1694: wior = IOR(wretval==-1 || (wretval==127 && errno != 0));
 1695: 
 1696: getenv	( c_addr1 u1 -- c_addr2 u2 )	gforth
 1697: ""The string @i{c-addr1 u1} specifies an environment variable. The string @i{c-addr2 u2}
 1698: is the host operating system's expansion of that environment variable. If the
 1699: environment variable does not exist, @i{c-addr2 u2} specifies a string 0 characters
 1700: in length.""
 1701: /* close ' to keep fontify happy */
 1702: c_addr2 = (Char *)getenv(cstr(c_addr1,u1,1));
 1703: u2 = (c_addr2 == NULL ? 0 : strlen((char *)c_addr2));
 1704: 
 1705: open-pipe	( c_addr u wfam -- wfileid wior )	gforth	open_pipe
 1706: wfileid=(Cell)popen(cstr(c_addr,u,1),pfileattr[wfam]); /* ~ expansion of 1st arg? */
 1707: wior = IOR(wfileid==0); /* !! the man page says that errno is not set reliably */
 1708: 
 1709: close-pipe	( wfileid -- wretval wior )		gforth	close_pipe
 1710: wretval = pclose((FILE *)wfileid);
 1711: wior = IOR(wretval==-1);
 1712: 
 1713: time&date	( -- nsec nmin nhour nday nmonth nyear )	facility-ext	time_and_date
 1714: ""Report the current time of day. Seconds, minutes and hours are numbered from 0.
 1715: Months are numbered from 1.""
 1716: #if 1
 1717: time_t now;
 1718: struct tm *ltime;
 1719: time(&now);
 1720: ltime=localtime(&now);
 1721: #else
 1722: struct timeval time1;
 1723: struct timezone zone1;
 1724: struct tm *ltime;
 1725: gettimeofday(&time1,&zone1);
 1726: /* !! Single Unix specification: 
 1727:    If tzp is not a null pointer, the behaviour is unspecified. */
 1728: ltime=localtime((time_t *)&time1.tv_sec);
 1729: #endif
 1730: nyear =ltime->tm_year+1900;
 1731: nmonth=ltime->tm_mon+1;
 1732: nday  =ltime->tm_mday;
 1733: nhour =ltime->tm_hour;
 1734: nmin  =ltime->tm_min;
 1735: nsec  =ltime->tm_sec;
 1736: 
 1737: ms	( n -- )	facility-ext
 1738: ""Wait at least @i{n} milli-second.""
 1739: struct timeval timeout;
 1740: timeout.tv_sec=n/1000;
 1741: timeout.tv_usec=1000*(n%1000);
 1742: (void)select(0,0,0,0,&timeout);
 1743: 
 1744: allocate	( u -- a_addr wior )	memory
 1745: ""Allocate @i{u} address units of contiguous data space. The initial
 1746: contents of the data space is undefined. If the allocation is successful,
 1747: @i{a-addr} is the start address of the allocated region and @i{wior}
 1748: is 0. If the allocation fails, @i{a-addr} is undefined and @i{wior}
 1749: is a non-zero I/O result code.""
 1750: a_addr = (Cell *)malloc(u?u:1);
 1751: wior = IOR(a_addr==NULL);
 1752: 
 1753: free	( a_addr -- wior )		memory
 1754: ""Return the region of data space starting at @i{a-addr} to the system.
 1755: The region must originally have been obtained using @code{allocate} or
 1756: @code{resize}. If the operational is successful, @i{wior} is 0.
 1757: If the operation fails, @i{wior} is a non-zero I/O result code.""
 1758: free(a_addr);
 1759: wior = 0;
 1760: 
 1761: resize	( a_addr1 u -- a_addr2 wior )	memory
 1762: ""Change the size of the allocated area at @i{a-addr1} to @i{u}
 1763: address units, possibly moving the contents to a different
 1764: area. @i{a-addr2} is the address of the resulting area.
 1765: If the operation is successful, @i{wior} is 0.
 1766: If the operation fails, @i{wior} is a non-zero
 1767: I/O result code. If @i{a-addr1} is 0, Gforth's (but not the Standard)
 1768: @code{resize} @code{allocate}s @i{u} address units.""
 1769: /* the following check is not necessary on most OSs, but it is needed
 1770:    on SunOS 4.1.2. */
 1771: /* close ' to keep fontify happy */
 1772: if (a_addr1==NULL)
 1773:   a_addr2 = (Cell *)malloc(u);
 1774: else
 1775:   a_addr2 = (Cell *)realloc(a_addr1, u);
 1776: wior = IOR(a_addr2==NULL);	/* !! Define a return code */
 1777: 
 1778: strerror	( n -- c_addr u )	gforth
 1779: c_addr = (Char *)strerror(n);
 1780: u = strlen((char *)c_addr);
 1781: 
 1782: strsignal	( n -- c_addr u )	gforth
 1783: c_addr = (Char *)strsignal(n);
 1784: u = strlen((char *)c_addr);
 1785: 
 1786: call-c	( ... w -- ... )	gforth	call_c
 1787: ""Call the C function pointed to by @i{w}. The C function has to
 1788: access the stack itself. The stack pointers are exported in the global
 1789: variables @code{SP} and @code{FP}.""
 1790: /* This is a first attempt at support for calls to C. This may change in
 1791:    the future */
 1792: gforth_FP=fp;
 1793: gforth_SP=sp;
 1794: ((void (*)())w)();
 1795: sp=gforth_SP;
 1796: fp=gforth_FP;
 1797: 
 1798: \+
 1799: \+file
 1800: 
 1801: close-file	( wfileid -- wior )		file	close_file
 1802: wior = IOR(fclose((FILE *)wfileid)==EOF);
 1803: 
 1804: open-file	( c_addr u wfam -- wfileid wior )	file	open_file
 1805: wfileid = (Cell)fopen(tilde_cstr(c_addr, u, 1), fileattr[wfam]);
 1806: wior =  IOR(wfileid == 0);
 1807: 
 1808: create-file	( c_addr u wfam -- wfileid wior )	file	create_file
 1809: Cell	fd;
 1810: fd = open(tilde_cstr(c_addr, u, 1), O_CREAT|O_TRUNC|ufileattr[wfam], 0666);
 1811: if (fd != -1) {
 1812:   wfileid = (Cell)fdopen(fd, fileattr[wfam]);
 1813:   wior = IOR(wfileid == 0);
 1814: } else {
 1815:   wfileid = 0;
 1816:   wior = IOR(1);
 1817: }
 1818: 
 1819: delete-file	( c_addr u -- wior )		file	delete_file
 1820: wior = IOR(unlink(tilde_cstr(c_addr, u, 1))==-1);
 1821: 
 1822: rename-file	( c_addr1 u1 c_addr2 u2 -- wior )	file-ext	rename_file
 1823: ""Rename file @i{c_addr1 u1} to new name @i{c_addr2 u2}""
 1824: wior = rename_file(c_addr1, u1, c_addr2, u2);
 1825: 
 1826: file-position	( wfileid -- ud wior )	file	file_position
 1827: /* !! use tell and lseek? */
 1828: ud = OFF2UD(ftello((FILE *)wfileid));
 1829: wior = IOR(UD2OFF(ud)==-1);
 1830: 
 1831: reposition-file	( ud wfileid -- wior )	file	reposition_file
 1832: wior = IOR(fseeko((FILE *)wfileid, UD2OFF(ud), SEEK_SET)==-1);
 1833: 
 1834: file-size	( wfileid -- ud wior )	file	file_size
 1835: struct stat buf;
 1836: wior = IOR(fstat(fileno((FILE *)wfileid), &buf)==-1);
 1837: ud = OFF2UD(buf.st_size);
 1838: 
 1839: resize-file	( ud wfileid -- wior )	file	resize_file
 1840: wior = IOR(ftruncate(fileno((FILE *)wfileid), UD2OFF(ud))==-1);
 1841: 
 1842: read-file	( c_addr u1 wfileid -- u2 wior )	file	read_file
 1843: /* !! fread does not guarantee enough */
 1844: u2 = fread(c_addr, sizeof(Char), u1, (FILE *)wfileid);
 1845: wior = FILEIO(u2<u1 && ferror((FILE *)wfileid));
 1846: /* !! is the value of ferror errno-compatible? */
 1847: if (wior)
 1848:   clearerr((FILE *)wfileid);
 1849: 
 1850: (read-line)	( c_addr u1 wfileid -- u2 flag u3 wior ) file	paren_read_line
 1851: struct Cellquad r = read_line(c_addr, u1, wfileid);
 1852: u2   = r.n1;
 1853: flag = r.n2;
 1854: u3   = r.n3;
 1855: wior = r.n4;
 1856: 
 1857: \+
 1858: 
 1859: write-file	( c_addr u1 wfileid -- wior )	file	write_file
 1860: /* !! fwrite does not guarantee enough */
 1861: #ifdef HAS_FILE
 1862: {
 1863:   UCell u2 = fwrite(c_addr, sizeof(Char), u1, (FILE *)wfileid);
 1864:   wior = FILEIO(u2<u1 && ferror((FILE *)wfileid));
 1865:   if (wior)
 1866:     clearerr((FILE *)wfileid);
 1867: }
 1868: #else
 1869: TYPE(c_addr, u1);
 1870: #endif
 1871: 
 1872: emit-file	( c wfileid -- wior )	gforth	emit_file
 1873: #ifdef HAS_FILE
 1874: wior = FILEIO(putc(c, (FILE *)wfileid)==EOF);
 1875: if (wior)
 1876:   clearerr((FILE *)wfileid);
 1877: #else
 1878: PUTC(c);
 1879: #endif
 1880: 
 1881: \+file
 1882: 
 1883: flush-file	( wfileid -- wior )		file-ext	flush_file
 1884: wior = IOR(fflush((FILE *) wfileid)==EOF);
 1885: 
 1886: file-status	( c_addr u -- wfam wior )	file-ext	file_status
 1887: struct Cellpair r = file_status(c_addr, u);
 1888: wfam = r.n1;
 1889: wior = r.n2;
 1890: 
 1891: file-eof?	( wfileid -- flag )	gforth	file_eof_query
 1892: flag = FLAG(feof((FILE *) wfileid));
 1893: 
 1894: open-dir	( c_addr u -- wdirid wior )	gforth	open_dir
 1895: ""Open the directory specified by @i{c-addr, u}
 1896: and return @i{dir-id} for futher access to it.""
 1897: wdirid = (Cell)opendir(tilde_cstr(c_addr, u, 1));
 1898: wior =  IOR(wdirid == 0);
 1899: 
 1900: read-dir	( c_addr u1 wdirid -- u2 flag wior )	gforth	read_dir
 1901: ""Attempt to read the next entry from the directory specified
 1902: by @i{dir-id} to the buffer of length @i{u1} at address @i{c-addr}. 
 1903: If the attempt fails because there is no more entries,
 1904: @i{ior}=0, @i{flag}=0, @i{u2}=0, and the buffer is unmodified.
 1905: If the attempt to read the next entry fails because of any other reason, 
 1906: return @i{ior}<>0.
 1907: If the attempt succeeds, store file name to the buffer at @i{c-addr}
 1908: and return @i{ior}=0, @i{flag}=true and @i{u2} equal to the size of the file name.
 1909: If the length of the file name is greater than @i{u1}, 
 1910: store first @i{u1} characters from file name into the buffer and
 1911: indicate "name too long" with @i{ior}, @i{flag}=true, and @i{u2}=@i{u1}.""
 1912: struct dirent * dent;
 1913: dent = readdir((DIR *)wdirid);
 1914: wior = 0;
 1915: flag = -1;
 1916: if(dent == NULL) {
 1917:   u2 = 0;
 1918:   flag = 0;
 1919: } else {
 1920:   u2 = strlen((char *)dent->d_name);
 1921:   if(u2 > u1) {
 1922:     u2 = u1;
 1923:     wior = -512-ENAMETOOLONG;
 1924:   }
 1925:   memmove(c_addr, dent->d_name, u2);
 1926: }
 1927: 
 1928: close-dir	( wdirid -- wior )	gforth	close_dir
 1929: ""Close the directory specified by @i{dir-id}.""
 1930: wior = IOR(closedir((DIR *)wdirid));
 1931: 
 1932: filename-match	( c_addr1 u1 c_addr2 u2 -- flag )	gforth	match_file
 1933: char * string = cstr(c_addr1, u1, 1);
 1934: char * pattern = cstr(c_addr2, u2, 0);
 1935: flag = FLAG(!fnmatch(pattern, string, 0));
 1936: 
 1937: set-dir	( c_addr u -- wior )	gforth set_dir
 1938: ""Change the current directory to @i{c-addr, u}.
 1939: Return an error if this is not possible""
 1940: wior = IOR(chdir(tilde_cstr(c_addr, u, 1)));
 1941: 
 1942: get-dir	( c_addr1 u1 -- c_addr2 u2 )	gforth get_dir
 1943: ""Store the current directory in the buffer specified by @{c-addr1, u1}.
 1944: If the buffer size is not sufficient, return 0 0""
 1945: c_addr2 = (Char *)getcwd((char *)c_addr1, u1);
 1946: if(c_addr2 != NULL) {
 1947:   u2 = strlen((char *)c_addr2);
 1948: } else {
 1949:   u2 = 0;
 1950: }
 1951: 
 1952: \+
 1953: 
 1954: newline	( -- c_addr u )	gforth
 1955: ""String containing the newline sequence of the host OS""
 1956: char newline[] = {
 1957: #if DIRSEP=='/'
 1958: /* Unix */
 1959: '\n'
 1960: #else
 1961: /* DOS, Win, OS/2 */
 1962: '\r','\n'
 1963: #endif
 1964: };
 1965: c_addr=(Char *)newline;
 1966: u=sizeof(newline);
 1967: :
 1968:  "newline count ;
 1969: Create "newline e? crlf [IF] 2 c, $0D c, [ELSE] 1 c, [THEN] $0A c,
 1970: 
 1971: \+os
 1972: 
 1973: utime	( -- dtime )	gforth
 1974: ""Report the current time in microseconds since some epoch.""
 1975: struct timeval time1;
 1976: gettimeofday(&time1,NULL);
 1977: dtime = timeval2us(&time1);
 1978: 
 1979: cputime ( -- duser dsystem ) gforth
 1980: ""duser and dsystem are the respective user- and system-level CPU
 1981: times used since the start of the Forth system (excluding child
 1982: processes), in microseconds (the granularity may be much larger,
 1983: however).  On platforms without the getrusage call, it reports elapsed
 1984: time (since some epoch) for duser and 0 for dsystem.""
 1985: #ifdef HAVE_GETRUSAGE
 1986: struct rusage usage;
 1987: getrusage(RUSAGE_SELF, &usage);
 1988: duser = timeval2us(&usage.ru_utime);
 1989: dsystem = timeval2us(&usage.ru_stime);
 1990: #else
 1991: struct timeval time1;
 1992: gettimeofday(&time1,NULL);
 1993: duser = timeval2us(&time1);
 1994: dsystem = DZERO;
 1995: #endif
 1996: 
 1997: \+
 1998: 
 1999: \+floating
 2000: 
 2001: \g floating
 2002: 
 2003: comparisons(f, r1 r2, f_, r1, r2, gforth, gforth, float, gforth)
 2004: comparisons(f0, r, f_zero_, r, 0., float, gforth, float, gforth)
 2005: 
 2006: s>f	( n -- r )		float	s_to_f
 2007: r = n;
 2008: 
 2009: d>f	( d -- r )		float	d_to_f
 2010: #ifdef BUGGY_LL_D2F
 2011: extern double ldexp(double x, int exp);
 2012: if (DHI(d)<0) {
 2013: #ifdef BUGGY_LL_ADD
 2014:   DCell d2=dnegate(d);
 2015: #else
 2016:   DCell d2=-d;
 2017: #endif
 2018:   r = -(ldexp((Float)DHI(d2),CELL_BITS) + (Float)DLO(d2));
 2019: } else
 2020:   r = ldexp((Float)DHI(d),CELL_BITS) + (Float)DLO(d);
 2021: #else
 2022: r = d;
 2023: #endif
 2024: 
 2025: f>d	( r -- d )		float	f_to_d
 2026: extern DCell double2ll(Float r);
 2027: d = double2ll(r);
 2028: 
 2029: f>s	( r -- n )		float	f_to_s
 2030: n = (Cell)r;
 2031: 
 2032: f!	( r f_addr -- )	float	f_store
 2033: ""Store @i{r} into the float at address @i{f-addr}.""
 2034: *f_addr = r;
 2035: 
 2036: f@	( f_addr -- r )	float	f_fetch
 2037: ""@i{r} is the float at address @i{f-addr}.""
 2038: r = *f_addr;
 2039: 
 2040: df@	( df_addr -- r )	float-ext	d_f_fetch
 2041: ""Fetch the double-precision IEEE floating-point value @i{r} from the address @i{df-addr}.""
 2042: #ifdef IEEE_FP
 2043: r = *df_addr;
 2044: #else
 2045: !! df@
 2046: #endif
 2047: 
 2048: df!	( r df_addr -- )	float-ext	d_f_store
 2049: ""Store @i{r} as double-precision IEEE floating-point value to the
 2050: address @i{df-addr}.""
 2051: #ifdef IEEE_FP
 2052: *df_addr = r;
 2053: #else
 2054: !! df!
 2055: #endif
 2056: 
 2057: sf@	( sf_addr -- r )	float-ext	s_f_fetch
 2058: ""Fetch the single-precision IEEE floating-point value @i{r} from the address @i{sf-addr}.""
 2059: #ifdef IEEE_FP
 2060: r = *sf_addr;
 2061: #else
 2062: !! sf@
 2063: #endif
 2064: 
 2065: sf!	( r sf_addr -- )	float-ext	s_f_store
 2066: ""Store @i{r} as single-precision IEEE floating-point value to the
 2067: address @i{sf-addr}.""
 2068: #ifdef IEEE_FP
 2069: *sf_addr = r;
 2070: #else
 2071: !! sf!
 2072: #endif
 2073: 
 2074: f+	( r1 r2 -- r3 )	float	f_plus
 2075: r3 = r1+r2;
 2076: 
 2077: f-	( r1 r2 -- r3 )	float	f_minus
 2078: r3 = r1-r2;
 2079: 
 2080: f*	( r1 r2 -- r3 )	float	f_star
 2081: r3 = r1*r2;
 2082: 
 2083: f/	( r1 r2 -- r3 )	float	f_slash
 2084: r3 = r1/r2;
 2085: 
 2086: f**	( r1 r2 -- r3 )	float-ext	f_star_star
 2087: ""@i{r3} is @i{r1} raised to the @i{r2}th power.""
 2088: r3 = pow(r1,r2);
 2089: 
 2090: fm*	( r1 n -- r2 )	gforth	fm_star
 2091: r2 = r1*n;
 2092: 
 2093: fm/	( r1 n -- r2 )	gforth	fm_slash
 2094: r2 = r1/n;
 2095: 
 2096: fm*/	( r1 n1 n2 -- r2 )	gforth	fm_star_slash
 2097: r2 = (r1*n1)/n2;
 2098: 
 2099: f**2	( r1 -- r2 )	gforth	fm_square
 2100: r2 = r1*r1;
 2101: 
 2102: fnegate	( r1 -- r2 )	float	f_negate
 2103: r2 = - r1;
 2104: 
 2105: fdrop	( r -- )		float	f_drop
 2106: 
 2107: fdup	( r -- r r )	float	f_dupe
 2108: 
 2109: fswap	( r1 r2 -- r2 r1 )	float	f_swap
 2110: 
 2111: fover	( r1 r2 -- r1 r2 r1 )	float	f_over
 2112: 
 2113: frot	( r1 r2 r3 -- r2 r3 r1 )	float	f_rote
 2114: 
 2115: fnip	( r1 r2 -- r2 )	gforth	f_nip
 2116: 
 2117: ftuck	( r1 r2 -- r2 r1 r2 )	gforth	f_tuck
 2118: 
 2119: float+	( f_addr1 -- f_addr2 )	float	float_plus
 2120: ""@code{1 floats +}.""
 2121: f_addr2 = f_addr1+1;
 2122: 
 2123: floats	( n1 -- n2 )	float
 2124: ""@i{n2} is the number of address units of @i{n1} floats.""
 2125: n2 = n1*sizeof(Float);
 2126: 
 2127: floor	( r1 -- r2 )	float
 2128: ""Round towards the next smaller integral value, i.e., round toward negative infinity.""
 2129: /* !! unclear wording */
 2130: r2 = floor(r1);
 2131: 
 2132: fround	( r1 -- r2 )	gforth	f_round
 2133: ""Round to the nearest integral value.""
 2134: r2 = rint(r1);
 2135: 
 2136: fmax	( r1 r2 -- r3 )	float	f_max
 2137: if (r1<r2)
 2138:   r3 = r2;
 2139: else
 2140:   r3 = r1;
 2141: 
 2142: fmin	( r1 r2 -- r3 )	float	f_min
 2143: if (r1<r2)
 2144:   r3 = r1;
 2145: else
 2146:   r3 = r2;
 2147: 
 2148: represent	( r c_addr u -- n f1 f2 )	float
 2149: char *sig;
 2150: size_t siglen;
 2151: int flag;
 2152: int decpt;
 2153: sig=ecvt(r, u, &decpt, &flag);
 2154: n=(r==0. ? 1 : decpt);
 2155: f1=FLAG(flag!=0);
 2156: f2=FLAG(isdigit((unsigned)(sig[0]))!=0);
 2157: siglen=strlen((char *)sig);
 2158: if (siglen>u) /* happens in glibc-2.1.3 if 999.. is rounded up */
 2159:   siglen=u;
 2160: if (!f2) /* workaround Cygwin trailing 0s for Inf and Nan */
 2161:   for (; sig[siglen-1]=='0'; siglen--);
 2162:     ;
 2163: memcpy(c_addr,sig,siglen);
 2164: memset(c_addr+siglen,f2?'0':' ',u-siglen);
 2165: 
 2166: >float	( c_addr u -- f:... flag )	float	to_float
 2167: ""Actual stack effect: ( c_addr u -- r t | f ).  Attempt to convert the
 2168: character string @i{c-addr u} to internal floating-point
 2169: representation. If the string represents a valid floating-point number
 2170: @i{r} is placed on the floating-point stack and @i{flag} is
 2171: true. Otherwise, @i{flag} is false. A string of blanks is a special
 2172: case and represents the floating-point number 0.""
 2173: Float r;
 2174: flag = to_float(c_addr, u, &r);
 2175: if (flag) {
 2176:   fp--;
 2177:   fp[0]=r;
 2178: }
 2179: 
 2180: fabs	( r1 -- r2 )	float-ext	f_abs
 2181: r2 = fabs(r1);
 2182: 
 2183: facos	( r1 -- r2 )	float-ext	f_a_cos
 2184: r2 = acos(r1);
 2185: 
 2186: fasin	( r1 -- r2 )	float-ext	f_a_sine
 2187: r2 = asin(r1);
 2188: 
 2189: fatan	( r1 -- r2 )	float-ext	f_a_tan
 2190: r2 = atan(r1);
 2191: 
 2192: fatan2	( r1 r2 -- r3 )	float-ext	f_a_tan_two
 2193: ""@i{r1/r2}=tan(@i{r3}). ANS Forth does not require, but probably
 2194: intends this to be the inverse of @code{fsincos}. In gforth it is.""
 2195: r3 = atan2(r1,r2);
 2196: 
 2197: fcos	( r1 -- r2 )	float-ext	f_cos
 2198: r2 = cos(r1);
 2199: 
 2200: fexp	( r1 -- r2 )	float-ext	f_e_x_p
 2201: r2 = exp(r1);
 2202: 
 2203: fexpm1	( r1 -- r2 )	float-ext	f_e_x_p_m_one
 2204: ""@i{r2}=@i{e}**@i{r1}@minus{}1""
 2205: #ifdef HAVE_EXPM1
 2206: extern double
 2207: #ifdef NeXT
 2208:               const
 2209: #endif
 2210:                     expm1(double);
 2211: r2 = expm1(r1);
 2212: #else
 2213: r2 = exp(r1)-1.;
 2214: #endif
 2215: 
 2216: fln	( r1 -- r2 )	float-ext	f_l_n
 2217: r2 = log(r1);
 2218: 
 2219: flnp1	( r1 -- r2 )	float-ext	f_l_n_p_one
 2220: ""@i{r2}=ln(@i{r1}+1)""
 2221: #ifdef HAVE_LOG1P
 2222: extern double
 2223: #ifdef NeXT
 2224:               const
 2225: #endif
 2226:                     log1p(double);
 2227: r2 = log1p(r1);
 2228: #else
 2229: r2 = log(r1+1.);
 2230: #endif
 2231: 
 2232: flog	( r1 -- r2 )	float-ext	f_log
 2233: ""The decimal logarithm.""
 2234: r2 = log10(r1);
 2235: 
 2236: falog	( r1 -- r2 )	float-ext	f_a_log
 2237: ""@i{r2}=10**@i{r1}""
 2238: extern double pow10(double);
 2239: r2 = pow10(r1);
 2240: 
 2241: fsin	( r1 -- r2 )	float-ext	f_sine
 2242: r2 = sin(r1);
 2243: 
 2244: fsincos	( r1 -- r2 r3 )	float-ext	f_sine_cos
 2245: ""@i{r2}=sin(@i{r1}), @i{r3}=cos(@i{r1})""
 2246: r2 = sin(r1);
 2247: r3 = cos(r1);
 2248: 
 2249: fsqrt	( r1 -- r2 )	float-ext	f_square_root
 2250: r2 = sqrt(r1);
 2251: 
 2252: ftan	( r1 -- r2 )	float-ext	f_tan
 2253: r2 = tan(r1);
 2254: :
 2255:  fsincos f/ ;
 2256: 
 2257: fsinh	( r1 -- r2 )	float-ext	f_cinch
 2258: r2 = sinh(r1);
 2259: :
 2260:  fexpm1 fdup fdup 1. d>f f+ f/ f+ f2/ ;
 2261: 
 2262: fcosh	( r1 -- r2 )	float-ext	f_cosh
 2263: r2 = cosh(r1);
 2264: :
 2265:  fexp fdup 1/f f+ f2/ ;
 2266: 
 2267: ftanh	( r1 -- r2 )	float-ext	f_tan_h
 2268: r2 = tanh(r1);
 2269: :
 2270:  f2* fexpm1 fdup 2. d>f f+ f/ ;
 2271: 
 2272: fasinh	( r1 -- r2 )	float-ext	f_a_cinch
 2273: r2 = asinh(r1);
 2274: :
 2275:  fdup fdup f* 1. d>f f+ fsqrt f/ fatanh ;
 2276: 
 2277: facosh	( r1 -- r2 )	float-ext	f_a_cosh
 2278: r2 = acosh(r1);
 2279: :
 2280:  fdup fdup f* 1. d>f f- fsqrt f+ fln ;
 2281: 
 2282: fatanh	( r1 -- r2 )	float-ext	f_a_tan_h
 2283: r2 = atanh(r1);
 2284: :
 2285:  fdup f0< >r fabs 1. d>f fover f- f/  f2* flnp1 f2/
 2286:  r> IF  fnegate  THEN ;
 2287: 
 2288: sfloats	( n1 -- n2 )	float-ext	s_floats
 2289: ""@i{n2} is the number of address units of @i{n1}
 2290: single-precision IEEE floating-point numbers.""
 2291: n2 = n1*sizeof(SFloat);
 2292: 
 2293: dfloats	( n1 -- n2 )	float-ext	d_floats
 2294: ""@i{n2} is the number of address units of @i{n1}
 2295: double-precision IEEE floating-point numbers.""
 2296: n2 = n1*sizeof(DFloat);
 2297: 
 2298: sfaligned	( c_addr -- sf_addr )	float-ext	s_f_aligned
 2299: ""@i{sf-addr} is the first single-float-aligned address greater
 2300: than or equal to @i{c-addr}.""
 2301: sf_addr = (SFloat *)((((Cell)c_addr)+(sizeof(SFloat)-1))&(-sizeof(SFloat)));
 2302: :
 2303:  [ 1 sfloats 1- ] Literal + [ -1 sfloats ] Literal and ;
 2304: 
 2305: dfaligned	( c_addr -- df_addr )	float-ext	d_f_aligned
 2306: ""@i{df-addr} is the first double-float-aligned address greater
 2307: than or equal to @i{c-addr}.""
 2308: df_addr = (DFloat *)((((Cell)c_addr)+(sizeof(DFloat)-1))&(-sizeof(DFloat)));
 2309: :
 2310:  [ 1 dfloats 1- ] Literal + [ -1 dfloats ] Literal and ;
 2311: 
 2312: v*	( f_addr1 nstride1 f_addr2 nstride2 ucount -- r ) gforth v_star
 2313: ""dot-product: r=v1*v2.  The first element of v1 is at f_addr1, the
 2314: next at f_addr1+nstride1 and so on (similar for v2). Both vectors have
 2315: ucount elements.""
 2316: r = v_star(f_addr1, nstride1, f_addr2, nstride2, ucount);
 2317: :
 2318:  >r swap 2swap swap 0e r> 0 ?DO
 2319:      dup f@ over + 2swap dup f@ f* f+ over + 2swap
 2320:  LOOP 2drop 2drop ; 
 2321: 
 2322: faxpy	( ra f_x nstridex f_y nstridey ucount -- )	gforth
 2323: ""vy=ra*vx+vy""
 2324: faxpy(ra, f_x, nstridex, f_y, nstridey, ucount);
 2325: :
 2326:  >r swap 2swap swap r> 0 ?DO
 2327:      fdup dup f@ f* over + 2swap dup f@ f+ dup f! over + 2swap
 2328:  LOOP 2drop 2drop fdrop ;
 2329: 
 2330: \+
 2331: 
 2332: \ The following words access machine/OS/installation-dependent
 2333: \   Gforth internals
 2334: \ !! how about environmental queries DIRECT-THREADED,
 2335: \   INDIRECT-THREADED, TOS-CACHED, FTOS-CACHED, CODEFIELD-DOES */
 2336: 
 2337: \ local variable implementation primitives
 2338: 
 2339: \+glocals
 2340: 
 2341: \g locals
 2342: 
 2343: @local#	( #noffset -- w )	gforth	fetch_local_number
 2344: w = *(Cell *)(lp+noffset);
 2345: 
 2346: @local0	( -- w )	new	fetch_local_zero
 2347: w = ((Cell *)lp)[0];
 2348: 
 2349: @local1	( -- w )	new	fetch_local_four
 2350: w = ((Cell *)lp)[1];
 2351: 
 2352: @local2	( -- w )	new	fetch_local_eight
 2353: w = ((Cell *)lp)[2];
 2354: 
 2355: @local3	( -- w )	new	fetch_local_twelve
 2356: w = ((Cell *)lp)[3];
 2357: 
 2358: \+floating
 2359: 
 2360: f@local#	( #noffset -- r )	gforth	f_fetch_local_number
 2361: r = *(Float *)(lp+noffset);
 2362: 
 2363: f@local0	( -- r )	new	f_fetch_local_zero
 2364: r = ((Float *)lp)[0];
 2365: 
 2366: f@local1	( -- r )	new	f_fetch_local_eight
 2367: r = ((Float *)lp)[1];
 2368: 
 2369: \+
 2370: 
 2371: laddr#	( #noffset -- c_addr )	gforth	laddr_number
 2372: /* this can also be used to implement lp@ */
 2373: c_addr = (Char *)(lp+noffset);
 2374: 
 2375: lp+!#	( #noffset -- )	gforth	lp_plus_store_number
 2376: ""used with negative immediate values it allocates memory on the
 2377: local stack, a positive immediate argument drops memory from the local
 2378: stack""
 2379: lp += noffset;
 2380: 
 2381: lp-	( -- )	new	minus_four_lp_plus_store
 2382: lp += -sizeof(Cell);
 2383: 
 2384: lp+	( -- )	new	eight_lp_plus_store
 2385: lp += sizeof(Float);
 2386: 
 2387: lp+2	( -- )	new	sixteen_lp_plus_store
 2388: lp += 2*sizeof(Float);
 2389: 
 2390: lp!	( c_addr -- )	gforth	lp_store
 2391: lp = (Address)c_addr;
 2392: 
 2393: >l	( w -- )	gforth	to_l
 2394: lp -= sizeof(Cell);
 2395: *(Cell *)lp = w;
 2396: 
 2397: \+floating
 2398: 
 2399: f>l	( r -- )	gforth	f_to_l
 2400: lp -= sizeof(Float);
 2401: *(Float *)lp = r;
 2402: 
 2403: fpick	( f:... u -- f:... r )		gforth
 2404: ""Actually the stack effect is @code{ r0 ... ru u -- r0 ... ru r0 }.""
 2405: r = fp[u];
 2406: :
 2407:  floats fp@ + f@ ;
 2408: 
 2409: \+
 2410: \+
 2411: 
 2412: \+OS
 2413: 
 2414: \g syslib
 2415: 
 2416: open-lib	( c_addr1 u1 -- u2 )	gforth	open_lib
 2417: #if defined(HAVE_LIBDL) || defined(HAVE_DLOPEN)
 2418: #ifndef RTLD_GLOBAL
 2419: #define RTLD_GLOBAL 0
 2420: #endif
 2421: u2=(UCell) dlopen(cstr(c_addr1, u1, 1), RTLD_GLOBAL | RTLD_LAZY);
 2422: #else
 2423: #  ifdef _WIN32
 2424: u2 = (Cell) GetModuleHandle(cstr(c_addr1, u1, 1));
 2425: #  else
 2426: #warning Define open-lib!
 2427: u2 = 0;
 2428: #  endif
 2429: #endif
 2430: 
 2431: lib-sym	( c_addr1 u1 u2 -- u3 )	gforth	lib_sym
 2432: #if defined(HAVE_LIBDL) || defined(HAVE_DLOPEN)
 2433: u3 = (UCell) dlsym((void*)u2,cstr(c_addr1, u1, 1));
 2434: #else
 2435: #  ifdef _WIN32
 2436: u3 = (Cell) GetProcAddress((HMODULE)u2, cstr(c_addr1, u1, 1));
 2437: #  else
 2438: #warning Define lib-sym!
 2439: u3 = 0;
 2440: #  endif
 2441: #endif
 2442: 
 2443: wcall	( ... u -- ... )	gforth
 2444: gforth_FP=fp;
 2445: sp=(Cell*)(SYSCALL(Cell*(*)(Cell *, void *))u)(sp, &gforth_FP);
 2446: fp=gforth_FP;
 2447: 
 2448: uw@ ( c_addr -- u )	gforth u_w_fetch
 2449: ""@i{u} is the zero-extended 16-bit value stored at @i{c_addr}.""
 2450: u = *(UWyde*)(c_addr);
 2451: 
 2452: sw@ ( c_addr -- n )	gforth s_w_fetch
 2453: ""@i{n} is the sign-extended 16-bit value stored at @i{c_addr}.""
 2454: n = *(Wyde*)(c_addr);
 2455: 
 2456: w! ( w c_addr -- )	gforth w_store
 2457: ""Store the bottom 16 bits of @i{w} at @i{c_addr}.""
 2458: *(Wyde*)(c_addr) = w;
 2459: 
 2460: ul@ ( c_addr -- u )	gforth u_l_fetch
 2461: ""@i{u} is the zero-extended 32-bit value stored at @i{c_addr}.""
 2462: u = *(UTetrabyte*)(c_addr);
 2463: 
 2464: sl@ ( c_addr -- n )	gforth s_l_fetch
 2465: ""@i{n} is the sign-extended 32-bit value stored at @i{c_addr}.""
 2466: n = *(Tetrabyte*)(c_addr);
 2467: 
 2468: l! ( w c_addr -- )	gforth l_store
 2469: ""Store the bottom 32 bits of @i{w} at @i{c_addr}.""
 2470: *(Tetrabyte*)(c_addr) = w;
 2471: 
 2472: \+FFCALL
 2473: 
 2474: av-start-void	( c_addr -- )	gforth  av_start_void
 2475: av_start_void(alist, c_addr);
 2476: 
 2477: av-start-int	( c_addr -- )	gforth  av_start_int
 2478: av_start_int(alist, c_addr, &irv);
 2479: 
 2480: av-start-float	( c_addr -- )	gforth  av_start_float
 2481: av_start_float(alist, c_addr, &frv);
 2482: 
 2483: av-start-double	( c_addr -- )	gforth  av_start_double
 2484: av_start_double(alist, c_addr, &drv);
 2485: 
 2486: av-start-longlong	( c_addr -- )	gforth  av_start_longlong
 2487: av_start_longlong(alist, c_addr, &llrv);
 2488: 
 2489: av-start-ptr	( c_addr -- )	gforth  av_start_ptr
 2490: av_start_ptr(alist, c_addr, void*, &prv);
 2491: 
 2492: av-int  ( w -- )  gforth  av_int
 2493: av_int(alist, w);
 2494: 
 2495: av-float	( r -- )	gforth  av_float
 2496: av_float(alist, r);
 2497: 
 2498: av-double	( r -- )	gforth  av_double
 2499: av_double(alist, r);
 2500: 
 2501: av-longlong	( d -- )	gforth  av_longlong
 2502: #ifdef BUGGY_LL_SIZE
 2503: av_longlong(alist, DLO(d));
 2504: #else
 2505: av_longlong(alist, d);
 2506: #endif
 2507: 
 2508: av-ptr	( c_addr -- )	gforth  av_ptr
 2509: av_ptr(alist, void*, c_addr);
 2510: 
 2511: av-int-r  ( R:w -- )  gforth  av_int_r
 2512: av_int(alist, w);
 2513: 
 2514: av-float-r	( -- )	gforth  av_float_r
 2515: float r = *(Float*)lp;
 2516: lp += sizeof(Float);
 2517: av_float(alist, r);
 2518: 
 2519: av-double-r	( -- )	gforth  av_double_r
 2520: double r = *(Float*)lp;
 2521: lp += sizeof(Float);
 2522: av_double(alist, r);
 2523: 
 2524: av-longlong-r	( R:d -- )	gforth  av_longlong_r
 2525: #ifdef BUGGY_LL_SIZE
 2526: av_longlong(alist, DLO(d));
 2527: #else
 2528: av_longlong(alist, d);
 2529: #endif
 2530: 
 2531: av-ptr-r	( R:c_addr -- )	gforth  av_ptr_r
 2532: av_ptr(alist, void*, c_addr);
 2533: 
 2534: av-call-void	( ... -- ... )	gforth  av_call_void
 2535: SAVE_REGS
 2536: av_call(alist);
 2537: REST_REGS
 2538: 
 2539: av-call-int	( ... -- ... w )	gforth  av_call_int
 2540: SAVE_REGS
 2541: av_call(alist);
 2542: REST_REGS
 2543: w = irv;
 2544: 
 2545: av-call-float	( ... -- ... r )	gforth  av_call_float
 2546: SAVE_REGS
 2547: av_call(alist);
 2548: REST_REGS
 2549: r = frv;
 2550: 
 2551: av-call-double	( ... -- ... r )	gforth  av_call_double
 2552: SAVE_REGS
 2553: av_call(alist);
 2554: REST_REGS
 2555: r = drv;
 2556: 
 2557: av-call-longlong	( ... -- ... d )	gforth  av_call_longlong
 2558: SAVE_REGS
 2559: av_call(alist);
 2560: REST_REGS
 2561: #ifdef BUGGY_LONG_LONG
 2562: DLO_IS(d, llrv);
 2563: DHI_IS(d, 0);
 2564: #else
 2565: d = llrv;
 2566: #endif
 2567: 
 2568: av-call-ptr	( ... -- ... c_addr )	gforth  av_call_ptr
 2569: SAVE_REGS
 2570: av_call(alist);
 2571: REST_REGS
 2572: c_addr = prv;
 2573: 
 2574: alloc-callback	( a_ip -- c_addr )	gforth	alloc_callback
 2575: c_addr = (char *)alloc_callback(gforth_callback, (Xt *)a_ip);
 2576: 
 2577: va-start-void	( -- )	gforth	va_start_void
 2578: va_start_void(gforth_clist);
 2579: 
 2580: va-start-int	( -- )	gforth	va_start_int
 2581: va_start_int(gforth_clist);
 2582: 
 2583: va-start-longlong	( -- )	gforth	va_start_longlong
 2584: va_start_longlong(gforth_clist);
 2585: 
 2586: va-start-ptr	( -- )	gforth	va_start_ptr
 2587: va_start_ptr(gforth_clist, (char *));
 2588: 
 2589: va-start-float	( -- )	gforth	va_start_float
 2590: va_start_float(gforth_clist);
 2591: 
 2592: va-start-double	( -- )	gforth	va_start_double
 2593: va_start_double(gforth_clist);
 2594: 
 2595: va-arg-int	( -- w )	gforth	va_arg_int
 2596: w = va_arg_int(gforth_clist);
 2597: 
 2598: va-arg-longlong	( -- d )	gforth	va_arg_longlong
 2599: #ifdef BUGGY_LONG_LONG
 2600: DLO_IS(d, va_arg_longlong(gforth_clist));
 2601: DHI_IS(d, 0);
 2602: #else
 2603: d = va_arg_longlong(gforth_clist);
 2604: #endif
 2605: 
 2606: va-arg-ptr	( -- c_addr )	gforth	va_arg_ptr
 2607: c_addr = (char *)va_arg_ptr(gforth_clist,char*);
 2608: 
 2609: va-arg-float	( -- r )	gforth	va_arg_float
 2610: r = va_arg_float(gforth_clist);
 2611: 
 2612: va-arg-double	( -- r )	gforth	va_arg_double
 2613: r = va_arg_double(gforth_clist);
 2614: 
 2615: va-return-void ( -- )	gforth va_return_void
 2616: va_return_void(gforth_clist);
 2617: return 0;
 2618: 
 2619: va-return-int ( w -- )	gforth va_return_int
 2620: va_return_int(gforth_clist, w);
 2621: return 0;
 2622: 
 2623: va-return-ptr ( c_addr -- )	gforth va_return_ptr
 2624: va_return_ptr(gforth_clist, void *, c_addr);
 2625: return 0;
 2626: 
 2627: va-return-longlong ( d -- )	gforth va_return_longlong
 2628: #ifdef BUGGY_LONG_LONG
 2629: va_return_longlong(gforth_clist, d.lo);
 2630: #else
 2631: va_return_longlong(gforth_clist, d);
 2632: #endif
 2633: return 0;
 2634: 
 2635: va-return-float ( r -- )	gforth va_return_float
 2636: va_return_float(gforth_clist, r);
 2637: return 0;
 2638: 
 2639: va-return-double ( r -- )	gforth va_return_double
 2640: va_return_double(gforth_clist, r);
 2641: return 0;
 2642: 
 2643: \+
 2644: 
 2645: \+LIBFFI
 2646: 
 2647: ffi-type ( n -- a_type )	gforth ffi_type
 2648: static void* ffi_types[] =
 2649:     { &ffi_type_void,
 2650:       &ffi_type_uint8, &ffi_type_sint8,
 2651:       &ffi_type_uint16, &ffi_type_sint16,
 2652:       &ffi_type_uint32, &ffi_type_sint32,
 2653:       &ffi_type_uint64, &ffi_type_sint64,
 2654:       &ffi_type_float, &ffi_type_double, &ffi_type_longdouble,
 2655:       &ffi_type_pointer };
 2656: a_type = ffi_types[n];
 2657: 
 2658: ffi-size ( n1 -- n2 )	gforth ffi_size
 2659: static int ffi_sizes[] =
 2660:     { sizeof(ffi_cif), sizeof(ffi_closure) };
 2661: n2 = ffi_sizes[n1];
 2662: 
 2663: ffi-prep-cif ( a_atypes n a_rtype a_cif -- w )	gforth ffi_prep_cif
 2664: w = ffi_prep_cif((ffi_cif *)a_cif, FFI_DEFAULT_ABI, n,
 2665: 	 (ffi_type *)a_rtype, (ffi_type **)a_atypes);
 2666: 
 2667: ffi-call ( a_avalues a_rvalue a_ip a_cif -- )	gforth ffi_call
 2668: SAVE_REGS
 2669: ffi_call((ffi_cif *)a_cif, (void(*)())a_ip, (void *)a_rvalue, (void **)a_avalues);
 2670: REST_REGS
 2671: 
 2672: ffi-prep-closure ( a_ip a_cif a_closure -- w )	gforth ffi_prep_closure
 2673: w = ffi_prep_closure((ffi_closure *)a_closure, (ffi_cif *)a_cif, gforth_callback, (void *)a_ip);
 2674: 
 2675: ffi-2@ ( a_addr -- d )	gforth ffi_2fetch
 2676: #ifdef BUGGY_LONG_LONG
 2677: DLO_IS(d, *(Cell*)(*a_addr));
 2678: DHI_IS(d, 0);
 2679: #else
 2680: d = *(DCell*)(a_addr);
 2681: #endif
 2682: 
 2683: ffi-2! ( d a_addr -- )	gforth ffi_2store
 2684: #ifdef BUGGY_LONG_LONG
 2685: *(Cell*)(a_addr) = DLO(d);
 2686: #else
 2687: *(DCell*)(a_addr) = d;
 2688: #endif
 2689: 
 2690: ffi-arg-int ( -- w )	gforth ffi_arg_int
 2691: w = *(int *)(*gforth_clist++);
 2692: 
 2693: ffi-arg-long ( -- w )	gforth ffi_arg_long
 2694: w = *(long *)(*gforth_clist++);
 2695: 
 2696: ffi-arg-longlong ( -- d )	gforth ffi_arg_longlong
 2697: #ifdef BUGGY_LONG_LONG
 2698: DLO_IS(d, *(Cell*)(*gforth_clist++));
 2699: DHI_IS(d, -(*(Cell*)(*gforth_clist++)<0));
 2700: #else
 2701: d = *(DCell*)(*gforth_clist++);
 2702: #endif
 2703: 
 2704: ffi-arg-dlong ( -- d )	gforth ffi_arg_dlong
 2705: #ifdef BUGGY_LONG_LONG
 2706: DLO_IS(d, *(Cell*)(*gforth_clist++));
 2707: DHI_IS(d, -(*(Cell*)(*gforth_clist++)<0));
 2708: #else
 2709: d = *(Cell*)(*gforth_clist++);
 2710: #endif
 2711: 
 2712: ffi-arg-ptr ( -- c_addr )	gforth ffi_arg_ptr
 2713: c_addr = *(Char **)(*gforth_clist++);
 2714: 
 2715: ffi-arg-float ( -- r )	gforth ffi_arg_float
 2716: r = *(float*)(*gforth_clist++);
 2717: 
 2718: ffi-arg-double ( -- r )	gforth ffi_arg_double
 2719: r = *(double*)(*gforth_clist++);
 2720: 
 2721: ffi-ret-void ( -- )	gforth ffi_ret_void
 2722: return 0;
 2723: 
 2724: ffi-ret-int ( w -- )	gforth ffi_ret_int
 2725: *(int*)(gforth_ritem) = w;
 2726: return 0;
 2727: 
 2728: ffi-ret-longlong ( d -- )	gforth ffi_ret_longlong
 2729: #ifdef BUGGY_LONG_LONG
 2730: *(Cell*)(gforth_ritem) = DLO(d);
 2731: #else
 2732: *(DCell*)(gforth_ritem) = d;
 2733: #endif
 2734: return 0;
 2735: 
 2736: ffi-ret-dlong ( d -- )	gforth ffi_ret_dlong
 2737: #ifdef BUGGY_LONG_LONG
 2738: *(Cell*)(gforth_ritem) = DLO(d);
 2739: #else
 2740: *(Cell*)(gforth_ritem) = d;
 2741: #endif
 2742: return 0;
 2743: 
 2744: ffi-ret-long ( n -- )	gforth ffi_ret_long
 2745: *(Cell*)(gforth_ritem) = n;
 2746: return 0;
 2747: 
 2748: ffi-ret-ptr ( c_addr -- )	gforth ffi_ret_ptr
 2749: *(Char **)(gforth_ritem) = c_addr;
 2750: return 0;
 2751: 
 2752: ffi-ret-float ( r -- )	gforth ffi_ret_float
 2753: *(float*)(gforth_ritem) = r;
 2754: return 0;
 2755: 
 2756: ffi-ret-double ( r -- )	gforth ffi_ret_double
 2757: *(double*)(gforth_ritem) = r;
 2758: return 0;
 2759: 
 2760: \+
 2761: 
 2762: \+OLDCALL
 2763: 
 2764: define(`uploop',
 2765:        `pushdef(`$1', `$2')_uploop(`$1', `$2', `$3', `$4', `$5')`'popdef(`$1')')
 2766: define(`_uploop',
 2767:        `ifelse($1, `$3', `$5',
 2768: 	       `$4`'define(`$1', incr($1))_uploop(`$1', `$2', `$3', `$4', `$5')')')
 2769: 
 2770: \ argflist(argnum): Forth argument list
 2771: define(argflist,
 2772:        `ifelse($1, 0, `',
 2773:                `uploop(`_i', 1, $1, ``u''`_i ', ``u''`_i')')')
 2774: \ argdlist(argnum): declare C's arguments
 2775: define(argdlist,
 2776:        `ifelse($1, 0, `',
 2777:                `uploop(`_i', 1, $1, `Cell, ', `Cell')')')
 2778: \ argclist(argnum): pass C's arguments
 2779: define(argclist,
 2780:        `ifelse($1, 0, `',
 2781:                `uploop(`_i', 1, $1, ``u''`_i, ', ``u''`_i')')')
 2782: \ icall(argnum)
 2783: define(icall,
 2784: `icall$1	( argflist($1) u -- uret )	gforth
 2785: uret = (SYSCALL(Cell(*)(argdlist($1)))u)(argclist($1));
 2786: 
 2787: ')
 2788: define(fcall,
 2789: `fcall$1	( argflist($1) u -- rret )	gforth
 2790: rret = (SYSCALL(Float(*)(argdlist($1)))u)(argclist($1));
 2791: 
 2792: ')
 2793: 
 2794: \ close ' to keep fontify happy
 2795: 
 2796: uploop(i, 0, 7, `icall(i)')
 2797: icall(20)
 2798: uploop(i, 0, 7, `fcall(i)')
 2799: fcall(20)
 2800: 
 2801: \+
 2802: \+
 2803: 
 2804: \g peephole
 2805: 
 2806: \+peephole
 2807: 
 2808: compile-prim1 ( a_prim -- ) gforth compile_prim1
 2809: ""compile prim (incl. immargs) at @var{a_prim}""
 2810: compile_prim1(a_prim);
 2811: 
 2812: finish-code ( ... -- ... ) gforth finish_code
 2813: ""Perform delayed steps in code generation (branch resolution, I-cache
 2814: flushing).""
 2815: /* The ... above are a workaround for a bug in gcc-2.95, which fails
 2816:    to save spTOS (gforth-fast --enable-force-reg) */
 2817: finish_code();
 2818: 
 2819: forget-dyncode ( c_code -- f ) gforth-internal forget_dyncode
 2820: f = forget_dyncode(c_code);
 2821: 
 2822: decompile-prim ( a_code -- a_prim ) gforth-internal decompile_prim
 2823: ""a_prim is the code address of the primitive that has been
 2824: compile_prim1ed to a_code""
 2825: a_prim = (Cell *)decompile_code((Label)a_code);
 2826: 
 2827: \ set-next-code and call2 do not appear in images and can be
 2828: \ renumbered arbitrarily
 2829: 
 2830: set-next-code ( #w -- ) gforth set_next_code
 2831: #ifdef NO_IP
 2832: next_code = (Label)w;
 2833: #endif
 2834: 
 2835: call2 ( #a_callee #a_ret_addr -- R:a_ret_addr ) gforth
 2836: /* call with explicit return address */
 2837: #ifdef NO_IP
 2838: INST_TAIL;
 2839: JUMP(a_callee);
 2840: #else
 2841: assert(0);
 2842: #endif
 2843: 
 2844: tag-offsets ( -- a_addr ) gforth tag_offsets
 2845: extern Cell groups[32];
 2846: a_addr = groups;
 2847: 
 2848: \+
 2849: 
 2850: \g static_super
 2851: 
 2852: ifdef(`STACK_CACHE_FILE',
 2853: `include(peeprules.vmg)')
 2854: 
 2855: \g end

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>