better documentation
[rrq/rrqforth.git] / adoc / p_literal_string.adoc
1 //compile.asm:  WORD p_literal_string,'LIT-STRING',fasm
2
3 anchor:p_literal_string[]
4
5 === Word: LIT-STRING
6
7 ....
8 Data stack: ( -- chars* n )
9 ....
10
11 "LIT-STRING" is a function word that pushes the char* and length n of
12 a subsequent inline string, then advances execution to continue after
13 the string. This is similar to <<p_lit,LIT>> but for a block literal.
14
15 Note that the inlined byte count includes the terminating NUL byte.
16
17 ====
18 .Definition concept for LIT-STRING
19 ****
20 : LIT-STRING  R@ DUP @ 8 +  R@ @  2DUP + R> + >R  1 - ;
21 ****
22 ====