Annotation of gforth/prim, revision 1.64

1.1       anton       1: \ Gforth primitives
                      2: 
1.62      anton       3: \ Copyright (C) 1995,1996,1997,1998,2000 Free Software Foundation, Inc.
1.1       anton       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
1.63      anton      19: \ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
1.1       anton      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: \ 
1.47      anton      29: \ forth name   ( stack effect )        category        [pronunciation]
1.1       anton      30: \ [""glossary entry""]
                     31: \ C code
                     32: \ [:
                     33: \ Forth code]
                     34: \ 
1.47      anton      35: \ Note: Fields in brackets are optional.  Word specifications have to
                     36: \ be separated by at least one empty line
1.1       anton      37: \
                     38: \ Both pronounciation and stack items (in the stack effect) must
1.48      anton      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.
1.1       anton      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: \ 
                     58: \ 
                     59: \ The stack variables have the following types:
                     60: \ 
                     61: \ name matches type
                     62: \ f.*          Bool
                     63: \ c.*          Char
                     64: \ [nw].*               Cell
                     65: \ u.*          UCell
                     66: \ d.*          DCell
                     67: \ ud.*         UDCell
                     68: \ r.*          Float
                     69: \ a_.*         Cell *
                     70: \ c_.*         Char *
                     71: \ f_.*         Float *
                     72: \ df_.*                DFloat *
                     73: \ sf_.*                SFloat *
                     74: \ xt.*         XT
                     75: \ wid.*                WID
                     76: \ f83name.*    F83Name *
                     77: \ 
                     78: \ 
                     79: \ 
                     80: \ In addition the following names can be used:
                     81: \ ip   the instruction pointer
                     82: \ sp   the data stack pointer
                     83: \ rp   the parameter stack pointer
                     84: \ lp   the locals stack pointer
                     85: \ NEXT executes NEXT
                     86: \ cfa  
                     87: \ NEXT1        executes NEXT1
                     88: \ FLAG(x)      makes a Forth flag from a C flag
                     89: \ 
                     90: \ 
                     91: \ 
                     92: \ Percentages in comments are from Koopmans book: average/maximum use
                     93: \ (taken from four, not very representative benchmarks)
                     94: \ 
                     95: \ 
                     96: \ 
                     97: \ To do:
                     98: \ 
                     99: \ throw execute, cfa and NEXT1 out?
                    100: \ macroize *ip, ip++, *ip++ (pipelining)?
                    101: 
                    102: \ these m4 macros would collide with identifiers
                    103: undefine(`index')
                    104: undefine(`shift')
                    105: 
1.47      anton     106: noop   ( -- )          gforth
1.1       anton     107: ;
                    108: :
                    109:  ;
                    110: 
1.47      anton     111: lit    ( -- w )                gforth
1.1       anton     112: w = (Cell)NEXT_INST;
                    113: INC_IP(1);
                    114: :
                    115:  r> dup @ swap cell+ >r ;
                    116: 
1.47      anton     117: execute        ( xt -- )               core
1.29      crook     118: ""Perform the semantics represented by the execution token, @i{xt}.""
1.1       anton     119: ip=IP;
1.64    ! anton     120: IF_spTOS(spTOS = sp[0]);
1.1       anton     121: EXEC(xt);
                    122: 
1.47      anton     123: perform        ( a_addr -- )   gforth
1.55      anton     124: ""@code{@@ execute}.""
1.1       anton     125: /* and pfe */
                    126: ip=IP;
1.64    ! anton     127: IF_spTOS(spTOS = sp[0]);
1.1       anton     128: EXEC(*(Xt *)a_addr);
                    129: :
                    130:  @ execute ;
                    131: 
1.31      jwilke    132: \fhas? skipbranchprims 0= [IF]
1.15      pazsan    133: \+glocals
1.1       anton     134: 
1.47      anton     135: branch-lp+!#   ( -- )  gforth  branch_lp_plus_store_number
1.1       anton     136: /* this will probably not be used */
                    137: branch_adjust_lp:
                    138: lp += (Cell)(IP[1]);
                    139: goto branch;
                    140: 
1.15      pazsan    141: \+
1.1       anton     142: 
1.47      anton     143: branch ( -- )          gforth
1.1       anton     144: branch:
1.23      anton     145: SET_IP((Xt *)(((Cell)IP)+(Cell)NEXT_INST));
1.1       anton     146: :
                    147:  r> dup @ + >r ;
                    148: 
                    149: \ condbranch(forthname,restline,code,forthcode)
                    150: \ this is non-syntactical: code must open a brace that is closed by the macro
                    151: define(condbranch,
                    152: $1     $2
1.23      anton     153: $3     SET_IP((Xt *)(((Cell)IP)+(Cell)NEXT_INST));
1.1       anton     154:        NEXT;
                    155: }
                    156: else
                    157:     INC_IP(1);
                    158: $4
                    159: 
1.15      pazsan    160: \+glocals
1.1       anton     161: 
                    162: $1-lp+!#       $2_lp_plus_store_number
                    163: $3    goto branch_adjust_lp;
                    164: }
                    165: else
                    166:     INC_IP(2);
                    167: 
1.15      pazsan    168: \+
1.1       anton     169: )
                    170: 
1.47      anton     171: condbranch(?branch,( f -- )            f83     question_branch,
1.1       anton     172: if (f==0) {
1.64    ! anton     173:     IF_spTOS(spTOS = sp[0]);
1.5       jwilke    174: ,:
                    175:  0= dup     \ !f !f
                    176:  r> dup @   \ !f !f IP branchoffset
                    177:  rot and +  \ !f IP|IP+branchoffset
                    178:  swap 0= cell and + \ IP''
                    179:  >r ;)
1.1       anton     180: 
                    181: \ we don't need an lp_plus_store version of the ?dup-stuff, because it
                    182: \ is only used in if's (yet)
                    183: 
1.15      pazsan    184: \+xconds
1.1       anton     185: 
1.47      anton     186: ?dup-?branch   ( f -- f )      new     question_dupe_question_branch
1.1       anton     187: ""The run-time procedure compiled by @code{?DUP-IF}.""
                    188: if (f==0) {
                    189:   sp++;
1.64    ! anton     190:   IF_spTOS(spTOS = sp[0]);
1.23      anton     191:   SET_IP((Xt *)(((Cell)IP)+(Cell)NEXT_INST));
1.1       anton     192:   NEXT;
                    193: }
                    194: else
                    195:   INC_IP(1);
                    196: 
1.47      anton     197: ?dup-0=-?branch        ( f -- )        new     question_dupe_zero_equals_question_branch
1.1       anton     198: ""The run-time procedure compiled by @code{?DUP-0=-IF}.""
                    199: /* the approach taken here of declaring the word as having the stack
                    200: effect ( f -- ) and correcting for it in the branch-taken case costs a
                    201: few cycles in that case, but is easy to convert to a CONDBRANCH
                    202: invocation */
                    203: if (f!=0) {
                    204:   sp--;
1.23      anton     205:   SET_IP((Xt *)(((Cell)IP)+(Cell)NEXT_INST));
1.1       anton     206:   NEXT;
                    207: }
                    208: else
                    209:   INC_IP(1);
                    210: 
1.15      pazsan    211: \+
1.31      jwilke    212: \f[THEN]
                    213: \fhas? skiploopprims 0= [IF]
1.1       anton     214: 
1.47      anton     215: condbranch((next),( -- )               cmFORTH paren_next,
1.1       anton     216: if ((*rp)--) {
                    217: ,:
                    218:  r> r> dup 1- >r
                    219:  IF dup @ + >r ELSE cell+ >r THEN ;)
                    220: 
1.47      anton     221: condbranch((loop),( -- )               gforth  paren_loop,
1.1       anton     222: Cell index = *rp+1;
                    223: Cell limit = rp[1];
                    224: if (index != limit) {
                    225:     *rp = index;
                    226: ,:
                    227:  r> r> 1+ r> 2dup =
                    228:  IF >r 1- >r cell+ >r
                    229:  ELSE >r >r dup @ + >r THEN ;)
                    230: 
1.47      anton     231: condbranch((+loop),( n -- )            gforth  paren_plus_loop,
1.1       anton     232: /* !! check this thoroughly */
                    233: Cell index = *rp;
                    234: /* sign bit manipulation and test: (x^y)<0 is equivalent to (x<0) != (y<0) */
                    235: /* dependent upon two's complement arithmetic */
                    236: Cell olddiff = index-rp[1];
                    237: if ((olddiff^(olddiff+n))>=0   /* the limit is not crossed */
                    238:     || (olddiff^n)>=0          /* it is a wrap-around effect */) {
                    239: #ifdef i386
                    240:     *rp += n;
                    241: #else
                    242:     *rp = index + n;
                    243: #endif
1.64    ! anton     244:     IF_spTOS(spTOS = sp[0]);
1.1       anton     245: ,:
                    246:  r> swap
                    247:  r> r> 2dup - >r
                    248:  2 pick r@ + r@ xor 0< 0=
                    249:  3 pick r> xor 0< 0= or
                    250:  IF    >r + >r dup @ + >r
                    251:  ELSE  >r >r drop cell+ >r THEN ;)
                    252: 
1.15      pazsan    253: \+xconds
1.1       anton     254: 
1.47      anton     255: condbranch((-loop),( u -- )            gforth  paren_minus_loop,
1.1       anton     256: /* !! check this thoroughly */
                    257: Cell index = *rp;
                    258: UCell olddiff = index-rp[1];
                    259: if (olddiff>u) {
                    260: #ifdef i386
                    261:     *rp -= u;
                    262: #else
                    263:     *rp = index - u;
                    264: #endif
1.64    ! anton     265:     IF_spTOS(spTOS = sp[0]);
1.1       anton     266: ,)
                    267: 
1.47      anton     268: condbranch((s+loop),( n -- )           gforth  paren_symmetric_plus_loop,
1.1       anton     269: ""The run-time procedure compiled by S+LOOP. It loops until the index
                    270: crosses the boundary between limit and limit-sign(n). I.e. a symmetric
                    271: version of (+LOOP).""
                    272: /* !! check this thoroughly */
                    273: Cell index = *rp;
                    274: Cell diff = index-rp[1];
                    275: Cell newdiff = diff+n;
                    276: if (n<0) {
                    277:     diff = -diff;
                    278:     newdiff = -newdiff;
                    279: }
                    280: if (diff>=0 || newdiff<0) {
                    281: #ifdef i386
                    282:     *rp += n;
                    283: #else
                    284:     *rp = index + n;
                    285: #endif
1.64    ! anton     286:     IF_spTOS(spTOS = sp[0]);
1.1       anton     287: ,)
                    288: 
1.15      pazsan    289: \+
1.1       anton     290: 
1.47      anton     291: unloop ( -- )  core
1.1       anton     292: rp += 2;
                    293: :
                    294:  r> rdrop rdrop >r ;
                    295: 
1.47      anton     296: (for)  ( ncount -- )           cmFORTH         paren_for
1.1       anton     297: /* or (for) = >r -- collides with unloop! */
                    298: *--rp = 0;
                    299: *--rp = ncount;
                    300: :
                    301:  r> swap 0 >r >r >r ;
                    302: 
1.47      anton     303: (do)   ( nlimit nstart -- )            gforth          paren_do
1.1       anton     304: /* or do it in high-level? 0.09/0.23% */
                    305: *--rp = nlimit;
                    306: *--rp = nstart;
                    307: :
                    308:  r> swap rot >r >r >r ;
                    309: 
1.47      anton     310: (?do)  ( nlimit nstart -- )    gforth  paren_question_do
1.1       anton     311: *--rp = nlimit;
                    312: *--rp = nstart;
                    313: if (nstart == nlimit) {
1.64    ! anton     314:     IF_spTOS(spTOS = sp[0]);
1.1       anton     315:     goto branch;
                    316:     }
                    317: else {
                    318:     INC_IP(1);
                    319: }
                    320: :
                    321:   2dup =
                    322:   IF   r> swap rot >r >r
                    323:        dup @ + >r
                    324:   ELSE r> swap rot >r >r
                    325:        cell+ >r
                    326:   THEN ;                               \ --> CORE-EXT
                    327: 
1.15      pazsan    328: \+xconds
1.1       anton     329: 
1.47      anton     330: (+do)  ( nlimit nstart -- )    gforth  paren_plus_do
1.1       anton     331: *--rp = nlimit;
                    332: *--rp = nstart;
                    333: if (nstart >= nlimit) {
1.64    ! anton     334:     IF_spTOS(spTOS = sp[0]);
1.1       anton     335:     goto branch;
                    336:     }
                    337: else {
                    338:     INC_IP(1);
                    339: }
                    340: :
                    341:  swap 2dup
                    342:  r> swap >r swap >r
                    343:  >=
                    344:  IF
                    345:      dup @ +
                    346:  ELSE
                    347:      cell+
                    348:  THEN  >r ;
                    349: 
1.47      anton     350: (u+do) ( ulimit ustart -- )    gforth  paren_u_plus_do
1.1       anton     351: *--rp = ulimit;
                    352: *--rp = ustart;
                    353: if (ustart >= ulimit) {
1.64    ! anton     354:     IF_spTOS(spTOS = sp[0]);
1.1       anton     355:     goto branch;
                    356:     }
                    357: else {
                    358:     INC_IP(1);
                    359: }
                    360: :
                    361:  swap 2dup
                    362:  r> swap >r swap >r
                    363:  u>=
                    364:  IF
                    365:      dup @ +
                    366:  ELSE
                    367:      cell+
                    368:  THEN  >r ;
                    369: 
1.47      anton     370: (-do)  ( nlimit nstart -- )    gforth  paren_minus_do
1.1       anton     371: *--rp = nlimit;
                    372: *--rp = nstart;
                    373: if (nstart <= nlimit) {
1.64    ! anton     374:     IF_spTOS(spTOS = sp[0]);
1.1       anton     375:     goto branch;
                    376:     }
                    377: else {
                    378:     INC_IP(1);
                    379: }
                    380: :
                    381:  swap 2dup
                    382:  r> swap >r swap >r
                    383:  <=
                    384:  IF
                    385:      dup @ +
                    386:  ELSE
                    387:      cell+
                    388:  THEN  >r ;
                    389: 
1.47      anton     390: (u-do) ( ulimit ustart -- )    gforth  paren_u_minus_do
1.1       anton     391: *--rp = ulimit;
                    392: *--rp = ustart;
                    393: if (ustart <= ulimit) {
1.64    ! anton     394:     IF_spTOS(spTOS = sp[0]);
1.1       anton     395:     goto branch;
                    396:     }
                    397: else {
                    398:     INC_IP(1);
                    399: }
                    400: :
                    401:  swap 2dup
                    402:  r> swap >r swap >r
                    403:  u<=
                    404:  IF
                    405:      dup @ +
                    406:  ELSE
                    407:      cell+
                    408:  THEN  >r ;
                    409: 
1.15      pazsan    410: \+
1.1       anton     411: 
1.5       jwilke    412: \ don't make any assumptions where the return stack is!!
                    413: \ implement this in machine code if it should run quickly!
                    414: 
1.47      anton     415: i      ( -- n )                core
1.1       anton     416: n = *rp;
                    417: :
1.5       jwilke    418: \ rp@ cell+ @ ;
                    419:   r> r> tuck >r >r ;
1.1       anton     420: 
1.47      anton     421: i'     ( -- w )                gforth          i_tick
1.1       anton     422: ""loop end value""
                    423: w = rp[1];
                    424: :
1.5       jwilke    425: \ rp@ cell+ cell+ @ ;
                    426:   r> r> r> dup itmp ! >r >r >r itmp @ ;
                    427: variable itmp
1.1       anton     428: 
1.47      anton     429: j      ( -- n )                core
1.1       anton     430: n = rp[2];
                    431: :
1.5       jwilke    432: \ rp@ cell+ cell+ cell+ @ ;
                    433:   r> r> r> r> dup itmp ! >r >r >r >r itmp @ ;
                    434: [IFUNDEF] itmp variable itmp [THEN]
1.1       anton     435: 
1.47      anton     436: k      ( -- n )                gforth
1.1       anton     437: n = rp[4];
                    438: :
1.5       jwilke    439: \ rp@ [ 5 cells ] Literal + @ ;
                    440:   r> r> r> r> r> r> dup itmp ! >r >r >r >r >r >r itmp @ ;
                    441: [IFUNDEF] itmp variable itmp [THEN]
1.31      jwilke    442: 
                    443: \f[THEN]
1.1       anton     444: 
                    445: \ digit is high-level: 0/0%
                    446: 
1.47      anton     447: move   ( c_from c_to ucount -- )               core
1.52      anton     448: ""Copy the contents of @i{ucount} aus at @i{c-from} to
1.33      anton     449: @i{c-to}. @code{move} works correctly even if the two areas overlap.""
1.52      anton     450: /* !! note that the standard specifies addr, not c-addr */
1.1       anton     451: memmove(c_to,c_from,ucount);
                    452: /* make an Ifdef for bsd and others? */
                    453: :
                    454:  >r 2dup u< IF r> cmove> ELSE r> cmove THEN ;
                    455: 
1.47      anton     456: cmove  ( c_from c_to u -- )    string  c_move
1.33      anton     457: ""Copy the contents of @i{ucount} characters from data space at
                    458: @i{c-from} to @i{c-to}. The copy proceeds @code{char}-by-@code{char}
                    459: from low address to high address; i.e., for overlapping areas it is
                    460: safe if @i{c-to}=<@i{c-from}.""
1.1       anton     461: while (u-- > 0)
                    462:   *c_to++ = *c_from++;
                    463: :
                    464:  bounds ?DO  dup c@ I c! 1+  LOOP  drop ;
                    465: 
1.47      anton     466: cmove> ( c_from c_to u -- )    string  c_move_up
1.33      anton     467: ""Copy the contents of @i{ucount} characters from data space at
                    468: @i{c-from} to @i{c-to}. The copy proceeds @code{char}-by-@code{char}
                    469: from high address to low address; i.e., for overlapping areas it is
                    470: safe if @i{c-to}>=@i{c-from}.""
1.1       anton     471: while (u-- > 0)
                    472:   c_to[u] = c_from[u];
                    473: :
                    474:  dup 0= IF  drop 2drop exit  THEN
                    475:  rot over + -rot bounds swap 1-
                    476:  DO  1- dup c@ I c!  -1 +LOOP  drop ;
                    477: 
1.47      anton     478: fill   ( c_addr u c -- )       core
1.52      anton     479: ""Store @i{c} in @i{u} chars starting at @i{c-addr}.""
1.1       anton     480: memset(c_addr,c,u);
                    481: :
                    482:  -rot bounds
                    483:  ?DO  dup I c!  LOOP  drop ;
                    484: 
1.47      anton     485: compare        ( c_addr1 u1 c_addr2 u2 -- n )  string
1.29      crook     486: ""Compare two strings lexicographically. If they are equal, @i{n} is 0; if
                    487: the first string is smaller, @i{n} is -1; if the first string is larger, @i{n}
1.1       anton     488: is 1. Currently this is based on the machine's character
1.26      crook     489: comparison. In the future, this may change to consider the current
1.1       anton     490: locale and its collation order.""
1.46      pazsan    491: /* close ' to keep fontify happy */ 
1.1       anton     492: n = memcmp(c_addr1, c_addr2, u1<u2 ? u1 : u2);
                    493: if (n==0)
                    494:   n = u1-u2;
                    495: if (n<0)
                    496:   n = -1;
                    497: else if (n>0)
                    498:   n = 1;
                    499: :
1.43      pazsan    500:  rot 2dup swap - >r min swap -text dup
                    501:  IF  rdrop  ELSE  drop r> sgn  THEN ;
                    502: : sgn ( n -- -1/0/1 )
                    503:  dup 0= IF EXIT THEN  0< 2* 1+ ;
1.1       anton     504: 
1.47      anton     505: -text  ( c_addr1 u c_addr2 -- n )      new     dash_text
1.1       anton     506: n = memcmp(c_addr1, c_addr2, u);
                    507: if (n<0)
                    508:   n = -1;
                    509: else if (n>0)
                    510:   n = 1;
                    511: :
                    512:  swap bounds
                    513:  ?DO  dup c@ I c@ = WHILE  1+  LOOP  drop 0
1.49      pazsan    514:  ELSE  c@ I c@ - unloop  THEN  sgn ;
1.43      pazsan    515: : sgn ( n -- -1/0/1 )
                    516:  dup 0= IF EXIT THEN  0< 2* 1+ ;
1.1       anton     517: 
1.47      anton     518: toupper        ( c1 -- c2 )    gforth
1.29      crook     519: ""If @i{c1} is a lower-case character (in the current locale), @i{c2}
1.25      anton     520: is the equivalent upper-case character. All other characters are unchanged.""
1.1       anton     521: c2 = toupper(c1);
                    522: :
                    523:  dup [char] a - [ char z char a - 1 + ] Literal u<  bl and - ;
                    524: 
1.47      anton     525: capscomp       ( c_addr1 u c_addr2 -- n )      new
1.1       anton     526: n = memcasecmp(c_addr1, c_addr2, u); /* !! use something that works in all locales */
                    527: if (n<0)
                    528:   n = -1;
                    529: else if (n>0)
                    530:   n = 1;
                    531: :
                    532:  swap bounds
                    533:  ?DO  dup c@ I c@ <>
                    534:      IF  dup c@ toupper I c@ toupper =
                    535:      ELSE  true  THEN  WHILE  1+  LOOP  drop 0
1.49      pazsan    536:  ELSE  c@ toupper I c@ toupper - unloop  THEN  sgn ;
1.1       anton     537: 
1.47      anton     538: -trailing      ( c_addr u1 -- c_addr u2 )              string  dash_trailing
1.29      crook     539: ""Adjust the string specified by @i{c-addr, u1} to remove all trailing
                    540: spaces. @i{u2} is the length of the modified string.""
1.1       anton     541: u2 = u1;
1.4       anton     542: while (u2>0 && c_addr[u2-1] == ' ')
1.1       anton     543:   u2--;
                    544: :
                    545:  BEGIN  1- 2dup + c@ bl =  WHILE
                    546:         dup  0= UNTIL  ELSE  1+  THEN ;
                    547: 
1.47      anton     548: /string        ( c_addr1 u1 n -- c_addr2 u2 )  string  slash_string
1.29      crook     549: ""Adjust the string specified by @i{c-addr1, u1} to remove @i{n}
1.27      crook     550: characters from the start of the string.""
1.1       anton     551: c_addr2 = c_addr1+n;
                    552: u2 = u1-n;
                    553: :
                    554:  tuck - >r + r> dup 0< IF  - 0  THEN ;
                    555: 
1.47      anton     556: +      ( n1 n2 -- n )          core    plus
1.1       anton     557: n = n1+n2;
                    558: 
                    559: \ PFE-0.9.14 has it differently, but the next release will have it as follows
1.47      anton     560: under+ ( n1 n2 n3 -- n n2 )    gforth  under_plus
1.29      crook     561: ""add @i{n3} to @i{n1} (giving @i{n})""
1.1       anton     562: n = n1+n3;
                    563: :
                    564:  rot + swap ;
                    565: 
1.47      anton     566: -      ( n1 n2 -- n )          core    minus
1.1       anton     567: n = n1-n2;
                    568: :
                    569:  negate + ;
                    570: 
1.47      anton     571: negate ( n1 -- n2 )            core
1.1       anton     572: /* use minus as alias */
                    573: n2 = -n1;
                    574: :
                    575:  invert 1+ ;
                    576: 
1.47      anton     577: 1+     ( n1 -- n2 )            core            one_plus
1.1       anton     578: n2 = n1+1;
                    579: :
                    580:  1 + ;
                    581: 
1.47      anton     582: 1-     ( n1 -- n2 )            core            one_minus
1.1       anton     583: n2 = n1-1;
                    584: :
                    585:  1 - ;
                    586: 
1.47      anton     587: max    ( n1 n2 -- n )  core
1.1       anton     588: if (n1<n2)
                    589:   n = n2;
                    590: else
                    591:   n = n1;
                    592: :
                    593:  2dup < IF swap THEN drop ;
                    594: 
1.47      anton     595: min    ( n1 n2 -- n )  core
1.1       anton     596: if (n1<n2)
                    597:   n = n1;
                    598: else
                    599:   n = n2;
                    600: :
                    601:  2dup > IF swap THEN drop ;
                    602: 
1.52      anton     603: abs    ( n -- u )      core
                    604: if (n<0)
                    605:   u = -n;
1.1       anton     606: else
1.52      anton     607:   u = n;
1.1       anton     608: :
                    609:  dup 0< IF negate THEN ;
                    610: 
1.47      anton     611: *      ( n1 n2 -- n )          core    star
1.1       anton     612: n = n1*n2;
                    613: :
                    614:  um* drop ;
                    615: 
1.47      anton     616: /      ( n1 n2 -- n )          core    slash
1.1       anton     617: n = n1/n2;
                    618: :
                    619:  /mod nip ;
                    620: 
1.47      anton     621: mod    ( n1 n2 -- n )          core
1.1       anton     622: n = n1%n2;
                    623: :
                    624:  /mod drop ;
                    625: 
1.47      anton     626: /mod   ( n1 n2 -- n3 n4 )              core            slash_mod
1.1       anton     627: n4 = n1/n2;
                    628: n3 = n1%n2; /* !! is this correct? look into C standard! */
                    629: :
                    630:  >r s>d r> fm/mod ;
                    631: 
1.47      anton     632: 2*     ( n1 -- n2 )            core            two_star
1.52      anton     633: ""Shift left by 1; also works on unsigned numbers""
1.1       anton     634: n2 = 2*n1;
                    635: :
                    636:  dup + ;
                    637: 
1.47      anton     638: 2/     ( n1 -- n2 )            core            two_slash
1.52      anton     639: ""Arithmetic shift right by 1.  For signed numbers this is a floored
                    640: division by 2 (note that @code{/} not necessarily floors).""
1.1       anton     641: n2 = n1>>1;
                    642: :
                    643:  dup MINI and IF 1 ELSE 0 THEN
                    644:  [ bits/byte cell * 1- ] literal 
1.5       jwilke    645:  0 DO 2* swap dup 2* >r MINI and 
1.1       anton     646:      IF 1 ELSE 0 THEN or r> swap
                    647:  LOOP nip ;
                    648: 
1.47      anton     649: fm/mod ( d1 n1 -- n2 n3 )              core            f_m_slash_mod
1.29      crook     650: ""Floored division: @i{d1} = @i{n3}*@i{n1}+@i{n2}, @i{n1}>@i{n2}>=0 or 0>=@i{n2}>@i{n1}.""
1.1       anton     651: #ifdef BUGGY_LONG_LONG
                    652: DCell r = fmdiv(d1,n1);
                    653: n2=r.hi;
                    654: n3=r.lo;
                    655: #else
                    656: /* assumes that the processor uses either floored or symmetric division */
                    657: n3 = d1/n1;
                    658: n2 = d1%n1;
                    659: /* note that this 1%-3>0 is optimized by the compiler */
                    660: if (1%-3>0 && (d1<0) != (n1<0) && n2!=0) {
                    661:   n3--;
                    662:   n2+=n1;
                    663: }
                    664: #endif
                    665: :
                    666:  dup >r dup 0< IF  negate >r dnegate r>  THEN
                    667:  over       0< IF  tuck + swap  THEN
                    668:  um/mod
                    669:  r> 0< IF  swap negate swap  THEN ;
                    670: 
1.47      anton     671: sm/rem ( d1 n1 -- n2 n3 )              core            s_m_slash_rem
1.29      crook     672: ""Symmetric division: @i{d1} = @i{n3}*@i{n1}+@i{n2}, sign(@i{n2})=sign(@i{d1}) or 0.""
1.1       anton     673: #ifdef BUGGY_LONG_LONG
                    674: DCell r = smdiv(d1,n1);
                    675: n2=r.hi;
                    676: n3=r.lo;
                    677: #else
                    678: /* assumes that the processor uses either floored or symmetric division */
                    679: n3 = d1/n1;
                    680: n2 = d1%n1;
                    681: /* note that this 1%-3<0 is optimized by the compiler */
                    682: if (1%-3<0 && (d1<0) != (n1<0) && n2!=0) {
                    683:   n3++;
                    684:   n2-=n1;
                    685: }
                    686: #endif
                    687: :
                    688:  over >r dup >r abs -rot
                    689:  dabs rot um/mod
                    690:  r> r@ xor 0< IF       negate       THEN
                    691:  r>        0< IF  swap negate swap  THEN ;
                    692: 
1.47      anton     693: m*     ( n1 n2 -- d )          core    m_star
1.1       anton     694: #ifdef BUGGY_LONG_LONG
                    695: d = mmul(n1,n2);
                    696: #else
                    697: d = (DCell)n1 * (DCell)n2;
                    698: #endif
                    699: :
                    700:  2dup      0< and >r
                    701:  2dup swap 0< and >r
                    702:  um* r> - r> - ;
                    703: 
1.47      anton     704: um*    ( u1 u2 -- ud )         core    u_m_star
1.1       anton     705: /* use u* as alias */
                    706: #ifdef BUGGY_LONG_LONG
                    707: ud = ummul(u1,u2);
                    708: #else
                    709: ud = (UDCell)u1 * (UDCell)u2;
                    710: #endif
                    711: :
                    712:    >r >r 0 0 r> r> [ 8 cells ] literal 0
                    713:    DO
                    714:        over >r dup >r 0< and d2*+ drop
                    715:        r> 2* r> swap
                    716:    LOOP 2drop ;
                    717: : d2*+ ( ud n -- ud+n c )
                    718:    over MINI
                    719:    and >r >r 2dup d+ swap r> + swap r> ;
                    720: 
1.47      anton     721: um/mod ( ud u1 -- u2 u3 )              core    u_m_slash_mod
1.32      anton     722: ""ud=u3*u1+u2, u1>u2>=0""
1.1       anton     723: #ifdef BUGGY_LONG_LONG
                    724: UDCell r = umdiv(ud,u1);
                    725: u2=r.hi;
                    726: u3=r.lo;
                    727: #else
                    728: u3 = ud/u1;
                    729: u2 = ud%u1;
                    730: #endif
                    731: :
                    732:    0 swap [ 8 cells 1 + ] literal 0
1.5       jwilke    733:    ?DO /modstep
1.1       anton     734:    LOOP drop swap 1 rshift or swap ;
                    735: : /modstep ( ud c R: u -- ud-?u c R: u )
1.5       jwilke    736:    >r over r@ u< 0= or IF r@ - 1 ELSE 0 THEN  d2*+ r> ;
1.1       anton     737: : d2*+ ( ud n -- ud+n c )
                    738:    over MINI
                    739:    and >r >r 2dup d+ swap r> + swap r> ;
                    740: 
1.47      anton     741: m+     ( d1 n -- d2 )          double          m_plus
1.1       anton     742: #ifdef BUGGY_LONG_LONG
                    743: d2.lo = d1.lo+n;
                    744: d2.hi = d1.hi - (n<0) + (d2.lo<d1.lo);
                    745: #else
                    746: d2 = d1+n;
                    747: #endif
                    748: :
                    749:  s>d d+ ;
                    750: 
1.47      anton     751: d+     ( d1 d2 -- d )          double  d_plus
1.1       anton     752: #ifdef BUGGY_LONG_LONG
                    753: d.lo = d1.lo+d2.lo;
                    754: d.hi = d1.hi + d2.hi + (d.lo<d1.lo);
                    755: #else
                    756: d = d1+d2;
                    757: #endif
                    758: :
                    759:  rot + >r tuck + swap over u> r> swap - ;
                    760: 
1.47      anton     761: d-     ( d1 d2 -- d )          double          d_minus
1.1       anton     762: #ifdef BUGGY_LONG_LONG
                    763: d.lo = d1.lo - d2.lo;
                    764: d.hi = d1.hi-d2.hi-(d1.lo<d2.lo);
                    765: #else
                    766: d = d1-d2;
                    767: #endif
                    768: :
                    769:  dnegate d+ ;
                    770: 
1.47      anton     771: dnegate        ( d1 -- d2 )            double  d_negate
1.1       anton     772: /* use dminus as alias */
                    773: #ifdef BUGGY_LONG_LONG
                    774: d2 = dnegate(d1);
                    775: #else
                    776: d2 = -d1;
                    777: #endif
                    778: :
                    779:  invert swap negate tuck 0= - ;
                    780: 
1.47      anton     781: d2*    ( d1 -- d2 )            double          d_two_star
1.52      anton     782: ""Shift left by 1; also works on unsigned numbers""
1.1       anton     783: #ifdef BUGGY_LONG_LONG
                    784: d2.lo = d1.lo<<1;
                    785: d2.hi = (d1.hi<<1) | (d1.lo>>(CELL_BITS-1));
                    786: #else
                    787: d2 = 2*d1;
                    788: #endif
                    789: :
                    790:  2dup d+ ;
                    791: 
1.47      anton     792: d2/    ( d1 -- d2 )            double          d_two_slash
1.52      anton     793: ""Arithmetic shift right by 1.  For signed numbers this is a floored
                    794: division by 2.""
1.1       anton     795: #ifdef BUGGY_LONG_LONG
                    796: d2.hi = d1.hi>>1;
                    797: d2.lo= (d1.lo>>1) | (d1.hi<<(CELL_BITS-1));
                    798: #else
                    799: d2 = d1>>1;
                    800: #endif
                    801: :
                    802:  dup 1 and >r 2/ swap 2/ [ 1 8 cells 1- lshift 1- ] Literal and
                    803:  r> IF  [ 1 8 cells 1- lshift ] Literal + THEN  swap ;
                    804: 
1.47      anton     805: and    ( w1 w2 -- w )          core
1.1       anton     806: w = w1&w2;
                    807: 
1.47      anton     808: or     ( w1 w2 -- w )          core
1.1       anton     809: w = w1|w2;
                    810: :
                    811:  invert swap invert and invert ;
                    812: 
1.47      anton     813: xor    ( w1 w2 -- w )          core    x_or
1.1       anton     814: w = w1^w2;
                    815: 
1.47      anton     816: invert ( w1 -- w2 )            core
1.1       anton     817: w2 = ~w1;
                    818: :
                    819:  MAXU xor ;
                    820: 
1.47      anton     821: rshift ( u1 n -- u2 )          core    r_shift
1.53      anton     822: ""Logical shift right by @i{n} bits.""
1.1       anton     823:   u2 = u1>>n;
                    824: :
                    825:     0 ?DO 2/ MAXI and LOOP ;
                    826: 
1.47      anton     827: lshift ( u1 n -- u2 )          core    l_shift
1.1       anton     828:   u2 = u1<<n;
                    829: :
                    830:     0 ?DO 2* LOOP ;
                    831: 
                    832: \ comparisons(prefix, args, prefix, arg1, arg2, wordsets...)
                    833: define(comparisons,
1.47      anton     834: $1=    ( $2 -- f )             $6      $3equals
1.1       anton     835: f = FLAG($4==$5);
                    836: :
                    837:     [ char $1x char 0 = [IF]
                    838:        ] IF false ELSE true THEN [
                    839:     [ELSE]
                    840:        ] xor 0= [
                    841:     [THEN] ] ;
                    842: 
1.47      anton     843: $1<>   ( $2 -- f )             $7      $3not_equals
1.1       anton     844: f = FLAG($4!=$5);
                    845: :
                    846:     [ char $1x char 0 = [IF]
                    847:        ] IF true ELSE false THEN [
                    848:     [ELSE]
                    849:        ] xor 0<> [
                    850:     [THEN] ] ;
                    851: 
1.47      anton     852: $1<    ( $2 -- f )             $8      $3less_than
1.1       anton     853: f = FLAG($4<$5);
                    854: :
                    855:     [ char $1x char 0 = [IF]
                    856:        ] MINI and 0<> [
                    857:     [ELSE] char $1x char u = [IF]
                    858:        ]   2dup xor 0<  IF nip ELSE - THEN 0<  [
                    859:        [ELSE]
                    860:            ] MINI xor >r MINI xor r> u< [
                    861:        [THEN]
                    862:     [THEN] ] ;
                    863: 
1.47      anton     864: $1>    ( $2 -- f )             $9      $3greater_than
1.1       anton     865: f = FLAG($4>$5);
                    866: :
                    867:     [ char $1x char 0 = [IF] ] negate [ [ELSE] ] swap [ [THEN] ]
                    868:     $1< ;
                    869: 
1.47      anton     870: $1<=   ( $2 -- f )             gforth  $3less_or_equal
1.1       anton     871: f = FLAG($4<=$5);
                    872: :
                    873:     $1> 0= ;
                    874: 
1.47      anton     875: $1>=   ( $2 -- f )             gforth  $3greater_or_equal
1.1       anton     876: f = FLAG($4>=$5);
                    877: :
                    878:     [ char $1x char 0 = [IF] ] negate [ [ELSE] ] swap [ [THEN] ]
                    879:     $1<= ;
                    880: 
                    881: )
                    882: 
                    883: comparisons(0, n, zero_, n, 0, core, core-ext, core, core-ext)
                    884: comparisons(, n1 n2, , n1, n2, core, core-ext, core, core)
                    885: comparisons(u, u1 u2, u_, u1, u2, gforth, gforth, core, core-ext)
                    886: 
                    887: \ dcomparisons(prefix, args, prefix, arg1, arg2, wordsets...)
                    888: define(dcomparisons,
1.47      anton     889: $1=    ( $2 -- f )             $6      $3equals
1.1       anton     890: #ifdef BUGGY_LONG_LONG
                    891: f = FLAG($4.lo==$5.lo && $4.hi==$5.hi);
                    892: #else
                    893: f = FLAG($4==$5);
                    894: #endif
                    895: 
1.47      anton     896: $1<>   ( $2 -- f )             $7      $3not_equals
1.1       anton     897: #ifdef BUGGY_LONG_LONG
                    898: f = FLAG($4.lo!=$5.lo || $4.hi!=$5.hi);
                    899: #else
                    900: f = FLAG($4!=$5);
                    901: #endif
                    902: 
1.47      anton     903: $1<    ( $2 -- f )             $8      $3less_than
1.1       anton     904: #ifdef BUGGY_LONG_LONG
                    905: f = FLAG($4.hi==$5.hi ? $4.lo<$5.lo : $4.hi<$5.hi);
                    906: #else
                    907: f = FLAG($4<$5);
                    908: #endif
                    909: 
1.47      anton     910: $1>    ( $2 -- f )             $9      $3greater_than
1.1       anton     911: #ifdef BUGGY_LONG_LONG
                    912: f = FLAG($4.hi==$5.hi ? $4.lo>$5.lo : $4.hi>$5.hi);
                    913: #else
                    914: f = FLAG($4>$5);
                    915: #endif
                    916: 
1.47      anton     917: $1<=   ( $2 -- f )             gforth  $3less_or_equal
1.1       anton     918: #ifdef BUGGY_LONG_LONG
                    919: f = FLAG($4.hi==$5.hi ? $4.lo<=$5.lo : $4.hi<=$5.hi);
                    920: #else
                    921: f = FLAG($4<=$5);
                    922: #endif
                    923: 
1.47      anton     924: $1>=   ( $2 -- f )             gforth  $3greater_or_equal
1.1       anton     925: #ifdef BUGGY_LONG_LONG
                    926: f = FLAG($4.hi==$5.hi ? $4.lo>=$5.lo : $4.hi>=$5.hi);
                    927: #else
                    928: f = FLAG($4>=$5);
                    929: #endif
                    930: 
                    931: )
                    932: 
1.15      pazsan    933: \+dcomps
1.1       anton     934: 
                    935: dcomparisons(d, d1 d2, d_, d1, d2, double, gforth, double, gforth)
                    936: dcomparisons(d0, d, d_zero_, d, DZERO, double, gforth, double, gforth)
                    937: dcomparisons(du, ud1 ud2, d_u_, ud1, ud2, gforth, gforth, double-ext, gforth)
                    938: 
1.15      pazsan    939: \+
1.1       anton     940: 
1.47      anton     941: within ( u1 u2 u3 -- f )               core-ext
1.32      anton     942: ""u2=<u1<u3 or: u3=<u2 and u1 is not in [u3,u2).  This works for
                    943: unsigned and signed numbers (but not a mixture).  Another way to think
                    944: about this word is to consider the numbers as a circle (wrapping
                    945: around from @code{max-u} to 0 for unsigned, and from @code{max-n} to
                    946: min-n for signed numbers); now consider the range from u2 towards
                    947: increasing numbers up to and excluding u3 (giving an empty range if
1.52      anton     948: u2=u3); if u1 is in this range, @code{within} returns true.""
1.1       anton     949: f = FLAG(u1-u2 < u3-u2);
                    950: :
                    951:  over - >r - r> u< ;
                    952: 
1.47      anton     953: sp@    ( -- a_addr )           gforth          sp_fetch
1.1       anton     954: a_addr = sp+1;
                    955: 
1.47      anton     956: sp!    ( a_addr -- )           gforth          sp_store
1.1       anton     957: sp = a_addr;
1.64    ! anton     958: /* works with and without spTOS caching */
1.1       anton     959: 
1.47      anton     960: rp@    ( -- a_addr )           gforth          rp_fetch
1.1       anton     961: a_addr = rp;
                    962: 
1.47      anton     963: rp!    ( a_addr -- )           gforth          rp_store
1.1       anton     964: rp = a_addr;
                    965: 
1.15      pazsan    966: \+floating
1.1       anton     967: 
1.47      anton     968: fp@    ( -- f_addr )   gforth  fp_fetch
1.1       anton     969: f_addr = fp;
                    970: 
1.47      anton     971: fp!    ( f_addr -- )   gforth  fp_store
1.1       anton     972: fp = f_addr;
                    973: 
1.15      pazsan    974: \+
1.1       anton     975: 
1.47      anton     976: ;s     ( -- )          gforth  semis
1.22      crook     977: ""The primitive compiled by @code{EXIT}.""
1.23      anton     978: SET_IP((Xt *)(*rp++));
1.1       anton     979: 
1.47      anton     980: >r     ( w -- )                core    to_r
1.52      anton     981: ""@code{( R: -- w )}""
1.1       anton     982: *--rp = w;
                    983: :
                    984:  (>r) ;
                    985: : (>r)  rp@ cell+ @ rp@ ! rp@ cell+ ! ;
                    986: 
1.47      anton     987: r>     ( -- w )                core    r_from
1.52      anton     988: ""@code{( R: w -- )}""
1.1       anton     989: w = *rp++;
                    990: :
                    991:  rp@ cell+ @ rp@ @ rp@ cell+ ! (rdrop) rp@ ! ;
                    992: Create (rdrop) ' ;s A,
                    993: 
1.47      anton     994: rdrop  ( -- )          gforth
1.52      anton     995: ""@code{( R: w -- )}""
1.1       anton     996: rp++;
                    997: :
                    998:  r> r> drop >r ;
                    999: 
1.47      anton    1000: 2>r    ( w1 w2 -- )    core-ext        two_to_r
1.52      anton    1001: ""@code{( R: -- w1 w2 )}""
1.1       anton    1002: *--rp = w1;
                   1003: *--rp = w2;
                   1004: :
                   1005:  swap r> swap >r swap >r >r ;
                   1006: 
1.47      anton    1007: 2r>    ( -- w1 w2 )    core-ext        two_r_from
1.52      anton    1008: ""@code{( R: w1 w2 -- )}""
1.1       anton    1009: w2 = *rp++;
                   1010: w1 = *rp++;
                   1011: :
                   1012:  r> r> swap r> swap >r swap ;
                   1013: 
1.47      anton    1014: 2r@    ( -- w1 w2 )    core-ext        two_r_fetch
1.52      anton    1015: ""@code{( R: w1 w2 -- w1 w2 )}""
1.1       anton    1016: w2 = rp[0];
                   1017: w1 = rp[1];
                   1018: :
                   1019:  i' j ;
                   1020: 
1.47      anton    1021: 2rdrop ( -- )          gforth  two_r_drop
1.52      anton    1022: ""@code{( R: w1 w2 -- )}""
1.1       anton    1023: rp+=2;
                   1024: :
                   1025:  r> r> drop r> drop >r ;
                   1026: 
1.47      anton    1027: over   ( w1 w2 -- w1 w2 w1 )           core
1.1       anton    1028: :
                   1029:  sp@ cell+ @ ;
                   1030: 
1.47      anton    1031: drop   ( w -- )                core
1.1       anton    1032: :
                   1033:  IF THEN ;
                   1034: 
1.47      anton    1035: swap   ( w1 w2 -- w2 w1 )              core
1.1       anton    1036: :
                   1037:  >r (swap) ! r> (swap) @ ;
                   1038: Variable (swap)
                   1039: 
1.47      anton    1040: dup    ( w -- w w )            core    dupe
1.1       anton    1041: :
                   1042:  sp@ @ ;
                   1043: 
1.47      anton    1044: rot    ( w1 w2 w3 -- w2 w3 w1 )        core    rote
1.1       anton    1045: :
                   1046: [ defined? (swap) [IF] ]
                   1047:     (swap) ! (rot) ! >r (rot) @ (swap) @ r> ;
                   1048: Variable (rot)
                   1049: [ELSE] ]
                   1050:     >r swap r> swap ;
                   1051: [THEN]
                   1052: 
1.47      anton    1053: -rot   ( w1 w2 w3 -- w3 w1 w2 )        gforth  not_rote
1.1       anton    1054: :
                   1055:  rot rot ;
                   1056: 
1.47      anton    1057: nip    ( w1 w2 -- w2 )         core-ext
1.1       anton    1058: :
1.6       jwilke   1059:  swap drop ;
1.1       anton    1060: 
1.47      anton    1061: tuck   ( w1 w2 -- w2 w1 w2 )   core-ext
1.1       anton    1062: :
                   1063:  swap over ;
                   1064: 
1.47      anton    1065: ?dup   ( w -- w )                      core    question_dupe
1.52      anton    1066: ""Actually the stack effect is: @code{( w -- 0 | w w )}.  It performs a
                   1067: @code{dup} if w is nonzero.""
1.1       anton    1068: if (w!=0) {
1.64    ! anton    1069:   IF_spTOS(*sp-- = w;)
1.1       anton    1070: #ifndef USE_TOS
                   1071:   *--sp = w;
                   1072: #endif
                   1073: }
                   1074: :
                   1075:  dup IF dup THEN ;
                   1076: 
1.47      anton    1077: pick   ( u -- w )                      core-ext
1.52      anton    1078: ""Actually the stack effect is @code{ x0 ... xu u -- x0 ... xu x0 }.""
1.1       anton    1079: w = sp[u+1];
                   1080: :
                   1081:  1+ cells sp@ + @ ;
                   1082: 
1.47      anton    1083: 2drop  ( w1 w2 -- )            core    two_drop
1.1       anton    1084: :
                   1085:  drop drop ;
                   1086: 
1.47      anton    1087: 2dup   ( w1 w2 -- w1 w2 w1 w2 )        core    two_dupe
1.1       anton    1088: :
                   1089:  over over ;
                   1090: 
1.47      anton    1091: 2over  ( w1 w2 w3 w4 -- w1 w2 w3 w4 w1 w2 )    core    two_over
1.1       anton    1092: :
                   1093:  3 pick 3 pick ;
                   1094: 
1.47      anton    1095: 2swap  ( w1 w2 w3 w4 -- w3 w4 w1 w2 )  core    two_swap
1.1       anton    1096: :
                   1097:  rot >r rot r> ;
                   1098: 
1.47      anton    1099: 2rot   ( w1 w2 w3 w4 w5 w6 -- w3 w4 w5 w6 w1 w2 )      double-ext      two_rote
1.1       anton    1100: :
                   1101:  >r >r 2swap r> r> 2swap ;
                   1102: 
1.47      anton    1103: 2nip   ( w1 w2 w3 w4 -- w3 w4 )        gforth  two_nip
1.1       anton    1104: :
                   1105:  2swap 2drop ;
                   1106: 
1.47      anton    1107: 2tuck  ( w1 w2 w3 w4 -- w3 w4 w1 w2 w3 w4 )    gforth  two_tuck
1.1       anton    1108: :
                   1109:  2swap 2over ;
                   1110: 
                   1111: \ toggle is high-level: 0.11/0.42%
                   1112: 
1.47      anton    1113: @      ( a_addr -- w )         core    fetch
1.52      anton    1114: ""@i{w} is the cell stored at @i{a_addr}.""
1.1       anton    1115: w = *a_addr;
                   1116: 
1.47      anton    1117: !      ( w a_addr -- )         core    store
1.52      anton    1118: ""Store @i{w} into the cell at @i{a-addr}.""
1.1       anton    1119: *a_addr = w;
                   1120: 
1.47      anton    1121: +!     ( n a_addr -- )         core    plus_store
1.52      anton    1122: ""Add @i{n} to the cell at @i{a-addr}.""
1.1       anton    1123: *a_addr += n;
                   1124: :
                   1125:  tuck @ + swap ! ;
                   1126: 
1.47      anton    1127: c@     ( c_addr -- c )         core    c_fetch
1.52      anton    1128: ""@i{c} is the char stored at @i{c_addr}.""
1.1       anton    1129: c = *c_addr;
                   1130: :
                   1131: [ bigendian [IF] ]
                   1132:     [ cell>bit 4 = [IF] ]
                   1133:        dup [ 0 cell - ] Literal and @ swap 1 and
                   1134:        IF  $FF and  ELSE  8>>  THEN  ;
                   1135:     [ [ELSE] ]
                   1136:        dup [ cell 1- ] literal and
                   1137:        tuck - @ swap [ cell 1- ] literal xor
                   1138:        0 ?DO 8>> LOOP $FF and
                   1139:     [ [THEN] ]
                   1140: [ [ELSE] ]
                   1141:     [ cell>bit 4 = [IF] ]
                   1142:        dup [ 0 cell - ] Literal and @ swap 1 and
                   1143:        IF  8>>  ELSE  $FF and  THEN
                   1144:     [ [ELSE] ]
                   1145:        dup [ cell  1- ] literal and 
                   1146:        tuck - @ swap
                   1147:        0 ?DO 8>> LOOP 255 and
                   1148:     [ [THEN] ]
                   1149: [ [THEN] ]
                   1150: ;
                   1151: : 8>> 2/ 2/ 2/ 2/  2/ 2/ 2/ 2/ ;
                   1152: 
1.47      anton    1153: c!     ( c c_addr -- )         core    c_store
1.52      anton    1154: ""Store @i{c} into the char at @i{c-addr}.""
1.1       anton    1155: *c_addr = c;
                   1156: :
                   1157: [ bigendian [IF] ]
                   1158:     [ cell>bit 4 = [IF] ]
                   1159:        tuck 1 and IF  $FF and  ELSE  8<<  THEN >r
                   1160:        dup -2 and @ over 1 and cells masks + @ and
                   1161:        r> or swap -2 and ! ;
                   1162:        Create masks $00FF , $FF00 ,
                   1163:     [ELSE] ]
                   1164:        dup [ cell 1- ] literal and dup 
                   1165:        [ cell 1- ] literal xor >r
                   1166:        - dup @ $FF r@ 0 ?DO 8<< LOOP invert and
                   1167:        rot $FF and r> 0 ?DO 8<< LOOP or swap ! ;
                   1168:     [THEN]
                   1169: [ELSE] ]
                   1170:     [ cell>bit 4 = [IF] ]
                   1171:        tuck 1 and IF  8<<  ELSE  $FF and  THEN >r
                   1172:        dup -2 and @ over 1 and cells masks + @ and
                   1173:        r> or swap -2 and ! ;
                   1174:        Create masks $FF00 , $00FF ,
                   1175:     [ELSE] ]
                   1176:        dup [ cell 1- ] literal and dup >r
                   1177:        - dup @ $FF r@ 0 ?DO 8<< LOOP invert and
                   1178:        rot $FF and r> 0 ?DO 8<< LOOP or swap ! ;
                   1179:     [THEN]
                   1180: [THEN]
                   1181: : 8<< 2* 2* 2* 2*  2* 2* 2* 2* ;
                   1182: 
1.47      anton    1183: 2!     ( w1 w2 a_addr -- )             core    two_store
1.52      anton    1184: ""Store @i{w2} into the cell at @i{c-addr} and @i{w1} into the next cell.""
1.1       anton    1185: a_addr[0] = w2;
                   1186: a_addr[1] = w1;
                   1187: :
                   1188:  tuck ! cell+ ! ;
                   1189: 
1.47      anton    1190: 2@     ( a_addr -- w1 w2 )             core    two_fetch
1.52      anton    1191: ""@i{w2} is the content of the cell stored at @i{a-addr}, @i{w1} is
                   1192: the content of the next cell.""
1.1       anton    1193: w2 = a_addr[0];
                   1194: w1 = a_addr[1];
                   1195: :
                   1196:  dup cell+ @ swap @ ;
                   1197: 
1.47      anton    1198: cell+  ( a_addr1 -- a_addr2 )  core    cell_plus
1.52      anton    1199: ""@code{1 cells +}""
1.1       anton    1200: a_addr2 = a_addr1+1;
                   1201: :
                   1202:  cell + ;
                   1203: 
1.47      anton    1204: cells  ( n1 -- n2 )            core
1.52      anton    1205: "" @i{n2} is the number of address units of @i{n1} cells.""
1.1       anton    1206: n2 = n1 * sizeof(Cell);
                   1207: :
                   1208:  [ cell
                   1209:  2/ dup [IF] ] 2* [ [THEN]
                   1210:  2/ dup [IF] ] 2* [ [THEN]
                   1211:  2/ dup [IF] ] 2* [ [THEN]
                   1212:  2/ dup [IF] ] 2* [ [THEN]
                   1213:  drop ] ;
                   1214: 
1.47      anton    1215: char+  ( c_addr1 -- c_addr2 )  core    char_plus
1.52      anton    1216: ""@code{1 chars +}.""
1.1       anton    1217: c_addr2 = c_addr1 + 1;
                   1218: :
                   1219:  1+ ;
                   1220: 
1.47      anton    1221: (chars)        ( n1 -- n2 )    gforth  paren_chars
1.1       anton    1222: n2 = n1 * sizeof(Char);
                   1223: :
                   1224:  ;
                   1225: 
1.47      anton    1226: count  ( c_addr1 -- c_addr2 u )        core
1.56      anton    1227: ""@i{c-addr2} is the first character and @i{u} the length of the
                   1228: counted string at @i{c-addr1}.""
1.1       anton    1229: u = *c_addr1;
                   1230: c_addr2 = c_addr1+1;
                   1231: :
                   1232:  dup 1+ swap c@ ;
                   1233: 
1.47      anton    1234: (f83find)      ( c_addr u f83name1 -- f83name2 )       new     paren_f83find
1.13      pazsan   1235: for (; f83name1 != NULL; f83name1 = (struct F83Name *)(f83name1->next))
1.1       anton    1236:   if ((UCell)F83NAME_COUNT(f83name1)==u &&
                   1237:       memcasecmp(c_addr, f83name1->name, u)== 0 /* or inline? */)
                   1238:     break;
                   1239: f83name2=f83name1;
                   1240: :
                   1241:     BEGIN  dup WHILE  (find-samelen)  dup  WHILE
                   1242:        >r 2dup r@ cell+ char+ capscomp  0=
                   1243:        IF  2drop r>  EXIT  THEN
                   1244:        r> @
                   1245:     REPEAT  THEN  nip nip ;
                   1246: : (find-samelen) ( u f83name1 -- u f83name2/0 )
                   1247:     BEGIN  2dup cell+ c@ $1F and <> WHILE  @  dup 0= UNTIL  THEN ;
                   1248: 
1.15      pazsan   1249: \+hash
1.1       anton    1250: 
1.47      anton    1251: (hashfind)     ( c_addr u a_addr -- f83name2 ) new     paren_hashfind
1.13      pazsan   1252: struct F83Name *f83name1;
1.1       anton    1253: f83name2=NULL;
                   1254: while(a_addr != NULL)
                   1255: {
1.13      pazsan   1256:    f83name1=(struct F83Name *)(a_addr[1]);
1.1       anton    1257:    a_addr=(Cell *)(a_addr[0]);
                   1258:    if ((UCell)F83NAME_COUNT(f83name1)==u &&
                   1259:        memcasecmp(c_addr, f83name1->name, u)== 0 /* or inline? */)
                   1260:      {
                   1261:        f83name2=f83name1;
                   1262:        break;
                   1263:      }
                   1264: }
                   1265: :
                   1266:  BEGIN  dup  WHILE
                   1267:         2@ >r >r dup r@ cell+ c@ $1F and =
                   1268:         IF  2dup r@ cell+ char+ capscomp 0=
                   1269:            IF  2drop r> rdrop  EXIT  THEN  THEN
                   1270:        rdrop r>
                   1271:  REPEAT nip nip ;
                   1272: 
1.47      anton    1273: (tablefind)    ( c_addr u a_addr -- f83name2 ) new     paren_tablefind
1.1       anton    1274: ""A case-sensitive variant of @code{(hashfind)}""
1.13      pazsan   1275: struct F83Name *f83name1;
1.1       anton    1276: f83name2=NULL;
                   1277: while(a_addr != NULL)
                   1278: {
1.13      pazsan   1279:    f83name1=(struct F83Name *)(a_addr[1]);
1.1       anton    1280:    a_addr=(Cell *)(a_addr[0]);
                   1281:    if ((UCell)F83NAME_COUNT(f83name1)==u &&
                   1282:        memcmp(c_addr, f83name1->name, u)== 0 /* or inline? */)
                   1283:      {
                   1284:        f83name2=f83name1;
                   1285:        break;
                   1286:      }
                   1287: }
                   1288: :
                   1289:  BEGIN  dup  WHILE
                   1290:         2@ >r >r dup r@ cell+ c@ $1F and =
                   1291:         IF  2dup r@ cell+ char+ -text 0=
                   1292:            IF  2drop r> rdrop  EXIT  THEN  THEN
                   1293:        rdrop r>
                   1294:  REPEAT nip nip ;
                   1295: 
1.47      anton    1296: (hashkey)      ( c_addr u1 -- u2 )             gforth  paren_hashkey
1.1       anton    1297: u2=0;
                   1298: while(u1--)
                   1299:    u2+=(Cell)toupper(*c_addr++);
                   1300: :
                   1301:  0 -rot bounds ?DO  I c@ toupper +  LOOP ;
                   1302: 
1.47      anton    1303: (hashkey1)     ( c_addr u ubits -- ukey )              gforth  paren_hashkey1
1.1       anton    1304: ""ukey is the hash key for the string c_addr u fitting in ubits bits""
                   1305: /* this hash function rotates the key at every step by rot bits within
                   1306:    ubits bits and xors it with the character. This function does ok in
                   1307:    the chi-sqare-test.  Rot should be <=7 (preferably <=5) for
                   1308:    ASCII strings (larger if ubits is large), and should share no
                   1309:    divisors with ubits.
                   1310: */
                   1311: unsigned rot = ((char []){5,0,1,2,3,4,5,5,5,5,3,5,5,5,5,7,5,5,5,5,7,5,5,5,5,6,5,5,5,5,7,5,5})[ubits];
                   1312: Char *cp = c_addr;
                   1313: for (ukey=0; cp<c_addr+u; cp++)
                   1314:     ukey = ((((ukey<<rot) | (ukey>>(ubits-rot))) 
                   1315:             ^ toupper(*cp))
                   1316:            & ((1<<ubits)-1));
                   1317: :
                   1318:  dup rot-values + c@ over 1 swap lshift 1- >r
                   1319:  tuck - 2swap r> 0 2swap bounds
                   1320:  ?DO  dup 4 pick lshift swap 3 pick rshift or
                   1321:       I c@ toupper xor
                   1322:       over and  LOOP
                   1323:  nip nip nip ;
                   1324: Create rot-values
                   1325:   5 c, 0 c, 1 c, 2 c, 3 c,  4 c, 5 c, 5 c, 5 c, 5 c,
                   1326:   3 c, 5 c, 5 c, 5 c, 5 c,  7 c, 5 c, 5 c, 5 c, 5 c,
                   1327:   7 c, 5 c, 5 c, 5 c, 5 c,  6 c, 5 c, 5 c, 5 c, 5 c,
                   1328:   7 c, 5 c, 5 c,
                   1329: 
1.15      pazsan   1330: \+
1.1       anton    1331: 
1.47      anton    1332: (parse-white)  ( c_addr1 u1 -- c_addr2 u2 )    gforth  paren_parse_white
1.1       anton    1333: /* use !isgraph instead of isspace? */
                   1334: Char *endp = c_addr1+u1;
                   1335: while (c_addr1<endp && isspace(*c_addr1))
                   1336:   c_addr1++;
                   1337: if (c_addr1<endp) {
                   1338:   for (c_addr2 = c_addr1; c_addr1<endp && !isspace(*c_addr1); c_addr1++)
                   1339:     ;
                   1340:   u2 = c_addr1-c_addr2;
                   1341: }
                   1342: else {
                   1343:   c_addr2 = c_addr1;
                   1344:   u2 = 0;
                   1345: }
                   1346: :
                   1347:  BEGIN  dup  WHILE  over c@ bl <=  WHILE  1 /string
                   1348:  REPEAT  THEN  2dup
                   1349:  BEGIN  dup  WHILE  over c@ bl >   WHILE  1 /string
                   1350:  REPEAT  THEN  nip - ;
                   1351: 
1.47      anton    1352: aligned        ( c_addr -- a_addr )    core
1.29      crook    1353: "" @i{a-addr} is the first aligned address greater than or equal to @i{c-addr}.""
1.1       anton    1354: a_addr = (Cell *)((((Cell)c_addr)+(sizeof(Cell)-1))&(-sizeof(Cell)));
                   1355: :
                   1356:  [ cell 1- ] Literal + [ -1 cells ] Literal and ;
                   1357: 
1.47      anton    1358: faligned       ( c_addr -- f_addr )    float   f_aligned
1.29      crook    1359: "" @i{f-addr} is the first float-aligned address greater than or equal to @i{c-addr}.""
1.1       anton    1360: f_addr = (Float *)((((Cell)c_addr)+(sizeof(Float)-1))&(-sizeof(Float)));
                   1361: :
                   1362:  [ 1 floats 1- ] Literal + [ -1 floats ] Literal and ;
                   1363: 
1.47      anton    1364: >body  ( xt -- a_addr )        core    to_body
1.40      crook    1365: "" Get the address of the body of the word represented by @i{xt} (the address
                   1366: of the word's data field).""
1.1       anton    1367: a_addr = PFA(xt);
                   1368: :
                   1369:     2 cells + ;
                   1370: 
1.35      jwilke   1371: \ threading stuff is currently only interesting if we have a compiler
                   1372: \fhas? standardthreading has? compiler and [IF]
1.28      jwilke   1373: 
1.47      anton    1374: >code-address  ( xt -- c_addr )                gforth  to_code_address
1.29      crook    1375: ""@i{c-addr} is the code address of the word @i{xt}.""
1.1       anton    1376: /* !! This behaves installation-dependently for DOES-words */
                   1377: c_addr = (Address)CODE_ADDRESS(xt);
                   1378: :
                   1379:     @ ;
                   1380: 
1.47      anton    1381: >does-code     ( xt -- a_addr )                gforth  to_does_code
1.58      anton    1382: ""If @i{xt} is the execution token of a child of a @code{DOES>} word,
1.29      crook    1383: @i{a-addr} is the start of the Forth code after the @code{DOES>};
                   1384: Otherwise @i{a-addr} is 0.""
1.1       anton    1385: a_addr = (Cell *)DOES_CODE(xt);
                   1386: :
                   1387:     cell+ @ ;
                   1388: 
1.47      anton    1389: code-address!  ( c_addr xt -- )                gforth  code_address_store
1.29      crook    1390: ""Create a code field with code address @i{c-addr} at @i{xt}.""
1.1       anton    1391: MAKE_CF(xt, c_addr);
1.10      anton    1392: CACHE_FLUSH(xt,(size_t)PFA(0));
1.1       anton    1393: :
                   1394:     ! ;
                   1395: 
1.47      anton    1396: does-code!     ( a_addr xt -- )                gforth  does_code_store
1.58      anton    1397: ""Create a code field at @i{xt} for a child of a @code{DOES>}-word;
                   1398: @i{a-addr} is the start of the Forth code after @code{DOES>}.""
1.1       anton    1399: MAKE_DOES_CF(xt, a_addr);
1.10      anton    1400: CACHE_FLUSH(xt,(size_t)PFA(0));
1.1       anton    1401: :
                   1402:     dodoes: over ! cell+ ! ;
                   1403: 
1.47      anton    1404: does-handler!  ( a_addr -- )   gforth  does_handler_store
1.58      anton    1405: ""Create a @code{DOES>}-handler at address @i{a-addr}. Normally,
                   1406: @i{a-addr} points just behind a @code{DOES>}.""
1.1       anton    1407: MAKE_DOES_HANDLER(a_addr);
1.10      anton    1408: CACHE_FLUSH((caddr_t)a_addr,DOES_HANDLER_SIZE);
1.1       anton    1409: :
                   1410:     drop ;
                   1411: 
1.47      anton    1412: /does-handler  ( -- n )        gforth  slash_does_handler
1.26      crook    1413: ""The size of a @code{DOES>}-handler (includes possible padding).""
1.1       anton    1414: /* !! a constant or environmental query might be better */
                   1415: n = DOES_HANDLER_SIZE;
                   1416: :
                   1417:     2 cells ;
                   1418: 
1.47      anton    1419: threading-method       ( -- n )        gforth  threading_method
1.1       anton    1420: ""0 if the engine is direct threaded. Note that this may change during
                   1421: the lifetime of an image.""
                   1422: #if defined(DOUBLY_INDIRECT)
                   1423: n=2;
                   1424: #else
                   1425: # if defined(DIRECT_THREADED)
                   1426: n=0;
                   1427: # else
                   1428: n=1;
                   1429: # endif
                   1430: #endif
                   1431: :
                   1432:  1 ;
1.28      jwilke   1433: 
1.35      jwilke   1434: \f[THEN]
1.1       anton    1435: 
1.47      anton    1436: key-file       ( wfileid -- n )                gforth  paren_key_file
1.17      pazsan   1437: #ifdef HAS_FILE
1.1       anton    1438: fflush(stdout);
1.12      pazsan   1439: n = key((FILE*)wfileid);
1.17      pazsan   1440: #else
                   1441: n = key(stdin);
                   1442: #endif
1.1       anton    1443: 
1.47      anton    1444: key?-file      ( wfileid -- n )                facility        key_q_file
1.17      pazsan   1445: #ifdef HAS_FILE
1.1       anton    1446: fflush(stdout);
1.12      pazsan   1447: n = key_query((FILE*)wfileid);
1.17      pazsan   1448: #else
                   1449: n = key_query(stdin);
                   1450: #endif
                   1451: 
                   1452: \+os
1.12      pazsan   1453: 
1.47      anton    1454: stdin  ( -- wfileid )  gforth
1.12      pazsan   1455: wfileid = (Cell)stdin;
1.1       anton    1456: 
1.47      anton    1457: stdout ( -- wfileid )  gforth
1.1       anton    1458: wfileid = (Cell)stdout;
                   1459: 
1.47      anton    1460: stderr ( -- wfileid )  gforth
1.1       anton    1461: wfileid = (Cell)stderr;
                   1462: 
1.47      anton    1463: form   ( -- urows ucols )      gforth
1.1       anton    1464: ""The number of lines and columns in the terminal. These numbers may change
                   1465: with the window size.""
                   1466: /* we could block SIGWINCH here to get a consistent size, but I don't
                   1467:  think this is necessary or always beneficial */
                   1468: urows=rows;
                   1469: ucols=cols;
                   1470: 
1.47      anton    1471: flush-icache   ( c_addr u -- ) gforth  flush_icache
1.1       anton    1472: ""Make sure that the instruction cache of the processor (if there is
1.29      crook    1473: one) does not contain stale data at @i{c-addr} and @i{u} bytes
1.1       anton    1474: afterwards. @code{END-CODE} performs a @code{flush-icache}
                   1475: automatically. Caveat: @code{flush-icache} might not work on your
                   1476: installation; this is usually the case if direct threading is not
                   1477: supported on your machine (take a look at your @file{machine.h}) and
                   1478: your machine has a separate instruction cache. In such cases,
                   1479: @code{flush-icache} does nothing instead of flushing the instruction
                   1480: cache.""
                   1481: FLUSH_ICACHE(c_addr,u);
                   1482: 
1.47      anton    1483: (bye)  ( n -- )        gforth  paren_bye
1.1       anton    1484: return (Label *)n;
                   1485: 
1.47      anton    1486: (system)       ( c_addr u -- wretval wior )    gforth  peren_system
1.20      pazsan   1487: #ifndef MSDOS
1.1       anton    1488: int old_tp=terminal_prepped;
                   1489: deprep_terminal();
1.20      pazsan   1490: #endif
1.1       anton    1491: wretval=system(cstr(c_addr,u,1)); /* ~ expansion on first part of string? */
                   1492: wior = IOR(wretval==-1 || (wretval==127 && errno != 0));
1.20      pazsan   1493: #ifndef MSDOS
1.1       anton    1494: if (old_tp)
                   1495:   prep_terminal();
1.20      pazsan   1496: #endif
1.1       anton    1497: 
1.47      anton    1498: getenv ( c_addr1 u1 -- c_addr2 u2 )    gforth
1.29      crook    1499: ""The string @i{c-addr1 u1} specifies an environment variable. The string @i{c-addr2 u2}
1.24      crook    1500: is the host operating system's expansion of that environment variable. If the
1.29      crook    1501: environment variable does not exist, @i{c-addr2 u2} specifies a string 0 characters
1.24      crook    1502: in length.""
1.46      pazsan   1503: /* close ' to keep fontify happy */
1.1       anton    1504: c_addr2 = getenv(cstr(c_addr1,u1,1));
                   1505: u2 = (c_addr2 == NULL ? 0 : strlen(c_addr2));
                   1506: 
1.56      anton    1507: open-pipe      ( c_addr u wfam -- wfileid wior )       gforth  open_pipe
                   1508: wfileid=(Cell)popen(cstr(c_addr,u,1),fileattr[wfam]); /* ~ expansion of 1st arg? */
1.1       anton    1509: wior = IOR(wfileid==0); /* !! the man page says that errno is not set reliably */
                   1510: 
1.47      anton    1511: close-pipe     ( wfileid -- wretval wior )             gforth  close_pipe
1.1       anton    1512: wretval = pclose((FILE *)wfileid);
                   1513: wior = IOR(wretval==-1);
                   1514: 
1.47      anton    1515: time&date      ( -- nsec nmin nhour nday nmonth nyear )        facility-ext    time_and_date
1.44      crook    1516: ""Report the current time of day. Seconds, minutes and hours are numbered from 0.
                   1517: Months are numbered from 1.""
1.1       anton    1518: struct timeval time1;
                   1519: struct timezone zone1;
                   1520: struct tm *ltime;
                   1521: gettimeofday(&time1,&zone1);
1.51      anton    1522: /* !! Single Unix specification: 
                   1523:    If tzp is not a null pointer, the behaviour is unspecified. */
1.1       anton    1524: ltime=localtime((time_t *)&time1.tv_sec);
                   1525: nyear =ltime->tm_year+1900;
                   1526: nmonth=ltime->tm_mon+1;
                   1527: nday  =ltime->tm_mday;
                   1528: nhour =ltime->tm_hour;
                   1529: nmin  =ltime->tm_min;
                   1530: nsec  =ltime->tm_sec;
                   1531: 
1.47      anton    1532: ms     ( n -- )        facility-ext
1.44      crook    1533: ""Wait at least @i{n} milli-second.""
1.1       anton    1534: struct timeval timeout;
                   1535: timeout.tv_sec=n/1000;
                   1536: timeout.tv_usec=1000*(n%1000);
                   1537: (void)select(0,0,0,0,&timeout);
                   1538: 
1.47      anton    1539: allocate       ( u -- a_addr wior )    memory
1.29      crook    1540: ""Allocate @i{u} address units of contiguous data space. The initial
1.27      crook    1541: contents of the data space is undefined. If the allocation is successful,
1.29      crook    1542: @i{a-addr} is the start address of the allocated region and @i{wior}
                   1543: is 0. If the allocation fails, @i{a-addr} is undefined and @i{wior}
1.52      anton    1544: is a non-zero I/O result code.""
1.1       anton    1545: a_addr = (Cell *)malloc(u?u:1);
                   1546: wior = IOR(a_addr==NULL);
                   1547: 
1.47      anton    1548: free   ( a_addr -- wior )              memory
1.29      crook    1549: ""Return the region of data space starting at @i{a-addr} to the system.
1.52      anton    1550: The region must originally have been obtained using @code{allocate} or
1.29      crook    1551: @code{resize}. If the operational is successful, @i{wior} is 0.
1.52      anton    1552: If the operation fails, @i{wior} is a non-zero I/O result code.""
1.1       anton    1553: free(a_addr);
                   1554: wior = 0;
                   1555: 
1.47      anton    1556: resize ( a_addr1 u -- a_addr2 wior )   memory
1.26      crook    1557: ""Change the size of the allocated area at @i{a-addr1} to @i{u}
1.1       anton    1558: address units, possibly moving the contents to a different
1.27      crook    1559: area. @i{a-addr2} is the address of the resulting area.
1.52      anton    1560: If the operation is successful, @i{wior} is 0.
                   1561: If the operation fails, @i{wior} is a non-zero
1.29      crook    1562: I/O result code. If @i{a-addr1} is 0, Gforth's (but not the Standard)
1.27      crook    1563: @code{resize} @code{allocate}s @i{u} address units.""
1.1       anton    1564: /* the following check is not necessary on most OSs, but it is needed
                   1565:    on SunOS 4.1.2. */
1.46      pazsan   1566: /* close ' to keep fontify happy */
1.1       anton    1567: if (a_addr1==NULL)
                   1568:   a_addr2 = (Cell *)malloc(u);
                   1569: else
                   1570:   a_addr2 = (Cell *)realloc(a_addr1, u);
                   1571: wior = IOR(a_addr2==NULL);     /* !! Define a return code */
                   1572: 
1.47      anton    1573: strerror       ( n -- c_addr u )       gforth
1.1       anton    1574: c_addr = strerror(n);
                   1575: u = strlen(c_addr);
                   1576: 
1.47      anton    1577: strsignal      ( n -- c_addr u )       gforth
1.1       anton    1578: c_addr = strsignal(n);
                   1579: u = strlen(c_addr);
                   1580: 
1.47      anton    1581: call-c ( w -- )        gforth  call_c
1.1       anton    1582: ""Call the C function pointed to by @i{w}. The C function has to
                   1583: access the stack itself. The stack pointers are exported in the global
                   1584: variables @code{SP} and @code{FP}.""
                   1585: /* This is a first attempt at support for calls to C. This may change in
                   1586:    the future */
1.64    ! anton    1587: IF_fpTOS(fp[0]=fpTOS);
1.1       anton    1588: FP=fp;
                   1589: SP=sp;
                   1590: ((void (*)())w)();
                   1591: sp=SP;
                   1592: fp=FP;
1.64    ! anton    1593: IF_spTOS(spTOS=sp[0]);
        !          1594: IF_fpTOS(fpTOS=fp[0]);
1.1       anton    1595: 
1.15      pazsan   1596: \+
                   1597: \+file
1.1       anton    1598: 
1.47      anton    1599: close-file     ( wfileid -- wior )             file    close_file
1.1       anton    1600: wior = IOR(fclose((FILE *)wfileid)==EOF);
                   1601: 
1.56      anton    1602: open-file      ( c_addr u wfam -- wfileid wior )       file    open_file
                   1603: wfileid = (Cell)fopen(tilde_cstr(c_addr, u, 1), fileattr[wfam]);
1.22      crook    1604: wior =  IOR(wfileid == 0);
1.1       anton    1605: 
1.56      anton    1606: create-file    ( c_addr u wfam -- wfileid wior )       file    create_file
1.1       anton    1607: Cell   fd;
1.56      anton    1608: fd = open(tilde_cstr(c_addr, u, 1), O_CREAT|O_TRUNC|ufileattr[wfam], 0666);
1.1       anton    1609: if (fd != -1) {
1.56      anton    1610:   wfileid = (Cell)fdopen(fd, fileattr[wfam]);
1.22      crook    1611:   wior = IOR(wfileid == 0);
1.1       anton    1612: } else {
1.22      crook    1613:   wfileid = 0;
1.1       anton    1614:   wior = IOR(1);
                   1615: }
                   1616: 
1.47      anton    1617: delete-file    ( c_addr u -- wior )            file    delete_file
1.1       anton    1618: wior = IOR(unlink(tilde_cstr(c_addr, u, 1))==-1);
                   1619: 
1.47      anton    1620: rename-file    ( c_addr1 u1 c_addr2 u2 -- wior )       file-ext        rename_file
1.29      crook    1621: ""Rename file @i{c_addr1 u1} to new name @i{c_addr2 u2}""
1.1       anton    1622: char *s1=tilde_cstr(c_addr2, u2, 1);
                   1623: wior = IOR(rename(tilde_cstr(c_addr1, u1, 0), s1)==-1);
                   1624: 
1.47      anton    1625: file-position  ( wfileid -- ud wior )  file    file_position
1.1       anton    1626: /* !! use tell and lseek? */
                   1627: ud = LONG2UD(ftell((FILE *)wfileid));
                   1628: wior = IOR(UD2LONG(ud)==-1);
                   1629: 
1.47      anton    1630: reposition-file        ( ud wfileid -- wior )  file    reposition_file
1.1       anton    1631: wior = IOR(fseek((FILE *)wfileid, UD2LONG(ud), SEEK_SET)==-1);
                   1632: 
1.47      anton    1633: file-size      ( wfileid -- ud wior )  file    file_size
1.1       anton    1634: struct stat buf;
                   1635: wior = IOR(fstat(fileno((FILE *)wfileid), &buf)==-1);
                   1636: ud = LONG2UD(buf.st_size);
                   1637: 
1.47      anton    1638: resize-file    ( ud wfileid -- wior )  file    resize_file
1.1       anton    1639: wior = IOR(ftruncate(fileno((FILE *)wfileid), UD2LONG(ud))==-1);
                   1640: 
1.47      anton    1641: read-file      ( c_addr u1 wfileid -- u2 wior )        file    read_file
1.1       anton    1642: /* !! fread does not guarantee enough */
                   1643: u2 = fread(c_addr, sizeof(Char), u1, (FILE *)wfileid);
                   1644: wior = FILEIO(u2<u1 && ferror((FILE *)wfileid));
                   1645: /* !! is the value of ferror errno-compatible? */
                   1646: if (wior)
                   1647:   clearerr((FILE *)wfileid);
                   1648: 
1.60      pazsan   1649: read-line      ( c_addr u1 wfileid -- u2 flag wior )   file    read_line
                   1650: ""this is only for backward compatibility""
1.1       anton    1651: Cell c;
                   1652: flag=-1;
                   1653: for(u2=0; u2<u1; u2++)
                   1654: {
1.45      anton    1655:    c = getc((FILE *)wfileid);
                   1656:    if (c=='\n') break;
                   1657:    if (c=='\r') {
                   1658:      if ((c = getc((FILE *)wfileid))!='\n')
                   1659:        ungetc(c,(FILE *)wfileid);
                   1660:      break;
                   1661:    }
                   1662:    if (c==EOF) {
1.1       anton    1663:        flag=FLAG(u2!=0);
                   1664:        break;
                   1665:      }
1.45      anton    1666:    c_addr[u2] = (Char)c;
1.1       anton    1667: }
                   1668: wior=FILEIO(ferror((FILE *)wfileid));
                   1669: 
1.15      pazsan   1670: \+
1.1       anton    1671: 
1.47      anton    1672: write-file     ( c_addr u1 wfileid -- wior )   file    write_file
1.1       anton    1673: /* !! fwrite does not guarantee enough */
1.39      pazsan   1674: #ifdef HAS_FILE
1.1       anton    1675: {
                   1676:   UCell u2 = fwrite(c_addr, sizeof(Char), u1, (FILE *)wfileid);
                   1677:   wior = FILEIO(u2<u1 && ferror((FILE *)wfileid));
                   1678:   if (wior)
                   1679:     clearerr((FILE *)wfileid);
                   1680: }
1.39      pazsan   1681: #else
                   1682: TYPE(c_addr, u1);
                   1683: #endif
1.17      pazsan   1684: 
1.47      anton    1685: emit-file      ( c wfileid -- wior )   gforth  emit_file
1.17      pazsan   1686: #ifdef HAS_FILE
1.1       anton    1687: wior = FILEIO(putc(c, (FILE *)wfileid)==EOF);
                   1688: if (wior)
                   1689:   clearerr((FILE *)wfileid);
1.17      pazsan   1690: #else
1.36      pazsan   1691: PUTC(c);
1.17      pazsan   1692: #endif
1.1       anton    1693: 
1.15      pazsan   1694: \+file
1.1       anton    1695: 
1.47      anton    1696: flush-file     ( wfileid -- wior )             file-ext        flush_file
1.1       anton    1697: wior = IOR(fflush((FILE *) wfileid)==EOF);
                   1698: 
1.56      anton    1699: file-status    ( c_addr u -- wfam wior )       file-ext        file_status
1.1       anton    1700: char *filename=tilde_cstr(c_addr, u, 1);
                   1701: if (access (filename, F_OK) != 0) {
1.56      anton    1702:   wfam=0;
1.1       anton    1703:   wior=IOR(1);
                   1704: }
                   1705: else if (access (filename, R_OK | W_OK) == 0) {
1.56      anton    1706:   wfam=2; /* r/w */
1.1       anton    1707:   wior=0;
                   1708: }
                   1709: else if (access (filename, R_OK) == 0) {
1.56      anton    1710:   wfam=0; /* r/o */
1.1       anton    1711:   wior=0;
                   1712: }
                   1713: else if (access (filename, W_OK) == 0) {
1.56      anton    1714:   wfam=4; /* w/o */
1.1       anton    1715:   wior=0;
                   1716: }
                   1717: else {
1.56      anton    1718:   wfam=1; /* well, we cannot access the file, but better deliver a legal
1.1       anton    1719:            access mode (r/o bin), so we get a decent error later upon open. */
                   1720:   wior=0;
                   1721: }
                   1722: 
1.15      pazsan   1723: \+
                   1724: \+floating
1.1       anton    1725: 
                   1726: comparisons(f, r1 r2, f_, r1, r2, gforth, gforth, float, gforth)
                   1727: comparisons(f0, r, f_zero_, r, 0., float, gforth, float, gforth)
                   1728: 
1.47      anton    1729: d>f    ( d -- r )              float   d_to_f
1.1       anton    1730: #ifdef BUGGY_LONG_LONG
                   1731: extern double ldexp(double x, int exp);
                   1732: r = ldexp((Float)d.hi,CELL_BITS) + (Float)d.lo;
                   1733: #else
                   1734: r = d;
                   1735: #endif
                   1736: 
1.47      anton    1737: f>d    ( r -- d )              float   f_to_d
1.1       anton    1738: #ifdef BUGGY_LONG_LONG
1.21      anton    1739: d.hi = ldexp(r,-(int)(CELL_BITS)) - (r<0);
1.1       anton    1740: d.lo = r-ldexp((Float)d.hi,CELL_BITS);
                   1741: #else
                   1742: d = r;
                   1743: #endif
                   1744: 
1.47      anton    1745: f!     ( r f_addr -- ) float   f_store
1.52      anton    1746: ""Store @i{r} into the float at address @i{f-addr}.""
1.1       anton    1747: *f_addr = r;
                   1748: 
1.47      anton    1749: f@     ( f_addr -- r ) float   f_fetch
1.52      anton    1750: ""@i{r} is the float at address @i{f-addr}.""
1.1       anton    1751: r = *f_addr;
                   1752: 
1.47      anton    1753: df@    ( df_addr -- r )        float-ext       d_f_fetch
1.52      anton    1754: ""Fetch the double-precision IEEE floating-point value @i{r} from the address @i{df-addr}.""
1.1       anton    1755: #ifdef IEEE_FP
                   1756: r = *df_addr;
                   1757: #else
                   1758: !! df@
                   1759: #endif
                   1760: 
1.47      anton    1761: df!    ( r df_addr -- )        float-ext       d_f_store
1.52      anton    1762: ""Store @i{r} as double-precision IEEE floating-point value to the
                   1763: address @i{df-addr}.""
1.1       anton    1764: #ifdef IEEE_FP
                   1765: *df_addr = r;
                   1766: #else
                   1767: !! df!
                   1768: #endif
                   1769: 
1.47      anton    1770: sf@    ( sf_addr -- r )        float-ext       s_f_fetch
1.52      anton    1771: ""Fetch the single-precision IEEE floating-point value @i{r} from the address @i{sf-addr}.""
1.1       anton    1772: #ifdef IEEE_FP
                   1773: r = *sf_addr;
                   1774: #else
                   1775: !! sf@
                   1776: #endif
                   1777: 
1.47      anton    1778: sf!    ( r sf_addr -- )        float-ext       s_f_store
1.52      anton    1779: ""Store @i{r} as single-precision IEEE floating-point value to the
                   1780: address @i{sf-addr}.""
1.1       anton    1781: #ifdef IEEE_FP
                   1782: *sf_addr = r;
                   1783: #else
                   1784: !! sf!
                   1785: #endif
                   1786: 
1.47      anton    1787: f+     ( r1 r2 -- r3 ) float   f_plus
1.1       anton    1788: r3 = r1+r2;
                   1789: 
1.47      anton    1790: f-     ( r1 r2 -- r3 ) float   f_minus
1.1       anton    1791: r3 = r1-r2;
                   1792: 
1.47      anton    1793: f*     ( r1 r2 -- r3 ) float   f_star
1.1       anton    1794: r3 = r1*r2;
                   1795: 
1.47      anton    1796: f/     ( r1 r2 -- r3 ) float   f_slash
1.1       anton    1797: r3 = r1/r2;
                   1798: 
1.47      anton    1799: f**    ( r1 r2 -- r3 ) float-ext       f_star_star
1.26      crook    1800: ""@i{r3} is @i{r1} raised to the @i{r2}th power.""
1.1       anton    1801: r3 = pow(r1,r2);
                   1802: 
1.47      anton    1803: fnegate        ( r1 -- r2 )    float   f_negate
1.1       anton    1804: r2 = - r1;
                   1805: 
1.47      anton    1806: fdrop  ( r -- )                float   f_drop
1.1       anton    1807: 
1.47      anton    1808: fdup   ( r -- r r )    float   f_dupe
1.1       anton    1809: 
1.47      anton    1810: fswap  ( r1 r2 -- r2 r1 )      float   f_swap
1.1       anton    1811: 
1.47      anton    1812: fover  ( r1 r2 -- r1 r2 r1 )   float   f_over
1.1       anton    1813: 
1.47      anton    1814: frot   ( r1 r2 r3 -- r2 r3 r1 )        float   f_rote
1.1       anton    1815: 
1.47      anton    1816: fnip   ( r1 r2 -- r2 ) gforth  f_nip
1.1       anton    1817: 
1.47      anton    1818: ftuck  ( r1 r2 -- r2 r1 r2 )   gforth  f_tuck
1.1       anton    1819: 
1.47      anton    1820: float+ ( f_addr1 -- f_addr2 )  float   float_plus
1.52      anton    1821: ""@code{1 floats +}.""
1.1       anton    1822: f_addr2 = f_addr1+1;
                   1823: 
1.47      anton    1824: floats ( n1 -- n2 )    float
1.52      anton    1825: ""@i{n2} is the number of address units of @i{n1} floats.""
1.1       anton    1826: n2 = n1*sizeof(Float);
                   1827: 
1.47      anton    1828: floor  ( r1 -- r2 )    float
1.26      crook    1829: ""Round towards the next smaller integral value, i.e., round toward negative infinity.""
1.1       anton    1830: /* !! unclear wording */
                   1831: r2 = floor(r1);
                   1832: 
1.47      anton    1833: fround ( r1 -- r2 )    float   f_round
1.26      crook    1834: ""Round to the nearest integral value.""
1.1       anton    1835: /* !! unclear wording */
                   1836: #ifdef HAVE_RINT
                   1837: r2 = rint(r1);
                   1838: #else
                   1839: r2 = floor(r1+0.5);
                   1840: /* !! This is not quite true to the rounding rules given in the standard */
                   1841: #endif
                   1842: 
1.47      anton    1843: fmax   ( r1 r2 -- r3 ) float   f_max
1.1       anton    1844: if (r1<r2)
                   1845:   r3 = r2;
                   1846: else
                   1847:   r3 = r1;
                   1848: 
1.47      anton    1849: fmin   ( r1 r2 -- r3 ) float   f_min
1.1       anton    1850: if (r1<r2)
                   1851:   r3 = r1;
                   1852: else
                   1853:   r3 = r2;
                   1854: 
1.47      anton    1855: represent      ( r c_addr u -- n f1 f2 )       float
1.1       anton    1856: char *sig;
                   1857: int flag;
                   1858: int decpt;
                   1859: sig=ecvt(r, u, &decpt, &flag);
                   1860: n=(r==0 ? 1 : decpt);
                   1861: f1=FLAG(flag!=0);
1.21      anton    1862: f2=FLAG(isdigit((unsigned)(sig[0]))!=0);
1.1       anton    1863: memmove(c_addr,sig,u);
                   1864: 
1.47      anton    1865: >float ( c_addr u -- flag )    float   to_float
1.56      anton    1866: ""Actual stack effect: ( c_addr u -- r t | f ).  Attempt to convert the
                   1867: character string @i{c-addr u} to internal floating-point
                   1868: representation. If the string represents a valid floating-point number
                   1869: @i{r} is placed on the floating-point stack and @i{flag} is
                   1870: true. Otherwise, @i{flag} is false. A string of blanks is a special
                   1871: case and represents the floating-point number 0.""
1.1       anton    1872: /* real signature: c_addr u -- r t / f */
                   1873: Float r;
                   1874: char *number=cstr(c_addr, u, 1);
                   1875: char *endconv;
1.42      pazsan   1876: int sign = 0;
                   1877: if(number[0]=='-') {
                   1878:    sign = 1;
                   1879:    number++;
                   1880:    u--;
                   1881: }
1.21      anton    1882: while(isspace((unsigned)(number[--u])) && u>0);
1.1       anton    1883: switch(number[u])
                   1884: {
                   1885:    case 'd':
                   1886:    case 'D':
                   1887:    case 'e':
                   1888:    case 'E':  break;
                   1889:    default :  u++; break;
                   1890: }
                   1891: number[u]='\0';
                   1892: r=strtod(number,&endconv);
                   1893: if((flag=FLAG(!(Cell)*endconv)))
                   1894: {
1.64    ! anton    1895:    IF_fpTOS(fp[0] = fpTOS);
1.1       anton    1896:    fp += -1;
1.64    ! anton    1897:    fpTOS = sign ? -r : r;
1.1       anton    1898: }
                   1899: else if(*endconv=='d' || *endconv=='D')
                   1900: {
                   1901:    *endconv='E';
                   1902:    r=strtod(number,&endconv);
                   1903:    if((flag=FLAG(!(Cell)*endconv)))
                   1904:      {
1.64    ! anton    1905:        IF_fpTOS(fp[0] = fpTOS);
1.1       anton    1906:        fp += -1;
1.64    ! anton    1907:        fpTOS = sign ? -r : r;
1.1       anton    1908:      }
                   1909: }
                   1910: 
1.47      anton    1911: fabs   ( r1 -- r2 )    float-ext       f_abs
1.1       anton    1912: r2 = fabs(r1);
                   1913: 
1.47      anton    1914: facos  ( r1 -- r2 )    float-ext       f_a_cos
1.1       anton    1915: r2 = acos(r1);
                   1916: 
1.47      anton    1917: fasin  ( r1 -- r2 )    float-ext       f_a_sine
1.1       anton    1918: r2 = asin(r1);
                   1919: 
1.47      anton    1920: fatan  ( r1 -- r2 )    float-ext       f_a_tan
1.1       anton    1921: r2 = atan(r1);
                   1922: 
1.47      anton    1923: fatan2 ( r1 r2 -- r3 ) float-ext       f_a_tan_two
1.26      crook    1924: ""@i{r1/r2}=tan(@i{r3}). ANS Forth does not require, but probably
1.1       anton    1925: intends this to be the inverse of @code{fsincos}. In gforth it is.""
                   1926: r3 = atan2(r1,r2);
                   1927: 
1.47      anton    1928: fcos   ( r1 -- r2 )    float-ext       f_cos
1.1       anton    1929: r2 = cos(r1);
                   1930: 
1.47      anton    1931: fexp   ( r1 -- r2 )    float-ext       f_e_x_p
1.1       anton    1932: r2 = exp(r1);
                   1933: 
1.47      anton    1934: fexpm1 ( r1 -- r2 )    float-ext       f_e_x_p_m_one
1.1       anton    1935: ""@i{r2}=@i{e}**@i{r1}@minus{}1""
                   1936: #ifdef HAVE_EXPM1
1.3       pazsan   1937: extern double
                   1938: #ifdef NeXT
                   1939:               const
                   1940: #endif
                   1941:                     expm1(double);
1.1       anton    1942: r2 = expm1(r1);
                   1943: #else
                   1944: r2 = exp(r1)-1.;
                   1945: #endif
                   1946: 
1.47      anton    1947: fln    ( r1 -- r2 )    float-ext       f_l_n
1.1       anton    1948: r2 = log(r1);
                   1949: 
1.47      anton    1950: flnp1  ( r1 -- r2 )    float-ext       f_l_n_p_one
1.1       anton    1951: ""@i{r2}=ln(@i{r1}+1)""
                   1952: #ifdef HAVE_LOG1P
1.3       pazsan   1953: extern double
                   1954: #ifdef NeXT
                   1955:               const
                   1956: #endif
                   1957:                     log1p(double);
1.1       anton    1958: r2 = log1p(r1);
                   1959: #else
                   1960: r2 = log(r1+1.);
                   1961: #endif
                   1962: 
1.47      anton    1963: flog   ( r1 -- r2 )    float-ext       f_log
1.26      crook    1964: ""The decimal logarithm.""
1.1       anton    1965: r2 = log10(r1);
                   1966: 
1.47      anton    1967: falog  ( r1 -- r2 )    float-ext       f_a_log
1.1       anton    1968: ""@i{r2}=10**@i{r1}""
                   1969: extern double pow10(double);
                   1970: r2 = pow10(r1);
                   1971: 
1.47      anton    1972: fsin   ( r1 -- r2 )    float-ext       f_sine
1.1       anton    1973: r2 = sin(r1);
                   1974: 
1.47      anton    1975: fsincos        ( r1 -- r2 r3 ) float-ext       f_sine_cos
1.1       anton    1976: ""@i{r2}=sin(@i{r1}), @i{r3}=cos(@i{r1})""
                   1977: r2 = sin(r1);
                   1978: r3 = cos(r1);
                   1979: 
1.47      anton    1980: fsqrt  ( r1 -- r2 )    float-ext       f_square_root
1.1       anton    1981: r2 = sqrt(r1);
                   1982: 
1.47      anton    1983: ftan   ( r1 -- r2 )    float-ext       f_tan
1.1       anton    1984: r2 = tan(r1);
                   1985: :
                   1986:  fsincos f/ ;
                   1987: 
1.47      anton    1988: fsinh  ( r1 -- r2 )    float-ext       f_cinch
1.1       anton    1989: r2 = sinh(r1);
                   1990: :
                   1991:  fexpm1 fdup fdup 1. d>f f+ f/ f+ f2/ ;
                   1992: 
1.47      anton    1993: fcosh  ( r1 -- r2 )    float-ext       f_cosh
1.1       anton    1994: r2 = cosh(r1);
                   1995: :
                   1996:  fexp fdup 1/f f+ f2/ ;
                   1997: 
1.47      anton    1998: ftanh  ( r1 -- r2 )    float-ext       f_tan_h
1.1       anton    1999: r2 = tanh(r1);
                   2000: :
                   2001:  f2* fexpm1 fdup 2. d>f f+ f/ ;
                   2002: 
1.47      anton    2003: fasinh ( r1 -- r2 )    float-ext       f_a_cinch
1.1       anton    2004: r2 = asinh(r1);
                   2005: :
                   2006:  fdup fdup f* 1. d>f f+ fsqrt f/ fatanh ;
                   2007: 
1.47      anton    2008: facosh ( r1 -- r2 )    float-ext       f_a_cosh
1.1       anton    2009: r2 = acosh(r1);
                   2010: :
                   2011:  fdup fdup f* 1. d>f f- fsqrt f+ fln ;
                   2012: 
1.47      anton    2013: fatanh ( r1 -- r2 )    float-ext       f_a_tan_h
1.1       anton    2014: r2 = atanh(r1);
                   2015: :
                   2016:  fdup f0< >r fabs 1. d>f fover f- f/  f2* flnp1 f2/
                   2017:  r> IF  fnegate  THEN ;
                   2018: 
1.47      anton    2019: sfloats        ( n1 -- n2 )    float-ext       s_floats
1.52      anton    2020: ""@i{n2} is the number of address units of @i{n1}
1.29      crook    2021: single-precision IEEE floating-point numbers.""
1.1       anton    2022: n2 = n1*sizeof(SFloat);
                   2023: 
1.47      anton    2024: dfloats        ( n1 -- n2 )    float-ext       d_floats
1.52      anton    2025: ""@i{n2} is the number of address units of @i{n1}
1.29      crook    2026: double-precision IEEE floating-point numbers.""
1.1       anton    2027: n2 = n1*sizeof(DFloat);
                   2028: 
1.47      anton    2029: sfaligned      ( c_addr -- sf_addr )   float-ext       s_f_aligned
1.52      anton    2030: ""@i{sf-addr} is the first single-float-aligned address greater
1.29      crook    2031: than or equal to @i{c-addr}.""
1.1       anton    2032: sf_addr = (SFloat *)((((Cell)c_addr)+(sizeof(SFloat)-1))&(-sizeof(SFloat)));
                   2033: :
                   2034:  [ 1 sfloats 1- ] Literal + [ -1 sfloats ] Literal and ;
                   2035: 
1.47      anton    2036: dfaligned      ( c_addr -- df_addr )   float-ext       d_f_aligned
1.52      anton    2037: ""@i{df-addr} is the first double-float-aligned address greater
1.29      crook    2038: than or equal to @i{c-addr}.""
1.1       anton    2039: df_addr = (DFloat *)((((Cell)c_addr)+(sizeof(DFloat)-1))&(-sizeof(DFloat)));
                   2040: :
                   2041:  [ 1 dfloats 1- ] Literal + [ -1 dfloats ] Literal and ;
                   2042: 
                   2043: \ The following words access machine/OS/installation-dependent
                   2044: \   Gforth internals
                   2045: \ !! how about environmental queries DIRECT-THREADED,
                   2046: \   INDIRECT-THREADED, TOS-CACHED, FTOS-CACHED, CODEFIELD-DOES */
                   2047: 
                   2048: \ local variable implementation primitives
1.15      pazsan   2049: \+
                   2050: \+glocals
1.1       anton    2051: 
1.47      anton    2052: @local#        ( -- w )        gforth  fetch_local_number
1.1       anton    2053: w = *(Cell *)(lp+(Cell)NEXT_INST);
                   2054: INC_IP(1);
                   2055: 
1.47      anton    2056: @local0        ( -- w )        new     fetch_local_zero
1.1       anton    2057: w = *(Cell *)(lp+0*sizeof(Cell));
                   2058: 
1.47      anton    2059: @local1        ( -- w )        new     fetch_local_four
1.1       anton    2060: w = *(Cell *)(lp+1*sizeof(Cell));
                   2061: 
1.47      anton    2062: @local2        ( -- w )        new     fetch_local_eight
1.1       anton    2063: w = *(Cell *)(lp+2*sizeof(Cell));
                   2064: 
1.47      anton    2065: @local3        ( -- w )        new     fetch_local_twelve
1.1       anton    2066: w = *(Cell *)(lp+3*sizeof(Cell));
                   2067: 
1.15      pazsan   2068: \+floating
1.1       anton    2069: 
1.47      anton    2070: f@local#       ( -- r )        gforth  f_fetch_local_number
1.1       anton    2071: r = *(Float *)(lp+(Cell)NEXT_INST);
                   2072: INC_IP(1);
                   2073: 
1.47      anton    2074: f@local0       ( -- r )        new     f_fetch_local_zero
1.1       anton    2075: r = *(Float *)(lp+0*sizeof(Float));
                   2076: 
1.47      anton    2077: f@local1       ( -- r )        new     f_fetch_local_eight
1.1       anton    2078: r = *(Float *)(lp+1*sizeof(Float));
                   2079: 
1.15      pazsan   2080: \+
1.1       anton    2081: 
1.47      anton    2082: laddr# ( -- c_addr )   gforth  laddr_number
1.1       anton    2083: /* this can also be used to implement lp@ */
                   2084: c_addr = (Char *)(lp+(Cell)NEXT_INST);
                   2085: INC_IP(1);
                   2086: 
1.47      anton    2087: lp+!#  ( -- )  gforth  lp_plus_store_number
1.1       anton    2088: ""used with negative immediate values it allocates memory on the
                   2089: local stack, a positive immediate argument drops memory from the local
                   2090: stack""
                   2091: lp += (Cell)NEXT_INST;
                   2092: INC_IP(1);
                   2093: 
1.47      anton    2094: lp-    ( -- )  new     minus_four_lp_plus_store
1.1       anton    2095: lp += -sizeof(Cell);
                   2096: 
1.47      anton    2097: lp+    ( -- )  new     eight_lp_plus_store
1.1       anton    2098: lp += sizeof(Float);
                   2099: 
1.47      anton    2100: lp+2   ( -- )  new     sixteen_lp_plus_store
1.1       anton    2101: lp += 2*sizeof(Float);
                   2102: 
1.47      anton    2103: lp!    ( c_addr -- )   gforth  lp_store
1.1       anton    2104: lp = (Address)c_addr;
                   2105: 
1.47      anton    2106: >l     ( w -- )        gforth  to_l
1.1       anton    2107: lp -= sizeof(Cell);
                   2108: *(Cell *)lp = w;
                   2109: 
1.15      pazsan   2110: \+floating
1.1       anton    2111: 
1.47      anton    2112: f>l    ( r -- )        gforth  f_to_l
1.1       anton    2113: lp -= sizeof(Float);
                   2114: *(Float *)lp = r;
                   2115: 
1.47      anton    2116: fpick  ( u -- r )              gforth
1.52      anton    2117: ""Actually the stack effect is @code{ r0 ... ru u -- r0 ... ru r0 }.""
1.11      anton    2118: r = fp[u+1]; /* +1, because update of fp happens before this fragment */
                   2119: :
                   2120:  floats fp@ + f@ ;
                   2121: 
1.15      pazsan   2122: \+
                   2123: \+
1.1       anton    2124: 
1.15      pazsan   2125: \+OS
1.1       anton    2126: 
                   2127: define(`uploop',
                   2128:        `pushdef(`$1', `$2')_uploop(`$1', `$2', `$3', `$4', `$5')`'popdef(`$1')')
                   2129: define(`_uploop',
                   2130:        `ifelse($1, `$3', `$5',
                   2131:               `$4`'define(`$1', incr($1))_uploop(`$1', `$2', `$3', `$4', `$5')')')
                   2132: \ argflist(argnum): Forth argument list
                   2133: define(argflist,
                   2134:        `ifelse($1, 0, `',
                   2135:                `uploop(`_i', 1, $1, `format(`u%d ', _i)', `format(`u%d ', _i)')')')
                   2136: \ argdlist(argnum): declare C's arguments
                   2137: define(argdlist,
                   2138:        `ifelse($1, 0, `',
                   2139:                `uploop(`_i', 1, $1, `Cell, ', `Cell')')')
                   2140: \ argclist(argnum): pass C's arguments
                   2141: define(argclist,
                   2142:        `ifelse($1, 0, `',
                   2143:                `uploop(`_i', 1, $1, `format(`u%d, ', _i)', `format(`u%d', _i)')')')
                   2144: \ icall(argnum)
                   2145: define(icall,
1.47      anton    2146: `icall$1       ( argflist($1)u -- uret )       gforth
1.9       pazsan   2147: uret = (SYSCALL(Cell(*)(argdlist($1)))u)(argclist($1));
1.1       anton    2148: 
                   2149: ')
                   2150: define(fcall,
1.47      anton    2151: `fcall$1       ( argflist($1)u -- rret )       gforth
1.9       pazsan   2152: rret = (SYSCALL(Float(*)(argdlist($1)))u)(argclist($1));
1.1       anton    2153: 
                   2154: ')
                   2155: 
1.46      pazsan   2156: \ close ' to keep fontify happy
1.1       anton    2157: 
1.47      anton    2158: open-lib       ( c_addr1 u1 -- u2 )    gforth  open_lib
1.1       anton    2159: #if defined(HAVE_LIBDL) || defined(HAVE_DLOPEN)
1.8       anton    2160: #ifndef RTLD_GLOBAL
                   2161: #define RTLD_GLOBAL 0
                   2162: #endif
1.7       pazsan   2163: u2=(UCell) dlopen(cstr(c_addr1, u1, 1), RTLD_GLOBAL | RTLD_LAZY);
1.1       anton    2164: #else
1.18      pazsan   2165: #  ifdef _WIN32
1.1       anton    2166: u2 = (Cell) GetModuleHandle(cstr(c_addr1, u1, 1));
                   2167: #  else
                   2168: #warning Define open-lib!
                   2169: u2 = 0;
                   2170: #  endif
                   2171: #endif
                   2172: 
1.47      anton    2173: lib-sym        ( c_addr1 u1 u2 -- u3 ) gforth  lib_sym
1.1       anton    2174: #if defined(HAVE_LIBDL) || defined(HAVE_DLOPEN)
                   2175: u3 = (UCell) dlsym((void*)u2,cstr(c_addr1, u1, 1));
                   2176: #else
1.18      pazsan   2177: #  ifdef _WIN32
1.1       anton    2178: u3 = (Cell) GetProcAddress((HMODULE)u2, cstr(c_addr1, u1, 1));
                   2179: #  else
                   2180: #warning Define lib-sym!
                   2181: u3 = 0;
                   2182: #  endif
                   2183: #endif
                   2184: 
                   2185: uploop(i, 0, 7, `icall(i)')
                   2186: icall(20)
                   2187: uploop(i, 0, 7, `fcall(i)')
                   2188: fcall(20)
                   2189: 
1.15      pazsan   2190: \+
1.1       anton    2191: 
1.47      anton    2192: up!    ( a_addr -- )   gforth  up_store
1.1       anton    2193: UP=up=(char *)a_addr;
                   2194: :
                   2195:  up ! ;
                   2196: Variable UP
1.34      jwilke   2197: 
1.47      anton    2198: wcall  ( u -- )        gforth
1.64    ! anton    2199: IF_fpTOS(fp[0]=fpTOS);
1.34      jwilke   2200: FP=fp;
                   2201: sp=(SYSCALL(Cell(*)(Cell *, void *))u)(sp, &FP);
                   2202: fp=FP;
1.64    ! anton    2203: IF_spTOS(spTOS=sp[0];)
        !          2204: IF_fpTOS(fpTOS=fp[0]);
1.46      pazsan   2205: 
                   2206: \+file
                   2207: 
1.47      anton    2208: open-dir       ( c_addr u -- wdirid wior )     gforth  open_dir
1.46      pazsan   2209: wdirid = (Cell)opendir(tilde_cstr(c_addr, u, 1));
                   2210: wior =  IOR(wdirid == 0);
                   2211: 
1.47      anton    2212: read-dir       ( c_addr u1 wdirid -- u2 flag wior )    gforth  read_dir
1.46      pazsan   2213: struct dirent * dent;
                   2214: dent = readdir((DIR *)wdirid);
                   2215: wior = 0;
                   2216: flag = -1;
                   2217: if(dent == NULL) {
                   2218:   u2 = 0;
                   2219:   flag = 0;
                   2220: } else {
                   2221:   u2 = strlen(dent->d_name);
                   2222:   if(u2 > u1)
                   2223:     u2 = u1;
                   2224:   memmove(c_addr, dent->d_name, u2);
                   2225: }
                   2226: 
1.47      anton    2227: close-dir      ( wdirid -- wior )      gforth  close_dir
1.46      pazsan   2228: wior = IOR(closedir((DIR *)wdirid));
                   2229: 
1.47      anton    2230: filename-match ( c_addr1 u1 c_addr2 u2 -- flag )       gforth  match_file
1.46      pazsan   2231: char * string = cstr(c_addr1, u1, 1);
                   2232: char * pattern = cstr(c_addr2, u2, 0);
                   2233: flag = FLAG(!fnmatch(pattern, string, 0));
                   2234: 
                   2235: \+
1.34      jwilke   2236: 
1.47      anton    2237: newline        ( -- c_addr u ) gforth
1.45      anton    2238: ""String containing the newline sequence of the host OS""
                   2239: char newline[] = {
                   2240: #ifdef unix
                   2241: '\n'
                   2242: #else
                   2243: '\r','\n'
                   2244: #endif
                   2245: };
                   2246: c_addr=newline;
                   2247: u=sizeof(newline);
1.49      pazsan   2248: :
                   2249:  "newline count ;
1.54      pazsan   2250: Create "newline e? crlf [IF] 2 c, $0D c, [ELSE] 1 c, [THEN] $0A c,
                   2251: 
                   2252: \+os
1.51      anton    2253: 
                   2254: utime  ( -- dtime )    gforth
                   2255: ""Report the current time in microseconds since some epoch.""
                   2256: struct timeval time1;
                   2257: gettimeofday(&time1,NULL);
                   2258: dtime = timeval2us(&time1);
                   2259: 
                   2260: cputime ( -- duser dsystem ) gforth
                   2261: ""duser and dsystem are the respective user- and system-level CPU
                   2262: times used since the start of the Forth system (excluding child
                   2263: processes), in microseconds (the granularity may be much larger,
                   2264: however).  On platforms without the getrusage call, it reports elapsed
                   2265: time (since some epoch) for duser and 0 for dsystem.""
                   2266: #ifdef HAVE_GETRUSAGE
                   2267: struct rusage usage;
                   2268: getrusage(RUSAGE_SELF, &usage);
                   2269: duser = timeval2us(&usage.ru_utime);
                   2270: dsystem = timeval2us(&usage.ru_stime);
                   2271: #else
                   2272: struct timeval time1;
                   2273: gettimeofday(&time1,NULL);
                   2274: duser = timeval2us(&time1);
1.57      anton    2275: #ifndef BUGGY_LONG_LONG
1.51      anton    2276: dsystem = (DCell)0;
1.57      anton    2277: #else
                   2278: dsystem=(DCell){0,0};
                   2279: #endif
1.51      anton    2280: #endif
                   2281: 
1.54      pazsan   2282: \+
                   2283: 
                   2284: \+floating
                   2285: 
1.51      anton    2286: v*     ( f_addr1 nstride1 f_addr2 nstride2 ucount -- r ) gforth v_star
                   2287: ""dot-product: r=v1*v2.  The first element of v1 is at f_addr1, the
                   2288: next at f_addr1+nstride1 and so on (similar for v2). Both vectors have
                   2289: ucount elements.""
                   2290: for (r=0.; ucount>0; ucount--) {
                   2291:   r += *f_addr1 * *f_addr2;
                   2292:   f_addr1 = (Float *)(((Address)f_addr1)+nstride1);
                   2293:   f_addr2 = (Float *)(((Address)f_addr2)+nstride2);
                   2294: }
1.54      pazsan   2295: :
                   2296:  >r swap 2swap swap 0e r> 0 ?DO
                   2297:      dup f@ over + 2swap dup f@ f* f+ over + 2swap
                   2298:  LOOP 2drop 2drop ; 
1.51      anton    2299: 
                   2300: faxpy  ( ra f_x nstridex f_y nstridey ucount -- )      gforth
                   2301: ""vy=ra*vx+vy""
                   2302: for (; ucount>0; ucount--) {
                   2303:   *f_y += ra * *f_x;
                   2304:   f_x = (Float *)(((Address)f_x)+nstridex);
                   2305:   f_y = (Float *)(((Address)f_y)+nstridey);
                   2306: }
1.54      pazsan   2307: :
                   2308:  >r swap 2swap swap r> 0 ?DO
                   2309:      fdup dup f@ f* over + 2swap dup f@ f+ dup f! over + 2swap
                   2310:  LOOP 2drop 2drop fdrop ;
1.60      pazsan   2311: 
                   2312: \+
                   2313: 
                   2314: \+file
                   2315: 
                   2316: (read-line)    ( c_addr u1 wfileid -- u2 flag u3 wior )        file    paren_read_line
                   2317: Cell c;
                   2318: flag=-1;
                   2319: u3=0;
                   2320: for(u2=0; u2<u1; u2++)
                   2321: {
                   2322:    c = getc((FILE *)wfileid);
                   2323:    u3++;
                   2324:    if (c=='\n') break;
                   2325:    if (c=='\r') {
                   2326:      if ((c = getc((FILE *)wfileid))!='\n')
                   2327:        ungetc(c,(FILE *)wfileid);
                   2328:      else
                   2329:        u3++;
                   2330:      break;
                   2331:    }
                   2332:    if (c==EOF) {
                   2333:        flag=FLAG(u2!=0);
                   2334:        break;
                   2335:      }
                   2336:    c_addr[u2] = (Char)c;
                   2337: }
                   2338: wior=FILEIO(ferror((FILE *)wfileid));
1.54      pazsan   2339: 
                   2340: \+

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