瀏覽代碼

Change all documentation HSF and HSH file to DOS CR/LF format

git-svn-id: file:///var/svn/tigccpp/trunk@1261 9552661e-59e3-4036-b4f2-dbe53926924f
godzil 16 年之前
父節點
當前提交
9f6cf34620
共有 100 個文件被更改,包括 1822 次插入2187 次删除
  1. 13 13
      tigcc/doc/System/Include/alloc.h/Bool.hsf
  2. 15 15
      tigcc/doc/System/Include/alloc.h/FreeHandles.hsf
  3. 19 19
      tigcc/doc/System/Include/alloc.h/HANDLE.hsf
  4. 0 22
      tigcc/doc/System/Include/alloc.h/HLock.hsf
  5. 11 11
      tigcc/doc/System/Include/alloc.h/H_NULL.hsf
  6. 0 25
      tigcc/doc/System/Include/alloc.h/HeapAlloc.hsf
  7. 25 25
      tigcc/doc/System/Include/alloc.h/HeapAllocESTACK.hsf
  8. 31 31
      tigcc/doc/System/Include/alloc.h/HeapAllocHigh.hsf
  9. 20 20
      tigcc/doc/System/Include/alloc.h/HeapAllocHighThrow.hsf
  10. 28 28
      tigcc/doc/System/Include/alloc.h/HeapAllocPtr.hsf
  11. 24 24
      tigcc/doc/System/Include/alloc.h/HeapAllocPtrThrow.hsf
  12. 0 19
      tigcc/doc/System/Include/alloc.h/HeapAllocThrow.hsf
  13. 16 16
      tigcc/doc/System/Include/alloc.h/HeapAvail.hsf
  14. 23 23
      tigcc/doc/System/Include/alloc.h/HeapCompress.hsf
  15. 0 28
      tigcc/doc/System/Include/alloc.h/HeapDeref.hsf
  16. 15 15
      tigcc/doc/System/Include/alloc.h/HeapEnd.hsf
  17. 0 17
      tigcc/doc/System/Include/alloc.h/HeapFree.hsf
  18. 0 31
      tigcc/doc/System/Include/alloc.h/HeapFreeIndir.hsf
  19. 34 34
      tigcc/doc/System/Include/alloc.h/HeapFreePtr.hsf
  20. 21 21
      tigcc/doc/System/Include/alloc.h/HeapGetHandle.hsf
  21. 19 19
      tigcc/doc/System/Include/alloc.h/HeapGetLock.hsf
  22. 0 22
      tigcc/doc/System/Include/alloc.h/HeapLock.hsf
  23. 23 23
      tigcc/doc/System/Include/alloc.h/HeapMax.hsf
  24. 23 23
      tigcc/doc/System/Include/alloc.h/HeapMoveHigh.hsf
  25. 21 21
      tigcc/doc/System/Include/alloc.h/HeapPtrToHandle.hsf
  26. 0 36
      tigcc/doc/System/Include/alloc.h/HeapRealloc.hsf
  27. 24 24
      tigcc/doc/System/Include/alloc.h/HeapReallocThrow.hsf
  28. 26 26
      tigcc/doc/System/Include/alloc.h/HeapShuffle.hsf
  29. 24 24
      tigcc/doc/System/Include/alloc.h/HeapSize.hsf
  30. 0 19
      tigcc/doc/System/Include/alloc.h/HeapUnlock.hsf
  31. 47 47
      tigcc/doc/System/Include/alloc.h/HeapWalk.hsf
  32. 15 15
      tigcc/doc/System/Include/alloc.h/HeapWalkCmds.hsf
  33. 11 11
      tigcc/doc/System/Include/alloc.h/NULL.hsf
  34. 5 5
      tigcc/doc/System/Include/alloc.h/alloc.hsh
  35. 39 39
      tigcc/doc/System/Include/alloc.h/alloca.hsf
  36. 32 32
      tigcc/doc/System/Include/alloc.h/calloc.hsf
  37. 24 24
      tigcc/doc/System/Include/alloc.h/calloc_throw.hsf
  38. 38 38
      tigcc/doc/System/Include/alloc.h/free.hsf
  39. 38 38
      tigcc/doc/System/Include/alloc.h/malloc.hsf
  40. 24 24
      tigcc/doc/System/Include/alloc.h/malloc_throw.hsf
  41. 45 45
      tigcc/doc/System/Include/alloc.h/realloc.hsf
  42. 24 24
      tigcc/doc/System/Include/alloc.h/realloc_throw.hsf
  43. 18 18
      tigcc/doc/System/Include/args.h/ArgCount.hsf
  44. 26 26
      tigcc/doc/System/Include/args.h/EX_getArg.hsf
  45. 22 22
      tigcc/doc/System/Include/args.h/EX_getBCD.hsf
  46. 26 26
      tigcc/doc/System/Include/args.h/GetArgType.hsf
  47. 23 23
      tigcc/doc/System/Include/args.h/GetFloatArg.hsf
  48. 44 44
      tigcc/doc/System/Include/args.h/GetIntArg.hsf
  49. 15 15
      tigcc/doc/System/Include/args.h/GetLongLongArg.hsf
  50. 20 20
      tigcc/doc/System/Include/args.h/GetStrnArg.hsf
  51. 19 19
      tigcc/doc/System/Include/args.h/GetSymstrArg.hsf
  52. 37 37
      tigcc/doc/System/Include/args.h/InitArgPtr.hsf
  53. 24 24
      tigcc/doc/System/Include/args.h/RemainingArgCnt.hsf
  54. 22 22
      tigcc/doc/System/Include/args.h/SkipArg.hsf
  55. 6 6
      tigcc/doc/System/Include/args.h/args.hsh
  56. 12 12
      tigcc/doc/System/Include/asmtypes.h/BOOL.hsf
  57. 9 9
      tigcc/doc/System/Include/asmtypes.h/BYTE.hsf
  58. 9 9
      tigcc/doc/System/Include/asmtypes.h/DWORD.hsf
  59. 9 9
      tigcc/doc/System/Include/asmtypes.h/SBYTE.hsf
  60. 9 9
      tigcc/doc/System/Include/asmtypes.h/SCHAR.hsf
  61. 9 9
      tigcc/doc/System/Include/asmtypes.h/SDWORD.hsf
  62. 9 9
      tigcc/doc/System/Include/asmtypes.h/SINT.hsf
  63. 9 9
      tigcc/doc/System/Include/asmtypes.h/SLONG.hsf
  64. 9 9
      tigcc/doc/System/Include/asmtypes.h/SSHORT.hsf
  65. 9 9
      tigcc/doc/System/Include/asmtypes.h/SWORD.hsf
  66. 9 9
      tigcc/doc/System/Include/asmtypes.h/UBYTE.hsf
  67. 9 9
      tigcc/doc/System/Include/asmtypes.h/UCHAR.hsf
  68. 9 9
      tigcc/doc/System/Include/asmtypes.h/UDWORD.hsf
  69. 9 9
      tigcc/doc/System/Include/asmtypes.h/UINT.hsf
  70. 9 9
      tigcc/doc/System/Include/asmtypes.h/ULONG.hsf
  71. 9 9
      tigcc/doc/System/Include/asmtypes.h/USHORT.hsf
  72. 9 9
      tigcc/doc/System/Include/asmtypes.h/UWORD.hsf
  73. 9 9
      tigcc/doc/System/Include/asmtypes.h/WORD.hsf
  74. 5 5
      tigcc/doc/System/Include/asmtypes.h/asmtypes.hsh
  75. 52 52
      tigcc/doc/System/Include/assert.h/assert.hsf
  76. 2 2
      tigcc/doc/System/Include/assert.h/assert.hsh
  77. 18 18
      tigcc/doc/System/Include/bascmd.h/bascmd.hsh
  78. 30 30
      tigcc/doc/System/Include/bascmd.h/cmd_andpic.hsf
  79. 24 24
      tigcc/doc/System/Include/bascmd.h/cmd_archive.hsf
  80. 0 33
      tigcc/doc/System/Include/bascmd.h/cmd_blddata.hsf
  81. 0 38
      tigcc/doc/System/Include/bascmd.h/cmd_circle.hsf
  82. 21 21
      tigcc/doc/System/Include/bascmd.h/cmd_clrdraw.hsf
  83. 28 28
      tigcc/doc/System/Include/bascmd.h/cmd_clrerr.hsf
  84. 27 27
      tigcc/doc/System/Include/bascmd.h/cmd_clrgraph.hsf
  85. 23 23
      tigcc/doc/System/Include/bascmd.h/cmd_clrhome.hsf
  86. 21 21
      tigcc/doc/System/Include/bascmd.h/cmd_clrio.hsf
  87. 22 22
      tigcc/doc/System/Include/bascmd.h/cmd_clrtable.hsf
  88. 25 25
      tigcc/doc/System/Include/bascmd.h/cmd_copyvar.hsf
  89. 0 22
      tigcc/doc/System/Include/bascmd.h/cmd_cubicreg.hsf
  90. 20 20
      tigcc/doc/System/Include/bascmd.h/cmd_custmoff.hsf
  91. 20 20
      tigcc/doc/System/Include/bascmd.h/cmd_custmon.hsf
  92. 29 29
      tigcc/doc/System/Include/bascmd.h/cmd_custom.hsf
  93. 29 29
      tigcc/doc/System/Include/bascmd.h/cmd_cycle.hsf
  94. 47 47
      tigcc/doc/System/Include/bascmd.h/cmd_cyclepic.hsf
  95. 33 33
      tigcc/doc/System/Include/bascmd.h/cmd_delfold.hsf
  96. 33 33
      tigcc/doc/System/Include/bascmd.h/cmd_delvar.hsf
  97. 0 27
      tigcc/doc/System/Include/bascmd.h/cmd_dialog.hsf
  98. 0 26
      tigcc/doc/System/Include/bascmd.h/cmd_disp.hsf
  99. 21 21
      tigcc/doc/System/Include/bascmd.h/cmd_dispg.hsf
  100. 28 28
      tigcc/doc/System/Include/bascmd.h/cmd_disphome.hsf

+ 13 - 13
tigcc/doc/System/Include/alloc.h/Bool.hsf

@@ -1,13 +1,13 @@
-[Main]
-Name=Bool
-Type=Type
-Subtype=Enumeration
-Header Files=alloc.h, args.h, cert.h, dialogs.h, error.h, estack.h, events.h, flash.h, graph.h, gray.h, intr.h, homescr.h, kbd.h, link.h, math.h, menus.h, statline.h, system.h, textedit.h, timath.h, vat.h, wingraph.h
-Definition=enum Bool {FALSE, TRUE};
-
-[Description]
-An enumeration to describe true or false values.
-
-[Explanation]
-The enum Bool represents a boolean value, that is, either 'true' or 'false'.
-The constant FALSE equals 0; TRUE equals 1.
+[Main]
+Name=Bool
+Type=Type
+Subtype=Enumeration
+Header Files=alloc.h, args.h, cert.h, dialogs.h, error.h, estack.h, events.h, flash.h, graph.h, gray.h, intr.h, homescr.h, kbd.h, link.h, math.h, menus.h, statline.h, system.h, textedit.h, timath.h, vat.h, wingraph.h
+Definition=enum Bool {FALSE, TRUE};
+
+[Description]
+An enumeration to describe true or false values.
+
+[Explanation]
+The enum Bool represents a boolean value, that is, either 'true' or 'false'.
+The constant FALSE equals 0; TRUE equals 1.

+ 15 - 15
tigcc/doc/System/Include/alloc.h/FreeHandles.hsf

@@ -1,15 +1,15 @@
-[Main]
-Name=FreeHandles
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h
-Definition=short FreeHandles (void);
-
-[ROM Call]
-Index=$23B
-
-[Description]
-Determines the number of free handles.
-
-[Explanation]
-FreeHandles returns the number of free handles.
+[Main]
+Name=FreeHandles
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h
+Definition=short FreeHandles (void);
+
+[ROM Call]
+Index=$23B
+
+[Description]
+Determines the number of free handles.
+
+[Explanation]
+FreeHandles returns the number of free handles.

+ 19 - 19
tigcc/doc/System/Include/alloc.h/HANDLE.hsf

@@ -1,19 +1,19 @@
-[Main]
-Name=HANDLE
-Type=Type
-Subtype=Scalar
-Header Files=alloc.h, cert.h, dialogs.h, estack.h, events.h, flash.h, menus.h, homescr.h, system.h, textedit.h, vat.h, wingraph.h, unknown.h
-Definition=typedef unsigned short HANDLE;
-Needed by=GR_WIN_VARS, DB3, FIFO_ELEMENT, FIFO_NODE, EVENT, EVENT_HANDLER, TEXT_EDIT
-See Also=HeapAlloc, HeapFree, HLock, HeapUnlock, HeapDeref
-
-[Description]
-Represents a handle associated with an allocated memory block.
-
-[Explanation]
-The HANDLE type is mainly used to manage dynamically allocated memory using
-functions from <A HREF="$$LINK(alloc.h/)">alloc.h</A>, but a lot of functions
-from other header files take instances of this type as parameters.
-<BR><BR>
-A handle points to a word-aligned block of memory, whose current address can
-be retrieved using <A HREF="$$LINK(HeapDeref)">HeapDeref</A>.
+[Main]
+Name=HANDLE
+Type=Type
+Subtype=Scalar
+Header Files=alloc.h, cert.h, dialogs.h, estack.h, events.h, flash.h, menus.h, homescr.h, system.h, textedit.h, vat.h, wingraph.h, unknown.h
+Definition=typedef unsigned short HANDLE;
+Needed by=GR_WIN_VARS, DB3, FIFO_ELEMENT, FIFO_NODE, EVENT, EVENT_HANDLER, TEXT_EDIT
+See Also=HeapAlloc, HeapFree, HLock, HeapUnlock, HeapDeref
+
+[Description]
+Represents a handle associated with an allocated memory block.
+
+[Explanation]
+The HANDLE type is mainly used to manage dynamically allocated memory using
+functions from <A HREF="$$LINK(alloc.h/)">alloc.h</A>, but a lot of functions
+from other header files take instances of this type as parameters.
+<BR><BR>
+A handle points to a word-aligned block of memory, whose current address can
+be retrieved using <A HREF="$$LINK(HeapDeref)">HeapDeref</A>.

文件差異過大導致無法顯示
+ 0 - 22
tigcc/doc/System/Include/alloc.h/HLock.hsf


+ 11 - 11
tigcc/doc/System/Include/alloc.h/H_NULL.hsf

@@ -1,11 +1,11 @@
-[Main]
-Name=H_NULL
-Type=Constant
-Header Files=alloc.h, cert.h, dialogs.h, estack.h, menus.h, homescr.h, vat.h
-Definition=#define H_NULL 0
-
-[Description]
-A null-handle value.
-
-[Explanation]
-H_NULL is a null-handle defined as a constant with value 0.
+[Main]
+Name=H_NULL
+Type=Constant
+Header Files=alloc.h, cert.h, dialogs.h, estack.h, menus.h, homescr.h, vat.h
+Definition=#define H_NULL 0
+
+[Description]
+A null-handle value.
+
+[Explanation]
+H_NULL is a null-handle defined as a constant with value 0.

文件差異過大導致無法顯示
+ 0 - 25
tigcc/doc/System/Include/alloc.h/HeapAlloc.hsf


+ 25 - 25
tigcc/doc/System/Include/alloc.h/HeapAllocESTACK.hsf

@@ -1,25 +1,25 @@
-[Main]
-Name=HeapAllocESTACK
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h
-Definition=HANDLE HeapAllocESTACK (unsigned long Size);
-
-[ROM Call]
-Index=$91
-
-[Description]
-Like <A HREF="$$LINK(HeapAlloc)">HeapAlloc</A>, but reduces the size of the expression stack if necessary.
-
-[Explanation]
-HeapAllocESTACK works like <A HREF="$$LINK(HeapAlloc)">HeapAlloc</A>, but 
-reduces the size of the expression stack if necessary (i.e. if there is not
-enough memory). Returns <A HREF="$$LINK(H_NULL)">H_NULL</A> if there is not enough
-memory even after reducing the size of the expression stack.
-<BR><BR>
-<B>Note:</B> The information about this routine in releases of TIGCCLIB prior to 2.0
-was wrong!
-
-[References]
-In=menus.h/MenuKey, unknown.h/_ROM_CALL_421
-Out=HeapAlloc, HeapCompress, HeapGetHandle, error.h/ER_catch, error.h/ER_success, estack.h/bottom_estack, estack.h/reset_estack_size, estack.h/top_estack, system.h/NeedStack, unknown.h/_ROM_CALL_5C6
+[Main]
+Name=HeapAllocESTACK
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h
+Definition=HANDLE HeapAllocESTACK (unsigned long Size);
+
+[ROM Call]
+Index=$91
+
+[Description]
+Like <A HREF="$$LINK(HeapAlloc)">HeapAlloc</A>, but reduces the size of the expression stack if necessary.
+
+[Explanation]
+HeapAllocESTACK works like <A HREF="$$LINK(HeapAlloc)">HeapAlloc</A>, but 
+reduces the size of the expression stack if necessary (i.e. if there is not
+enough memory). Returns <A HREF="$$LINK(H_NULL)">H_NULL</A> if there is not enough
+memory even after reducing the size of the expression stack.
+<BR><BR>
+<B>Note:</B> The information about this routine in releases of TIGCCLIB prior to 2.0
+was wrong!
+
+[References]
+In=menus.h/MenuKey, unknown.h/_ROM_CALL_421
+Out=HeapAlloc, HeapCompress, HeapGetHandle, error.h/ER_catch, error.h/ER_success, estack.h/bottom_estack, estack.h/reset_estack_size, estack.h/top_estack, system.h/NeedStack, unknown.h/_ROM_CALL_5C6

+ 31 - 31
tigcc/doc/System/Include/alloc.h/HeapAllocHigh.hsf

@@ -1,31 +1,31 @@
-[Main]
-Name=HeapAllocHigh
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h
-Definition=HANDLE HeapAllocHigh (unsigned long Size);
-See Also=HeapAlloc
-
-[ROM Call]
-Index=$92
-
-[Description]
-Allocates memory at the high end of the heap and returns the handle of the allocated block.
-
-[Explanation]
-HeapAllocHigh allocates a block of <I>Size</I> bytes of heap memory at the high end of the heap,
-locks it, and returns its handle. Returns <A HREF="$$LINK(H_NULL)">H_NULL</A> if there is not enough memory.
-The primary use of this routine is to allocate task
-local storage. It also compresses the heap first to (hopefully) move all used
-(unlocked) blocks of memory down. This routine will cause garbage collection.
-<BR><BR>
-<B>Note:</B> Blocks of memory that are locked for long periods of time should be moved high
-in memory so that they do not interfere as much with rest of the system. This routine
-ALWAYS compresses the heap before it tries to allocate the requested memory and so is
-much slower than the standard <A HREF="$$LINK(HeapAlloc)">HeapAlloc</A> routine. Locking
-memory may cause the system to run out of useable memory sooner than if memory is
-kept unlocked.
-
-[References]
-In=HeapAllocHighThrow, HeapAllocPtr, malloc, gray.h/GrayOn, homescr.h/HS_popEStack
-Out=HeapAlloc, HeapCompress, HeapGetHandle, HeapLock, system.h/NeedStack
+[Main]
+Name=HeapAllocHigh
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h
+Definition=HANDLE HeapAllocHigh (unsigned long Size);
+See Also=HeapAlloc
+
+[ROM Call]
+Index=$92
+
+[Description]
+Allocates memory at the high end of the heap and returns the handle of the allocated block.
+
+[Explanation]
+HeapAllocHigh allocates a block of <I>Size</I> bytes of heap memory at the high end of the heap,
+locks it, and returns its handle. Returns <A HREF="$$LINK(H_NULL)">H_NULL</A> if there is not enough memory.
+The primary use of this routine is to allocate task
+local storage. It also compresses the heap first to (hopefully) move all used
+(unlocked) blocks of memory down. This routine will cause garbage collection.
+<BR><BR>
+<B>Note:</B> Blocks of memory that are locked for long periods of time should be moved high
+in memory so that they do not interfere as much with rest of the system. This routine
+ALWAYS compresses the heap before it tries to allocate the requested memory and so is
+much slower than the standard <A HREF="$$LINK(HeapAlloc)">HeapAlloc</A> routine. Locking
+memory may cause the system to run out of useable memory sooner than if memory is
+kept unlocked.
+
+[References]
+In=HeapAllocHighThrow, HeapAllocPtr, malloc, gray.h/GrayOn, homescr.h/HS_popEStack
+Out=HeapAlloc, HeapCompress, HeapGetHandle, HeapLock, system.h/NeedStack

+ 20 - 20
tigcc/doc/System/Include/alloc.h/HeapAllocHighThrow.hsf

@@ -1,20 +1,20 @@
-[Main]
-Name=HeapAllocHighThrow
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h
-Definition=HANDLE HeapAllocHighThrow (unsigned long Size);
-
-[ROM Call]
-Index=$94
-
-[Description]
-Performs <A HREF="$$LINK(HeapAllocHigh)">HeapAllocHigh</A>, and throws an error if not successful.
-
-[Explanation]
-HeapAllocHighThrow calls <A HREF="$$LINK(HeapAllocHigh)">HeapAllocHigh</A> and throws a memory error if there is
-not enough memory. Otherwise, it returns the handle of the allocated block.
-
-[References]
-In=bascmd.h/cmd_sinreg, bascmd.h/cmd_sorta, bascmd.h/cmd_sortd, basfunc.h/push_determinant, basfunc.h/push_red_row_ech, basfunc.h/push_row_echelon, basfunc.h/push_simult, unknown.h/push_sq_matrix_to_whole_number, unknown.h/_ROM_CALL_494, unknown.h/_ROM_CALL_495
-Out=HeapAllocHigh
+[Main]
+Name=HeapAllocHighThrow
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h
+Definition=HANDLE HeapAllocHighThrow (unsigned long Size);
+
+[ROM Call]
+Index=$94
+
+[Description]
+Performs <A HREF="$$LINK(HeapAllocHigh)">HeapAllocHigh</A>, and throws an error if not successful.
+
+[Explanation]
+HeapAllocHighThrow calls <A HREF="$$LINK(HeapAllocHigh)">HeapAllocHigh</A> and throws a memory error if there is
+not enough memory. Otherwise, it returns the handle of the allocated block.
+
+[References]
+In=bascmd.h/cmd_sinreg, bascmd.h/cmd_sorta, bascmd.h/cmd_sortd, basfunc.h/push_determinant, basfunc.h/push_red_row_ech, basfunc.h/push_row_echelon, basfunc.h/push_simult, unknown.h/push_sq_matrix_to_whole_number, unknown.h/_ROM_CALL_494, unknown.h/_ROM_CALL_495
+Out=HeapAllocHigh

+ 28 - 28
tigcc/doc/System/Include/alloc.h/HeapAllocPtr.hsf

@@ -1,28 +1,28 @@
-[Main]
-Name=HeapAllocPtr
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h
-Definition=void *HeapAllocPtr (unsigned long Size);
-Attributes=__attribute__((__malloc__))
-
-[ROM Call]
-Index=$A2
-
-[Description]
-Allocates memory at the high end of the heap and returns a pointer to the allocated block.
-
-[Explanation]
-HeapAllocPtr performs <A HREF="$$LINK(HeapAllocHigh)">HeapAllocHigh</A>, but instead of the handle, it returns
-a pointer to the allocated block (<A HREF="$$LINK(NULL)">NULL</A> in a case of error). It also
-gives a necessary information to the heap manager which is needed later for deallocating
-the memory using <A HREF="$$LINK(HeapFreePtr)">HeapFreePtr</A> command. This routine is principally
-equivalent to ANSI C <A HREF="$$LINK(malloc)">malloc</A> function, so it is aliased here also as
-<A HREF="$$LINK(malloc)">malloc</A>.
-<BR><BR>
-<B>Note:</B> If somebody is interested in it, the handle of the allocated block is stored two
-bytes below the address returned by HeapAllocPtr.
-
-[References]
-Out=HeapAllocHigh, system.h/NeedStack
-In=calloc, HeapAllocPtrThrow, realloc, dll.h/LoadDLL, stdio.h/fopen, stdio.h/scanf, stdio.h/vscanf, stdlib.h/atexit
+[Main]
+Name=HeapAllocPtr
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h
+Definition=void *HeapAllocPtr (unsigned long Size);
+Attributes=__attribute__((__malloc__))
+
+[ROM Call]
+Index=$A2
+
+[Description]
+Allocates memory at the high end of the heap and returns a pointer to the allocated block.
+
+[Explanation]
+HeapAllocPtr performs <A HREF="$$LINK(HeapAllocHigh)">HeapAllocHigh</A>, but instead of the handle, it returns
+a pointer to the allocated block (<A HREF="$$LINK(NULL)">NULL</A> in a case of error). It also
+gives a necessary information to the heap manager which is needed later for deallocating
+the memory using <A HREF="$$LINK(HeapFreePtr)">HeapFreePtr</A> command. This routine is principally
+equivalent to ANSI C <A HREF="$$LINK(malloc)">malloc</A> function, so it is aliased here also as
+<A HREF="$$LINK(malloc)">malloc</A>.
+<BR><BR>
+<B>Note:</B> If somebody is interested in it, the handle of the allocated block is stored two
+bytes below the address returned by HeapAllocPtr.
+
+[References]
+Out=HeapAllocHigh, system.h/NeedStack
+In=calloc, HeapAllocPtrThrow, realloc, dll.h/LoadDLL, stdio.h/fopen, stdio.h/scanf, stdio.h/vscanf, stdlib.h/atexit

+ 24 - 24
tigcc/doc/System/Include/alloc.h/HeapAllocPtrThrow.hsf

@@ -1,24 +1,24 @@
-[Main]
-Name=HeapAllocPtrThrow
-Type=Function
-Subtype=tigcc.a
-Header Files=alloc.h
-Definition=void *HeapAllocPtrThrow (unsigned long Size);
-Attributes=__attribute__((__malloc__))
-
-[Library Call]
-Asm=1
-
-[Registers]
-Size=a0
-
-[Description]
-Performs <A HREF="$$LINK(HeapAllocPtr)">HeapAllocPtr</A>, and throws an error if not successful.
-
-[Explanation]
-HeapAllocPtrThrow calls <A HREF="$$LINK(HeapAllocPtr)">HeapAllocPtr</A> and throws a
-memory error if there is not enough memory. Otherwise, it returns the handle
-of the allocated block.
-
-[References]
-Out=HeapAllocPtr
+[Main]
+Name=HeapAllocPtrThrow
+Type=Function
+Subtype=tigcc.a
+Header Files=alloc.h
+Definition=void *HeapAllocPtrThrow (unsigned long Size);
+Attributes=__attribute__((__malloc__))
+
+[Library Call]
+Asm=1
+
+[Registers]
+Size=a0
+
+[Description]
+Performs <A HREF="$$LINK(HeapAllocPtr)">HeapAllocPtr</A>, and throws an error if not successful.
+
+[Explanation]
+HeapAllocPtrThrow calls <A HREF="$$LINK(HeapAllocPtr)">HeapAllocPtr</A> and throws a
+memory error if there is not enough memory. Otherwise, it returns the handle
+of the allocated block.
+
+[References]
+Out=HeapAllocPtr

文件差異過大導致無法顯示
+ 0 - 19
tigcc/doc/System/Include/alloc.h/HeapAllocThrow.hsf


+ 16 - 16
tigcc/doc/System/Include/alloc.h/HeapAvail.hsf

@@ -1,16 +1,16 @@
-[Main]
-Name=HeapAvail
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h
-Definition=unsigned long HeapAvail (void);
-
-[ROM Call]
-Index=$8F
-
-[Description]
-Determines the size of the heap.
-
-[Explanation]
-HeapAvail returns the total amount of free bytes in the heap (the sum of all
-of the individual blocks of memory).
+[Main]
+Name=HeapAvail
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h
+Definition=unsigned long HeapAvail (void);
+
+[ROM Call]
+Index=$8F
+
+[Description]
+Determines the size of the heap.
+
+[Explanation]
+HeapAvail returns the total amount of free bytes in the heap (the sum of all
+of the individual blocks of memory).

+ 23 - 23
tigcc/doc/System/Include/alloc.h/HeapCompress.hsf

@@ -1,23 +1,23 @@
-[Main]
-Name=HeapCompress
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h
-Definition=void HeapCompress (void);
-See Also=HeapShuffle
-
-[ROM Call]
-Index=$95
-
-[Description]
-Compresses the heap.
-
-[Explanation]
-HeapCompress coalesces all used heap blocks, deleting any free blocks from the
-heap if possible. If there are any locked blocks, the heap may remain fragmented.
-This routine is called automatically by the system whenever it is needed
-and usually should not be called by applications.
-
-[References]
-In=HeapAlloc, HeapAllocESTACK, HeapAllocHigh, HeapMax, HeapMoveHigh, HeapRealloc, HeapShuffle, unknown.h/time_loop
-Out=mem.h/memmove, system.h/NeedStack
+[Main]
+Name=HeapCompress
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h
+Definition=void HeapCompress (void);
+See Also=HeapShuffle
+
+[ROM Call]
+Index=$95
+
+[Description]
+Compresses the heap.
+
+[Explanation]
+HeapCompress coalesces all used heap blocks, deleting any free blocks from the
+heap if possible. If there are any locked blocks, the heap may remain fragmented.
+This routine is called automatically by the system whenever it is needed
+and usually should not be called by applications.
+
+[References]
+In=HeapAlloc, HeapAllocESTACK, HeapAllocHigh, HeapMax, HeapMoveHigh, HeapRealloc, HeapShuffle, unknown.h/time_loop
+Out=mem.h/memmove, system.h/NeedStack

文件差異過大導致無法顯示
+ 0 - 28
tigcc/doc/System/Include/alloc.h/HeapDeref.hsf


+ 15 - 15
tigcc/doc/System/Include/alloc.h/HeapEnd.hsf

@@ -1,15 +1,15 @@
-[Main]
-Name=HeapEnd
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h
-Definition=void *HeapEnd (void);
-
-[ROM Call]
-Index=$A1
-
-[Description]
-Determines the end of the heap.
-
-[Explanation]
-HeapEnd returns a pointer to the end of the heap.
+[Main]
+Name=HeapEnd
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h
+Definition=void *HeapEnd (void);
+
+[ROM Call]
+Index=$A1
+
+[Description]
+Determines the end of the heap.
+
+[Explanation]
+HeapEnd returns a pointer to the end of the heap.

文件差異過大導致無法顯示
+ 0 - 17
tigcc/doc/System/Include/alloc.h/HeapFree.hsf


文件差異過大導致無法顯示
+ 0 - 31
tigcc/doc/System/Include/alloc.h/HeapFreeIndir.hsf


+ 34 - 34
tigcc/doc/System/Include/alloc.h/HeapFreePtr.hsf

@@ -1,34 +1,34 @@
-[Main]
-Name=HeapFreePtr
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h
-Definition=void HeapFreePtr (void *Ptr);
-
-[ROM Call]
-Index=$A3
-
-[Description]
-Frees a block allocated using <A HREF="$$LINK(HeapAllocPtr)">HeapAllocPtr</A>.
-
-[Explanation]
-HeapFreePtr frees a heap block pointed to by <I>Ptr</I>. The block must be a block
-which was allocated using the <A HREF="$$LINK(HeapAllocPtr)">HeapAllocPtr</A> command.
-<BR><BR>
-Do not attempt to use HeapFreePtr on a pointer which has changed after it was allocated
-with <A HREF="$$LINK(HeapAllocPtr)">HeapAllocPtr</A>. For example, the following code
-will certainly crash the calculator:
-<PRE>char *ptr = HeapAllocPtr (2);
-if (ptr)
-  {
-    *(ptr++) = 'A';  // pointer changed here
-    *ptr = 0;
-    ...
-    HeapFreePtr (ptr);
-  }
-</PRE>
-Instead, preserve the original pointer and pass it to HeapFreePtr.
-
-[References]
-Out=HeapFree
-In=dll.h/UnloadDLL, stdio.h/fopen, stdio.h/scanf, stdio.h/vscanf, stdlib.h/atexit
+[Main]
+Name=HeapFreePtr
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h
+Definition=void HeapFreePtr (void *Ptr);
+
+[ROM Call]
+Index=$A3
+
+[Description]
+Frees a block allocated using <A HREF="$$LINK(HeapAllocPtr)">HeapAllocPtr</A>.
+
+[Explanation]
+HeapFreePtr frees a heap block pointed to by <I>Ptr</I>. The block must be a block
+which was allocated using the <A HREF="$$LINK(HeapAllocPtr)">HeapAllocPtr</A> command.
+<BR><BR>
+Do not attempt to use HeapFreePtr on a pointer which has changed after it was allocated
+with <A HREF="$$LINK(HeapAllocPtr)">HeapAllocPtr</A>. For example, the following code
+will certainly crash the calculator:
+<PRE>char *ptr = HeapAllocPtr (2);
+if (ptr)
+  {
+    *(ptr++) = 'A';  // pointer changed here
+    *ptr = 0;
+    ...
+    HeapFreePtr (ptr);
+  }
+</PRE>
+Instead, preserve the original pointer and pass it to HeapFreePtr.
+
+[References]
+Out=HeapFree
+In=dll.h/UnloadDLL, stdio.h/fopen, stdio.h/scanf, stdio.h/vscanf, stdlib.h/atexit

+ 21 - 21
tigcc/doc/System/Include/alloc.h/HeapGetHandle.hsf

@@ -1,21 +1,21 @@
-[Main]
-Name=HeapGetHandle
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h
-Definition=HANDLE HeapGetHandle (void);
-
-[ROM Call]
-Index=$239
-
-[Description]
-Gets the next available handle.
-
-[Explanation]
-HeapGetHandle returns the number of the first unallocated (free) handle, or
-<A HREF="$$LINK(H_NULL)">H_NULL</A> if there are no free handles. Used mainly
-for internal purposes.
-
-[References]
-In=HeapAlloc, HeapAllocESTACK, HeapAllocHigh, unknown.h/time_loop
-Out=HeapFree, mem.h/memmove, mem.h/memset
+[Main]
+Name=HeapGetHandle
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h
+Definition=HANDLE HeapGetHandle (void);
+
+[ROM Call]
+Index=$239
+
+[Description]
+Gets the next available handle.
+
+[Explanation]
+HeapGetHandle returns the number of the first unallocated (free) handle, or
+<A HREF="$$LINK(H_NULL)">H_NULL</A> if there are no free handles. Used mainly
+for internal purposes.
+
+[References]
+In=HeapAlloc, HeapAllocESTACK, HeapAllocHigh, unknown.h/time_loop
+Out=HeapFree, mem.h/memmove, mem.h/memset

+ 19 - 19
tigcc/doc/System/Include/alloc.h/HeapGetLock.hsf

@@ -1,19 +1,19 @@
-[Main]
-Name=HeapGetLock
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h
-Definition=short HeapGetLock (HANDLE Handle);
-
-[ROM Call]
-Index=$9B
-
-[Description]
-Determines whether a block is locked.
-
-[Explanation]
-Returns non-zero if the block given by <I>Handle</I> is locked, 0 if it is not
-(i.e. if that memory is free to move on the next heap compression).
-
-[References]
-In=dialogs.h/Dialog, dll.h/LoadDLL, estack.h/NG_RPNToText, events.h/handleRclKey, unknown.h/push_user_func, unknown.h/_ROM_CALL_438
+[Main]
+Name=HeapGetLock
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h
+Definition=short HeapGetLock (HANDLE Handle);
+
+[ROM Call]
+Index=$9B
+
+[Description]
+Determines whether a block is locked.
+
+[Explanation]
+Returns non-zero if the block given by <I>Handle</I> is locked, 0 if it is not
+(i.e. if that memory is free to move on the next heap compression).
+
+[References]
+In=dialogs.h/Dialog, dll.h/LoadDLL, estack.h/NG_RPNToText, events.h/handleRclKey, unknown.h/push_user_func, unknown.h/_ROM_CALL_438

文件差異過大導致無法顯示
+ 0 - 22
tigcc/doc/System/Include/alloc.h/HeapLock.hsf


+ 23 - 23
tigcc/doc/System/Include/alloc.h/HeapMax.hsf

@@ -1,23 +1,23 @@
-[Main]
-Name=HeapMax
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h
-Definition=unsigned long HeapMax (void);
-
-[ROM Call]
-Index=$9C
-
-[Description]
-Determines the size of the largest allocatable block.
-
-[Explanation]
-HeapMax returns the size of the largest block allocatable on
-the heap (it will be in the range of 0 through 65520).
-Note that this may not be equal to <A HREF="$$LINK(HeapAvail)">HeapAvail</A>
-due to locked blocks, overhead, and maximum block size. This routine will
-(always) cause heap compression (garbage collection).
-
-[References]
-Out=HeapCompress
-In=stdio.h/scanf, stdio.h/vscanf
+[Main]
+Name=HeapMax
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h
+Definition=unsigned long HeapMax (void);
+
+[ROM Call]
+Index=$9C
+
+[Description]
+Determines the size of the largest allocatable block.
+
+[Explanation]
+HeapMax returns the size of the largest block allocatable on
+the heap (it will be in the range of 0 through 65520).
+Note that this may not be equal to <A HREF="$$LINK(HeapAvail)">HeapAvail</A>
+due to locked blocks, overhead, and maximum block size. This routine will
+(always) cause heap compression (garbage collection).
+
+[References]
+Out=HeapCompress
+In=stdio.h/scanf, stdio.h/vscanf

+ 23 - 23
tigcc/doc/System/Include/alloc.h/HeapMoveHigh.hsf

@@ -1,23 +1,23 @@
-[Main]
-Name=HeapMoveHigh
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h
-Definition=HANDLE HeapMoveHigh (HANDLE Handle);
-
-[ROM Call]
-Index=$A0
-
-[Description]
-Reallocates a block.
-
-[Explanation]
-HeapMoveHigh tries to reallocate a block referenced by <I>Handle</I> as high in
-memory as possible. The block must not be locked. If successful, returns
-the handle passed; otherwise returns <A HREF="$$LINK(H_NULL)">H_NULL</A> (in this case,
-the block is still in the same place as before, so no memory is lost). This routine
-will cause heap compression (garbage collection).
-
-[References]
-In=estack.h/NG_execute, homescr.h/HomeExecute, textedit.h/TE_handleEvent, unknown.h/CustomBegin, unknown.h/push_user_func
-Out=HeapCompress, mem.h/memmove, system.h/NeedStack
+[Main]
+Name=HeapMoveHigh
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h
+Definition=HANDLE HeapMoveHigh (HANDLE Handle);
+
+[ROM Call]
+Index=$A0
+
+[Description]
+Reallocates a block.
+
+[Explanation]
+HeapMoveHigh tries to reallocate a block referenced by <I>Handle</I> as high in
+memory as possible. The block must not be locked. If successful, returns
+the handle passed; otherwise returns <A HREF="$$LINK(H_NULL)">H_NULL</A> (in this case,
+the block is still in the same place as before, so no memory is lost). This routine
+will cause heap compression (garbage collection).
+
+[References]
+In=estack.h/NG_execute, homescr.h/HomeExecute, textedit.h/TE_handleEvent, unknown.h/CustomBegin, unknown.h/push_user_func
+Out=HeapCompress, mem.h/memmove, system.h/NeedStack

+ 21 - 21
tigcc/doc/System/Include/alloc.h/HeapPtrToHandle.hsf

@@ -1,21 +1,21 @@
-[Main]
-Name=HeapPtrToHandle
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h
-Definition=HANDLE HeapPtrToHandle (void *Ptr);
-
-[ROM Call]
-Index=$23A
-
-[Description]
-Determines the handle associated with a block.
-
-[Explanation]
-HeapPtrToHandle returns the handle which is associated with a block that is
-pointed to by <I>Ptr</I> (or <A HREF="$$LINK(H_NULL)">H_NULL</A> if there is not a handle
-that references the given block).
-This routine works by searching the entire table of handles for the given pointer,
-and so should be used accordingly. It assumes that the heap has not been compressed
-since the dereferenced pointer was
-originally obtained or the block it points to is locked.
+[Main]
+Name=HeapPtrToHandle
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h
+Definition=HANDLE HeapPtrToHandle (void *Ptr);
+
+[ROM Call]
+Index=$23A
+
+[Description]
+Determines the handle associated with a block.
+
+[Explanation]
+HeapPtrToHandle returns the handle which is associated with a block that is
+pointed to by <I>Ptr</I> (or <A HREF="$$LINK(H_NULL)">H_NULL</A> if there is not a handle
+that references the given block).
+This routine works by searching the entire table of handles for the given pointer,
+and so should be used accordingly. It assumes that the heap has not been compressed
+since the dereferenced pointer was
+originally obtained or the block it points to is locked.

文件差異過大導致無法顯示
+ 0 - 36
tigcc/doc/System/Include/alloc.h/HeapRealloc.hsf


+ 24 - 24
tigcc/doc/System/Include/alloc.h/HeapReallocThrow.hsf

@@ -1,24 +1,24 @@
-[Main]
-Name=HeapReallocThrow
-Type=Function
-Subtype=tigcc.a
-Header Files=alloc.h
-Definition=HANDLE HeapReallocThrow (HANDLE Handle, unsigned long NewSize);
-
-[Library Call]
-Asm=1
-
-[Registers]
-Handle=d0
-NewSize=a0
-
-[Description]
-Performs <A HREF="$$LINK(HeapRealloc)">HeapRealloc</A>, and throws an error if not successful.
-
-[Explanation]
-HeapReallocThrow calls <A HREF="$$LINK(HeapRealloc)">HeapRealloc</A> and throws a
-memory error if there is not enough memory. Otherwise, it returns the handle
-of the allocated block.
-
-[References]
-Out=HeapRealloc
+[Main]
+Name=HeapReallocThrow
+Type=Function
+Subtype=tigcc.a
+Header Files=alloc.h
+Definition=HANDLE HeapReallocThrow (HANDLE Handle, unsigned long NewSize);
+
+[Library Call]
+Asm=1
+
+[Registers]
+Handle=d0
+NewSize=a0
+
+[Description]
+Performs <A HREF="$$LINK(HeapRealloc)">HeapRealloc</A>, and throws an error if not successful.
+
+[Explanation]
+HeapReallocThrow calls <A HREF="$$LINK(HeapRealloc)">HeapRealloc</A> and throws a
+memory error if there is not enough memory. Otherwise, it returns the handle
+of the allocated block.
+
+[References]
+Out=HeapRealloc

+ 26 - 26
tigcc/doc/System/Include/alloc.h/HeapShuffle.hsf

@@ -1,26 +1,26 @@
-[Main]
-Name=HeapShuffle
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h
-Definition=void HeapShuffle (void);
-MinAMS=2.00
-See Also=HeapCompress, HeapWalk
-
-[ROM Call]
-Index=$474
-
-[Description]
-Shuffles all unlocked blocks on the heap.
-
-[Explanation]
-HeapShuffle shuffles all unlocked blocks on the heap.
-As a consequence, all dereferenced handles to unlocked blocks of memory in the heap may become invalid.
-This function is <I>not</I> the same as <A HREF="$$LINK(HeapCompress)">HeapCompress</A>.
-It is used mainly for debugging the program.
-<BR><BR>
-Here is a test example (called "Heap Shuffle"):
-$$EXAMPLE(Heap Shuffle.c)
-
-[References]
-Out=HeapCompress, mem.h/memmove, unknown.h/_ROM_CALL_3CF
+[Main]
+Name=HeapShuffle
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h
+Definition=void HeapShuffle (void);
+MinAMS=2.00
+See Also=HeapCompress, HeapWalk
+
+[ROM Call]
+Index=$474
+
+[Description]
+Shuffles all unlocked blocks on the heap.
+
+[Explanation]
+HeapShuffle shuffles all unlocked blocks on the heap.
+As a consequence, all dereferenced handles to unlocked blocks of memory in the heap may become invalid.
+This function is <I>not</I> the same as <A HREF="$$LINK(HeapCompress)">HeapCompress</A>.
+It is used mainly for debugging the program.
+<BR><BR>
+Here is a test example (called "Heap Shuffle"):
+$$EXAMPLE(Heap Shuffle.c)
+
+[References]
+Out=HeapCompress, mem.h/memmove, unknown.h/_ROM_CALL_3CF

+ 24 - 24
tigcc/doc/System/Include/alloc.h/HeapSize.hsf

@@ -1,24 +1,24 @@
-[Main]
-Name=HeapSize
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h
-Definition=unsigned long HeapSize (HANDLE Handle);
-
-[ROM Call]
-Index=$9E
-
-[Description]
-Determines the size of an allocated block.
-
-[Explanation]
-HeapSize returns the number of bytes allocated for the heap block referenced by
-<I>Handle</I>. Due to word alignment and minimum block size, this may not be the
-amount it was allocated with. Also note that because of locked blocks, it is possible
-(rare) that a heap block will actually be bumped up a few words by the
-<A HREF="$$LINK(HeapCompress)">HeapCompress</A> routine. So never assume that the value
-returned by HeapSize is the true number of bytes used by the data stored in the
-heap block.
-
-[References]
-In=dialogs.h/DialogAdd, files.h/TIOS_FClose: FClose, files.h/TIOS_FPutC: FPutC, stdio.h/fopen, vat.h/EM_moveSymFromExtMem, vat.h/EM_moveSymToExtMem, vat.h/EM_twinSymFromExtMem, vat.h/FindProgramVar, unknown.h/_ROM_CALL_438
+[Main]
+Name=HeapSize
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h
+Definition=unsigned long HeapSize (HANDLE Handle);
+
+[ROM Call]
+Index=$9E
+
+[Description]
+Determines the size of an allocated block.
+
+[Explanation]
+HeapSize returns the number of bytes allocated for the heap block referenced by
+<I>Handle</I>. Due to word alignment and minimum block size, this may not be the
+amount it was allocated with. Also note that because of locked blocks, it is possible
+(rare) that a heap block will actually be bumped up a few words by the
+<A HREF="$$LINK(HeapCompress)">HeapCompress</A> routine. So never assume that the value
+returned by HeapSize is the true number of bytes used by the data stored in the
+heap block.
+
+[References]
+In=dialogs.h/DialogAdd, files.h/TIOS_FClose: FClose, files.h/TIOS_FPutC: FPutC, stdio.h/fopen, vat.h/EM_moveSymFromExtMem, vat.h/EM_moveSymToExtMem, vat.h/EM_twinSymFromExtMem, vat.h/FindProgramVar, unknown.h/_ROM_CALL_438

文件差異過大導致無法顯示
+ 0 - 19
tigcc/doc/System/Include/alloc.h/HeapUnlock.hsf


+ 47 - 47
tigcc/doc/System/Include/alloc.h/HeapWalk.hsf

@@ -1,47 +1,47 @@
-[Main]
-Name=HeapWalk
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h
-Definition=short HeapWalk (short function);
-MinAMS=2.00
-See Also=HeapShuffle, vat.h/, vat.h/SymFindFolderName, unknown.h/pSymPG, unknown.h/SymPG_S
-
-[ROM Call]
-Index=$12C
-
-[Description]
-Verifies and dumps the contents of the heap.
-
-[Explanation]
-HeapWall looks through the heap to verify it is valid.
-Then it prints the status of the heap, prints the size of each heap block and its handle, or prints the symbol table, according to the value of <I>function</I>.
-HeapWalk uses <A HREF="$$LINK(link.h/LIO_SendData)">LIO_SendData</A> to send the output through the link port.
-<BR><BR>
-The valid values for <I>function</I>, defined in the enum <A HREF="$$LINK(HeapWalkCmds)">HeapWalkCmds</A>, are:
-<BR><BR>
-<TABLE BORDER CELLPADDING="3">
-<TR>
-  <TD VALIGN="TOP">H_WALK_VERIFY</TD>
-  <TD>The function just verifies the heap, and outputs nothing to the link port.</TD>
-</TR>
-<TR>
-  <TD VALIGN="TOP">H_WALK_STATUS</TD>
-  <TD>The function outputs the total free space, maximum size of a free block, number of used and free blocks, and the number of locked blocks.</TD>
-</TR>
-<TR>
-  <TD VALIGN="TOP">H_WALK_DUMP</TD>
-  <TD>The function outputs the heap status and the size of the heap block for each handle.</TD>
-</TR>
-<TR>
-  <TD VALIGN="TOP">H_WALK_SYM</TD>
-  <TD><B>AMS 2.04 or higher</B>: The function outputs the entire VAT.</TD>
-</TR>
-</TABLE>
-<BR>
-HeapWalk called with <I>function</I> as H_WALK_VERIFY, H_WALK_STATUS or H_WALK_DUMP, returns TRUE if the heap is valid, FALSE otherwise.<BR>
-
-<I>HeapWalk(H_WALK_SYM)</I> executes this block of code after verifying the heap. The example "List variables and folders" works on any AMS version, unlike HeapWalk(H_WALK_SYM):
-$$EXAMPLE(List variables and folders.c)
-[References]
-Out=error.h/ER_catch, link.h/LIO_SendData, mem.h/memcpy, stdio.h/sprintf, string.h/strlen, unknown.h/pSymPG, vat.h/SymFindFirst, vat.h/SymFindFolderName, vat.h/SymFindNext
+[Main]
+Name=HeapWalk
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h
+Definition=short HeapWalk (short function);
+MinAMS=2.00
+See Also=HeapShuffle, vat.h/, vat.h/SymFindFolderName, unknown.h/pSymPG, unknown.h/SymPG_S
+
+[ROM Call]
+Index=$12C
+
+[Description]
+Verifies and dumps the contents of the heap.
+
+[Explanation]
+HeapWall looks through the heap to verify it is valid.
+Then it prints the status of the heap, prints the size of each heap block and its handle, or prints the symbol table, according to the value of <I>function</I>.
+HeapWalk uses <A HREF="$$LINK(link.h/LIO_SendData)">LIO_SendData</A> to send the output through the link port.
+<BR><BR>
+The valid values for <I>function</I>, defined in the enum <A HREF="$$LINK(HeapWalkCmds)">HeapWalkCmds</A>, are:
+<BR><BR>
+<TABLE BORDER CELLPADDING="3">
+<TR>
+  <TD VALIGN="TOP">H_WALK_VERIFY</TD>
+  <TD>The function just verifies the heap, and outputs nothing to the link port.</TD>
+</TR>
+<TR>
+  <TD VALIGN="TOP">H_WALK_STATUS</TD>
+  <TD>The function outputs the total free space, maximum size of a free block, number of used and free blocks, and the number of locked blocks.</TD>
+</TR>
+<TR>
+  <TD VALIGN="TOP">H_WALK_DUMP</TD>
+  <TD>The function outputs the heap status and the size of the heap block for each handle.</TD>
+</TR>
+<TR>
+  <TD VALIGN="TOP">H_WALK_SYM</TD>
+  <TD><B>AMS 2.04 or higher</B>: The function outputs the entire VAT.</TD>
+</TR>
+</TABLE>
+<BR>
+HeapWalk called with <I>function</I> as H_WALK_VERIFY, H_WALK_STATUS or H_WALK_DUMP, returns TRUE if the heap is valid, FALSE otherwise.<BR>
+
+<I>HeapWalk(H_WALK_SYM)</I> executes this block of code after verifying the heap. The example "List variables and folders" works on any AMS version, unlike HeapWalk(H_WALK_SYM):
+$$EXAMPLE(List variables and folders.c)
+[References]
+Out=error.h/ER_catch, link.h/LIO_SendData, mem.h/memcpy, stdio.h/sprintf, string.h/strlen, unknown.h/pSymPG, vat.h/SymFindFirst, vat.h/SymFindFolderName, vat.h/SymFindNext

+ 15 - 15
tigcc/doc/System/Include/alloc.h/HeapWalkCmds.hsf

@@ -1,15 +1,15 @@
-[Main]
-Name=HeapWalkCmds
-Type=Type
-Subtype=Enumeration
-Header Files=alloc.h
-Definition=enum HeapWalkCmds {H_WALK_VERIFY = 0, H_WALK_STATUS = 1, H_WALK_DUMP = 2, H_WALK_SYM = 3};
-MinAMS=2.00
-
-[H_WALK_SYM]
-MinAMS=2.04
-
-[Description]
-An enumeration describing the valid parameters for <A HREF="$$LINK(HeapWalk)">HeapWalk</A>.
-
-[Explanation]
+[Main]
+Name=HeapWalkCmds
+Type=Type
+Subtype=Enumeration
+Header Files=alloc.h
+Definition=enum HeapWalkCmds {H_WALK_VERIFY = 0, H_WALK_STATUS = 1, H_WALK_DUMP = 2, H_WALK_SYM = 3};
+MinAMS=2.00
+
+[H_WALK_SYM]
+MinAMS=2.04
+
+[Description]
+An enumeration describing the valid parameters for <A HREF="$$LINK(HeapWalk)">HeapWalk</A>.
+
+[Explanation]

+ 11 - 11
tigcc/doc/System/Include/alloc.h/NULL.hsf

@@ -1,11 +1,11 @@
-[Main]
-Name=NULL
-Type=Constant
-Header Files=alloc.h, args.h, cert.h, dialogs.h, events.h, flash.h, kbd.h, link.h, mem.h, menus.h, stddef.h, stdio.h, stdlib.h, string.h, vat.h, wingraph.h
-Definition=#define NULL ((void *) 0)
-
-[Description]
-A null-pointer value.
-
-[Explanation]
-NULL is a null-pointer value, defined as a pointer to the address 0.
+[Main]
+Name=NULL
+Type=Constant
+Header Files=alloc.h, args.h, cert.h, dialogs.h, events.h, flash.h, kbd.h, link.h, mem.h, menus.h, stddef.h, stdio.h, stdlib.h, string.h, vat.h, wingraph.h
+Definition=#define NULL ((void *) 0)
+
+[Description]
+A null-pointer value.
+
+[Explanation]
+NULL is a null-pointer value, defined as a pointer to the address 0.

+ 5 - 5
tigcc/doc/System/Include/alloc.h/alloc.hsh

@@ -1,5 +1,5 @@
-[Main]
-See Also=mem.h/
-
-[Description]
-Routines for dynamic memory allocation
+[Main]
+See Also=mem.h/
+
+[Description]
+Routines for dynamic memory allocation

+ 39 - 39
tigcc/doc/System/Include/alloc.h/alloca.hsf

@@ -1,39 +1,39 @@
-[Main]
-Name=alloca
-Type=Function
-Subtype=Builtin
-Header Files=alloc.h, stdlib.h
-Definition=void *alloca (unsigned long Size);
-
-[Description]
-Allocates memory on the local storage space.
-
-[Explanation]
-alloca is a function which is not included in the ANSI C standard, but it exists in many C dialects
-(including TIGCC). It allocates a block of <I>Size</I> bytes on the CPU stack (local
-storage space), in opposite to <A HREF="$$LINK(malloc)">malloc</A> which allocates memory on the
-memory heap. The space allocated with alloca exists until the containing function returns
-(i.e. it will be automatically deallocated at the end of the function). Be aware of the
-fact that the size of the hardware stack on TI calculators is limited to 16 kilobytes, so
-do not use alloca for allocating large blocks.
-<BR><BR>
-alloca is usually used for simulating automatic variable-sized one-dimensional arrays, which will be automatically
-deallocated when the function ends (like all automatic variables), so it is sometimes more
-preferable than <A HREF="$$LINK(malloc)">malloc</A>. For example, to simulate
-<PRE>int a[n];
-</PRE>
-where <I>'n'</I> is not known in advance, you can use
-<PRE>int *a = alloca (n);
-</PRE>
-Note, however, that GNU C extensions allows <A HREF="$$INFOLINK(gnuexts/SEC76)">variable-length
-arrays</A>, which are more elegant than usage of alloca, and which may also be with more than
-one dimension (which is not possible with alloca).
-<BR><BR>
-<B>Note:</B> alloca is a built-in (open-coded) function in GNU C, which is translated to a single
-instruction which simply adjusts the stack. Some compiler command options (like
-<B>'-ansi'</B>) prevent alloca from being an open-coded function. In this implementation
-of TIGCC, you can not use alloca with such options (however, it is very unlikely that you will
-ever have such problems).
-
-[References]
-In=vat.h/SYMSTR
+[Main]
+Name=alloca
+Type=Function
+Subtype=Builtin
+Header Files=alloc.h, stdlib.h
+Definition=void *alloca (unsigned long Size);
+
+[Description]
+Allocates memory on the local storage space.
+
+[Explanation]
+alloca is a function which is not included in the ANSI C standard, but it exists in many C dialects
+(including TIGCC). It allocates a block of <I>Size</I> bytes on the CPU stack (local
+storage space), in opposite to <A HREF="$$LINK(malloc)">malloc</A> which allocates memory on the
+memory heap. The space allocated with alloca exists until the containing function returns
+(i.e. it will be automatically deallocated at the end of the function). Be aware of the
+fact that the size of the hardware stack on TI calculators is limited to 16 kilobytes, so
+do not use alloca for allocating large blocks.
+<BR><BR>
+alloca is usually used for simulating automatic variable-sized one-dimensional arrays, which will be automatically
+deallocated when the function ends (like all automatic variables), so it is sometimes more
+preferable than <A HREF="$$LINK(malloc)">malloc</A>. For example, to simulate
+<PRE>int a[n];
+</PRE>
+where <I>'n'</I> is not known in advance, you can use
+<PRE>int *a = alloca (n);
+</PRE>
+Note, however, that GNU C extensions allows <A HREF="$$INFOLINK(gnuexts/SEC76)">variable-length
+arrays</A>, which are more elegant than usage of alloca, and which may also be with more than
+one dimension (which is not possible with alloca).
+<BR><BR>
+<B>Note:</B> alloca is a built-in (open-coded) function in GNU C, which is translated to a single
+instruction which simply adjusts the stack. Some compiler command options (like
+<B>'-ansi'</B>) prevent alloca from being an open-coded function. In this implementation
+of TIGCC, you can not use alloca with such options (however, it is very unlikely that you will
+ever have such problems).
+
+[References]
+In=vat.h/SYMSTR

+ 32 - 32
tigcc/doc/System/Include/alloc.h/calloc.hsf

@@ -1,32 +1,32 @@
-[Main]
-Name=calloc
-Type=Function
-Subtype=tigcc.a
-Header Files=alloc.h, stdlib.h
-Definition=void *calloc (unsigned short NoOfItems, unsigned short SizeOfItems);
-See Also=malloc, realloc, free, calloc_throw
-
-[Library Call]
-Asm=1
-
-[Registers]
-NoOfItems=d0
-SizeOfItems=d1
-
-[Description]
-Allocates a memory block for a given number and size of items.
-
-[Explanation]
-calloc allocates a block of <I>NoOfItems</I>&nbsp;x&nbsp;<I>SizeOfItems</I>
-bytes from the memory heap. On success, calloc returns a pointer to the newly allocated
-block of memory. If not enough space exists for the new block, it returns
-<A HREF="$$LINK(NULL)">NULL</A>. The allocated block will be cleared to zero content.
-<BR><BR>
-<B>Note:</B> In releases of TIGCCLIB prior to 2.0, calloc was implemented here as a macro,
-Now, it is a function. It first calls <A HREF="$$LINK(malloc)">malloc</A>
-with <I>NoOfItems</I>&nbsp;x&nbsp;<I>SizeOfItems</I> as the argument, then calls
-<A HREF="$$LINK(mem.h/memset)">memset</A> if the first call was successful.
-
-[References]
-Out=HeapAllocPtr, mem.h/memset
-In=calloc_throw
+[Main]
+Name=calloc
+Type=Function
+Subtype=tigcc.a
+Header Files=alloc.h, stdlib.h
+Definition=void *calloc (unsigned short NoOfItems, unsigned short SizeOfItems);
+See Also=malloc, realloc, free, calloc_throw
+
+[Library Call]
+Asm=1
+
+[Registers]
+NoOfItems=d0
+SizeOfItems=d1
+
+[Description]
+Allocates a memory block for a given number and size of items.
+
+[Explanation]
+calloc allocates a block of <I>NoOfItems</I>&nbsp;x&nbsp;<I>SizeOfItems</I>
+bytes from the memory heap. On success, calloc returns a pointer to the newly allocated
+block of memory. If not enough space exists for the new block, it returns
+<A HREF="$$LINK(NULL)">NULL</A>. The allocated block will be cleared to zero content.
+<BR><BR>
+<B>Note:</B> In releases of TIGCCLIB prior to 2.0, calloc was implemented here as a macro,
+Now, it is a function. It first calls <A HREF="$$LINK(malloc)">malloc</A>
+with <I>NoOfItems</I>&nbsp;x&nbsp;<I>SizeOfItems</I> as the argument, then calls
+<A HREF="$$LINK(mem.h/memset)">memset</A> if the first call was successful.
+
+[References]
+Out=HeapAllocPtr, mem.h/memset
+In=calloc_throw

+ 24 - 24
tigcc/doc/System/Include/alloc.h/calloc_throw.hsf

@@ -1,24 +1,24 @@
-[Main]
-Name=calloc_throw
-Type=Function
-Subtype=tigcc.a
-Header Files=alloc.h
-Definition=void *calloc_throw (unsigned short NoOfItems, unsigned short SizeOfItems);
-
-[Library Call]
-Asm=1
-
-[Registers]
-NoOfItems=d0
-SizeOfItems=d1
-
-[Description]
-Performs <A HREF="$$LINK(alloc.h/calloc)">calloc</A>, and throws an error if not successful.
-
-[Explanation]
-calloc_throw calls <A HREF="$$LINK(calloc)">calloc</A> and throws a
-memory error if there is not enough memory. Otherwise, it returns a pointer
-to the allocated block.
-
-[References]
-Out=calloc
+[Main]
+Name=calloc_throw
+Type=Function
+Subtype=tigcc.a
+Header Files=alloc.h
+Definition=void *calloc_throw (unsigned short NoOfItems, unsigned short SizeOfItems);
+
+[Library Call]
+Asm=1
+
+[Registers]
+NoOfItems=d0
+SizeOfItems=d1
+
+[Description]
+Performs <A HREF="$$LINK(alloc.h/calloc)">calloc</A>, and throws an error if not successful.
+
+[Explanation]
+calloc_throw calls <A HREF="$$LINK(calloc)">calloc</A> and throws a
+memory error if there is not enough memory. Otherwise, it returns a pointer
+to the allocated block.
+
+[References]
+Out=calloc

+ 38 - 38
tigcc/doc/System/Include/alloc.h/free.hsf

@@ -1,38 +1,38 @@
-[Main]
-Name=free
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h, stdlib.h
-Definition=void free (void *Ptr);
-See Also=malloc, realloc, calloc
-
-[ROM Call]
-Index=$A3
-
-[Description]
-Frees an allocated block.
-
-[Explanation]
-free deallocates a memory block allocated by a previous call to
-<A HREF="$$LINK(malloc)">malloc</A> or <A HREF="$$LINK(calloc)">calloc</A>.
-<BR><BR>
-<B>Note:</B> free is in fact an ANSI C alias for a TIOS routine originally called
-<A HREF="$$LINK(HeapFreePtr)">HeapFreePtr</A>.
-<BR><BR>
-Do not attempt to use free on a pointer which has changed after it was allocated
-with <A HREF="$$LINK(malloc)">malloc</A>, <A HREF="$$LINK(calloc)">calloc</A>,
-or <A HREF="$$LINK(realloc)">realloc</A>. For example, the following code
-will certainly crash the calculator:
-<PRE>char *ptr = malloc (2);
-if (ptr)
-  {
-    *(ptr++) = 'A';  // pointer changed here
-    *ptr = 0;
-    ...
-    free (ptr);
-  }
-</PRE>
-Instead, preserve the original pointer and pass it to free.
-
-[References]
-Out=HeapFree
+[Main]
+Name=free
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h, stdlib.h
+Definition=void free (void *Ptr);
+See Also=malloc, realloc, calloc
+
+[ROM Call]
+Index=$A3
+
+[Description]
+Frees an allocated block.
+
+[Explanation]
+free deallocates a memory block allocated by a previous call to
+<A HREF="$$LINK(malloc)">malloc</A> or <A HREF="$$LINK(calloc)">calloc</A>.
+<BR><BR>
+<B>Note:</B> free is in fact an ANSI C alias for a TIOS routine originally called
+<A HREF="$$LINK(HeapFreePtr)">HeapFreePtr</A>.
+<BR><BR>
+Do not attempt to use free on a pointer which has changed after it was allocated
+with <A HREF="$$LINK(malloc)">malloc</A>, <A HREF="$$LINK(calloc)">calloc</A>,
+or <A HREF="$$LINK(realloc)">realloc</A>. For example, the following code
+will certainly crash the calculator:
+<PRE>char *ptr = malloc (2);
+if (ptr)
+  {
+    *(ptr++) = 'A';  // pointer changed here
+    *ptr = 0;
+    ...
+    free (ptr);
+  }
+</PRE>
+Instead, preserve the original pointer and pass it to free.
+
+[References]
+Out=HeapFree

+ 38 - 38
tigcc/doc/System/Include/alloc.h/malloc.hsf

@@ -1,38 +1,38 @@
-[Main]
-Name=malloc
-Type=Function
-Subtype=ROM Call
-Header Files=alloc.h, stdlib.h
-Definition=void *malloc (unsigned long Size);
-Attributes=__attribute__((__malloc__))
-See Also=realloc, calloc, free, malloc_throw
-
-[ROM Call]
-Index=$A2
-
-[Description]
-Allocates a memory block.
-
-[Explanation]
-malloc allocates a block of <I>Size</I> bytes from the memory heap.
-It allows a program to allocate memory explicitly as it's needed, and in
-the exact amounts needed. The heap is used for dynamic allocation of
-variable-sized blocks of memory. Many data structures, such as trees and
-lists, naturally employ heap memory allocation. On success, malloc returns
-a pointer to the newly allocated block of memory. If not enough space
-exists for the new block, it returns <A HREF="$$LINK(NULL)">NULL</A>. The contents
-of the block are left unchanged. If the argument <I>Size</I> is zero
-malloc also returns <A HREF="$$LINK(NULL)">NULL</A>.
-malloc is in fact an ANSI C alias for a TIOS routine originally called
-<A HREF="$$LINK(HeapAllocPtr)">HeapAllocPtr</A> (see description of it for more
-system info).
-<BR><BR>
-<B>Note:</B> As the TIOS memory manager assigns a handle to each allocated block, and
-as the total number of handles is limited, malloc is not good for algorithms
-where you need to allocate a large number of small blocks (as in implementations
-of linked lists which are usually seen in various C language books and tutorials).
-The same is true for all other TIOS memory management routines.
-
-[References]
-Out=HeapAllocHigh, system.h/NeedStack
-In=malloc_throw
+[Main]
+Name=malloc
+Type=Function
+Subtype=ROM Call
+Header Files=alloc.h, stdlib.h
+Definition=void *malloc (unsigned long Size);
+Attributes=__attribute__((__malloc__))
+See Also=realloc, calloc, free, malloc_throw
+
+[ROM Call]
+Index=$A2
+
+[Description]
+Allocates a memory block.
+
+[Explanation]
+malloc allocates a block of <I>Size</I> bytes from the memory heap.
+It allows a program to allocate memory explicitly as it's needed, and in
+the exact amounts needed. The heap is used for dynamic allocation of
+variable-sized blocks of memory. Many data structures, such as trees and
+lists, naturally employ heap memory allocation. On success, malloc returns
+a pointer to the newly allocated block of memory. If not enough space
+exists for the new block, it returns <A HREF="$$LINK(NULL)">NULL</A>. The contents
+of the block are left unchanged. If the argument <I>Size</I> is zero
+malloc also returns <A HREF="$$LINK(NULL)">NULL</A>.
+malloc is in fact an ANSI C alias for a TIOS routine originally called
+<A HREF="$$LINK(HeapAllocPtr)">HeapAllocPtr</A> (see description of it for more
+system info).
+<BR><BR>
+<B>Note:</B> As the TIOS memory manager assigns a handle to each allocated block, and
+as the total number of handles is limited, malloc is not good for algorithms
+where you need to allocate a large number of small blocks (as in implementations
+of linked lists which are usually seen in various C language books and tutorials).
+The same is true for all other TIOS memory management routines.
+
+[References]
+Out=HeapAllocHigh, system.h/NeedStack
+In=malloc_throw

+ 24 - 24
tigcc/doc/System/Include/alloc.h/malloc_throw.hsf

@@ -1,24 +1,24 @@
-[Main]
-Name=malloc_throw
-Type=Function
-Subtype=tigcc.a
-Header Files=alloc.h
-Definition=void *malloc_throw (unsigned long Size);
-Attributes=__attribute__((__malloc__))
-
-[Library Call]
-Asm=1
-
-[Registers]
-Size=a0
-
-[Description]
-Performs <A HREF="$$LINK(alloc.h/malloc)">malloc</A>, and throws an error if not successful.
-
-[Explanation]
-malloc_throw calls <A HREF="$$LINK(malloc)">malloc</A> and throws a
-memory error if there is not enough memory. Otherwise, it returns a pointer
-to the allocated block.
-
-[References]
-Out=malloc
+[Main]
+Name=malloc_throw
+Type=Function
+Subtype=tigcc.a
+Header Files=alloc.h
+Definition=void *malloc_throw (unsigned long Size);
+Attributes=__attribute__((__malloc__))
+
+[Library Call]
+Asm=1
+
+[Registers]
+Size=a0
+
+[Description]
+Performs <A HREF="$$LINK(alloc.h/malloc)">malloc</A>, and throws an error if not successful.
+
+[Explanation]
+malloc_throw calls <A HREF="$$LINK(malloc)">malloc</A> and throws a
+memory error if there is not enough memory. Otherwise, it returns a pointer
+to the allocated block.
+
+[References]
+Out=malloc

+ 45 - 45
tigcc/doc/System/Include/alloc.h/realloc.hsf

@@ -1,45 +1,45 @@
-[Main]
-Name=realloc
-Type=Function
-Subtype=tigcc.a
-Header Files=alloc.h, stdlib.h
-Definition=void *realloc (void *Ptr, unsigned long NewSize);
-See Also=malloc, calloc, free, realloc_throw
-
-[Library Call]
-Asm=1
-
-[Registers]
-Ptr=a0
-NewSize=d0
-
-[Description]
-Reallocates allocated memory.
-
-[Explanation]
-realloc attempts to shrink or expand the previously allocated block to <I>NewSize</I>
-bytes. The <I>Ptr</I> argument points to a memory block previously obtained by calling
-<A HREF="$$LINK(malloc)">malloc</A>, <A HREF="$$LINK(calloc)">calloc</A>, or realloc.
-It may also be <A HREF="$$LINK(NULL)">NULL</A>; in this case the function simply calls <A HREF="$$LINK(malloc)">malloc</A>.
-<BR><BR>
-realloc adjusts the size of the allocated block to <I>NewSize</I>, copying the contents to a new location
-if necessary (note that the block will not stay in high memory after the reallocation, but
-it will still remain locked; see other functions from this header file for more info).
-realloc returns the address of the reallocated block, which can be different than the address
-of the original block. If the block cannot be reallocated, realloc returns <A HREF="$$LINK(NULL)">NULL</A>.
-<BR><BR>
-Usually realloc keeps the current contents of the block intact; only the portion of the block
-which is newly allocated is not initialized and contains random content. However, unlike
-<A HREF="$$LINK(HeapRealloc)">HeapRealloc</A>, the function frees the block pointed to by
-<I>Ptr</I> if there was an error, so you can not assume that the data pointed to by <I>Ptr</I>
-is still valid. This is done because there is no way to guarantee that <I>Ptr</I> is still
-valid after the heap compression which <A HREF="$$LINK(HeapRealloc)">HeapRealloc</A> tries to
-perform (this function uses <A HREF="$$LINK(HeapRealloc)">HeapRealloc</A> internally).
-<BR><BR>
-<B>Note:</B> realloc is introduced to increase compatibility with ANSI C. It is better to use
-the official TIOS function <A HREF="$$LINK(HeapRealloc)">HeapRealloc</A>, which uses a system of handles
-to memory blocks.
-
-[References]
-Out=HeapAllocPtr, HeapFree, HeapRealloc, HeapUnlock, HLock
-In=realloc_throw, stdlib.h/atexit
+[Main]
+Name=realloc
+Type=Function
+Subtype=tigcc.a
+Header Files=alloc.h, stdlib.h
+Definition=void *realloc (void *Ptr, unsigned long NewSize);
+See Also=malloc, calloc, free, realloc_throw
+
+[Library Call]
+Asm=1
+
+[Registers]
+Ptr=a0
+NewSize=d0
+
+[Description]
+Reallocates allocated memory.
+
+[Explanation]
+realloc attempts to shrink or expand the previously allocated block to <I>NewSize</I>
+bytes. The <I>Ptr</I> argument points to a memory block previously obtained by calling
+<A HREF="$$LINK(malloc)">malloc</A>, <A HREF="$$LINK(calloc)">calloc</A>, or realloc.
+It may also be <A HREF="$$LINK(NULL)">NULL</A>; in this case the function simply calls <A HREF="$$LINK(malloc)">malloc</A>.
+<BR><BR>
+realloc adjusts the size of the allocated block to <I>NewSize</I>, copying the contents to a new location
+if necessary (note that the block will not stay in high memory after the reallocation, but
+it will still remain locked; see other functions from this header file for more info).
+realloc returns the address of the reallocated block, which can be different than the address
+of the original block. If the block cannot be reallocated, realloc returns <A HREF="$$LINK(NULL)">NULL</A>.
+<BR><BR>
+Usually realloc keeps the current contents of the block intact; only the portion of the block
+which is newly allocated is not initialized and contains random content. However, unlike
+<A HREF="$$LINK(HeapRealloc)">HeapRealloc</A>, the function frees the block pointed to by
+<I>Ptr</I> if there was an error, so you can not assume that the data pointed to by <I>Ptr</I>
+is still valid. This is done because there is no way to guarantee that <I>Ptr</I> is still
+valid after the heap compression which <A HREF="$$LINK(HeapRealloc)">HeapRealloc</A> tries to
+perform (this function uses <A HREF="$$LINK(HeapRealloc)">HeapRealloc</A> internally).
+<BR><BR>
+<B>Note:</B> realloc is introduced to increase compatibility with ANSI C. It is better to use
+the official TIOS function <A HREF="$$LINK(HeapRealloc)">HeapRealloc</A>, which uses a system of handles
+to memory blocks.
+
+[References]
+Out=HeapAllocPtr, HeapFree, HeapRealloc, HeapUnlock, HLock
+In=realloc_throw, stdlib.h/atexit

+ 24 - 24
tigcc/doc/System/Include/alloc.h/realloc_throw.hsf

@@ -1,24 +1,24 @@
-[Main]
-Name=realloc_throw
-Type=Function
-Subtype=tigcc.a
-Header Files=alloc.h
-Definition=void *realloc_throw (void *Ptr, unsigned long NewSize);
-
-[Library Call]
-Asm=1
-
-[Registers]
-Ptr=a0
-NewSize=d0
-
-[Description]
-Performs <A HREF="$$LINK(alloc.h/realloc)">realloc</A>, and throws an error if not successful.
-
-[Explanation]
-realloc_throw calls <A HREF="$$LINK(realloc)">realloc</A> and throws a
-memory error if there is not enough memory. Otherwise, it returns a pointer
-to the allocated block.
-
-[References]
-Out=realloc
+[Main]
+Name=realloc_throw
+Type=Function
+Subtype=tigcc.a
+Header Files=alloc.h
+Definition=void *realloc_throw (void *Ptr, unsigned long NewSize);
+
+[Library Call]
+Asm=1
+
+[Registers]
+Ptr=a0
+NewSize=d0
+
+[Description]
+Performs <A HREF="$$LINK(alloc.h/realloc)">realloc</A>, and throws an error if not successful.
+
+[Explanation]
+realloc_throw calls <A HREF="$$LINK(realloc)">realloc</A> and throws a
+memory error if there is not enough memory. Otherwise, it returns a pointer
+to the allocated block.
+
+[References]
+Out=realloc

+ 18 - 18
tigcc/doc/System/Include/args.h/ArgCount.hsf

@@ -1,18 +1,18 @@
-[Main]
-Name=ArgCount
-Type=Function
-Subtype=Macro
-Header Files=args.h
-Definition=unsigned short ArgCount (void);
-Real Definition=#define ArgCount() (RemainingArgCnt (top_estack))
-See Also=RemainingArgCnt
-
-[Description]
-Returns the number of arguments passed to the program.
-
-[Explanation]
-ArgCount returns the number of arguments passed to the called program. It is a simple
-macro which calls TIOS function <A HREF="$$LINK(RemainingArgCnt)">RemainingArgCnt</A>.
-
-[References]
-Out=RemainingArgCnt, estack.h/top_estack
+[Main]
+Name=ArgCount
+Type=Function
+Subtype=Macro
+Header Files=args.h
+Definition=unsigned short ArgCount (void);
+Real Definition=#define ArgCount() (RemainingArgCnt (top_estack))
+See Also=RemainingArgCnt
+
+[Description]
+Returns the number of arguments passed to the program.
+
+[Explanation]
+ArgCount returns the number of arguments passed to the called program. It is a simple
+macro which calls TIOS function <A HREF="$$LINK(RemainingArgCnt)">RemainingArgCnt</A>.
+
+[References]
+Out=RemainingArgCnt, estack.h/top_estack

+ 26 - 26
tigcc/doc/System/Include/args.h/EX_getArg.hsf

@@ -1,26 +1,26 @@
-[Main]
-Name=EX_getArg
-Type=Function
-Subtype=ROM Call
-Header Files=args.h
-Definition=ESI EX_getArg (short n);
-
-[ROM Call]
-Index=$BE
-
-[Description]
-Returns a pointer to the nth argument.
-
-[Explanation]
-EX_getArg is TIOS function which may be useful if you want to access arguments in
-non_sequential order. EX_getArg returns a pointer to the argument which ordinal
-number is <I>n</I> (which may be later processed using <A HREF="$$LINK(GetIntArg)">GetIntArg</A>
-etc.). Arguments are numbered from zero (i.e. 0, 1, 2, <B>...</B> N-1
-where N is the total number of arguments). Note that when <I>n</I>&nbsp;=&nbsp;N,
-EX_getArg returns <A HREF="$$LINK(alloc.h/NULL)">NULL</A>, and when <I>n</I>&nbsp;&gt;&nbsp;N,
-EX_getArg throws an error, so it is good idea to check in advance the total number
-of arguments using <A HREF="$$LINK(ArgCount)">ArgCount</A>.
-
-[References]
-Out=estack.h/next_expression_index, estack.h/top_estack
-In=EX_getBCD
+[Main]
+Name=EX_getArg
+Type=Function
+Subtype=ROM Call
+Header Files=args.h
+Definition=ESI EX_getArg (short n);
+
+[ROM Call]
+Index=$BE
+
+[Description]
+Returns a pointer to the nth argument.
+
+[Explanation]
+EX_getArg is TIOS function which may be useful if you want to access arguments in
+non_sequential order. EX_getArg returns a pointer to the argument which ordinal
+number is <I>n</I> (which may be later processed using <A HREF="$$LINK(GetIntArg)">GetIntArg</A>
+etc.). Arguments are numbered from zero (i.e. 0, 1, 2, <B>...</B> N-1
+where N is the total number of arguments). Note that when <I>n</I>&nbsp;=&nbsp;N,
+EX_getArg returns <A HREF="$$LINK(alloc.h/NULL)">NULL</A>, and when <I>n</I>&nbsp;&gt;&nbsp;N,
+EX_getArg throws an error, so it is good idea to check in advance the total number
+of arguments using <A HREF="$$LINK(ArgCount)">ArgCount</A>.
+
+[References]
+Out=estack.h/next_expression_index, estack.h/top_estack
+In=EX_getBCD

+ 22 - 22
tigcc/doc/System/Include/args.h/EX_getBCD.hsf

@@ -1,22 +1,22 @@
-[Main]
-Name=EX_getBCD
-Type=Function
-Subtype=ROM Call
-Header Files=args.h
-Definition=short EX_getBCD (short n, float *dest);
-
-[ROM Call]
-Index=$BF
-
-[Description]
-Gets the nth floating point argument.
-
-[Explanation]
-EX_getBCD is a somewhat limited TIOS function. It first calls <A HREF="$$LINK(EX_getArg)">EX_getArg</A>
-passing <I>n</I> to it. Then, if the argument pointed to by the result of
-<A HREF="$$LINK(EX_getArg)">EX_getArg</A> is not a floating point number, EX_getBCD returns
-<A HREF="$$LINK(alloc.h/Bool)">FALSE</A>, otherwise it stores the floating point value to the variable pointed to by
-<I>dest</I> and returns <A HREF="$$LINK(alloc.h/Bool)">TRUE</A>.
-
-[References]
-Out=EX_getArg, unknown.h/estack_to_float
+[Main]
+Name=EX_getBCD
+Type=Function
+Subtype=ROM Call
+Header Files=args.h
+Definition=short EX_getBCD (short n, float *dest);
+
+[ROM Call]
+Index=$BF
+
+[Description]
+Gets the nth floating point argument.
+
+[Explanation]
+EX_getBCD is a somewhat limited TIOS function. It first calls <A HREF="$$LINK(EX_getArg)">EX_getArg</A>
+passing <I>n</I> to it. Then, if the argument pointed to by the result of
+<A HREF="$$LINK(EX_getArg)">EX_getArg</A> is not a floating point number, EX_getBCD returns
+<A HREF="$$LINK(alloc.h/Bool)">FALSE</A>, otherwise it stores the floating point value to the variable pointed to by
+<I>dest</I> and returns <A HREF="$$LINK(alloc.h/Bool)">TRUE</A>.
+
+[References]
+Out=EX_getArg, unknown.h/estack_to_float

+ 26 - 26
tigcc/doc/System/Include/args.h/GetArgType.hsf

@@ -1,26 +1,26 @@
-[Main]
-Name=GetArgType
-Type=Function
-Subtype=Macro
-Header Files=args.h
-Definition=unsigned char GetArgType (CESI ap);
-Real Definition=#define GetArgType(p) (*(CESI)(p))
-
-[Description]
-Returns the type of the current argument.
-
-[Explanation]
-GetArgType returns a one-byte value which determines the type of the current argument
-(pointed to by <I>ap</I>). There are many types of arguments: strings, integers
-(positive or negative), fractions, floats, symbols, various algebraic expressions,
-lists, matrices, etc. The enum <A HREF="$$LINK(estack.h/Tags)">Tags</A>
-defines a lot of constants: the most commonly used in argument lists are
-STR_TAG, POSINT_TAG, NEGINT_TAG, FLOAT_TAG, POSFRAC_TAG, ENDFRAC_TAG,
-COMPLEX_TAG, LIST_TAG and END_TAG. They represent respectively a string, a positive integer, a negative
-integer, a floating point value, a positive fraction, a negative fraction, a complex number,
-a beginning of the list structure and an end-of-list marker (which also has meaning "no more arguments").
-Any values except these need to be regarded as "an expression": you need to handle them
-"by hand" (of course, if you know how).
-See <A HREF="$$LINK(InitArgPtr)">InitArgPtr</A> for an example of usage.<BR><BR>
-<B>Note:</B> You can use <A HREF="$$LINK(SkipArg)">SkipArg</A> to bypass the argument which you don't know
-how to handle (or, which you don't want to handle for any reason).
+[Main]
+Name=GetArgType
+Type=Function
+Subtype=Macro
+Header Files=args.h
+Definition=unsigned char GetArgType (CESI ap);
+Real Definition=#define GetArgType(p) (*(CESI)(p))
+
+[Description]
+Returns the type of the current argument.
+
+[Explanation]
+GetArgType returns a one-byte value which determines the type of the current argument
+(pointed to by <I>ap</I>). There are many types of arguments: strings, integers
+(positive or negative), fractions, floats, symbols, various algebraic expressions,
+lists, matrices, etc. The enum <A HREF="$$LINK(estack.h/Tags)">Tags</A>
+defines a lot of constants: the most commonly used in argument lists are
+STR_TAG, POSINT_TAG, NEGINT_TAG, FLOAT_TAG, POSFRAC_TAG, ENDFRAC_TAG,
+COMPLEX_TAG, LIST_TAG and END_TAG. They represent respectively a string, a positive integer, a negative
+integer, a floating point value, a positive fraction, a negative fraction, a complex number,
+a beginning of the list structure and an end-of-list marker (which also has meaning "no more arguments").
+Any values except these need to be regarded as "an expression": you need to handle them
+"by hand" (of course, if you know how).
+See <A HREF="$$LINK(InitArgPtr)">InitArgPtr</A> for an example of usage.<BR><BR>
+<B>Note:</B> You can use <A HREF="$$LINK(SkipArg)">SkipArg</A> to bypass the argument which you don't know
+how to handle (or, which you don't want to handle for any reason).

+ 23 - 23
tigcc/doc/System/Include/args.h/GetFloatArg.hsf

@@ -1,23 +1,23 @@
-[Main]
-Name=GetFloatArg
-Type=Function
-Subtype=Macro
-Header Files=args.h
-Definition=float GetFloatArg (CESI &ap);
-Real Definition=#define GetFloatArg(p) ({float __f; (CESI)(p)-=10; _rom_call(void*,(),26A)(&__f,(CESI)(p)+1,9L); ((char*)&__f)[9]=0; __f;})
-See Also=estack.h/estack_number_to_Float
-
-[Description]
-Returns the current argument of floating point type.
-
-[Explanation]
-GetFloatArg is a macro which returns the current floating point argument
-(pointed to by <I>ap</I>) and modifies <I>ap</I> to point to the next argument in
-the argument list. So, each successive time GetFloatArg is used, it returns the next
-argument in the argument list.
-Note that GetFloatArg assumes that the current argument <I>is</I> a floating point value (not an
-integer). This may be checked using <A HREF="$$LINK(GetArgType)">GetArgType</A>. If this
-is not true, the result of GetFloatArg is unpredictable.
-
-[References]
-Out=mem.h/memcpy
+[Main]
+Name=GetFloatArg
+Type=Function
+Subtype=Macro
+Header Files=args.h
+Definition=float GetFloatArg (CESI &ap);
+Real Definition=#define GetFloatArg(p) ({float __f; (CESI)(p)-=10; _rom_call(void*,(),26A)(&__f,(CESI)(p)+1,9L); ((char*)&__f)[9]=0; __f;})
+See Also=estack.h/estack_number_to_Float
+
+[Description]
+Returns the current argument of floating point type.
+
+[Explanation]
+GetFloatArg is a macro which returns the current floating point argument
+(pointed to by <I>ap</I>) and modifies <I>ap</I> to point to the next argument in
+the argument list. So, each successive time GetFloatArg is used, it returns the next
+argument in the argument list.
+Note that GetFloatArg assumes that the current argument <I>is</I> a floating point value (not an
+integer). This may be checked using <A HREF="$$LINK(GetArgType)">GetArgType</A>. If this
+is not true, the result of GetFloatArg is unpredictable.
+
+[References]
+Out=mem.h/memcpy

+ 44 - 44
tigcc/doc/System/Include/args.h/GetIntArg.hsf

@@ -1,44 +1,44 @@
-[Main]
-Name=GetIntArg
-Type=Function
-Subtype=Macro
-Header Files=args.h
-Definition=unsigned long GetIntArg (CESI &ap);
-Real Definition=#define GetIntArg(p) ({register unsigned short __n=*(--(ESI)(p)); register unsigned long __s=0; while(__n--) __s=(__s<<8)+*(--(unsigned char*)(p)); (ESI)(p)--; __s;})
-See Also=GetLongLongArg
-
-[Description]
-Returns the current argument of integer type.
-
-[Explanation]
-GetIntArg is a macro which returns the current integer argument
-(pointed to by <I>ap</I>) and modifies <I>ap</I> to point to the next argument in
-the argument list. So, each successive time GetIntArg is used, it returns the next
-argument in the argument list. If the argument is a negative number (check the sign using
-<A HREF="$$LINK(GetArgType)">GetArgType</A>), GetIntArg returns its absolute value.
-See <A HREF="$$LINK(InitArgPtr)">InitArgPtr</A> for an example of usage.
-Note that GetIntArg assumes that the current argument IS an integer, either positive
-or negative (this may be checked using <A HREF="$$LINK(GetArgType)">GetArgType</A>). If this
-is not true, the result of GetIntArg is unpredictable.
-<BR><BR>
-If the current argument type is a fraction, do the following to pick it:
-<PRE>numerator = GetIntArg (ap);
-ap++;
-denominator = GetIntArg (ap);
-</PRE>
-i.e. pick two integers, with increasing argument pointer between two picks.
-<BR><BR>
-<B>Note:</B> It is not recommended to do something like
-<PRE>a = GetIntArg (top_estack);
-</PRE>
-It works fine sometimes, but not always. GetIntArg
-is a function-looking macro, with <B>changes</B> the value of its actual
-argument. So, if you write the statement mentioned above,
-you will also change the value of TIOS system variable <A HREF="$$LINK(estack.h/top_estack)">top_estack</A>,
-which is not always a good idea. So, I strictly recommend using an auxiliary variable,
-like in the following example:
-<PRE>ESI argptr = top_estack;
-...
-a = GetIntArg (argptr);
-</PRE>
-Using this method, you will avoid unexpected changes of <A HREF="$$LINK(estack.h/top_estack)">top_estack</A>.
+[Main]
+Name=GetIntArg
+Type=Function
+Subtype=Macro
+Header Files=args.h
+Definition=unsigned long GetIntArg (CESI &ap);
+Real Definition=#define GetIntArg(p) ({register unsigned short __n=*(--(ESI)(p)); register unsigned long __s=0; while(__n--) __s=(__s<<8)+*(--(unsigned char*)(p)); (ESI)(p)--; __s;})
+See Also=GetLongLongArg
+
+[Description]
+Returns the current argument of integer type.
+
+[Explanation]
+GetIntArg is a macro which returns the current integer argument
+(pointed to by <I>ap</I>) and modifies <I>ap</I> to point to the next argument in
+the argument list. So, each successive time GetIntArg is used, it returns the next
+argument in the argument list. If the argument is a negative number (check the sign using
+<A HREF="$$LINK(GetArgType)">GetArgType</A>), GetIntArg returns its absolute value.
+See <A HREF="$$LINK(InitArgPtr)">InitArgPtr</A> for an example of usage.
+Note that GetIntArg assumes that the current argument IS an integer, either positive
+or negative (this may be checked using <A HREF="$$LINK(GetArgType)">GetArgType</A>). If this
+is not true, the result of GetIntArg is unpredictable.
+<BR><BR>
+If the current argument type is a fraction, do the following to pick it:
+<PRE>numerator = GetIntArg (ap);
+ap++;
+denominator = GetIntArg (ap);
+</PRE>
+i.e. pick two integers, with increasing argument pointer between two picks.
+<BR><BR>
+<B>Note:</B> It is not recommended to do something like
+<PRE>a = GetIntArg (top_estack);
+</PRE>
+It works fine sometimes, but not always. GetIntArg
+is a function-looking macro, with <B>changes</B> the value of its actual
+argument. So, if you write the statement mentioned above,
+you will also change the value of TIOS system variable <A HREF="$$LINK(estack.h/top_estack)">top_estack</A>,
+which is not always a good idea. So, I strictly recommend using an auxiliary variable,
+like in the following example:
+<PRE>ESI argptr = top_estack;
+...
+a = GetIntArg (argptr);
+</PRE>
+Using this method, you will avoid unexpected changes of <A HREF="$$LINK(estack.h/top_estack)">top_estack</A>.

+ 15 - 15
tigcc/doc/System/Include/args.h/GetLongLongArg.hsf

@@ -1,15 +1,15 @@
-[Main]
-Name=GetLongLongArg
-Type=Function
-Subtype=Macro
-Header Files=args.h
-Definition=unsigned long long GetLongLongArg (CESI &ap);
-Real Definition=#define GetLongLongArg(p) ({register unsigned short __n=*(--(ESI)(p)); register unsigned long long __s=0; while(__n--) __s=(__s<<8)+*(--(unsigned char*)(p)); (ESI)(p)--; __s;})
-See Also=GetIntArg
-
-[Description]
-Returns the current argument of double-long integer type.
-
-[Explanation]
-GetLongLongArg works like <A HREF="$$LINK(GetIntArg)">GetIntArg</A>, but
-returns a <A HREF="$$INFOLINK(gnuexts/SEC72)">double-long integer</A>.
+[Main]
+Name=GetLongLongArg
+Type=Function
+Subtype=Macro
+Header Files=args.h
+Definition=unsigned long long GetLongLongArg (CESI &ap);
+Real Definition=#define GetLongLongArg(p) ({register unsigned short __n=*(--(ESI)(p)); register unsigned long long __s=0; while(__n--) __s=(__s<<8)+*(--(unsigned char*)(p)); (ESI)(p)--; __s;})
+See Also=GetIntArg
+
+[Description]
+Returns the current argument of double-long integer type.
+
+[Explanation]
+GetLongLongArg works like <A HREF="$$LINK(GetIntArg)">GetIntArg</A>, but
+returns a <A HREF="$$INFOLINK(gnuexts/SEC72)">double-long integer</A>.

+ 20 - 20
tigcc/doc/System/Include/args.h/GetStrnArg.hsf

@@ -1,20 +1,20 @@
-[Main]
-Name=GetStrnArg
-Type=Function
-Subtype=Macro
-Header Files=args.h
-Definition=const char *GetStrnArg (CESI &ap);
-Real Definition=#define GetStrnArg(p) ({(ESI)(p)-=2; while(*(ESI)(p)--); (const char*)((ESI)(p)+2);})
-
-[Description]
-Returns the current argument of string type.
-
-[Explanation]
-GetStrnArg is a macro which returns the current string argument
-(pointed to by <I>ap</I>) and modifies <I>ap</I> to point to the next argument in
-the argument list. So, each successive time GetStrnArg is used, it returns the next
-argument in the argument list.
-See <A HREF="$$LINK(InitArgPtr)">InitArgPtr</A> for an example of usage.
-Note that GetStrnArg assumes that the current argument IS a string (this may be
-checked using <A HREF="$$LINK(GetArgType)">GetArgType</A>). If this is not true, the
-effect of GetStrnArg is unpredictable.
+[Main]
+Name=GetStrnArg
+Type=Function
+Subtype=Macro
+Header Files=args.h
+Definition=const char *GetStrnArg (CESI &ap);
+Real Definition=#define GetStrnArg(p) ({(ESI)(p)-=2; while(*(ESI)(p)--); (const char*)((ESI)(p)+2);})
+
+[Description]
+Returns the current argument of string type.
+
+[Explanation]
+GetStrnArg is a macro which returns the current string argument
+(pointed to by <I>ap</I>) and modifies <I>ap</I> to point to the next argument in
+the argument list. So, each successive time GetStrnArg is used, it returns the next
+argument in the argument list.
+See <A HREF="$$LINK(InitArgPtr)">InitArgPtr</A> for an example of usage.
+Note that GetStrnArg assumes that the current argument IS a string (this may be
+checked using <A HREF="$$LINK(GetArgType)">GetArgType</A>). If this is not true, the
+effect of GetStrnArg is unpredictable.

+ 19 - 19
tigcc/doc/System/Include/args.h/GetSymstrArg.hsf

@@ -1,19 +1,19 @@
-[Main]
-Name=GetSymstrArg
-Type=Function
-Subtype=Macro
-Header Files=args.h
-Definition=SYM_STR GetSymstrArg (CESI &ap);
-Real Definition=#define GetSymstrArg(p) ({register ESI __t=(ESI)(p); (ESI)(p)-=2; while(*(ESI)(p)--); (const char*)(__t-1);})
-
-[Description]
-Returns a pointer to the terminating zero byte of the current argument of string type.
-
-[Explanation]
-GetSymstrArg does the same task as <A HREF="$$LINK(GetStrnArg)">GetStrnArg</A> but returns
-a pointer to the terminating zero byte of the string, instead of a pointer to the
-first byte of the string. This function is implemented because nearly all functions for
-TIOS VAT handling need just the pointer to the terminating byte of the string. As
-the arguments are stored in memory as strings which are bounded with zero bytes from
-both sides, the result of GetSymstrArg may be directly passed to TIOS VAT routines.
-See <A HREF="$$LINK(vat.h/)">vat.h</A> for more info.
+[Main]
+Name=GetSymstrArg
+Type=Function
+Subtype=Macro
+Header Files=args.h
+Definition=SYM_STR GetSymstrArg (CESI &ap);
+Real Definition=#define GetSymstrArg(p) ({register ESI __t=(ESI)(p); (ESI)(p)-=2; while(*(ESI)(p)--); (const char*)(__t-1);})
+
+[Description]
+Returns a pointer to the terminating zero byte of the current argument of string type.
+
+[Explanation]
+GetSymstrArg does the same task as <A HREF="$$LINK(GetStrnArg)">GetStrnArg</A> but returns
+a pointer to the terminating zero byte of the string, instead of a pointer to the
+first byte of the string. This function is implemented because nearly all functions for
+TIOS VAT handling need just the pointer to the terminating byte of the string. As
+the arguments are stored in memory as strings which are bounded with zero bytes from
+both sides, the result of GetSymstrArg may be directly passed to TIOS VAT routines.
+See <A HREF="$$LINK(vat.h/)">vat.h</A> for more info.

+ 37 - 37
tigcc/doc/System/Include/args.h/InitArgPtr.hsf

@@ -1,37 +1,37 @@
-[Main]
-Name=InitArgPtr
-Type=Function
-Subtype=Macro
-Header Files=args.h
-Definition=void InitArgPtr (CESI &ap);
-Real Definition=#define InitArgPtr(p) ((void) ((p)=top_estack))
-
-[Description]
-Initializes a pointer to the first argument passed to the program.
-
-[Explanation]
-InitArgPtr is a macro which initializes <I>ap</I> (which is a pointer of type
-<A HREF="$$LINK(estack.h/ESI)">ESI</A>) to point to the first argument passed to the assembly
-program. Principally, calling
-<PRE>InitArgPtr (argptr);
-</PRE>
-is equal to doing
-<PRE>argptr = top_estack;
-</PRE>
-See <A HREF="$$LINK(estack.h/top_estack)">top_estack</A> for more info.
-<BR><BR>
-InitArgPtr must be used before the first call to <A HREF="$$LINK(GetStrnArg)">GetStrnArg</A> etc.
-Here is an example of a program which reads string or integer arguments passed to it,
-and displays them on the screen, one by one (called "Argument Test"):
-$$EXAMPLE(Argument Test.c)
-If the name of this program is <B>example.89z</B>, try to call it on the calculator using
-<PRE>example ("strarg1", 123, -12, "strarg2")
-</PRE>
-to see how it works in practice.
-<BR><BR>
-<B>Note:</B> I used notation "&amp;<I>ap</I>" in the prototype description, although passing by
-reference does not exist in ordinary C (only in C++). However, this macro is implemented
-in such a way that it simulates "passing by reference".
-
-[References]
-Out=estack.h/top_estack
+[Main]
+Name=InitArgPtr
+Type=Function
+Subtype=Macro
+Header Files=args.h
+Definition=void InitArgPtr (CESI &ap);
+Real Definition=#define InitArgPtr(p) ((void) ((p)=top_estack))
+
+[Description]
+Initializes a pointer to the first argument passed to the program.
+
+[Explanation]
+InitArgPtr is a macro which initializes <I>ap</I> (which is a pointer of type
+<A HREF="$$LINK(estack.h/ESI)">ESI</A>) to point to the first argument passed to the assembly
+program. Principally, calling
+<PRE>InitArgPtr (argptr);
+</PRE>
+is equal to doing
+<PRE>argptr = top_estack;
+</PRE>
+See <A HREF="$$LINK(estack.h/top_estack)">top_estack</A> for more info.
+<BR><BR>
+InitArgPtr must be used before the first call to <A HREF="$$LINK(GetStrnArg)">GetStrnArg</A> etc.
+Here is an example of a program which reads string or integer arguments passed to it,
+and displays them on the screen, one by one (called "Argument Test"):
+$$EXAMPLE(Argument Test.c)
+If the name of this program is <B>example.89z</B>, try to call it on the calculator using
+<PRE>example ("strarg1", 123, -12, "strarg2")
+</PRE>
+to see how it works in practice.
+<BR><BR>
+<B>Note:</B> I used notation "&amp;<I>ap</I>" in the prototype description, although passing by
+reference does not exist in ordinary C (only in C++). However, this macro is implemented
+in such a way that it simulates "passing by reference".
+
+[References]
+Out=estack.h/top_estack

+ 24 - 24
tigcc/doc/System/Include/args.h/RemainingArgCnt.hsf

@@ -1,24 +1,24 @@
-[Main]
-Name=RemainingArgCnt
-Type=Function
-Subtype=ROM Call
-Header Files=args.h
-Definition=unsigned short RemainingArgCnt (CESI ap);
-Attributes=__attribute__((__pure__))
-MinAMS=1.01
-See Also=ArgCount
-
-[ROM Call]
-Index=$3C3
-
-[Description]
-Returns the remaining number of arguments passed to the program.
-
-[Explanation]
-RemainingArgCnt returns the number of remaining arguments passed to the called program,
-i.e. the number of arguments which are not yet picked up. It is a simple
-alias for the TIOS function <A HREF="$$LINK(estack.h/remaining_element_count)">remaining_element_count</A>.
-
-[References]
-Out=estack.h/remaining_element_count
-In=ArgCount
+[Main]
+Name=RemainingArgCnt
+Type=Function
+Subtype=ROM Call
+Header Files=args.h
+Definition=unsigned short RemainingArgCnt (CESI ap);
+Attributes=__attribute__((__pure__))
+MinAMS=1.01
+See Also=ArgCount
+
+[ROM Call]
+Index=$3C3
+
+[Description]
+Returns the remaining number of arguments passed to the program.
+
+[Explanation]
+RemainingArgCnt returns the number of remaining arguments passed to the called program,
+i.e. the number of arguments which are not yet picked up. It is a simple
+alias for the TIOS function <A HREF="$$LINK(estack.h/remaining_element_count)">remaining_element_count</A>.
+
+[References]
+Out=estack.h/remaining_element_count
+In=ArgCount

+ 22 - 22
tigcc/doc/System/Include/args.h/SkipArg.hsf

@@ -1,22 +1,22 @@
-[Main]
-Name=SkipArg
-Type=Function
-Subtype=Macro
-Header Files=args.h
-Definition=void SkipArg (CESI &ap);
-Real Definition=#define SkipArg(p) ((void) ((p) = _rom_call(ESI,(ESI),10A) (p)))
-
-[Description]
-Skips the current argument.
-
-[Explanation]
-SkipArg is a macro which modifies <I>ap</I> to point to the next argument in
-the argument list, regardless of its type. Note that this function must not be
-called if <A HREF="$$LINK(GetArgType)">GetArgType</A> returns <A HREF="$$LINK(estack.h/Tags)">END_TAG</A>,
-i.e. if there is no more arguments. Else, an error will be thrown.
-<BR><BR>
-<B>Note:</B> SkipArg is implemented by calling TIOS function
-<A HREF="$$LINK(estack.h/next_expression_index)">next_expression_index</A>.
-
-[References]
-Out=estack.h/next_expression_index
+[Main]
+Name=SkipArg
+Type=Function
+Subtype=Macro
+Header Files=args.h
+Definition=void SkipArg (CESI &ap);
+Real Definition=#define SkipArg(p) ((void) ((p) = _rom_call(ESI,(ESI),10A) (p)))
+
+[Description]
+Skips the current argument.
+
+[Explanation]
+SkipArg is a macro which modifies <I>ap</I> to point to the next argument in
+the argument list, regardless of its type. Note that this function must not be
+called if <A HREF="$$LINK(GetArgType)">GetArgType</A> returns <A HREF="$$LINK(estack.h/Tags)">END_TAG</A>,
+i.e. if there is no more arguments. Else, an error will be thrown.
+<BR><BR>
+<B>Note:</B> SkipArg is implemented by calling TIOS function
+<A HREF="$$LINK(estack.h/next_expression_index)">next_expression_index</A>.
+
+[References]
+Out=estack.h/next_expression_index

+ 6 - 6
tigcc/doc/System/Include/args.h/args.hsh

@@ -1,6 +1,6 @@
-[Description]
-Routines for retrieving arguments passed to the program
-
-[Bottom]
-<B>Note:</B> The header file <A HREF="$$LINK(estack.h/)">estack.h</A> contains a much more powerful set of
-functions to manipulate the expression stack.
+[Description]
+Routines for retrieving arguments passed to the program
+
+[Bottom]
+<B>Note:</B> The header file <A HREF="$$LINK(estack.h/)">estack.h</A> contains a much more powerful set of
+functions to manipulate the expression stack.

+ 12 - 12
tigcc/doc/System/Include/asmtypes.h/BOOL.hsf

@@ -1,12 +1,12 @@
-[Main]
-Name=BOOL
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef unsigned short BOOL;
-
-[Description]
-Boolean type.
-
-[Explanation]
-A type for storing 0 or 1.
+[Main]
+Name=BOOL
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef unsigned short BOOL;
+
+[Description]
+Boolean type.
+
+[Explanation]
+A type for storing 0 or 1.

+ 9 - 9
tigcc/doc/System/Include/asmtypes.h/BYTE.hsf

@@ -1,9 +1,9 @@
-[Main]
-Name=BYTE
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef unsigned char BYTE;
-
-[Description]
-One-byte type.
+[Main]
+Name=BYTE
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef unsigned char BYTE;
+
+[Description]
+One-byte type.

+ 9 - 9
tigcc/doc/System/Include/asmtypes.h/DWORD.hsf

@@ -1,9 +1,9 @@
-[Main]
-Name=DWORD
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef unsigned long DWORD;
-
-[Description]
-Four-byte type.
+[Main]
+Name=DWORD
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef unsigned long DWORD;
+
+[Description]
+Four-byte type.

+ 9 - 9
tigcc/doc/System/Include/asmtypes.h/SBYTE.hsf

@@ -1,9 +1,9 @@
-[Main]
-Name=SBYTE
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef signed char SBYTE;
-
-[Description]
-Signed one-byte type.
+[Main]
+Name=SBYTE
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef signed char SBYTE;
+
+[Description]
+Signed one-byte type.

+ 9 - 9
tigcc/doc/System/Include/asmtypes.h/SCHAR.hsf

@@ -1,9 +1,9 @@
-[Main]
-Name=SCHAR
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef signed char SCHAR;
-
-[Description]
-Signed character type.
+[Main]
+Name=SCHAR
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef signed char SCHAR;
+
+[Description]
+Signed character type.

+ 9 - 9
tigcc/doc/System/Include/asmtypes.h/SDWORD.hsf

@@ -1,9 +1,9 @@
-[Main]
-Name=SDWORD
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef signed long SDWORD;
-
-[Description]
-Signed four-byte type.
+[Main]
+Name=SDWORD
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef signed long SDWORD;
+
+[Description]
+Signed four-byte type.

+ 9 - 9
tigcc/doc/System/Include/asmtypes.h/SINT.hsf

@@ -1,9 +1,9 @@
-[Main]
-Name=SINT
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef signed int SINT;
-
-[Description]
-Signed integer type.
+[Main]
+Name=SINT
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef signed int SINT;
+
+[Description]
+Signed integer type.

+ 9 - 9
tigcc/doc/System/Include/asmtypes.h/SLONG.hsf

@@ -1,9 +1,9 @@
-[Main]
-Name=SLONG
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef signed long SLONG;
-
-[Description]
-Signed long integer type.
+[Main]
+Name=SLONG
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef signed long SLONG;
+
+[Description]
+Signed long integer type.

+ 9 - 9
tigcc/doc/System/Include/asmtypes.h/SSHORT.hsf

@@ -1,9 +1,9 @@
-[Main]
-Name=SSHORT
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef signed short SSHORT;
-
-[Description]
-Signed short integer type.
+[Main]
+Name=SSHORT
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef signed short SSHORT;
+
+[Description]
+Signed short integer type.

+ 9 - 9
tigcc/doc/System/Include/asmtypes.h/SWORD.hsf

@@ -1,9 +1,9 @@
-[Main]
-Name=SWORD
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef signed short SWORD;
-
-[Description]
-Signed two-byte type.
+[Main]
+Name=SWORD
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef signed short SWORD;
+
+[Description]
+Signed two-byte type.

+ 9 - 9
tigcc/doc/System/Include/asmtypes.h/UBYTE.hsf

@@ -1,9 +1,9 @@
-[Main]
-Name=UBYTE
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef unsigned char UBYTE;
-
-[Description]
-Unsigned one-byte type.
+[Main]
+Name=UBYTE
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef unsigned char UBYTE;
+
+[Description]
+Unsigned one-byte type.

+ 9 - 9
tigcc/doc/System/Include/asmtypes.h/UCHAR.hsf

@@ -1,9 +1,9 @@
-[Main]
-Name=UCHAR
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef unsigned char UCHAR;
-
-[Description]
-Unsigned character type.
+[Main]
+Name=UCHAR
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef unsigned char UCHAR;
+
+[Description]
+Unsigned character type.

+ 9 - 9
tigcc/doc/System/Include/asmtypes.h/UDWORD.hsf

@@ -1,9 +1,9 @@
-[Main]
-Name=UDWORD
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef unsigned long UDWORD;
-
-[Description]
-Unsigned four-byte type.
+[Main]
+Name=UDWORD
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef unsigned long UDWORD;
+
+[Description]
+Unsigned four-byte type.

+ 9 - 9
tigcc/doc/System/Include/asmtypes.h/UINT.hsf

@@ -1,9 +1,9 @@
-[Main]
-Name=UINT
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef unsigned int UINT;
-
-[Description]
-Unsigned integer type.
+[Main]
+Name=UINT
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef unsigned int UINT;
+
+[Description]
+Unsigned integer type.

+ 9 - 9
tigcc/doc/System/Include/asmtypes.h/ULONG.hsf

@@ -1,9 +1,9 @@
-[Main]
-Name=ULONG
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef unsigned long ULONG;
-
-[Description]
-Unsigned long integer type.
+[Main]
+Name=ULONG
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef unsigned long ULONG;
+
+[Description]
+Unsigned long integer type.

+ 9 - 9
tigcc/doc/System/Include/asmtypes.h/USHORT.hsf

@@ -1,9 +1,9 @@
-[Main]
-Name=USHORT
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef unsigned short USHORT;
-
-[Description]
-Unsigned short integer type.
+[Main]
+Name=USHORT
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef unsigned short USHORT;
+
+[Description]
+Unsigned short integer type.

+ 9 - 9
tigcc/doc/System/Include/asmtypes.h/UWORD.hsf

@@ -1,9 +1,9 @@
-[Main]
-Name=UWORD
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef unsigned short UWORD;
-
-[Description]
-Unsigned two-byte type.
+[Main]
+Name=UWORD
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef unsigned short UWORD;
+
+[Description]
+Unsigned two-byte type.

+ 9 - 9
tigcc/doc/System/Include/asmtypes.h/WORD.hsf

@@ -1,9 +1,9 @@
-[Main]
-Name=WORD
-Type=Type
-Subtype=Scalar
-Header Files=asmtypes.h
-Definition=typedef unsigned short WORD;
-
-[Description]
-Two-byte type.
+[Main]
+Name=WORD
+Type=Type
+Subtype=Scalar
+Header Files=asmtypes.h
+Definition=typedef unsigned short WORD;
+
+[Description]
+Two-byte type.

+ 5 - 5
tigcc/doc/System/Include/asmtypes.h/asmtypes.hsh

@@ -1,5 +1,5 @@
-[Description]
-Common type definitions known to ASM programmers
-
-[Top]
-This header file contains a set of predefined types which are common in assembly programs.
+[Description]
+Common type definitions known to ASM programmers
+
+[Top]
+This header file contains a set of predefined types which are common in assembly programs.

+ 52 - 52
tigcc/doc/System/Include/assert.h/assert.hsf

@@ -1,52 +1,52 @@
-[Main]
-Name=assert
-Type=Function
-Subtype=Macro
-Header Files=assert.h
-Definition=void assert (short condition);
-Real Definition=#define assert(p) ((p) ? (void) 0 : __assertion_failed (#p, __FILE__, __LINE__))
-
-[Description]
-Tests a condition and possibly aborts.
-
-[Explanation]
-assert is a macro for debugging purposes that expands to an if statement.
-If <I>condition</I> evaluates to zero, assert opens an error message box, waits for
-a keypress, then abort the program. Here is a HTMLized "picture" which shows principally
-how such message box looks like:
-<BR><BR>
-<CENTER>
-<TABLE BORDER CELLPADDING="3">
-<TR><TD>
-<CENTER>
-<B>ASSERTION FAILED</B>
-</CENTER>
-</TD></TR>
-<TR><TD>
-<BR>
-&nbsp;&nbsp;<B>Condition:</B> <I>condition_written_as_text</I>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-<BR><BR>
-&nbsp;&nbsp;<B>File:</B> <I>filename</I>&nbsp;&nbsp;&nbsp;<B>Line:</B> <I>linenum</I>
-<BR><BR><BR>
-<TABLE BORDER><TR><TD><B>&nbsp;&nbsp;Enter=OK&nbsp;&nbsp;</B></TD></TR></TABLE>
-</TD></TR>
-</TABLE>
-</CENTER>
-<BR>
-The <I>filename</I> and <I>linenum</I> listed in the message box are the source file name and
-line number where the assert macro appears. assert expands to relatively big code, so if you have
-many assert statements in the program, it may become quite long relatively fast. But, if you place
-the directive
-<PRE>#define NDEBUG
-</PRE>
-("no debugging") in the source code before the
-<PRE>#include &lt;assert.h&gt;
-</PRE>
-directive, the assert statement will be ignored.
-<BR><BR>
-It might be hard to use this function if you are compiling your program with the <A HREF="$$INFOLINK(ide)">IDE</A>
-(it is possible to get wrong line numbers). In any case, turning off file splitting may be useful.
-
-[References]
-Out=graph.h/ScrRect, kbd.h/ngetchx, wingraph.h/DrawStaticButton, wingraph.h/MakeWinRect, wingraph.h/WinClose, wingraph.h/WinFont, wingraph.h/WinOpen, wingraph.h/WinStr, stdio.h/sprintf
+[Main]
+Name=assert
+Type=Function
+Subtype=Macro
+Header Files=assert.h
+Definition=void assert (short condition);
+Real Definition=#define assert(p) ((p) ? (void) 0 : __assertion_failed (#p, __FILE__, __LINE__))
+
+[Description]
+Tests a condition and possibly aborts.
+
+[Explanation]
+assert is a macro for debugging purposes that expands to an if statement.
+If <I>condition</I> evaluates to zero, assert opens an error message box, waits for
+a keypress, then abort the program. Here is a HTMLized "picture" which shows principally
+how such message box looks like:
+<BR><BR>
+<CENTER>
+<TABLE BORDER CELLPADDING="3">
+<TR><TD>
+<CENTER>
+<B>ASSERTION FAILED</B>
+</CENTER>
+</TD></TR>
+<TR><TD>
+<BR>
+&nbsp;&nbsp;<B>Condition:</B> <I>condition_written_as_text</I>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+<BR><BR>
+&nbsp;&nbsp;<B>File:</B> <I>filename</I>&nbsp;&nbsp;&nbsp;<B>Line:</B> <I>linenum</I>
+<BR><BR><BR>
+<TABLE BORDER><TR><TD><B>&nbsp;&nbsp;Enter=OK&nbsp;&nbsp;</B></TD></TR></TABLE>
+</TD></TR>
+</TABLE>
+</CENTER>
+<BR>
+The <I>filename</I> and <I>linenum</I> listed in the message box are the source file name and
+line number where the assert macro appears. assert expands to relatively big code, so if you have
+many assert statements in the program, it may become quite long relatively fast. But, if you place
+the directive
+<PRE>#define NDEBUG
+</PRE>
+("no debugging") in the source code before the
+<PRE>#include &lt;assert.h&gt;
+</PRE>
+directive, the assert statement will be ignored.
+<BR><BR>
+It might be hard to use this function if you are compiling your program with the <A HREF="$$INFOLINK(ide)">IDE</A>
+(it is possible to get wrong line numbers). In any case, turning off file splitting may be useful.
+
+[References]
+Out=graph.h/ScrRect, kbd.h/ngetchx, wingraph.h/DrawStaticButton, wingraph.h/MakeWinRect, wingraph.h/WinClose, wingraph.h/WinFont, wingraph.h/WinOpen, wingraph.h/WinStr, stdio.h/sprintf

+ 2 - 2
tigcc/doc/System/Include/assert.h/assert.hsh

@@ -1,2 +1,2 @@
-[Description]
-Assert routine for debugging purposes
+[Description]
+Assert routine for debugging purposes

+ 18 - 18
tigcc/doc/System/Include/bascmd.h/bascmd.hsh

@@ -1,18 +1,18 @@
-[Main]
-See Also=basfunc.h/, basop.h/
-
-[Description]
-Routines for executing TI-Basic commands
-
-[Bottom]
-<B>Note:</B> All functions from this header file get parameters from the expression stack, so this
-header file must be used in conjunction with <A HREF="$$LINK(estack.h/)">estack.h</A>. You need to
-learn about the usage of the expression stack before using any function from this header file.
-All functions defined here execute particular TI-Basic commands. They sometimes
-may be useful to perform some operations which can not be implemented in C easily. But note that
-if you use functions from this header file too much, this will decrease the performance of your
-program significantly. In an extreme case, it will in fact decrease to that of a TI-Basic program! So
-use functions from this header file only if it is really necessary. Also note that these
-functions act exactly like the appropriate TI-Basic commands (including throwing errors if
-something is wrong), so the use of an error tracking mechanism from the <A HREF="$$LINK(error.h/)">error.h</A>
-header file is highly recommended.
+[Main]
+See Also=basfunc.h/, basop.h/
+
+[Description]
+Routines for executing TI-Basic commands
+
+[Bottom]
+<B>Note:</B> All functions from this header file get parameters from the expression stack, so this
+header file must be used in conjunction with <A HREF="$$LINK(estack.h/)">estack.h</A>. You need to
+learn about the usage of the expression stack before using any function from this header file.
+All functions defined here execute particular TI-Basic commands. They sometimes
+may be useful to perform some operations which can not be implemented in C easily. But note that
+if you use functions from this header file too much, this will decrease the performance of your
+program significantly. In an extreme case, it will in fact decrease to that of a TI-Basic program! So
+use functions from this header file only if it is really necessary. Also note that these
+functions act exactly like the appropriate TI-Basic commands (including throwing errors if
+something is wrong), so the use of an error tracking mechanism from the <A HREF="$$LINK(error.h/)">error.h</A>
+header file is highly recommended.

+ 30 - 30
tigcc/doc/System/Include/bascmd.h/cmd_andpic.hsf

@@ -1,30 +1,30 @@
-[Main]
-Name=cmd_andpic
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_andpic (SYM_STR SymName, CESI y, CESI x);
-MinAMS=1.01
-See Also=cmd_rclpic, cmd_xorpic, cmd_rplcpic, cmd_stopic, graph.h/BitmapPut
-
-[ROM Call]
-Index=$32A
-
-[Description]
-Executes TI-Basic 'AndPic' command.
-
-[Explanation]
-cmd_andpic displays the Graph Screen and logically ANDs the picture stored in
-the TI-Basic variable pointed to by <I>SymName</I> (a VAT variable string,
-see <A HREF="$$LINK(vat.h/SYMSTR)">SYMSTR</A>) into the current graph screen
-at the pixel coordinates determined by the values pointed to by <I>y</I> and
-<I>x</I>, respectively. Both <I>x</I> and <I>y</I> should point to integer items.
-<I>SymName</I> should be the name of a PIC variable.
-<BR><BR>
-See <A HREF="$$LINK(graph.h/BitmapPut)">BitmapPut</A> for much faster
-low-level manipulations with bitmap pictures, independently of the Graph
-Screen.
-
-[References]
-Out=estack.h/GetValue, estack.h/HToESI, graphing.h/gr_active, unknown.h/GraphActivate, vat.h/DerefSym, vat.h/VarRecall, wingraph.h/WinBitmapPut
-Out_EV_eventLoop=1
+[Main]
+Name=cmd_andpic
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_andpic (SYM_STR SymName, CESI y, CESI x);
+MinAMS=1.01
+See Also=cmd_rclpic, cmd_xorpic, cmd_rplcpic, cmd_stopic, graph.h/BitmapPut
+
+[ROM Call]
+Index=$32A
+
+[Description]
+Executes TI-Basic 'AndPic' command.
+
+[Explanation]
+cmd_andpic displays the Graph Screen and logically ANDs the picture stored in
+the TI-Basic variable pointed to by <I>SymName</I> (a VAT variable string,
+see <A HREF="$$LINK(vat.h/SYMSTR)">SYMSTR</A>) into the current graph screen
+at the pixel coordinates determined by the values pointed to by <I>y</I> and
+<I>x</I>, respectively. Both <I>x</I> and <I>y</I> should point to integer items.
+<I>SymName</I> should be the name of a PIC variable.
+<BR><BR>
+See <A HREF="$$LINK(graph.h/BitmapPut)">BitmapPut</A> for much faster
+low-level manipulations with bitmap pictures, independently of the Graph
+Screen.
+
+[References]
+Out=estack.h/GetValue, estack.h/HToESI, graphing.h/gr_active, unknown.h/GraphActivate, vat.h/DerefSym, vat.h/VarRecall, wingraph.h/WinBitmapPut
+Out_EV_eventLoop=1

+ 24 - 24
tigcc/doc/System/Include/bascmd.h/cmd_archive.hsf

@@ -1,24 +1,24 @@
-[Main]
-Name=cmd_archive
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_archive (CESI VarNameList);
-MinAMS=2.00
-See Also=cmd_unarchiv, cmd_lock, cmd_unlock
-
-[ROM Call]
-Index=$448
-
-[Description]
-Executes TI-Basic 'Archive' command.
-
-[Explanation]
-cmd_archive archives one or more TI-Basic variables (i.e. VAT symbols). For
-details about <I>VarNameList</I>, see
-<A HREF="$$LINK(cmd_lock)">cmd_lock</A>.
-
-[References]
-In=link.h/OSLinkCmd, vat.h/EM_moveSymToExtMem
-Out=estack.h/HToESI, estack.h/next_expression_index, vat.h/CheckSysFunc, vat.h/DerefSym, vat.h/EM_moveSymToExtMem, vat.h/SymDelTwin, vat.h/VarRecall, unknown.h/_ROM_CALL_5CA
-Out_EV_eventLoop=1
+[Main]
+Name=cmd_archive
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_archive (CESI VarNameList);
+MinAMS=2.00
+See Also=cmd_unarchiv, cmd_lock, cmd_unlock
+
+[ROM Call]
+Index=$448
+
+[Description]
+Executes TI-Basic 'Archive' command.
+
+[Explanation]
+cmd_archive archives one or more TI-Basic variables (i.e. VAT symbols). For
+details about <I>VarNameList</I>, see
+<A HREF="$$LINK(cmd_lock)">cmd_lock</A>.
+
+[References]
+In=link.h/OSLinkCmd, vat.h/EM_moveSymToExtMem
+Out=estack.h/HToESI, estack.h/next_expression_index, vat.h/CheckSysFunc, vat.h/DerefSym, vat.h/EM_moveSymToExtMem, vat.h/SymDelTwin, vat.h/VarRecall, unknown.h/_ROM_CALL_5CA
+Out_EV_eventLoop=1

文件差異過大導致無法顯示
+ 0 - 33
tigcc/doc/System/Include/bascmd.h/cmd_blddata.hsf


文件差異過大導致無法顯示
+ 0 - 38
tigcc/doc/System/Include/bascmd.h/cmd_circle.hsf


+ 21 - 21
tigcc/doc/System/Include/bascmd.h/cmd_clrdraw.hsf

@@ -1,21 +1,21 @@
-[Main]
-Name=cmd_clrdraw
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_clrdraw (void);
-MinAMS=1.01
-
-[ROM Call]
-Index=$32D
-
-[Description]
-Executes TI-Basic 'ClrDraw' command.
-
-[Explanation]
-cmd_clrdraw clears the Graph Screen window and resets the Smart Graph feature, so that the
-next time the Graph Screen is displayed, the graph will be redrawn.
-
-[References]
-In=cmd_newprob
-Out=graphing.h/gr_active
+[Main]
+Name=cmd_clrdraw
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_clrdraw (void);
+MinAMS=1.01
+
+[ROM Call]
+Index=$32D
+
+[Description]
+Executes TI-Basic 'ClrDraw' command.
+
+[Explanation]
+cmd_clrdraw clears the Graph Screen window and resets the Smart Graph feature, so that the
+next time the Graph Screen is displayed, the graph will be redrawn.
+
+[References]
+In=cmd_newprob
+Out=graphing.h/gr_active

+ 28 - 28
tigcc/doc/System/Include/bascmd.h/cmd_clrerr.hsf

@@ -1,28 +1,28 @@
-[Main]
-Name=cmd_clrerr
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_clrerr (void);
-MinAMS=1.01
-See Also=cmd_try, cmd_passerr
-
-[ROM Call]
-Index=$32E
-
-[Description]
-Executes TI-Basic 'ClrErr' command.
-
-[Explanation]
-cmd_clrerr sets the TI-Basic system variable "errornum" to zero and clears the internal
-error context variables.
-<BR><BR>
-<B>Note:</B> See <A HREF="$$LINK(error.h/TRY)">TRY</A>,
-<A HREF="$$LINK(error.h/ONERR)">ONERR</A>, and
-<A HREF="$$LINK(error.h/ENDTRY)">ENDTRY</A> to learn how to take control over
-errors while executing a C program.
-
-[References]
-In=cmd_newprob
-Out=unknown.h/clear_error_context, unknown.h/Float0Index, vat.h/VarStore
-Out_EV_eventLoop=1
+[Main]
+Name=cmd_clrerr
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_clrerr (void);
+MinAMS=1.01
+See Also=cmd_try, cmd_passerr
+
+[ROM Call]
+Index=$32E
+
+[Description]
+Executes TI-Basic 'ClrErr' command.
+
+[Explanation]
+cmd_clrerr sets the TI-Basic system variable "errornum" to zero and clears the internal
+error context variables.
+<BR><BR>
+<B>Note:</B> See <A HREF="$$LINK(error.h/TRY)">TRY</A>,
+<A HREF="$$LINK(error.h/ONERR)">ONERR</A>, and
+<A HREF="$$LINK(error.h/ENDTRY)">ENDTRY</A> to learn how to take control over
+errors while executing a C program.
+
+[References]
+In=cmd_newprob
+Out=unknown.h/clear_error_context, unknown.h/Float0Index, vat.h/VarStore
+Out_EV_eventLoop=1

+ 27 - 27
tigcc/doc/System/Include/bascmd.h/cmd_clrgraph.hsf

@@ -1,27 +1,27 @@
-[Main]
-Name=cmd_clrgraph
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_clrgraph (void);
-MinAMS=1.01
-See Also=cmd_graph, cmd_table
-
-[ROM Call]
-Index=$32F
-
-[Description]
-Executes TI-Basic 'ClrGraph' command.
-
-[Explanation]
-cmd_clrgraph clears all functions or expressions that were graphed with the
-TI-Basic Graph command (or <A HREF="$$LINK(cmd_graph)">cmd_graph</A> from
-this header file), or were created with the TI-Basic Table command (or
-<A HREF="$$LINK(cmd_table)">cmd_table</A> from this header file).
-All previously selected functions in the Y= Editor application will be
-graphed the next time that the graph is displayed.
-
-[References]
-In=cmd_newprob
-Out=graphing.h/gr_active, unknown.h/gr_DelFolder
-Out_EV_eventLoop=1
+[Main]
+Name=cmd_clrgraph
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_clrgraph (void);
+MinAMS=1.01
+See Also=cmd_graph, cmd_table
+
+[ROM Call]
+Index=$32F
+
+[Description]
+Executes TI-Basic 'ClrGraph' command.
+
+[Explanation]
+cmd_clrgraph clears all functions or expressions that were graphed with the
+TI-Basic Graph command (or <A HREF="$$LINK(cmd_graph)">cmd_graph</A> from
+this header file), or were created with the TI-Basic Table command (or
+<A HREF="$$LINK(cmd_table)">cmd_table</A> from this header file).
+All previously selected functions in the Y= Editor application will be
+graphed the next time that the graph is displayed.
+
+[References]
+In=cmd_newprob
+Out=graphing.h/gr_active, unknown.h/gr_DelFolder
+Out_EV_eventLoop=1

+ 23 - 23
tigcc/doc/System/Include/bascmd.h/cmd_clrhome.hsf

@@ -1,23 +1,23 @@
-[Main]
-Name=cmd_clrhome
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_clrhome (void);
-MinAMS=1.01
-See Also=homescr.h/HS_freeAll, estack.h/ARb_real_count, estack.h/ARb_int_count
-
-[ROM Call]
-Index=$330
-
-[Description]
-Executes TI-Basic 'ClrHome' command.
-
-[Explanation]
-cmd_clrhome clears all items stored in the Home Screen history area and clears the Home Screen
-window. It also resets the suffixes of arbitrary constants or integers (like
-<B>@1</B>, <B>@n2</B>, etc.) to 1.
-
-[References]
-Out=estack.h/ARb_int_count, estack.h/ARb_real_count, homescr.h/HS_freeAll, wingraph.h/WinClr
-In=cmd_newprob
+[Main]
+Name=cmd_clrhome
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_clrhome (void);
+MinAMS=1.01
+See Also=homescr.h/HS_freeAll, estack.h/ARb_real_count, estack.h/ARb_int_count
+
+[ROM Call]
+Index=$330
+
+[Description]
+Executes TI-Basic 'ClrHome' command.
+
+[Explanation]
+cmd_clrhome clears all items stored in the Home Screen history area and clears the Home Screen
+window. It also resets the suffixes of arbitrary constants or integers (like
+<B>@1</B>, <B>@n2</B>, etc.) to 1.
+
+[References]
+Out=estack.h/ARb_int_count, estack.h/ARb_real_count, homescr.h/HS_freeAll, wingraph.h/WinClr
+In=cmd_newprob

+ 21 - 21
tigcc/doc/System/Include/bascmd.h/cmd_clrio.hsf

@@ -1,21 +1,21 @@
-[Main]
-Name=cmd_clrio
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_clrio (void);
-MinAMS=1.01
-
-[ROM Call]
-Index=$331
-
-[Description]
-Executes TI-Basic 'ClrIO' command.
-
-[Explanation]
-cmd_clrio clears the TI-Basic Program I/O Screen window (without displaying it to the screen),
-and sets the Program I/O Screen window cursor position to the upper left corner.
-
-[References]
-Out=wingraph.h/WinClr
-In=cmd_newprob
+[Main]
+Name=cmd_clrio
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_clrio (void);
+MinAMS=1.01
+
+[ROM Call]
+Index=$331
+
+[Description]
+Executes TI-Basic 'ClrIO' command.
+
+[Explanation]
+cmd_clrio clears the TI-Basic Program I/O Screen window (without displaying it to the screen),
+and sets the Program I/O Screen window cursor position to the upper left corner.
+
+[References]
+Out=wingraph.h/WinClr
+In=cmd_newprob

+ 22 - 22
tigcc/doc/System/Include/bascmd.h/cmd_clrtable.hsf

@@ -1,22 +1,22 @@
-[Main]
-Name=cmd_clrtable
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_clrtable (void);
-MinAMS=1.01
-
-[ROM Call]
-Index=$332
-
-[Description]
-Executes TI-Basic 'ClrTable' command.
-
-[Explanation]
-cmd_clrtable clears all table values. This applies only to the ASK setting on the Table Setup
-dialog box. See the TI-Basic manual for more info.
-
-[References]
-In=cmd_newprob
-Out=alloc.h/HeapFree, dialogs.h/Dialog, graphing.h/gr_active, unknown.h/CreateEmptyList
-Out_EV_eventLoop=1
+[Main]
+Name=cmd_clrtable
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_clrtable (void);
+MinAMS=1.01
+
+[ROM Call]
+Index=$332
+
+[Description]
+Executes TI-Basic 'ClrTable' command.
+
+[Explanation]
+cmd_clrtable clears all table values. This applies only to the ASK setting on the Table Setup
+dialog box. See the TI-Basic manual for more info.
+
+[References]
+In=cmd_newprob
+Out=alloc.h/HeapFree, dialogs.h/Dialog, graphing.h/gr_active, unknown.h/CreateEmptyList
+Out_EV_eventLoop=1

+ 25 - 25
tigcc/doc/System/Include/bascmd.h/cmd_copyvar.hsf

@@ -1,25 +1,25 @@
-[Main]
-Name=cmd_copyvar
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_copyvar (SYM_STR SrcName, SYM_STR DestName);
-MinAMS=1.01
-See Also=cmd_movevar, cmd_rename
-
-[ROM Call]
-Index=$333
-
-[Description]
-Executes TI-Basic 'CopyVar' command.
-
-[Explanation]
-cmd_copyvar copies the contents of one TI-Basic variable to another one. The parameters
-<I>SrcName</I> and <I>DestName</I> should point to the variable tags of the source and the
-destination variable, respectively. If the destination variable does not
-exist, cmd_copyvar creates it. This function may be used instead of low-level
-routines from <A HREF="$$LINK(vat.h/)">vat.h</A>.
-
-[References]
-Out=unknown.h/_ROM_CALL_438
-Out_EV_eventLoop=1
+[Main]
+Name=cmd_copyvar
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_copyvar (SYM_STR SrcName, SYM_STR DestName);
+MinAMS=1.01
+See Also=cmd_movevar, cmd_rename
+
+[ROM Call]
+Index=$333
+
+[Description]
+Executes TI-Basic 'CopyVar' command.
+
+[Explanation]
+cmd_copyvar copies the contents of one TI-Basic variable to another one. The parameters
+<I>SrcName</I> and <I>DestName</I> should point to the variable tags of the source and the
+destination variable, respectively. If the destination variable does not
+exist, cmd_copyvar creates it. This function may be used instead of low-level
+routines from <A HREF="$$LINK(vat.h/)">vat.h</A>.
+
+[References]
+Out=unknown.h/_ROM_CALL_438
+Out_EV_eventLoop=1

文件差異過大導致無法顯示
+ 0 - 22
tigcc/doc/System/Include/bascmd.h/cmd_cubicreg.hsf


+ 20 - 20
tigcc/doc/System/Include/bascmd.h/cmd_custmoff.hsf

@@ -1,20 +1,20 @@
-[Main]
-Name=cmd_custmoff
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_custmoff (void);
-MinAMS=1.01
-
-[ROM Call]
-Index=$335
-
-[Description]
-Executes TI-Basic 'CustmOff' command.
-
-[Explanation]
-cmd_custmoff removes the custom toolbar menu in the current application.
-The custom toolbar is removed automatically when you change the application.
-
-[References]
-Out=unknown.h/CustomEnd
+[Main]
+Name=cmd_custmoff
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_custmoff (void);
+MinAMS=1.01
+
+[ROM Call]
+Index=$335
+
+[Description]
+Executes TI-Basic 'CustmOff' command.
+
+[Explanation]
+cmd_custmoff removes the custom toolbar menu in the current application.
+The custom toolbar is removed automatically when you change the application.
+
+[References]
+Out=unknown.h/CustomEnd

+ 20 - 20
tigcc/doc/System/Include/bascmd.h/cmd_custmon.hsf

@@ -1,20 +1,20 @@
-[Main]
-Name=cmd_custmon
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_custmon (void);
-MinAMS=1.01
-See Also=cmd_toolbar, menus.h/
-
-[ROM Call]
-Index=$336
-
-[Description]
-Executes TI-Basic 'CustmOn' command.
-
-[Explanation]
-cmd_custmon activates a custom toolbar menu in the current application.
-
-[References]
-Out=unknown.h/CustomBegin
+[Main]
+Name=cmd_custmon
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_custmon (void);
+MinAMS=1.01
+See Also=cmd_toolbar, menus.h/
+
+[ROM Call]
+Index=$336
+
+[Description]
+Executes TI-Basic 'CustmOn' command.
+
+[Explanation]
+cmd_custmon activates a custom toolbar menu in the current application.
+
+[References]
+Out=unknown.h/CustomBegin

+ 29 - 29
tigcc/doc/System/Include/bascmd.h/cmd_custom.hsf

@@ -1,29 +1,29 @@
-[Main]
-Name=cmd_custom
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_custom (void);
-MinAMS=1.01
-See Also=cmd_toolbar, menus.h/
-
-[ROM Call]
-Index=$337
-
-[Description]
-Executes TI-Basic 'Custom' command.
-
-[Explanation]
-cmd_custom is an internal subroutine used by the TI-Basic interpreter for defining
-custom menus using 'Custom'...'EndCustm' blocks.
-As this function depends heavily on some system state variables of the
-TI-Basic intepreter which are not set correctly while executing an ASM
-program, it is extremely unlikely that this function may be used inside a C
-program for anything useful.
-<BR><BR>
-<B>Note:</B> Look at the functions from <A HREF="$$LINK(menus.h/)">menus.h</A> if you want to make menus inside a
-C program.
-
-[References]
-Out=alloc.h/HeapAllocThrow, alloc.h/HeapFreeIndir, error.h/ER_catch, error.h/ER_success, error.h/ER_throwVar, estack.h/HToESI, estack.h/next_expression_index, estack.h/top_estack, menus.h/MenuAddIcon, menus.h/MenuAddText, menus.h/MenuNew, string.h/strlen, system.h/NeedStack, unknown.h/CustomFree, estack.h/push_simplify, unknown.h/ReallocExprStruct, vat.h/DerefSym, vat.h/VarRecall, unknown.h/_ROM_CALL_5C8
-Out_EV_eventLoop=1
+[Main]
+Name=cmd_custom
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_custom (void);
+MinAMS=1.01
+See Also=cmd_toolbar, menus.h/
+
+[ROM Call]
+Index=$337
+
+[Description]
+Executes TI-Basic 'Custom' command.
+
+[Explanation]
+cmd_custom is an internal subroutine used by the TI-Basic interpreter for defining
+custom menus using 'Custom'...'EndCustm' blocks.
+As this function depends heavily on some system state variables of the
+TI-Basic intepreter which are not set correctly while executing an ASM
+program, it is extremely unlikely that this function may be used inside a C
+program for anything useful.
+<BR><BR>
+<B>Note:</B> Look at the functions from <A HREF="$$LINK(menus.h/)">menus.h</A> if you want to make menus inside a
+C program.
+
+[References]
+Out=alloc.h/HeapAllocThrow, alloc.h/HeapFreeIndir, error.h/ER_catch, error.h/ER_success, error.h/ER_throwVar, estack.h/HToESI, estack.h/next_expression_index, estack.h/top_estack, menus.h/MenuAddIcon, menus.h/MenuAddText, menus.h/MenuNew, string.h/strlen, system.h/NeedStack, unknown.h/CustomFree, estack.h/push_simplify, unknown.h/ReallocExprStruct, vat.h/DerefSym, vat.h/VarRecall, unknown.h/_ROM_CALL_5C8
+Out_EV_eventLoop=1

+ 29 - 29
tigcc/doc/System/Include/bascmd.h/cmd_cycle.hsf

@@ -1,29 +1,29 @@
-[Main]
-Name=cmd_cycle
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_cycle (void);
-MinAMS=1.01
-
-[ROM Call]
-Index=$338
-
-[Description]
-Executes TI-Basic 'Cycle' command.
-
-[Explanation]
-cmd_cycle is an internal subroutine used by the TI-Basic interpreter for
-executing the Cycle command (performs searching for a matching For/EndFor
-instruction, etc.).
-As this function depends heavily on some system state variables of the
-TI-Basic intepreter which are not set correctly while executing an ASM
-program, it is extremely unlikely that this function may be used inside a C
-program for anything useful.
-<BR><BR>
-<B>Note:</B> If you want to achieve a similar effect in the C language like
-using the Cycle command in TI-Basic, you should use the
-<CODE><A HREF="$$INFOLINK(keywords/continue)">continue</A></CODE> keyword.
-
-[References]
-Out=estack.h/next_expression_index, unknown.h/index_after_match_endtag, unknown.h/_ROM_CALL_5C8
+[Main]
+Name=cmd_cycle
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_cycle (void);
+MinAMS=1.01
+
+[ROM Call]
+Index=$338
+
+[Description]
+Executes TI-Basic 'Cycle' command.
+
+[Explanation]
+cmd_cycle is an internal subroutine used by the TI-Basic interpreter for
+executing the Cycle command (performs searching for a matching For/EndFor
+instruction, etc.).
+As this function depends heavily on some system state variables of the
+TI-Basic intepreter which are not set correctly while executing an ASM
+program, it is extremely unlikely that this function may be used inside a C
+program for anything useful.
+<BR><BR>
+<B>Note:</B> If you want to achieve a similar effect in the C language like
+using the Cycle command in TI-Basic, you should use the
+<CODE><A HREF="$$INFOLINK(keywords/continue)">continue</A></CODE> keyword.
+
+[References]
+Out=estack.h/next_expression_index, unknown.h/index_after_match_endtag, unknown.h/_ROM_CALL_5C8

+ 47 - 47
tigcc/doc/System/Include/bascmd.h/cmd_cyclepic.hsf

@@ -1,47 +1,47 @@
-[Main]
-Name=cmd_cyclepic
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_cyclepic (CESI PicNamePrefix, CESI n, CESI wait, CESI cycles, CESI direction);
-MinAMS=1.01
-
-[ROM Call]
-Index=$339
-
-[Description]
-Executes TI-Basic 'CyclePic' command.
-
-[Explanation]
-cmd_cyclepic implements the TI-Basic CyclePic command, which displays the
-Graph Screen and then displays a series of pictures (a slide show) on it in a
-cycle. The <I>PicNamePrefix</I> parameter should point to a string item on
-the expression stack (more precise, to its <A HREF="$$LINK(estack.h/Tags)">STR_TAG</A>),
-and <I>n</I> should point to an integer item which determines the total
-number of pictures.
-<BR><BR>
-The names of the TI-Basic PIC variables which contain the
-picture data will be derived from <I>PicNamePrefix</I> and <I>n</I>. For
-example, if <I>PicNamePrefix</I> points to "pic" and <I>n</I> points to 5,
-the picture data will be picked from TI-Basic PIC variables
-called "pic1", "pic2", "pic3", "pic4" and "pic5".
-<BR><BR>
-The <I>wait</I> parameter should point to an integer or floating point item which
-determines the time between pictures. <I>cycles</I> should point to an
-integer item which determines the number of times to cycle through the
-pictures. <I>direction</I> should point to an integer item containing 1 or -1.
-If it is 1, the pictures will be displayed in a normal loop, and if it is -1,
-the loop will run in both directions.
-<BR><BR>
-<B>Note:</B> The TI-Basic command CyclePic is implemented to allow making
-simple animations in the TI-Basic. Although this function principally may be
-used in C to accomplish the same task, the usage of it is tedious and there
-are much better ways for doing this in C which are also independent of the
-Graph Screen. Take a look at the functions from
-<A HREF="$$LINK(graph.h/)">graph.h</A>,
-<A HREF="$$LINK(wingraph.h/)">wingraph.h</A>, and
-<A HREF="$$LINK(sprites.h/)">sprites.h</A>.
-
-[References]
-Out=estack.h/GetValue, estack.h/HToESI, estack.h/next_expression_index, graphing.h/gr_active, mem.h/memset, stdio.h/sprintf, string.h/strlen, system.h/idle, system.h/OSCheckBreak, system.h/OSFreeTimer, system.h/OSRegisterTimer, system.h/OSTimerExpired, unknown.h/ForceFloat, unknown.h/GraphActivate, vat.h/DerefSym, vat.h/FindSymInFolder, vat.h/TempFolderName, vat.h/ValidateSymName, vat.h/VarRecall, wingraph.h/WinBitmapPut, unknown.h/_bcd_math
-Out_EV_eventLoop=1
+[Main]
+Name=cmd_cyclepic
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_cyclepic (CESI PicNamePrefix, CESI n, CESI wait, CESI cycles, CESI direction);
+MinAMS=1.01
+
+[ROM Call]
+Index=$339
+
+[Description]
+Executes TI-Basic 'CyclePic' command.
+
+[Explanation]
+cmd_cyclepic implements the TI-Basic CyclePic command, which displays the
+Graph Screen and then displays a series of pictures (a slide show) on it in a
+cycle. The <I>PicNamePrefix</I> parameter should point to a string item on
+the expression stack (more precise, to its <A HREF="$$LINK(estack.h/Tags)">STR_TAG</A>),
+and <I>n</I> should point to an integer item which determines the total
+number of pictures.
+<BR><BR>
+The names of the TI-Basic PIC variables which contain the
+picture data will be derived from <I>PicNamePrefix</I> and <I>n</I>. For
+example, if <I>PicNamePrefix</I> points to "pic" and <I>n</I> points to 5,
+the picture data will be picked from TI-Basic PIC variables
+called "pic1", "pic2", "pic3", "pic4" and "pic5".
+<BR><BR>
+The <I>wait</I> parameter should point to an integer or floating point item which
+determines the time between pictures. <I>cycles</I> should point to an
+integer item which determines the number of times to cycle through the
+pictures. <I>direction</I> should point to an integer item containing 1 or -1.
+If it is 1, the pictures will be displayed in a normal loop, and if it is -1,
+the loop will run in both directions.
+<BR><BR>
+<B>Note:</B> The TI-Basic command CyclePic is implemented to allow making
+simple animations in the TI-Basic. Although this function principally may be
+used in C to accomplish the same task, the usage of it is tedious and there
+are much better ways for doing this in C which are also independent of the
+Graph Screen. Take a look at the functions from
+<A HREF="$$LINK(graph.h/)">graph.h</A>,
+<A HREF="$$LINK(wingraph.h/)">wingraph.h</A>, and
+<A HREF="$$LINK(sprites.h/)">sprites.h</A>.
+
+[References]
+Out=estack.h/GetValue, estack.h/HToESI, estack.h/next_expression_index, graphing.h/gr_active, mem.h/memset, stdio.h/sprintf, string.h/strlen, system.h/idle, system.h/OSCheckBreak, system.h/OSFreeTimer, system.h/OSRegisterTimer, system.h/OSTimerExpired, unknown.h/ForceFloat, unknown.h/GraphActivate, vat.h/DerefSym, vat.h/FindSymInFolder, vat.h/TempFolderName, vat.h/ValidateSymName, vat.h/VarRecall, wingraph.h/WinBitmapPut, unknown.h/_bcd_math
+Out_EV_eventLoop=1

+ 33 - 33
tigcc/doc/System/Include/bascmd.h/cmd_delfold.hsf

@@ -1,33 +1,33 @@
-[Main]
-Name=cmd_delfold
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_delfold (CESI FolderNameList);
-MinAMS=1.01
-See Also=cmd_newfold, vat.h/FolderDel
-
-[ROM Call]
-Index=$33A
-
-[Description]
-Executes TI-Basic 'DelFold' command.
-
-[Explanation]
-cmd_delfold deletes one or more empty folders. It expects the following
-layout on the expression stack:
-<BR><BR>
-<A HREF="$$LINK(estack.h/Tags)">END_TAG</A> <I>symname_n</I> ... <I>symname_2</I> <I>symname_1</I>
-<BR><BR>
-<I>symname_1</I>, <I>symname_2</I>, etc. are VAT symbol names
-(see <A HREF="$$LINK(vat.h/SYMSTR)">SYMSTR</A> and
-<A HREF="$$LINK(estack.h/Tags)">Tags</A> for more info) of folders which
-are supposed to be deleted. The <I>FolderNameList</I> parameter should point
-to the tag of the last item. This function may be used as a high-level
-alternative for the low-level function
-<A HREF="$$LINK(vat.h/FolderDel)">FolderDel</A> from the
-<A HREF="$$LINK(vat.h/)">vat.h</A> header file.
-
-[References]
-Out=estack.h/next_expression_index, statline.h/ST_folder, vat.h/DerefSym, vat.h/HSymDel, vat.h/SymFindHome
-Out_EV_eventLoop=1
+[Main]
+Name=cmd_delfold
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_delfold (CESI FolderNameList);
+MinAMS=1.01
+See Also=cmd_newfold, vat.h/FolderDel
+
+[ROM Call]
+Index=$33A
+
+[Description]
+Executes TI-Basic 'DelFold' command.
+
+[Explanation]
+cmd_delfold deletes one or more empty folders. It expects the following
+layout on the expression stack:
+<BR><BR>
+<A HREF="$$LINK(estack.h/Tags)">END_TAG</A> <I>symname_n</I> ... <I>symname_2</I> <I>symname_1</I>
+<BR><BR>
+<I>symname_1</I>, <I>symname_2</I>, etc. are VAT symbol names
+(see <A HREF="$$LINK(vat.h/SYMSTR)">SYMSTR</A> and
+<A HREF="$$LINK(estack.h/Tags)">Tags</A> for more info) of folders which
+are supposed to be deleted. The <I>FolderNameList</I> parameter should point
+to the tag of the last item. This function may be used as a high-level
+alternative for the low-level function
+<A HREF="$$LINK(vat.h/FolderDel)">FolderDel</A> from the
+<A HREF="$$LINK(vat.h/)">vat.h</A> header file.
+
+[References]
+Out=estack.h/next_expression_index, statline.h/ST_folder, vat.h/DerefSym, vat.h/HSymDel, vat.h/SymFindHome
+Out_EV_eventLoop=1

+ 33 - 33
tigcc/doc/System/Include/bascmd.h/cmd_delvar.hsf

@@ -1,33 +1,33 @@
-[Main]
-Name=cmd_delvar
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_delvar (CESI VarNameList);
-MinAMS=1.01
-See Also=vat.h/SymDel
-
-[ROM Call]
-Index=$33B
-
-[Description]
-Executes TI-Basic 'DelVar' command.
-
-[Explanation]
-This function deletes one or more TI-Basic variables. It expects the
-following layout on the expression stack:
-<BR><BR>
-<A HREF="$$LINK(estack.h/Tags)">END_TAG</A> <I>symname_n</I> ... <I>symname_2</I> <I>symname_1</I>
-<BR><BR>
-<I>symname_1</I>, <I>symname_2</I>, etc. are VAT symbol names
-(see <A HREF="$$LINK(vat.h/SYMSTR)">SYMSTR</A> and
-<A HREF="$$LINK(estack.h/Tags)">Tags</A> for more info) of variables which
-are supposed to be deleted. The <I>VarNameList</I> parameter should point to
-the tag of the last item. This function may be used as a high-level
-alternative for the low-level function
-<A HREF="$$LINK(vat.h/SymDel)">SymDel</A> from the
-<A HREF="$$LINK(vat.h/)">vat.h</A> header file.
-
-[References]
-Out=alloc.h/HeapFree, estack.h/next_expression_index, vat.h/DerefSym, vat.h/HSymDel, vat.h/VarRecall, unknown.h/_ROM_CALL_46B
-Out_EV_eventLoop=1
+[Main]
+Name=cmd_delvar
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_delvar (CESI VarNameList);
+MinAMS=1.01
+See Also=vat.h/SymDel
+
+[ROM Call]
+Index=$33B
+
+[Description]
+Executes TI-Basic 'DelVar' command.
+
+[Explanation]
+This function deletes one or more TI-Basic variables. It expects the
+following layout on the expression stack:
+<BR><BR>
+<A HREF="$$LINK(estack.h/Tags)">END_TAG</A> <I>symname_n</I> ... <I>symname_2</I> <I>symname_1</I>
+<BR><BR>
+<I>symname_1</I>, <I>symname_2</I>, etc. are VAT symbol names
+(see <A HREF="$$LINK(vat.h/SYMSTR)">SYMSTR</A> and
+<A HREF="$$LINK(estack.h/Tags)">Tags</A> for more info) of variables which
+are supposed to be deleted. The <I>VarNameList</I> parameter should point to
+the tag of the last item. This function may be used as a high-level
+alternative for the low-level function
+<A HREF="$$LINK(vat.h/SymDel)">SymDel</A> from the
+<A HREF="$$LINK(vat.h/)">vat.h</A> header file.
+
+[References]
+Out=alloc.h/HeapFree, estack.h/next_expression_index, vat.h/DerefSym, vat.h/HSymDel, vat.h/VarRecall, unknown.h/_ROM_CALL_46B
+Out_EV_eventLoop=1

文件差異過大導致無法顯示
+ 0 - 27
tigcc/doc/System/Include/bascmd.h/cmd_dialog.hsf


文件差異過大導致無法顯示
+ 0 - 26
tigcc/doc/System/Include/bascmd.h/cmd_disp.hsf


+ 21 - 21
tigcc/doc/System/Include/bascmd.h/cmd_dispg.hsf

@@ -1,21 +1,21 @@
-[Main]
-Name=cmd_dispg
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_dispg (void);
-MinAMS=1.01
-
-[ROM Call]
-Index=$33E
-
-[Description]
-Executes TI-Basic 'DispG' command.
-
-[Explanation]
-cmd_dispg displays the current contents of the Graph Screen window by switching to
-the "Graph" application (see the <A HREF="$$LINK(events.h/)">events.h</A> header file for more information
-about switching applications).
-
-[References]
-Out=unknown.h/GraphActivate
+[Main]
+Name=cmd_dispg
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_dispg (void);
+MinAMS=1.01
+
+[ROM Call]
+Index=$33E
+
+[Description]
+Executes TI-Basic 'DispG' command.
+
+[Explanation]
+cmd_dispg displays the current contents of the Graph Screen window by switching to
+the "Graph" application (see the <A HREF="$$LINK(events.h/)">events.h</A> header file for more information
+about switching applications).
+
+[References]
+Out=unknown.h/GraphActivate

+ 28 - 28
tigcc/doc/System/Include/bascmd.h/cmd_disphome.hsf

@@ -1,28 +1,28 @@
-[Main]
-Name=cmd_disphome
-Type=Function
-Subtype=ROM Call
-Header Files=bascmd.h
-Definition=void cmd_disphome (void);
-MinAMS=1.01
-
-[ROM Call]
-Index=$33F
-
-[Description]
-Executes TI-Basic 'DispHome' command.
-
-[Explanation]
-cmd_disphome displays the current content of the Home Screen window.
-More precise, it starts the Home application if it is not already running, and makes sure the
-Home Screen window is being displayed switching from the Program I/O window if necessary.
-The OS will deactivate or terminate the current application to activate the
-Home Screen.
-<BR><BR>
-<B>Note:</B> If you used any function from this header file which displays various windows which
-are different than Home Screen window (for example, TI-Basic Program I/O Screen window), use
-cmd_disphome before returning from your program to activate the Home Screen again!
-
-[References]
-Out=alloc.h/HeapFreeIndir, estack.h/bottom_estack, events.h/EV_setCmdState, events.h/EV_setFKeyState, events.h/EV_startApp, homescr.h/HS_countFIFO, statline.h/ST_stack, textedit.h/TE_focus, unknown.h/EV_currentApp, unknown.h/EV_quit, wingraph.h/WinActivate, wingraph.h/WinDeactivate, wingraph.h/WinFill, wingraph.h/WinHide, unknown.h/_ROM_CALL_471, unknown.h/_ROM_CALL_5DE
-Out_EV_eventLoop=1
+[Main]
+Name=cmd_disphome
+Type=Function
+Subtype=ROM Call
+Header Files=bascmd.h
+Definition=void cmd_disphome (void);
+MinAMS=1.01
+
+[ROM Call]
+Index=$33F
+
+[Description]
+Executes TI-Basic 'DispHome' command.
+
+[Explanation]
+cmd_disphome displays the current content of the Home Screen window.
+More precise, it starts the Home application if it is not already running, and makes sure the
+Home Screen window is being displayed switching from the Program I/O window if necessary.
+The OS will deactivate or terminate the current application to activate the
+Home Screen.
+<BR><BR>
+<B>Note:</B> If you used any function from this header file which displays various windows which
+are different than Home Screen window (for example, TI-Basic Program I/O Screen window), use
+cmd_disphome before returning from your program to activate the Home Screen again!
+
+[References]
+Out=alloc.h/HeapFreeIndir, estack.h/bottom_estack, events.h/EV_setCmdState, events.h/EV_setFKeyState, events.h/EV_startApp, homescr.h/HS_countFIFO, statline.h/ST_stack, textedit.h/TE_focus, unknown.h/EV_currentApp, unknown.h/EV_quit, wingraph.h/WinActivate, wingraph.h/WinDeactivate, wingraph.h/WinFill, wingraph.h/WinHide, unknown.h/_ROM_CALL_471, unknown.h/_ROM_CALL_5DE
+Out_EV_eventLoop=1

部分文件因文件數量過多而無法顯示